HIbernate實體類注解配置

一、類級別注解

1、@Entity(name="EntityName") 

必須

name為可選,對應數據庫中一的個表

2、@Table(name="",catalog="",schema="")

可選,通常和@Entity配合使用,只能標注在實體的class定義處,表示實體對應的數據庫表的信息

name:可選,表示表的名稱.默認地,表名和實體名稱一致,只有在不一致的情況下才需要指定表名

catalog:可選,表示Catalog名稱,默認為Catalog("").

schema:可選,表示Schema名稱,默認為Schema("").

二、屬性級別注解

1、@id

必須，定義映射到數據庫表的主鍵的屬性,一個實體只能有一個屬性被映射為主鍵.置於getXxxx()前.

2、@GeneratedValue(strategy=GenerationType,generator="")

可選

strategy:表示主鍵生成策略,有AUTO,INDENTITY,SEQUENCE 和 TABLE 4種,分別表示讓ORM框架自動選擇,根據數據庫的Identity字段自動生成（主要是自動增長類型的主鍵，適用於sql server,mysql，DB2，MS等數據庫中,oracle不適用）,根據數據庫表的Sequence字段生成（oracle，DB2使用該種）,使用一個特定的數據庫表格來保存主鍵,默認為AUTO

generator:表示主鍵生成器的名稱,這個屬性通常和ORM框架相關,例如,Hibernate可以指定uuid、native等主鍵生成方式.

示例:

@Id
@GeneratedValues(strategy=StrategyType.INDETITY)
public int getId() {
    return id;
}

3、@Basic(fetch=FetchType,optional=true)

可選，@Basic表示一個簡單的屬性到數據庫表的字段的映射,對於沒有任何標注的getXxxx()方法,默認即為@Basic

fetch: 表示該屬性的讀取策略,有EAGER和LAZY兩種,分別表示主支抓取和延遲加載,默認為EAGER.

optional:表示該屬性是否允許為null,默認為true

示例:

@Basic(optional=false)
public String getAddress() {
    return address;
}

4、@Column

可選，@Column描述了數據庫表中該字段的詳細定義,這對於根據JPA注解生成數據庫表結構的工具非常有作用.

name:表示數據庫表中該字段的名稱,默認情形屬性名稱一致

nullable:表示該字段是否允許為null,默認為true

unique:表示該字段是否是唯一標識,默認為false

length:表示該字段的大小,僅對String類型的字段有效

insertable:表示在ORM框架執行插入操作時,該字段是否應出現INSETRT語句中,默認為true

updateable:表示在ORM框架執行更新操作時,該字段是否應該出現在UPDATE語句中,默認為true.對於一經創建就不可以更改的字段,該屬性非常有用,如對於birthday字段.

columnDefinition:表示該字段在數據庫中的實際類型.通常ORM框架可以根據屬性類型自動判斷數據庫中字段的類型,但是對於Date類型仍無法確定數據庫中字段類型究竟是DATE,TIME還是TIMESTAMP.此外,String的默認映射類型為VARCHAR,如果要將String類型映射到特定數據庫的BLOB或TEXT字段類型,該屬性非常有用.

示例:

@Column(name="BIRTH",nullable="false",columnDefinition="DATE")
public String getBithday() {
    return birthday;
}

5、@Temporal

可選，用於定義映射到數據庫的時間精度

@Temporal(TemporalType=DATE)       日期

@Temporal(TemporalType=TIME)       時間

@Temporal(TemporalType=TIMESTAMP) 兩者兼具

6、@Transient

可選，@Transient表示該屬性並非一個到數據庫表的字段的映射,ORM框架將忽略該屬性.

如果一個屬性並非數據庫表的字段映射,就務必將其標示為@Transient,否則,ORM框架默認其注解為@Basic

示例:

//根據birth計算出age屬性
@Transient
public int getAge() {
    return getYear(new Date()) - getYear(birth);
}

 三、映射繼承關系

