1. 程式人生 > >Hibernate註解使用方法總結

Hibernate註解使用方法總結

轉載至:http://blog.csdn.net/arybd/article/details/52065030

1.類級別註解

@Entity     對映實體類

@Table    對映數句庫表

@Entity(name="tableName") - 必須,註解將一個類宣告為一個實體bean。

屬性:

name - 可選,對應資料庫中的一個表。若表名與實體類名相同,則可以省略。

@Table(name="",catalog="",schema="")  - 可選,通常和@Entity 配合使用,只能標註在實  體的 class 定義處,表示實體對應的資料庫表的資訊。

屬性:

name - 可選,表示表的名稱,預設地,表名和實體名稱一致,只有在不一致的情況下才需要指定表名

catalog - 可選,表示Catalog名稱,預設為 Catalog("").

schema - 可選 , 表示 Schema 名稱 , 預設為Schema("").

2.屬性級別註解

@Id     對映生成主鍵

@Version    定義樂觀鎖

@Column     對映表的列

@Transient     定義暫態屬性  

2.1 與主鍵相關注解

@Id - 必須,定義了對映到資料庫表的主鍵的屬性,一個實體只能有一個屬性被對映為主鍵,置於 getXxxx() 前。

@GeneratedValue(strategy=GenerationType,generator="") - 可選,用於定義主鍵生成策略。

屬性:

Strategy - 表示主鍵生成策略,取值有:

GenerationType.AUTO - 根據底層資料庫自動選擇(預設),若資料庫支援自動增長型別,則為自動增長。

GenerationType.INDENTITY - 根據資料庫的Identity欄位生成,支援DB2、MySQL、MS、SQL Server、SyBase與HyperanoicSQL資料庫的Identity 型別主鍵。

GenerationType.SEQUENCE

 - 使用Sequence來決定主鍵的取值,適合Oracle、DB2等 支援Sequence的資料庫,一般結合@SequenceGenerator使用。

沒有自動增長型別,只能用Sequence)

GenerationType.TABLE  - 使用指定表來決定主鍵取值,結合@TableGenerator使用。

如:

@Id

@TableGenerator(name="tab_cat_gen",allocationSize=1)

@GeneratedValue(Strategy=GenerationType.Table)

Generator - 表示主鍵生成器的名稱,這個屬性通常和ORM框架相關 , 例如:

hibernate 可以指定 uuid 等主鍵生成方式

@SequenceGenerator — 註解聲明瞭一個數據庫序列。

屬性:
name - 表示該表主鍵生成策略名稱,它被引用在@GeneratedValue中設定的“gernerator”值中。
sequenceName - 表示生成策略用到的資料庫序列名稱。
initialValue - 表示主鍵初始值,預設為0.
allocationSize - 每次主鍵值增加的大小,例如設定成1,則表示每次建立新記錄後自動加1,預設為50.

示例 :

    @Id

    @GeneratedValues(strategy=StrategyType.SEQUENCE)

    public int getPk() {

       return pk;  

    } 

Hibernate的訪問型別為field時,在欄位上進行註解聲;

訪問型別為property時,在getter方法上進行註釋宣告。

2.2 與非主鍵相關注解

@Version - 可以在實體bean中使用@Version註解,通過這種方式可新增對樂觀鎖定的支援

@Basic - 用於宣告屬性的存取策略:

@Basic(fetch=FetchType.EAGER)   即時獲取(預設的存取策略)

@Basic(fetch=FetchType.LAZY)    延遲獲取

@Temporal - 用於定義對映到資料庫的時間精度:

@Temporal(TemporalType=DATE)       日期

@Temporal(TemporalType=TIME)       時間

@Temporal(TemporalType=TIMESTAMP) 兩者兼具

@Column - 可將屬性對映到列,使用該註解來覆蓋預設值,@Column描述了資料庫表中該欄位的詳細定義,這對於根據 JPA 註解生成資料庫表結構的工具非常有作用。

屬性:

name - 可選,表示資料庫表中該欄位的名稱,預設情形屬性名稱一致

nullable - 可選,表示該欄位是否允許為 null,預設為 true

unique - 可選,表示該欄位是否是唯一標識,預設為 false

length - 可選,表示該欄位的大小,僅對 String 型別的欄位有效,預設值255.

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;

 }

