[轉]實體類注解

本文轉載自查看原文 2017-12-21 13:00 1177 Java

@Entity
//繼承策略。另一個類繼承本類，那么本類里的屬性應用到另一個類中
@Inheritance(strategy = InheritanceType.JOINED ) 
@Table(name="INFOM_TESTRESULT")
public class TestResult extends IdEntity{}

@Entity(name="EntityName")

必須

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

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

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

<br><strong>name</strong>:可選,表示表的名稱.默認地,表名和實體名稱一致,只有在不一致的情況下才需要指定表名 <br><strong>catalog</strong>:可選,表示Catalog名稱,默認為Catalog(""). <br><strong>schema</strong>:可選,表示Schema名稱,默認為Schema("").</font></p>

@id

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

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

可選

<br><strong>strategy</strong>:表示主鍵生成策略,有AUTO,INDENTITY,SEQUENCE 和 TABLE 4種,分別表示讓ORM框架自動選擇, <br>根據數據庫的Identity字段生成,根據數據庫表的Sequence字段生成,以有根據一個額外的表生成主鍵,默認為AUTO <br><strong>generator</strong>:表示主鍵生成器的名稱,這個屬性通常和ORM框架相關,例如,Hibernate可以指定uuid等主鍵生成方式. <br>示例: </font></p>

@Id
@GeneratedValues(strategy=StrategyType.SEQUENCE)
public int getPk() {
   return pk;
}

@Basic(fetch=FetchType,optional=true)

可選

<br><strong>@Basic</strong>表示一個簡單的屬性到數據庫表的字段的映射,對於沒有任何標注的getXxxx()方法,默認即為@Basic <br><strong>fetch</strong>: 表示該屬性的讀取策略,有EAGER和LAZY兩種,分別表示主支抓取和延遲加載,默認為EAGER. <br><strong>optional</strong>:表示該屬性是否允許為null,默認為true <br>示例:</font> </p>

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

@Column

可選

<br><strong>@Column</strong>描述了數據庫表中該字段的詳細定義,這對於根據JPA注解生成數據庫表結構的工具非常有作用. <br><strong>name</strong>:表示數據庫表中該字段的名稱,默認情形屬性名稱一致 <br><strong>nullable</strong>:表示該字段是否允許為null,默認為true <br><strong>unique</strong>:表示該字段是否是唯一標識,默認為false <br><strong>length</strong>:表示該字段的大小,僅對String類型的字段有效 <br><strong>insertable</strong>:表示在ORM框架執行插入操作時,該字段是否應出現INSETRT語句中,默認為true <br><strong>updateable</strong>:表示在ORM框架執行更新操作時,該字段是否應該出現在UPDATE語句中,默認為true.對於一經創建就不可以更改的字段,該屬性非常有用,如對於birthday字段. <br><strong>columnDefinition</strong>:表示該字段在數據庫中的實際類型.通常ORM框架可以根據屬性類型自動判斷數據庫中字段的類型,但是對於Date類型仍無法確定數據庫中字段類型究竟是DATE,TIME還是 <br><strong>TIMESTAMP</strong>.此外,String的默認映射類型為VARCHAR,如果要將String類型映射到特定數據庫的BLOB或TEXT字段類型,該屬性非常有用. <br>示例:</font> </p>

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

@Transient

可選

<br><strong>@Transient</strong>表示該屬性並非一個到數據庫表的字段的映射,ORM框架將忽略該屬性. <br>如果一個屬性並非數據庫表的字段映射,就務必將其標示為@Transient,否則,ORM框架默認其注解為@Basic <br>示例:</font> </p>

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

@ManyToOne(fetch=FetchType,cascade=CascadeType)

可選

<br><strong>@ManyToOne</strong>表示一個多對一的映射,該注解標注的屬性通常是數據庫表的外鍵 <br><strong>optional</strong>:是否允許該字段為null,該屬性應該根據數據庫表的外鍵約束來確定,默認為true <br><strong>fetch</strong>:表示抓取策略,默認為FetchType.EAGER <br><strong>cascade</strong>:表示默認的級聯操作策略,可以指定為ALL,PERSIST,MERGE,REFRESH和REMOVE中的若干組合,默認為無級聯操作 （見最后cascade屬性取值） <br><strong>targetEntity</strong>:表示該屬性關聯的實體類型.該屬性通常不必指定,ORM框架根據屬性類型自動判斷targetEntity. <br>示例:</font> </p>

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

