Hibernate註解的使用詳解
1、配置對映關係的xml方式
我們知道,Hibernate是一個典型的ORM框架,用以解決物件和關係的不匹配。其思想就是將關係資料庫中表的記錄對映成為物件,以物件形式展現,這樣一來,就可以把對資料庫的操作轉化為對物件的操作。
而ORM一般是採用xml的格式儲存物件與關係資料表的對映,我們也可以從下面示例中看到hibernate中的一個對映配置表的表現形式:
<?xml version="1.0" encoding="utf-8"?> 2 <!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN" 3 "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd"> 4 5 <hibernate-mapping> 6 <class name="com.zker.model.job.SysJob" table="SYS_JOB" lazy="true"> 7 <id name="jobId" column="JOB_ID"> 8 <generator class="sequence"> 9 <param name="sequence">SEQ_SYS_JOB</param> 10 </generator> 11 </id> 12 <property name="jobName" type="string" column="JOB_NAME" /> 13 <property name="jobDesc" type="string" column="JOB_DESC" /> 14 <property name="lastModity" type="timestamp" column="LAST_MODIFY" /> 15 <!--與使用者關聯--> 16 <set name="sysUsers" table="SYS_USER"> 17 <key column="JOB_ID" /> 18 <one-to-many class="com.zker.model.user.SysUser" /> 19 </set> 20 21 </class> 22 </hibernate-mapping>
2、註解的優點
而完成這個ORM對映關係配置的方式,還有一種,就是使用註解。
- 充分利用 Java 的反射機制獲取類結構資訊,這些資訊可以有效減少配置的工作
- 註釋和 Java 程式碼位於一個檔案中,有助於增強程式的內聚性,便於程式設計師開發
- 使用註解就不用配置實體和資料庫的對映檔案了
下面我們來看看註解怎麼用:
3、常用註解的使用方法
3.1 類級別的註解
- @Entity 對映實體類
- @Table 對映數句庫表
@Entity(name = "tableName")
- 屬性:
- name - 可選,對應資料庫中的一個表。若表名與實體類名相同,則可以省略
@Table(name = "", catalog = "", schema = "") - 可選,通常和@Entity 配合使用,只能標註在實體的 class 定義處,表示實體對應的資料庫表的資訊
- 屬性:
- name - 可選,表示表的名稱,預設的表名和實體名稱一致,只有在不一致的情況下才需要指定表名
- catalog
- schema - 可選 , 表示 Schema 名稱 , 預設為Schema("")
3.2 屬性級別的註解
- @Id 對映生成主鍵
- @GeneratedValue 定義主鍵生成策略
- @SequenceGenerator 聲明瞭一個數據庫序列
- @Version 定義樂觀鎖
- @Basic 宣告屬性的存取策略
- @Column 對映表的列
- @Transient 定義暫態屬性
屬性級別的註解,都是放在其對應的getter前。
3.2.1 與主鍵相關注解
@Id - 必須,定義了對映到資料庫表的主鍵的屬性,一個實體只能有一個屬性被對映為主鍵,置於 getXxx() 前
@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使用(Oracle沒有自動增長型別,只能用Sequence)
- GenerationType.TABLE 使用指定表來決定主鍵取值,結合@TableGenerator使用
- generator - 表示主鍵生成器的名稱,這個屬性通常和ORM框架相關 , 例如:Hibernate 可以指定 uuid 等主鍵生成方式
@SequenceGenerator — 註解聲明瞭一個數據庫序列
- 屬性:
- name - 表示該表主鍵生成策略名稱,它被引用在@GeneratedValue中設定的“gernerator”值中
- sequenceName - 表示生成策略用到的資料庫序列名稱
- initialValue - 表示主鍵初始值,預設為0
- allocationSize - 每次主鍵值增加的大小,例如設定成1,則表示每次建立新記錄後自動加1,預設為50
3.2.2 與非主鍵相關注解
@Version - 可以在實體bean中使用@Version註解,通過這種方式可新增對樂觀鎖定的支援(見參考連結)
@Basic - 用於宣告屬性的存取策略:
- @Basic(fetch=FetchType.EAGER) 即時獲取(預設的存取策略)
- @Basic(fetch=FetchType.LAZY) 延遲獲取
@Column - 可將屬性對映到列,使用該註解來覆蓋預設值,@Column描述了資料庫表中該欄位的詳細定義
- 屬性:
- 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 欄位型別,該屬性非常有用
@Transient - 可選,表示該屬性並非一個到資料庫表的欄位的對映,ORM框架將忽略該屬性,如果一個屬性並非資料庫表的欄位對映,就務必將其標示為@Transient,否則ORM框架預設其註解為 @Basic
3.3 對映實體類的關聯關係
單向一對多:一方有集合屬性,包含多個多方,而多方沒有一方的引用。使用者--->電子郵件
單向多對一:多方有一方的引用,一方沒有多方的引用。論文類別---> 類別
雙向一對多:兩邊都有多方的引用,方便查詢。班級---> 學生
雙向多對一:兩邊都有多方的引用,方便查詢。
單向多對多:需要一箇中間表來維護兩個實體表。論壇--->文章
單向一對一:資料唯一,資料庫資料也是一對一。艦船---> 水手
主鍵相同的一對一:使用同一個主鍵,省掉外來鍵關聯。客戶---> 地址
3.3.1 關聯對映的一些共有屬性
@JoinColumn - 可選,用於描述一個關聯的欄位。@JoinColumn和@Column類似,這個描述的不是一個簡單欄位,而是一個關聯欄位,例如描述一個 @ManyToOne 的欄位。(即用來定義外來鍵在我們這個表中的屬性名,例如實體Order有一個User user屬性來關聯實體User,則Order的user屬性為一個外來鍵)
- 屬性:
- name - 該欄位的名稱,由於@JoinColumn描述的是一個關聯欄位,如ManyToOne, 則預設的名稱由其關聯的實體決定
@OneToOne、@OneToMany、@ManyToOne、ManyToMany 的共有屬性:
- fetch - 配置載入方式。取值有:
- Fetch.EAGER - 及時載入,多對一預設是Fetch.EAGER eager
- Fetch.LAZY - 延遲載入,一對多預設是Fetch.LAZY
- cascade - 設定級聯方式,取值有:
- CascadeType.PERSIST - 儲存 - 呼叫JPA規範中的persist(),不適用於Hibernate的save()方法
- CascadeType.REMOVE - 刪除 - 呼叫JPA規範中的remove()時,適用於Hibernate的delete()方法
- CascadeType.MERGE - 修改 - 呼叫JPA規範中merge()時,不適用於Hibernate的update()方法
- CascadeType.REFRESH - 重新整理 - 呼叫JPA規範中的refresh()時,適用於Hibernate的flush()方法
- CascadeType.ALL - 全部 - JPA規範中的所有持久化方法
- targetEntity - 配置集合屬性型別,如:@OneToMany(targetEntity=Book.class)
@OneToOne – 表示一個一對一的對映:
主表類A與從表類B的主鍵值相對應
2
主表:
3
@OneToOne(cascade = CascadeType.ALL)
4
@PrimaryKeyJoinColumn
5
public B getB(){
6
return b;
7
}
從表:無
1
主表A中有一個從表屬性是B型別的b
2
主表:
3
@OneToOne(cascade = CascadeType.ALL)
4
@JoinColumn(name="主表外來鍵") //這裡指定的是資料庫中的外來鍵欄位。
5
public B getB(){
6
return b;
7
}
8
9
從表:無
1
主表A中有一個從表屬性是B型別的b,同時,從表B中有一個主表屬性是A型別的a
2
主表:
3
@OneToOne(cascade = CascadeType.ALL)
4
@JoinColumn(name="主表外來鍵") //這裡指定的是資料庫中的外來鍵欄位。
5
public B getB(){
6
return b;
7
}
8
9
從表:
10
@OneToOne(mappedBy = "主表類中的從表屬性")
11
public 主表類 get主表類(){
12
return 主表物件
13
}