天天看點

JPA的Column注解總結

就像@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表示小數點所占的位數。

在使用此@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方法前:

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

下面舉幾個小例子:

示例一:指定字段“contact_name”的長度是“512”,并且值不能為null。

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

建立的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;

monthly_income double(12,2),

示例三:自定義生成CLOB類型字段的SQL語句。

@Column(name=" contact_name ",columnDefinition="clob not null")

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

contact_name clob (200) not null,

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

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

示例四:字段值為隻讀的,不允許插入和修改。通常用于主鍵和外鍵。

private Integer id;

@Column(name="id",insertable=false,updatable=false)

public Integer getId() {

return id;