JPA & Hibernate 註解

標籤：

先說說JPA和Hibernate的關係

JPA（Java Persistence API），是Java EE 5的標準ORM介面，也是ejb3規範的一部分。

Hibernate是當今很流行的ORM架構，也是JPA的一個實現，其它還有Toplink之類的ROM架構。

JPA和Hibernate之間的關係，可以簡單的理解為JPA是標準介面，Hibernate是實現。
Hibernate主要是通過三個組件來實現的：

• hibernate-core：Hibernate的核心實現，提供了Hibernate所有的核心功能。
• hibernate-entitymanager：Hibernate實現了標準的JPA，可以把它看成hibernate-core和JPA之間的適配器，它並不直接提供ORM的功能，而是對hibernate-core進行封裝，使得Hibernate符合JPA的規範。
• hibernate-annotation：Hibernate支援annotation方式配置的基礎，它包括了標準的JPA annotation以及Hibernate自身特殊功能的annotation。

註解詳細如下：

?

1	@Entity(name="EntityName")

必須，name為可選，對應資料庫中一的個表

?

1	@Table(name="",catalog="",schema="")

可選，通常和 @Entity 配合使用，只能標註在實體的class定義處,表示實體對應的資料庫表的資訊。
name：可選，表示表的名稱。預設，表名和實體名稱一致，只有在不一致的情況下才需要指定表名。
catalog：可選，表示Catalog名稱，預設為Catalog(“”)。
schema：可選，表示Schema名稱，預設為Schema(“”)。

 

@id
@id定義了映射到資料庫表的主鍵的屬性，一個實體只能有一個屬性被映射為主鍵。

@GeneratedValue(strategy=GenerationType,generator=””)
可選
strategy：表示主鍵建置原則，有AUTO，INDENTITY，SEQUENCE 和 TABLE 4種，分別表示讓ORM架構自動選擇，根據資料庫的 Identity 欄位產生，根據資料庫表的 Sequence 欄位產生，以有根據一個額外的表產生主鍵，預設為 AUTO。

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

@Basic(fetch=FetchType,optional=true)
可選
@Basic表示一個簡單的屬性到資料庫表的欄位的映射，對於沒有任何標註的getXxxx()方法，預設即為@Basic
fetch：表示該屬性的讀取策略，有EAGER和LAZY兩種，分別表示主支抓取和消極式載入，預設為EAGER。
optional：表示該屬性是否允許為null，預設為true。

@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欄位類型，該屬性非常有用。

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

 @OneToOne(fetch=FetchType,cascade=CascadeType)
可選
@OneToOne描述一個一對一的關聯
fetch：表示抓取策略，預設為FetchType.LAZY
cascade：表示級聯操作策略

@ManyToOne(fetch=FetchType,cascade=CascadeType)
可選
@ManyToOne表示一個多對一的映射,該註解標註的屬性通常是資料庫表的外鍵
optional：是否允許該欄位為null，該屬性應該根據資料庫表的外鍵約束來確定，預設為true
fetch：表示抓取策略，預設為FetchType.EAGER
cascade：表示預設的級聯操作策略，可以指定為ALL，PERSIST，MERGE，REFRESH和REMOVE中的若干組合，預設為無級聯操作
targetEntity：表示該屬性關聯的實體類型。該屬性通常不必指定，ORM架構根據屬性類型自動判斷targetEntity。

 

@OneToMany(fetch=FetchType,cascade=CascadeType)
可選
@OneToMany描述一個一對多的關聯,該屬性應該為集體類型,在資料庫中並沒有實際欄位。
fetch：表示抓取策略,預設為FetchType.LAZY,因為關聯的多個對象通常不必從資料庫預先讀取到記憶體
cascade：表示級聯操作策略,對於OneToMany類型的關聯非常重要,通常該實體更新或刪除時,其關聯的實體也應當被更新或刪除
例如：實體User和Order是OneToMany的關係，則實體User被刪除時，其關聯的實體Order也應該被全部刪除

@ManyToMany
可選

@ManyToMany 描述一個多對多的關聯.多對多關聯上是兩個一對多關聯,但是在ManyToMany描述中,中間表是由ORM架構自動處理
targetEntity:表示多對多關聯的另一個實體類的全名,例如:package.Book.class
mappedBy:表示多對多關聯的另一個實體類的對應集合屬性名稱
兩個實體間相互關聯的屬性必須標記為@ManyToMany,並相互指定targetEntity屬性,
需要注意的是,有且只有一個實體的@ManyToMany註解需要指定mappedBy屬性,指向targetEntity的集合屬性名稱
利用ORM工具自動產生的表除了User和Book表外,還自動產生了一個User_Book表,用於實現多對多關聯

@JoinColumn
可選
@JoinColumn和@Column類似,介量描述的不是一個簡單欄位,而一一個關聯欄位,例如.描述一個@ManyToOne的欄位.
name:該欄位的名稱.由於@JoinColumn描述的是一個關聯欄位,如ManyToOne,則預設的名稱由其關聯的實體決定.
例如,實體Order有一個user屬性來關聯實體User,則Order的user屬性為一個外鍵,
其預設的名稱為實體User的名稱+底線+實體User的主鍵名稱

@JoinTable(name = “student_teacher”, inverseJoinColumns = @JoinColumn(name = “tid”), joinColumns = @JoinColumn(name = “sid”))

可選

由第三張表來維護兩張表的關係

name：是關係表的名字

joinColumns：自己這一端的主鍵

inverseJoinColumns：對方的主鍵

 

@MappedSuperclass
可選
@MappedSuperclass可以將超類的JPA註解傳遞給子類,使子類能夠繼承超類的JPA註解

@Embedded
@Embedded將幾個欄位組合成一個類,並作為整個Entity的一個屬性.
例如User包括id,name,city,street,zip屬性.
我們希望city,street,zip屬性對應為Address對象.這樣,User對象將具有id,name和address這三個屬性.
Address對象必須定義為@Embededable

驗證註解

@Pattern
String
通過Regex來驗證字串
@Pattern(regex=”[a-z]{6}”)

@Length
String
驗證字串的長度
@length(min=3,max=20)

@Email
String
驗證一個Email地址是否有效
@email

@Range
Long
驗證一個整型是否在有效範圍內
@Range(min=0,max=100)

@Min
Long
驗證一個整型必須不小於指定值
@Min(value=10)

@Max
Long
驗證一個整型必須不大於指定值
@Max(value=20)

@Size
集合或數組
集合或數組的大小是否在指定範圍內
@Size(min=1,max=255)

JPA & Hibernate 註解