JPA & Hibernate 注解，詳解

JPA & Hibernate 注解

1、@Entity(name="EntityName")

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

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

可選,通常和@Entity配合使用,隻能标注在實體的class定義處,表示實體對應的資料庫表的資訊

name:可選,表示表的名稱.預設地,表名和實體名稱一緻,隻有在不一緻的情況下才需要指定表名

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

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

3、@id

必須

@id定義了映射到資料庫表的主鍵的屬性,一個實體隻能有一個屬性被映射為主鍵.置于getXxxx()前.

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

可選

strategy:表示主鍵生成政策,有AUTO,INDENTITY,SEQUENCE 和 TABLE 4種,分别表示讓ORM架構自動選擇,

根據資料庫的Identity字段生成,根據資料庫表的Sequence字段生成,以有根據一個額外的表生成主鍵,預設為AUTO

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

示例:

     @Id

    @GeneratedValues(strategy=StrategyType.SEQUENCE)

     public int getPk() {

       returnpk;

     }

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

可選

@Basic表示一個簡單的屬性到資料庫表的字段的映射,對于沒有任何标注的getXxxx()方法,預設即為@Basic

fetch: 表示該屬性的讀取政策,有EAGER和LAZY兩種,分别表示主支抓取和延遲加載,預設為EAGER.

optional:表示該屬性是否允許為null,預設為true

示例:

    @Basic(optional=false)

     public StringgetAddress() {

       returnaddress;

     }

6、@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 StringgetBithday() {

       returnbirthday;

     }

7、@Transient

可選

@Transient表示該屬性并非一個到資料庫表的字段的映射,ORM架構将忽略該屬性.

如果一個屬性并非資料庫表的字段映射,就務必将其标示為@Transient,否則,ORM架構預設其注解為@Basic

示例:

     //根據birth計算出age屬性

     @Transient

     public int getAge(){

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

     }

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

可選

@ManyToOne表示一個多對一的映射,該注解标注的屬性通常是資料庫表的外鍵

optional:是否允許該字段為null,該屬性應該根據資料庫表的外鍵限制來确定,預設為true

fetch:表示抓取政策,預設為FetchType.EAGER

cascade:表示預設的級聯操作政策,可以指定為ALL,PERSIST,MERGE,REFRESH和REMOVE中的若幹組合,預設為無級聯操作

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

示例:

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

     //在Order類中定義

     @ManyToOne()

    @JoinColumn(name="USER")

     public UsergetUser() {

       returnuser;

     }

9、@JoinColumn

可選

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

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

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

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

示例:

     見@ManyToOne

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

可選

@OneToMany描述一個一對多的關聯,該屬性應該為集體類型,在資料庫中并沒有實際字段.

fetch:表示抓取政策,預設為FetchType.LAZY,因為關聯的多個對象通常不必從資料庫預先讀取到記憶體

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

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

示例:

    @OneTyMany(cascade=ALL)

     public ListgetOrders() {

       returnorders;

     }

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

可選

@OneToOne描述一個一對一的關聯

fetch:表示抓取政策,預設為FetchType.LAZY

cascade:表示級聯操作政策

示例:

    @OneToOne(fetch=FetchType.LAZY)

     public BloggetBlog() {

       returnblog;

     }

12、@ManyToMany

可選

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

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

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

示例:

     User實體表示使用者,Book實體表示書籍,為了描述使用者收藏的書籍,可以在User和Book之間建立ManyToMany關聯

     @Entity

     public class User {

       privateList books;

      @ManyToMany(targetEntity=package.Book.class)

       publicList getBooks() {

          return books;

       }

       publicvoid setBooks(List books) {

          this.books=books;

       }

     }

     @Entity

     public class Book {

       privateList users;

      @ManyToMany(targetEntity=package.Users.class, mappedBy="books")

       publicList getUsers() {

          return users;

       }

       publicvoid setUsers(List users) {

          this.users=users;

       }

     }

兩個實體間互相關聯的屬性必須标記為@ManyToMany,并互相指定targetEntity屬性,

需要注意的是,有且隻有一個實體的@ManyToMany注解需要指定mappedBy屬性,指向targetEntity的集合屬性名稱

利用ORM工具自動生成的表除了User和Book表外,還自動生成了一個User_Book表,用于實作多對多關聯

13、@MappedSuperclass

可選

@MappedSuperclass可以将超類的JPA注解傳遞給子類,使子類能夠繼承超類的JPA注解

示例:

     @MappedSuperclass

     public classEmployee() {

       ....

     }

     @Entity

     public classEngineer extends Employee {

       .....

     }

     @Entity

     public class Managerextends Employee {

       .....

     }

14、@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

     public class User {

      @Embedded

       publicAddress getAddress() {

          ..........

       }

     }

Hibernate驗證注解

注解

适用類型

說明

示例

@Pattern

String

通過正規表達式來驗證字元串

@attern(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)

以上每個注解都可能性有一個message屬性，用于在驗證失敗後向使用者傳回的消息，還可以三個屬性上使用多個注解 <!--v:3.2-->