@Transient - 可選,表示該屬性並非一個到資料庫表的欄位的對映,ORM框架將忽略該屬性,如果一個屬性並非資料庫表的欄位對映,就務必將其標示為@Transient,否則ORM 框架預設其註解為 @Basic

示例 :

    // 根據 birth 計算出 age 屬性

    @Transient

    public int getAge() {

       return getYear(new Date()) - getYear(birth);

    }

2.3無註解屬性的預設值

如果屬性為單一型別,則對映為@Basic

否則,如果屬性對應的型別定義了@Embeddable註解,則對映為@Embedded

否則,如果屬性對應的型別實現了Serializable, 則屬性被對映為@Basic並在一個列中儲存該物件的serialized版本,

否則,如果該屬性的型別為Java.sql.Clob  java.sql.Blob,則作為@Lob並對映到適當的LobType.

3.對映繼承關係

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

4.對映實體bean的關聯關係

4.1關聯對映的一些定義

單向一對多:一方有集合屬性,包含多個多方,而多方沒有一方的引用。使用者--->電子郵件

單向多對一:多方有一方的引用,一方沒有多方的引用。論文類別---> 類別

雙向一對多:兩邊都有多方的引用,方便查詢。班級---> 學生

雙向多對一:兩邊都有多方的引用,方便查詢。

單向多對多:需要一箇中間表來維護兩個實體表。論壇--->文章

單向一對一:資料唯一,資料庫資料也是一對一。艦船---> 水手

主鍵相同的一對一:使用同一個主鍵,省掉外來鍵關聯。客戶---> 地址

單向:關係寫哪邊,就由誰管理。

雙向:一般由多方管理。

@OneToMany(mappedBy="對方") //反向配置,對方管理。

4.2 關聯對映的一些共有屬性

@OneToOne@OneToMany@ManyToOneManyToMany的共有屬性:

fetch - 配置載入方式。取值有

Fetch.EAGER -  及時載入,多對一預設是Fetch.EAGER 

Fetch.LAZY - 延遲載入,一對多預設是Fetch.LAZY

cascade - 設定級聯方式,取值有:

CascadeType.PERSIST - 儲存

CascadeType.REMOVE - 刪除

CascadeType.MERGE - 修改

CascadeType.REFRESH - 重新整理

CascadeType.ALL - 全部

targetEntity - 配置集合屬性型別,如:@OneToMany(targetEntity=Book.class)

@JoinColumn - 可選,用於描述一個關聯的欄位。

@JoinColumn和@Column類似,介量描述的不是一個簡單欄位,而是一個關聯欄位,例如描述一個 @ManyToOne 的欄位。

屬性:

name - 該欄位的名稱,由於@JoinColumn描述的是一個關聯欄位,如ManyToOne, 則預設的名稱由其關聯的實體決定。

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

其預設的名稱為實體User的名稱 + 下劃線 + 實體User的主鍵名稱

4.3 一對一關聯

@OneToOne  表示一個一對一的對映

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是可選的。預設值是從表變數名+"_"+從表的主鍵(注意,這裡加的是主鍵。而不是主鍵對應的變數)。

4.4 多對一關聯

@ManyToOne - 表示一個多對一的對映,該註解標註的屬性通常是資料庫表的外來鍵。

1.單向多對一:多方有一方的引用,一方沒有多方的引用。

           在多方

@ManyToOne(targetEntity=XXXX.class)   //指定關聯物件

@JoinColumn(name="")                            //指定產生的外來鍵欄位名

2.雙向多對一:配置方式同雙向一對多。

示例 :

    // 訂單 Order 和使用者 User 是一個 ManyToOne 的關係

    // 在 Order 類中定義

    @ManyToOne()

    @JoinColumn(name="USER")

    public User getUser() {

       return user;

    }

4.5 一對多關聯

@OneToMany - 描述一個一對多的關聯,該屬性應該為集合型別,在資料庫中並沒有實際欄位。

1.單向一對多:一方有集合屬性,包含多個多方,而多方沒有一方的引用。

@OneToMany  預設會使用連線表做一對多關聯

新增@JoinColumn(name="xxx_id") 後,就會使用外來鍵關聯,而不使用連線表了。

2.雙向一對多

1)在多方

@ManyToOne

@JoinColumn(name="自己的資料庫外來鍵列名")

2)在一方

@OneToMany(mappedBy="多端的關聯屬性名")