1、@Inheritance(strategy)

定義所選擇的策略. 這個注解需要在每個類層次結構(class hierarchy) 最頂端的實體類上使用

strategy繼承類所選策略，InheritanceType.TABLE_PER_CLASS，InheritanceType.SINGLE_TABLE，InheritanceType.JOINED

2、@MappedSuperclass

可選，將超類的JPA注解傳遞給子類,使子類能夠繼承超類的JPA注解。

• 標注為@MappedSuperclass的類將不是一個完整的實體類，他將不會映射到數據庫表，但是他的屬性都將映射到其子類的數據庫字段中。
• 標注為@MappedSuperclass的類不能再標注@Entity或@Table注解，也無需實現序列化接口。

示例:

@MappedSuperclass 
public class Employee() { 
    .... 
} 
   
@Entity 
@Table(name="engineer")
public class Engineer extends Employee { 
    ..... 
} 

@Entity 
@Table(name="manager")
public class Manager extends Employee { 
    ..... 
}

3、@Embedded

可選

@Embedded將幾個字段組合成一個類,並作為整個Entity的一個屬性.

例如User包括id,name,city,street,zip屬性.

我們希望city,street,zip屬性映射為Address對象.這樣,User對象將具有id,name和address這三個屬性.

Address對象必須定義為@Embededable

示例:

@Embeddable 
public class Address {city,street,zip} 

@Entity
@Table(name="user") 
public class User { 
    @Embedded 
    @AttributeOverrides( {@AttributeOverride(name = "firstName", column = @Column(name = "first_name")),...})
    public Address getAddress() { 
        .......... 
    } 
}    

 

四、映射實體bean的關聯關系

1、共有屬性

1.1、fetch

配置加載方式

Fetch.EAGER -  及時加載，多對一默認是Fetch.EAGER 

Fetch.LAZY - 延遲加載，一對多默認是Fetch.LAZY

1.2、cascade

設置級聯方式

CascadeType.PERSIST - 保存

CascadeType.REMOVE - 刪除

CascadeType.MERGE - 修改

CascadeType.REFRESH - 刷新

CascadeType.ALL - 全部

1.3、targetEntity

配置集合屬性類型，如：@OneToMany(targetEntity=Book.class)

1.4、@JoinColumn

可選

@JoinColumn和@Column類似,這里描述的不是一個簡單字段,而是一個關聯字段（通常是外鍵）,例如.描述一個@ManyToOne的字段.

name:該字段的名稱.由於@JoinColumn描述的是一個關聯字段,如ManyToOne,則默認的名稱由其關聯的實體決定.

例如,實體Order有一個user屬性來關聯實體User,則Order的user屬性為一個外鍵,

其默認的名稱為實體User的名稱+下划線+實體User的主鍵名稱

2、@ManyToOne(fetch=FetchType,cascade=CascadeType)

可選，表示一個多對一的映射,該注解標注的屬性通常是數據庫表的外鍵

optional:是否允許該字段為null,該屬性應該根據數據庫表的外鍵約束來確定,默認為true

fetch:表示抓取策略,默認為FetchType.EAGER

cascade:表示默認的級聯操作策略,可以指定為ALL,PERSIST,MERGE,REFRESH和REMOVE中的若干組合,默認為無級聯操作

targetEntity:表示該屬性關聯的實體類型.該屬性通常不必指定,ORM框架根據屬性類型自動判斷targetEntity.

示例：

    //訂單Order和用戶User是一個ManyToOne的關系 ，@JoinColumn定義外鍵列名
    //在Order類中定義 
    @ManyToOne() 
    @JoinColumn(name="userid") 
    public User getUser() { 
       return user; 
    }

3、@OneToMany(fetch=FetchType,cascade=CascadeType)

可選，描述一個一對多的關聯,該屬性應該為集體類型,在數據庫中並沒有實際字段。默認會使用連接表做一對多關聯，添加@JoinColumn(name="xxx_id") 后，就會使用外鍵關聯，而不使用連接表了。

