JPA的Column註解總結

Love Lenka發表於2016-10-20

就像@Table註解用來標識實體類與資料表的對應關係類似,@Column註解來標識實體類中屬性與資料表中欄位的對應關係。

該註解的定義如下:

@Target({METHOD, FIELD}) @Retention(RUNTIME)
public @interface Column {
String name() default "";
boolean unique() default false;
boolean nullable() default true;
boolean insertable() default true;
boolean updatable() default true;
String columnDefinition() default "";
String table() default "";
int length() default 255;
int precision() default 0;
int scale() default 0;
}

從定義可以看出,@Column註解一共有10個屬性,這10個屬性均為可選屬性,各屬性含義分別如下:

name
name屬性定義了被標註欄位在資料庫表中所對應欄位的名稱;

unique
unique屬性表示該欄位是否為唯一標識,預設為false。如果表中有一個欄位需要唯一標識,則既可以使用該標記,也可以使用@Table標記中的@UniqueConstraint。

nullable
nullable屬性表示該欄位是否可以為null值,預設為true。

insertable
insertable屬性表示在使用“INSERT”指令碼插入資料時,是否需要插入該欄位的值。

updatable
updatable屬性表示在使用“UPDATE”指令碼插入資料時,是否需要更新該欄位的值。insertable和updatable屬性一般多用於只讀的屬性,例如主鍵和外來鍵等。這些欄位的值通常是自動生成的。

columnDefinition
columnDefinition屬性表示建立表時,該欄位建立的SQL語句,一般用於透過Entity生成表定義時使用。(也就是說,如果DB中表已經建好,該屬性沒有必要使用。)

table
table屬性定義了包含當前欄位的表名。

length
length屬性表示欄位的長度,當欄位的型別為varchar時,該屬性才有效,預設為255個字元。

precision和scale
precision屬性和scale屬性表示精度,當欄位型別為double時,precision表示數值的總長度,scale表示小數點所佔的位數。

API文件地址:http://docs.oracle.com/javaee/5/api/javax/persistence/Column.html

在使用此@Column標記時,需要注意以下幾個問題:

此標記可以標註在getter方法或屬性前,例如以下的兩種標註方法都是正確的:

標註在屬性前:

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Table;

@Entity
@Table(name = "contact")
public class ContactEO {

@Column(name = " contact_name ")
private String name;

public String getName() {
return name;
}

public void setName(String name) {
this.name = name;
}
}

標註在getter方法前:

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Table;

@Entity
@Table(name = "contact")
public class ContactEO {
private String name;

@Column(name = " contact_name ")
public String getName() {
return name;
}

public void setName(String name) {
this.name = name;
}
}

提示:JPA規範中並沒有明確指定那種標註方法,只要兩種標註方式任選其一都可以。這根據個人的喜好來選擇,筆者習慣使用第二種方法。

下面舉幾個小例子:

示例一:指定欄位“contact_name”的長度是“512”,並且值不能為null。

private String name;
@Column(name="contact_name",nullable=false,length=512)

public String getName() {
return name;

}

建立的SQL語句如下所示。

CREATE TABLE contact (
id integer not null,
contact_name varchar (512) not null,
primary key (id)
)

示例二:指定欄位“monthly_income”月收入的型別為double型,精度為12位,小數點位數為2位。

private BigDecimal monthlyIncome;
@Column(name="monthly_income",precision=12, scale=2)
public BigDecimal getMonthlyIncome() {
return monthlyIncome;
}

建立的SQL語句如下所示。

CREATE TABLE contact (
id integer not null,
monthly_income double(12,2),
primary key (id)
)

示例三:自定義生成CLOB型別欄位的SQL語句。

private String name;
@Column(name=" contact_name ",columnDefinition="clob not null")
public String getName() {
return name;
}

生成表的定義SQL語句如下所示。

CREATE TABLE contact (
id integer not null,
contact_name clob (200) not null,
primary key (id)
)

其中,加粗的部分為columnDefinition屬性設定的值。若不指定該屬性,通常使用預設的型別建表,若此時需要自定義建表的型別時,可在該屬性中設定。

提示:透過Entity定義生成表,還是透過表配置Entity,這是兩種不同的ORM策略。

示例四:欄位值為只讀的,不允許插入和修改。通常用於主鍵和外來鍵。

private Integer id;

@Column(name="id",insertable=false,updatable=false)
public Integer getId() {
return id;
}

相關文章