@JoinColumn(name="對方的資料庫外來鍵列名")

4.6 多對多關聯

@ManyToMany - 可選,描述一個多對多的關聯。

屬性:

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

mappedBy - 用在雙向關聯中,把關係的維護權翻轉。

1.單向多對多關聯:

    在主控方加入@ManyToMany註解即可。

2.雙向多對多關聯:

    兩個實體間互相關聯的屬性必須標記為@ManyToMany,並相互指定targetEntity屬性。有且只有一個實體的@ManyToMany註解需要指定mappedBy屬性,指向targetEntity的集合屬性名稱。

以下為使用註解的例項:

我們以產品型別ProductType類和產品Product類為例,一個產品型別對應多個產品,刪除產品型別將該型別下的所有產品同時刪除。首先需要@OneToMany和@ManyToOne標籤來設定外來鍵約束。

在一對多的關係中,一是關係維護端(owner side),多是關係被維護端(inverse side)。

@OneToMany有5個屬性:targetEntity,fetch,mappedBy,orphanRemoval,cascade

# targetEntity   (Class targetEntity() default void.class;)  屬性表示預設關聯的實體型別,預設為當前標註的實體類;
因為一對多的實體集合時儲存在集合類中,因此必須指明集合類中儲存的具體型別:
1)指定集合泛型的具體型別;如:public List<Product> getProducts() {...}
2)指定targetEntity屬性型別;如:@OneToMany(targetEntity=Product.class,...)

# fetch  (FetchType fetch() default LAZY;)  屬性是該實體的載入方式,FetchType是列舉型別,值有兩種:LAZY和EAGER。一對多,一的一方,FetchType預設是LAZY, 多的一方FetchType預設是EAGER。如果在欄位中宣告為Eager,那麼在取得當前Bean時,同時會抓取Bean中的關聯Bean值。即資料庫查詢多次。反之Lazy則在之後抓取提交查詢。具體實驗講解:[Hibernate] - EAGER and LAZY

@OneToMany(

#orphanRemoval  (boolean orphanRemoval() default false;)  屬性作用是刪除孤立記錄,即外來鍵為空的型別,預設為false。該屬性為true時會根據外來鍵執行級聯刪除,因為當你刪除productType的記錄時,會使product表的記錄外來鍵被刪除變為孤立記錄,該屬性進而將孤立記錄刪除掉。但hibernate實際執行的語句是先刪除product表中的記錄,後刪除productType表中的記錄。

#cascade  (CascadeType[] cascade() default {};)  級聯屬性,預設為空。該屬性其實是一個值為列舉型別CascadeType的陣列,在jpa的CascadeType列舉型別裡面,有PERSIST(級聯儲存操作),MERGE(合併(merge=save+update)),REMOVE(級聯刪除操作),REFRESH(級聯重新整理操作),DETACH(級聯分離操作),ALL(所有級聯操作)等6個列舉變數,其中DETACH是jpa2.0新加入的變數。這些變數的作用和他們的名字一樣,可以很清楚的辨別出。這裡我現在僅僅用過級聯刪除操作,其他的操作都僅僅是從名字和註釋上猜測的,留待以後測試

上面是jpa的級聯操作,但在網上很多教程中往往寫到用CascadeType.DELETE_ORPHAN,該操作屬於hibernate自身的級聯操作,在hibernate4中已宣告過時,並推薦使用orphanRemoval屬性來級聯刪除記錄。

在級聯刪除記錄時,要先用hibernate.load()方法載入持久化物件,然後才能根據外來鍵進行級聯刪除。至於load()方法和get()方法有什麼不同,這裡有一篇博文講的不錯:hibernate session的常用方法解析

注意:改變model類的時候可能需要重新建表,如果級聯刪除不成功可以試一下。

下面開始程式碼,首先是productType類,要求刪除type的時候要刪掉該type對應的所有product:

  1. package com.nanwang.model;  
  2. import java.util.ArrayList;  
  3. import java.util.List;  
  4. import javax.persistence.Column;  
  5. import javax.persistence.Entity;  
  6. import javax.persistence.GeneratedValue;  
  7. import javax.persistence.Id;  
  8. import javax.persistence.OneToMany;  
  9. import org.hibernate.annotations.Cascade;  
  10. import org.hibernate.annotations.CascadeType;  
  11. /** 
  12.  * @author wang