fetch:表示抓取策略,默認為FetchType.LAZY,因為關聯的多個對象通常不必從數據庫預先讀取到內存

cascade:表示級聯操作策略,對於OneToMany類型的關聯非常重要,通常該實體更新或刪除時,其關聯的實體也應當被更新或刪除

例如:實體User和Order是OneToMany的關系,則實體User被刪除時,其關聯的實體Order也應該被全部刪除

示例:

    //用戶User和訂單Order是一個OneToMany的關系,@JoinColumn(name="對方的數據庫表外鍵列名") 
    //在User類中定義 
    @OneToMany(mappyedBy="user") 
    @JoinColumn(name="userid")
    public <Set>Order getOrders() { 
       return orders; 
    }

4、@OneToOne(fetch=FetchType,cascade=CascadeType)

可選，描述一個一對一的關聯

fetch:表示抓取策略,默認為FetchType.LAZY

cascade:表示級聯操作策略

（1）主表類A與從表類B的主鍵值相對應。
 主表：

@OneToOne(cascade = CascadeType.ALL)
@PrimaryKeyJoinColumn
public B getB(){
    Return b;
}

從表：無

（2）主表A中有一個從表屬性是B類型的b

主表：

@OneToOne(cascade = CascadeType.ALL)
@JoinColumn(name="主表外鍵")   //這里指定的是數據庫中的外鍵字段。
public B getB(){
    return b;
}

從表：無

（3）主表A中有一個從表屬性是B類型的b，同時，從表B中有一個主表屬性是A類型的a
主表：

@OneToOne(cascade = CascadeType.ALL)
@JoinColumn(name="主表外鍵")   //這里指定的是數據庫中的外鍵字段。
public B getB(){
    return b;
}

從表：

@OneToOne(mappedBy = "主表類中的從表屬性")
public 主表類 get主表類(){
    return 主表對象
}

  注意：@JoinColumn是可選的。默認值是從表變量名+"_"+從表的主鍵（注意，這里加的是主鍵。而不是主鍵對應的變量）。

示例:

@OneToOne(fetch=FetchType.LAZY)
public Blog getBlog() {
    return blog;
}

5、@ManyToMany

可選，描述一個多對多的關聯.多對多關聯上是兩個一對多關聯,但是在ManyToMany描述中,中間表是由ORM框架自動處理

targetEntity:表示多對多關聯的另一個實體類的全名,例如:package.Book.class

mappedBy:表示多對多關聯的另一個實體類的對應集合屬性名稱

fetch:表示抓取策略

cascade:表示級聯操作策略

示例:

　　Teacher實體表示教師,Student實體表示學生,為了描述教師和學生關系,可以在Teacher和Student之間建立ManyToMany關聯

public class Student{
    private Set<Teacher> teachers=new HashSet<Teacher>();
    @ManyToMany
    @JoinTable(name="teacher_student",joinColumns={@JoinColumn(name="sid")},inverseJoinColumns={@JoinColumn(name="tid")})
    public Set<Teacher> getTeachers() {
        return teachers;
    }
}

public class Teacher{
    private Set<Student> students=new HashSet<Student>();
    @ManyToMany(mappedBy="teachers")
    public Set<Student> getStudents() {
        return students;
    }
}

6、@JoinTable

通過表關聯的方式來映射一對多或者多對多的關系時，要使用@JoinTable這個標記

無注解屬性的默認值

1）如果屬性為單一類型,則映射為@Basic，

2）如果屬性對應的類型定義了@Embeddable注解,則映射為@Embedded

3）如果屬性對應的類型實現了Serializable, 則屬性被映射為@Basic並在一個列中保存該對象的serialized版本

4）如果該屬性的類型為java.sql.Clob 或 java.sql.Blob,則作為@Lob並映射到適當的LobType.。