@JoinColumn

可選

<br><strong>@JoinColumn</strong>和@Column類似,介量描述的不是一個簡單字段,而一一個關聯字段,例如.描述一個@ManyToOne的字段. <br><strong>name</strong>:該字段的名稱.由於@JoinColumn描述的是一個關聯字段,如ManyToOne,則默認的名稱由其關聯的實體決定. <br>例如,實體Order有一個user屬性來關聯實體User,則Order的user屬性為一個外鍵, <br>其默認的名稱為實體User的名稱+下划線+實體User的主鍵名稱 <br>示例: <br>&nbsp;&nbsp;&nbsp;&nbsp; 見<strong>@ManyToOne</strong></font></p>

@OneToMany(fetch=FetchType,cascade=CascadeType)

可選

<br><strong>@OneToMany</strong>描述一個一對多的關聯,該屬性應該為集體類型,在數據庫中並沒有實際字段. <br><strong>fetch</strong>:表示抓取策略,默認為FetchType.LAZY,因為關聯的多個對象通常不必從數據庫預先讀取到內存 <br><strong>cascade</strong>:表示級聯操作策略,對於OneToMany類型的關聯非常重要,通常該實體更新或刪除時,其關聯的實體也應當被更新或刪除 <br>例如:實體User和Order是OneToMany的關系,則實體User被刪除時,其關聯的實體Order也應該被全部刪除 <br>示例:</font> </p>

@OneTyMany(cascade=ALL)
public List getOrders() {
  return orders;
}

@OneToOne(fetch=FetchType,cascade=CascadeType)

可選

<br><strong>@OneToOne</strong>描述一個一對一的關聯 <br><strong>fetch</strong>:表示抓取策略,默認為FetchType.LAZY <br><strong>cascade</strong>:表示級聯操作策略 <br>示例:</font> </p>

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

@ManyToMany

可選

<br><strong>@ManyToMany</strong> 描述一個多對多的關聯.多對多關聯上是兩個一對多關聯,但是在ManyToMany描述中,中間表是由ORM框架自動處理 <br><strong>targetEntity</strong>:表示多對多關聯的另一個實體類的全名,例如:package.Book.class <br><strong>mappedBy</strong>:表示多對多關聯的另一個實體類的對應集合屬性名稱 <br>示例:</font> </p>

//User實體表示用戶,Book實體表示書籍,為了描述用戶收藏的書籍,可以在User和Book之間建立ManyToMany關聯
     @Entity
     public class User {
       private List books;
       @ManyToMany(targetEntity=package.Book.class)
       public List getBooks() {
           return books;
       }
       public void setBooks(List books) {
           this.books=books;
       }
     }
 @Entity
 </span><span style="color: #0000ff">public</span> <span style="color: #0000ff">class</span><span style="color: #000000"> Book {
   </span><span style="color: #0000ff">private</span><span style="color: #000000"> List users;
   @ManyToMany(targetEntity</span>=<span style="color: #0000ff">package</span>.Users.<span style="color: #0000ff">class</span>, mappedBy="books"<span style="color: #000000">)
   </span><span style="color: #0000ff">public</span><span style="color: #000000"> List getUsers() {
       </span><span style="color: #0000ff">return</span><span style="color: #000000"> users;
   }
   </span><span style="color: #0000ff">public</span> <span style="color: #0000ff">void</span><span style="color: #000000"> setUsers(List users) {
       </span><span style="color: #0000ff">this</span>.users=<span style="color: #000000">users;
   }
 }</span></pre>

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

<br>利用ORM工具自動生成的表除了User和Book表外,還自動生成了一個User_Book表,用於實現多對多關聯</font></p>

@MappedSuperclass

可選

<br><strong>@MappedSuperclass</strong>可以將超類的JPA注解傳遞給子類,使子類能夠繼承超類的JPA注解 <br>示例:</font></p>

     @MappedSuperclass
     public class Employee() {
       ....
     }
 @Entity
 </span><span style="color: #0000ff">public</span> <span style="color: #0000ff">class</span> Engineer <span style="color: #0000ff">extends</span><span style="color: #000000"> Employee {
   .....
 }
 @Entity
 </span><span style="color: #0000ff">public</span> <span style="color: #0000ff">class</span> Manager <span style="color: #0000ff">extends</span><span style="color: #000000"> Employee {
   .....
 }</span></pre>

