hibernate annotation註解方式來處理對映關係

藍星花發表於2017-12-06

在hibernate中,通常配置物件關係對映關係有兩種

  • 一種是基於xml的方式
  • 另一種是基於annotation的註解方式

熟話說,蘿蔔青菜,可有所愛,每個人都有自己喜歡的配置方式,我在試了這兩種方式以後,發現使用annotation的方式可以更簡介,所以這裡就簡單記錄下通過annotation來配置各種對映關係,在hibernate4以後已經將annotation的jar包整合進來了,如果使用hibernate3的版本就需要引入annotation的jar包。

@Entity  --->如果我們當前這個bean要設定成實體物件,就需要加上Entity這個註解
@Table(name="t_user")  ---->  設定資料庫的表名
//@Table(name="",catalog="",schema="")
public class User
{
    private int id;
    private String username;
    private String password;
    private Date born;
    private Date registerDate;
    @Column(name="register_date")  --->  Column中的name屬性對應了資料庫的該欄位名字,裡面還有其他屬性,例如length,nullable等等
    public Date getRegisterDate()
    {
        return registerDate;
    }
    public void setRegisterDate(Date registerDate)
    {
        this.registerDate = registerDate;
    }

    @Id  --->  定義為資料庫的主鍵ID  (建議不要在屬性上引入註解,因為屬性是private的,如果引入註解會破壞其封裝特性,所以建議在getter方法上加入註解)
    @GeneratedValue  ---->  ID的生成策略為自動生成  
    public int getId()
    {
        return id;
    }
    public void setId(int id)
    {
        this.id = id;
    }
   ............
}



最後只需要在hibernate.cfg.xml檔案裡面將該實體類加進去即可:

<!-- 基於annotation的配置 -->
        <mapping class="com.xiaoluo.bean.User"/>
<!-- 基於hbm.xml配置檔案 -->
        <mapping resource="com/xiaoluo/bean/User.hbm.xml"/>


@Entity
@Table(name="tbl_user")
publicclass User implements Serializable{
 @Id
 @GeneratedValue(strategy = GenerationType.AUTO)
 @Column(name="id")
 private Integer id;

 @Column(name="name")
 private String name;

 @Column(name="age")
 private String age;
 public String getAge() {returnage; }
 publicvoid setAge(String age) {this.age = age;}

 public String getName() {returnname;}
 publicvoid setName(String name) {this.name = name;}

 public User() {  }

 public Integer getId() { returnthis.id; }
 publicvoid setId(Integer id) {this.id = id;}
}


@Entity
//繼承策略。另一個類繼承本類,那麼本類裡的屬性應用到另一個類中
@Inheritance(strategy = InheritanceType.JOINED ) 
@Table(name="INFOM_TESTRESULT")
public class TestResult extends IdEntity{}
 
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() {
       return pk;
     }
 
5、@Basic(fetch=FetchType,optional=true)
可選
@Basic表示一個簡單的屬性到資料庫表的欄位的對映,對於沒有任何標註的getXxxx()方法,預設即為@Basic
fetch: 表示該屬性的讀取策略,有EAGER和LAZY兩種,分別表示主支抓取和延遲載入,預設為EAGER.
optional:表示該屬性是否允許為null,預設為true
示例:
     @Basic(optional=false)
     public String getAddress() {
       return address;
     }
 
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 String getBithday() {
       return birthday;
     }
 
7、@Transient
可選
@Transient表示該屬性並非一個到資料庫表的欄位的對映,ORM框架將忽略該屬性.
如果一個屬性並非資料庫表的欄位對映,就務必將其標示為@Transient,否則,ORM框架預設其註解為@Basic
示例:
     //根據birth計算出age屬性
     @Transient
     public int getAge() {
       return getYear(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 User getUser() {
       return user;
     }
 
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 List getOrders() {
       return orders;
     }
 
11、@OneToOne(fetch=FetchType,cascade=CascadeType)
可選
@OneToOne描述一個一對一的關聯
fetch:表示抓取策略,預設為FetchType.LAZY
cascade:表示級聯操作策略
示例:
     @OneToOne(fetch=FetchType.LAZY)
     public Blog getBlog() {
       return blog;
     }
 
12、@ManyToMany
可選
@ManyToMany 描述一個多對多的關聯.多對多關聯上是兩個一對多關聯,但是在ManyToMany描述中,中間表是由ORM框架自動處理
targetEntity:表示多對多關聯的另一個實體類的全名,例如:package.Book.class
mappedBy:表示多對多關聯的另一個實體類的對應集合屬性名稱
示例:
     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
     public class Book {
       private List users;
       @ManyToMany(targetEntity=package.Users.class, mappedBy="books")
       public List getUsers() {
           return users;
       }
       public void setUsers(List users) {
           this.users=users;
       }
     }
兩個實體間相互關聯的屬性必須標記為@ManyToMany,並相互指定targetEntity屬性,
需要注意的是,有且只有一個實體的@ManyToMany註解需要指定mappedBy屬性,指向targetEntity的集合屬性名稱
利用ORM工具自動生成的表除了User和Book表外,還自動生成了一個User_Book表,用於實現多對多關聯
 
13、@MappedSuperclass
可選
@MappedSuperclass可以將超類的JPA註解傳遞給子類,使子類能夠繼承超類的JPA註解
示例:
     @MappedSuperclass
     public class Employee() {
       ....
     }
 
     @Entity
     public class Engineer extends Employee {
       .....
     }
     @Entity
     public class Manager extends 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
       public Address 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屬性,用於在驗證失敗後向使用者返回的訊息,還可以三個屬性上使用多個註解




相關文章