@Embedded

可選

<br><strong>@Embedded</strong>將幾個字段組合成一個類,並作為整個Entity的一個屬性. <br>例如User包括id,name,city,street,zip屬性. <br>我們希望city,street,zip屬性映射為Address對象.這樣,User對象將具有id,name和address這三個屬性. <br>Address對象必須定義為@Embededable <br>示例:</font> </p>

     @Embeddable
     public class Address {city,street,zip}
     @Entity
     public class User {
       @Embedded
       public Address getAddress() {
           ..........
       }
     }

Hibernate驗證注解

  <td width="100" valign="top"><font color="#000000">適用類型</font></td>

  <td width="210" valign="top"><font color="#000000">說明</font></td>

  <td width="216" valign="top"><font color="#000000">示例</font></td>
</tr>

<tr>
  <td width="100" valign="top"><font color="#000000">@Pattern</font></td>

  <td width="100" valign="top"><font color="#000000">String</font></td>

  <td width="210" valign="top"><font color="#000000">通過正則表達式來驗證字符串</font></td>

  <td width="216" valign="top"><font color="#000000">@Pattern(regex=”[a-z]{6}”)</font></td>
</tr>

<tr>
  <td width="100" valign="top"><font color="#000000">@Length</font></td>

  <td width="100" valign="top"><font color="#000000">String</font></td>

  <td width="210" valign="top"><font color="#000000">驗證字符串的長度</font></td>

  <td width="216" valign="top"><font color="#000000">@length(min=3,max=20)</font></td>
</tr>

<tr>
  <td width="100" valign="top"><font color="#000000">@Email</font></td>

  <td width="100" valign="top"><font color="#000000">String</font></td>

  <td width="210" valign="top"><font color="#000000">驗證一個Email地址是否有效</font></td>

  <td width="216" valign="top"><font color="#000000">@email</font></td>
</tr>

<tr>
  <td width="100" valign="top"><font color="#000000">@Range</font></td>

  <td width="100" valign="top"><font color="#000000">Long</font></td>

  <td width="210" valign="top"><font color="#000000">驗證一個整型是否在有效的范圍內</font></td>

  <td width="216" valign="top"><font color="#000000">@Range(min=0,max=100)</font></td>
</tr>

<tr>
  <td width="100" valign="top"><font color="#000000">@Min</font></td>

  <td width="100" valign="top"><font color="#000000">Long</font></td>

  <td width="210" valign="top"><font color="#000000">驗證一個整型必須不小於指定值</font></td>

  <td width="216" valign="top"><font color="#000000">@Min(value=10)</font></td>
</tr>

<tr>
  <td width="100" valign="top"><font color="#000000">@Max</font></td>

  <td width="100" valign="top"><font color="#000000">Long</font></td>

  <td width="210" valign="top"><font color="#000000">驗證一個整型必須不大於指定值</font></td>

  <td width="216" valign="top"><font color="#000000">@Max(value=20)</font></td>
</tr>

<tr>
  <td width="100" valign="top"><font color="#000000">@Size</font></td>

  <td width="100" valign="top"><font color="#000000">集合或數組</font></td>

  <td width="210" valign="top"><font color="#000000">集合或數組的大小是否在指定范圍內</font></td>

  <td width="216" valign="top"><font color="#000000">@Size(min=1,max=255)</font></td>
</tr>

注解

以上來源網址Hibernate 實體類注解

附：cascade屬性取值

1、none：忽略其他關聯的對象，默認值。

2、save-update：當session通過save(),update(),saveOrUpdate()方法來保存或更新對象時，級聯保存所有關聯的新建的臨時對象，並且級聯更新所有關聯的游離對象。

3、persist：當session通過persist()方法來保存當前對象時，會級聯保存所有關聯的新建的臨時對象。

4、merge：通過Session的merge()方法來保存當前對象時，會級聯融合所有關聯的游離對象。

5、delete：通過delete()刪除當前對象時，會級聯刪除所有關聯的對象。

6、lock：通過lock()把當前游離對象加入session緩存時，會把所有的游離對象也加入Session緩存中。

7、replicate:通過replicate()復制當前對象時，會級聯復制所有關聯的對象。

8、evict:通過evict()清除session緩存中對象時，會級聯清除所有關聯的對象。

9、refresh:通過refresh()刷新當前對象時，會級聯刷新所有關聯的對象。(刷新是指同步更新session緩存中數據)