hibernate註解詳解

基本註解

聲明實體Bean 
[java] view plain copy
    @Entity <span style="font-family: Arial;">  </span>  
    public class Flight implements Serializable {    
      Long id;    
      @Id    
      public Long getId() { return id; }    
      public void setId(Long id) { this.id = id; }    
    }    

@Entity

@Entity 註解將一個類聲明爲實體 Bean, @Id 註解聲明瞭該實體Bean的標識屬性。  
Hibernate 可以對類的屬性或者方法進行註解。屬性對應field類別,方法的 getXxx()對應property類別。  
定義表  
通過 @Table 爲實體Bean指定對應數據庫表,目錄和schema的名字。  
[java] view plain copy
    @Entity    
    @Table(name="tbl_sky")    
    public class Sky implements Serializable {    
    @Table 註解包含一個schema和一個catelog 屬性,使用@UniqueConstraints 可以定義表的唯一約束。    
      
    @Table(name="tbl_sky",    
      uniqueConstraints = {@UniqueConstraint(columnNames={"month""day"})}    
    )    

上述代碼在  "month" 和 "day" 兩個 field 上加上 unique constrainst.

@Version  

@Version 註解用於支持樂觀鎖版本控制。  
[java] view plain copy
    @Entity    
    public class Flight implements Serializable {    
       ...    
       @Version    
       @Column(name="OPTLOCK")    
       public Integer getVersion() { ... }    
    }    

version屬性映射到 "OPTLOCK" 列,entity manager 使用這個字段來檢測衝突。 一般可以用 數字 或者 timestamp 類型來支持 version.  
實體Bean中所有非static 非 transient 屬性都可以被持久化,除非用@Transient註解。  
默認情況下,所有屬性都用 @Basic 註解。  
[java] view plain copy
    public transient int counter; //transient property    
      
    private String firstname; //persistent property    
    @Transient    
    String getLengthInMeter() { ... } //transient property    
    String getName() {... } // persistent property    
    @Basic    
    int getLength() { ... } // persistent property    
    @Basic(fetch = FetchType.LAZY)    
    String getDetailedComment() { ... } // persistent property    
    @Temporal(TemporalType.TIME)    
    java.util.Date getDepartureTime() { ... } // persistent property    
    @Enumerated(EnumType.STRING)    
    Starred getNote() { ... } //enum persisted as String in database    
上述代碼中 counter, lengthInMeter 屬性將忽略不被持久化,而 firstname, name, length 被定義爲可持久化和可獲取的。

@TemporalType   

@TemporalType.(DATE,TIME,TIMESTAMP) 分別Map java.sql.(Date, Time, Timestamp).

@Lob  

@Lob 註解屬性將被持久化爲 Blog 或 Clob 類型。具體的java.sql.Clob, Character[], char[] 和 java.lang.String 將被持久化爲 Clob 類型. java.sql.Blob, Byte[], byte[] 和 serializable type 將被持久化爲 Blob 類型。  
[java] view plain copy
    @Lob    
    public String getFullText() {    
       return fullText;  // clob type    
    }    
        
        
    @Lob    
    public byte[] getFullCode() {    
      return fullCode;  // blog type    
    }    

如果定義Blob 或者 Clob有報錯java.lang.UnsupportedOperationException: Clobs are not cacheable可參考以下鏈接 http://blog.csdn.net/kongjiea/article/details/51015076

 @Column

@Column 註解將屬性映射到列。  
[java] view plain copy
    @Entity    
    public class Flight implements Serializable {    
       ...    
       @Column(updatable = false, name = "flight_name", nullable = false, length=50)    
       public String getName() { ... }    
定義 name 屬性映射到 flight_name column, not null, can't update, length equal 50  
[java] view plain copy
    @Column(    
       name="columnName"; (1) 列名    
       boolean unique() default false; (2)    是否在該列上設置唯一約束    
       boolean nullable() default true; (3)   列可空?    
       boolean insertable() default true; (4) 該列是否作爲生成 insert語句的一個列    
       boolean updatable() default true; (5)  該列是否作爲生成 update語句的一個列    
       String columnDefinition() default ""; (6)  默認值    
       String table() default ""; (7)             定義對應的表(deault 是主表)    
       int length() default 255; (8)              列長度    
       int precision() default 0// decimal precision (9)  decimal精度    
       int scale() default 0// decimal scale        (10)  decimal長度    

@Embeddable

嵌入式對象(又稱組件)也就是別的對象定義的屬性  
組件類必須在類一級定義 @Embeddable 註解。在特定的實體關聯屬性上使用 @Embeddable 和 @AttributeOverride 註解可以覆蓋該屬性對應的嵌入式對象的列映射。  
[java] view plain copy
    @Entity    
    public class Person implements Serializable {    
       // Persistent component using defaults    
       Address homeAddress;    
       @Embedded    
       @AttributeOverrides( {    
          @AttributeOverride(name="iso2", column = @Column(name="bornIso2") ),    
          @AttributeOverride(name="name", column = @Column(name="bornCountryName") )    
       } )    
       Country bornIn;    
       ...    
    }    
        
    @Embeddable    
    public class Address implements Serializable {    
       String city;    
       Country nationality; //no overriding here    
    }    
        
    @Embeddable    
    public class Country implements Serializable {    
       private String iso2;    
       @Column(name="countryName"private String name;    
       public String getIso2() { return iso2; }    
       public void setIso2(String iso2) { this.iso2 = iso2; }    
       public String getName() { return name; }    
       public void setName(String name) { this.name = name; }    
       ...    
    }    

Person 類定義了 Address 和  Country 對象,具體兩個類實現見上。  
無註解屬性默認值:  
屬性爲簡單類型,則映射爲 @Basic  
屬性對應的類型定義了 @Embeddable 註解,則映射爲 @Embedded  
屬性對應的類型實現了Serializable,則屬性被映射爲@Basic並在一個列中保存該對象的serialized版本。  
屬性的類型爲 java.sql.Clob or java.sql.Blob, 則映射到 @Lob 對應的類型。  
@Id和@GenerateValue
@Id 映射主鍵屬性  註解可將實體Bean中某個屬性定義爲主鍵,使用@GenerateValue註解可以定義該標識符的生成策略。  
  
 AUTO  可以是 identity column, sequence 或者 table 類型,取決於不同底層的數據庫  
TABLE 使用table保存id值  
[java] view plain copy
    IDENTITY - identity column    
    SEQUENCE - seque    
        
    nce     
        
    @Id @GeneratedValue(strategy=GenerationType.SEQUENCE, generator="SEQ_STORE")    
    public Integer getId() { ... }    
    @Id @GeneratedValue(strategy=GenerationType.IDENTITY)    
    public Long getId() { ... }    
AUTO 生成器,適用與可移值的應用,多個@Id可以共享同一個 identifier生成器,只要把generator屬性設成相同的值就可以。通過@SequenceGenerator 和 @TableGenerator 可以配置不同的 identifier 生成器。   
[java] view plain copy
    <table-generator name="EMP_GEN"    
         table="GENERATOR_TABLE"    
         pk-column-name="key"    
         value-column-name="hi"    
         pk-column-value="EMP"    
         allocation-size="20"/>    
    //and the annotation equivalent    
    @javax.persistence.TableGenerator(    
         name="EMP_GEN",    
         table="GENERATOR_TABLE",    
         pkColumnName = "key",    
         valueColumnName = "hi"    
         pkColumnValue="EMP",    
         allocationSize=20    
    )    
    <sequence-generator name="SEQ_GEN"    
         sequence-name="my_sequence"    
         allocation-size="20"/>    
    //and the annotation equivalent    
    @javax.persistence.SequenceGenerator(    
         name="SEQ_GEN",    
         sequenceName="my_sequence",    
         allocationSize=20    
    )    
        
    The next example shows the definition of a sequence generator in a class scope:    
        
    @Entity    
    @javax.persistence.SequenceGenerator(    
        name="SEQ_STORE",    
        sequenceName="my_sequence"    
    )    
    public class Store implements Serializable {    
       private Long id;    
       @Id @GeneratedValue(strategy=GenerationType.SEQUENCE, generator="SEQ_STORE")    
       public Long getId() { return id; }    
    }    
Store類使用名爲my_sequence的sequence,並且SEQ_STORE生成器對於其他類是不可見的。  
通過下面語法,你可以定義組合鍵。  
將組件類註解爲 @Embeddable, 並將組件的屬性註解爲 @Id  
 將組件的屬性註解爲 @EmbeddedId  
 將類註解爲 @IdClass,並將該實體中所有主鍵的屬性都註解爲 @Id  
  
[java] view plain copy
    @Entity    
    @IdClass(FootballerPk.class)    
    public class Footballer {    
      //part of the id key    
      @Id public String getFirstname() {    
        return firstname;    
      }    
      public void setFirstname(String firstname) {    
         this.firstname = firstname;    
      }    
      //part of the id key    
      @Id public String getLastname() {    
        return lastname;    
      }    
      public void setLastname(String lastname) {    
        this.lastname = lastname;    
      }    
      public String getClub() {    
        return club;    
      }    
      public void setClub(String club) {    
       this.club = club;    
      }    
      //appropriate equals() and hashCode() implementation    
    }    
        
    @Embeddable    
    public class FootballerPk implements Serializable {    
      //same name and type as in Footballer    
      public String getFirstname() {    
        return firstname;    
      }    
      public void setFirstname(String firstname) {    
        this.firstname = firstname;    
      }    
      //same name and type as in Footballer    
      public String getLastname() {    
        return lastname;    
      }    
      public void setLastname(String lastname) {    
       this.lastname = lastname;    
      }    
      //appropriate equals() and hashCode() implementation    
    }    
        
    @Entity    
    @AssociationOverride( name="id.channel", joinColumns = @JoinColumn(name="chan_id") )    
    public class TvMagazin {    
       @EmbeddedId public TvMagazinPk id;    
       @Temporal(TemporalType.TIME) Date time;    
    }    
        
        
    @Embeddable    
    public class TvMagazinPk implements Serializable {    
       @ManyToOne    
       public Channel channel;    
       public String name;    
       @ManyToOne    
       public Presenter presenter;    
    }    

映射繼承關係  

  
EJB支持3種類型的繼承。  
  
Table per Class Strategy: the <union-class> element in Hibernate 每個類一張表  
Single Table per Class Hierarchy Strategy: the <subclass> element in Hibernate 每個類層次結構一張表  
Joined Subclass Strategy: the <joined-subclass> element in Hibernate 連接的子類策略  
@Inheritance
@Inheritance 註解來定義所選的之類策略。  
  
每個類一張表  
[java] view plain copy
    @Entity    
    @Inheritance(strategy = InheritanceType.TABLE_PER_CLASS)    
    public class Flight implements Serializable {  
有缺點,如多態查詢或關聯。Hibernate 使用 SQL Union 查詢來實現這種策略。 這種策略支持雙向的一對多關聯,但不支持 IDENTIFY 生成器策略,因爲ID必須在多個表間共享。一旦使用就不能使用AUTO和IDENTIFY生成器。  
  
每個類層次結構一張表  
[java] view plain copy
    @Entity    
    @Inheritance(strategy=InheritanceType.SINGLE_TABLE)    
    @DiscriminatorColumn(    
        name="planetype",    
        discriminatorType=DiscriminatorType.STRING    
    )    
    @DiscriminatorValue("Plane")    
    public class Plane { ... }    
        
    @Entity    
    @DiscriminatorValue("A320")    
    public class A320 extends Plane { ... }    
整個層次結構中的所有父類和子類屬性都映射到同一個表中,他們的實例通過一個辨別符列(discriminator)來區分。  
  
Plane 是父類。@DiscriminatorColumn 註解定義了辨別符列。對於繼承層次結構中的每個類, @DiscriminatorValue 註解指定了用來辨別該類的值。 辨別符列名字默認爲 DTYPE,其默認值爲實體名。其類型爲DiscriminatorType.STRING。  
  
連接的子類  
[java] view plain copy
    @Entity    
    @Inheritance(strategy=InheritanceType.JOINED)    
    public class Boat implements Serializable { ... }    
        
        
    @Entity    
    public class Ferry extends Boat { ... }    
        
    @Entity    
    @PrimaryKeyJoinColumn(name="BOAT_ID")    
    public class AmericaCupClass extends Boat { ... }    
以上所有實體使用 JOINED 策略 Ferry和Boat class使用同名的主鍵關聯(eg: Boat.id Ferry.id), AmericaCupClass 和 Boat 關聯的條件爲 Boat.id AmericaCupClass.BOAT_ID.  
  
從父類繼承的屬性  
[java] view plain copy
    @MappedSuperclass    
    public class BaseEntity {    
      @Basic    
      @Temporal(TemporalType.TIMESTAMP)    
      public Date getLastUpdate() { ... }    
      public String getLastUpdater() { ... }    
      ...    
    }    
        
    @Entity class Order extends BaseEntity {    
      @Id public Integer getId() { ... }    
      ...    
    }    
繼承父類的一些屬性,但不用父類作爲映射實體,這時候需要 @MappedSuperclass 註解。 上述實體映射到數據庫中的時候對應 Order 實體Bean, 其具有 id, lastUpdate, lastUpdater 三個屬性。如果沒有@MappedSuperclass 註解,則父類中屬性忽略,這是 Order 實體 Bean 只有 id 一個屬性。  

關聯映射註解 

 @OneToOne一對一  

使用 @OneToOne 註解可以建立實體Bean之間的一對一關係。一對一關係有3種情況。  
關聯的實體都共享同樣的主鍵。  
[java] view plain copy
    @Entity    
    public class Body {    
      @Id    
      public Long getId() { return id; }    
      @OneToOne(cascade = CascadeType.ALL)    
      @PrimaryKeyJoinColumn    
      public Heart getHeart() {    
         return heart;    
      }    
      ...    
    }    
        
    @Entity    
    public class Heart {    
      @Id    
      public Long getId() { ...}    
    }    
通過@PrimaryKeyJoinColumn 註解定義了一對一的關聯關係。  

 @ManyToOne多對一  

使用 @ManyToOne 註解定義多對一關係。  
[java] view plain copy
    @Entity()    
    public class Flight implements Serializable {    
      @ManyToOne( cascade = {CascadeType.PERSIST, CascadeType.MERGE} )    
      @JoinColumn(name="COMP_ID")    
      public Company getCompany() {    
        return company;    
      }    
      ...    
    }    
其中@JoinColumn 註解是可選的,關鍵字段默認值和一對一關聯的情況相似。列名爲:主題的關聯屬性名 下劃線 被關聯端的主鍵列名。本例中爲company_id,因爲關聯的屬性是company, Company的主鍵爲 id.  
  
@ManyToOne 註解有個targetEntity屬性,該參數定義了目標實體名。通常不需要定義,大部分情況爲默認值。但下面這種情況則需要 targetEntity 定義(使用接口作爲返回值,而不是常用的實體)。  
[java] view plain copy
    @Entity()    
    public class Flight implements Serializable {    
       @ManyToOne(cascade=   {CascadeType.PERSIST,CascadeType.MERGE},targetEntity= CompanyImpl.class)    
       @JoinColumn(name="COMP_ID")    
       public Company getCompany() {    
         return company;    
       }    
       ...    
    }  <pre name="code" class="java" style="font-size: 14px; line-height: 26px;"><span style="font-family: Arial;">public </span><wbr style="font-family: Arial;"><span style="font-family: Arial;">interface </span><wbr style="font-family: Arial;"><span style="font-family: Arial;">Company </span><wbr style="font-family: Arial;"><span style="font-family: Arial;">{ </span><wbr style="font-family: Arial;"><span style="font-family: Arial;"> ...</span></pre>  
    <pre></pre>  
    <pre></pre>  
    <pre></pre>  
    <pre></pre>  
多對一也可以通過關聯表的方式來映射,通過 @JoinTable 註解可定義關聯表。該關聯表包含指回實體的外鍵(通過@JoinTable.joinColumns)以及指向目標實體表的外鍵(通過@JoinTable.inverseJoinColumns).  
[java] view plain copy
    @Entity()    
    public class Flight implements Serializable {    
        
       @ManyToOne( cascade = {CascadeType.PERSIST, CascadeType.MERGE} )    
       @JoinTable(name="Flight_Company",    
           joinColumns = @JoinColumn(name="FLIGHT_ID"),    
           inverseJoinColumns = @JoinColumn(name="COMP_ID")    
       )    
       public Company getCompany() {    
           return company;    
       }    
       ...    
    }    
集合類型  
 一對多  
@OneToMany 註解可定義一對多關聯。一對多關聯可以是雙向的。  
雙向  
  
規範中多對一端幾乎總是雙向關聯中的主體(owner)端,而一對多的關聯註解爲 @OneToMany(mappedBy=)  
[java] view plain copy
    @Entity    
    public class Troop {    
      @OneToMany(mappedBy="troop")    
      public Set<Soldier> getSoldiers() {    
      ...    
    }  <pre name="code" class="java" style="font-size: 14px; line-height: 26px;">@Entity    
    public class Soldier {    
      @ManyToOne    
      @JoinColumn(name="troop_fk")    
      public Troop getTroop() {    
      ...    
      }    
    </pre>  
    <pre></pre>  
Troop 通過troop屬性和Soldier建立了一對多的雙向關聯。在 mappedBy 端不必也不能定義任何物理映射。  
  
單向  
[java] view plain copy
    @Entity    
    public class Customer implements Serializable {    
       @OneToMany(cascade=CascadeType.ALL, fetch=FetchType.EAGER)    
       @JoinColumn(name="CUST_ID")    
       public Set<Ticket> getTickets() {    
          ...    
       }    
        
    @Entity    
    public class Ticket implements Serializable {    
       ... //no bidir    
    }    
一般通過連接表來實現這種關聯,可以通過@JoinColumn註解來描述這種單向關聯關係。上例 Customer 通過 CUST_ID 列和 Ticket 建立了單向關聯關係。   
通過關聯表來處理單向關聯  
[java] view plain copy
    @Entity    
    public class Trainer {    
      @OneToMany    
      @JoinTable(    
         name="TrainedMonkeys",    
         joinColumns = @JoinColumn( name="trainer_id"),    
         inverseJoinColumns = @JoinColumn( name="monkey_id")    
      )    
      public Set<Monkey> getTrainedMonkeys() {    
         ...    
      }    
    @Entity    
    public class Monkey {    
      ... //no bidir    
    }    
通過關聯表來處理單向一對多關係是首選,這種關聯通過 @JoinTable 註解來進行描述。上例子中 Trainer 通過TrainedMonkeys表和Monkey建立了單向關聯關係。其中外鍵trainer_id關聯到Trainer(joinColumns)而外鍵monkey_id關聯到Monkey(inverseJoinColumns).  
默認處理機制  
 
通過連接表來建立單向一對多關聯不需要描述任何物理映射,表名由一下3個部分組成,主表(owner table)表名 下劃線 從表(the other side table)表名。指向主表的外鍵名:主表表名+下劃線+主表主鍵列名 指向從表的外鍵定義爲唯一約束,用來表示一對多的關聯關係。  
[java] view plain copy
    @Entity    
    public class Trainer {    
      @OneToMany    
      public Set<Tiger> getTrainedTigers() {    
      ...    
    }    
        
    @Entity    
    public class Tiger {    
      ... //no bidir    
    }    
        
上述例子中 Trainer 和 Tiger 通過 Trainer_Tiger 連接表建立單向關聯關係。其中外鍵 trainer_id 關聯到 Trainer表,而外鍵 trainedTigers_id 關聯到 Tiger 表。  

 @ManyToMany多對多  

  
通過 @ManyToMany 註解定義多對多關係,同時通過 @JoinTable 註解描述關聯表和關聯條件。其中一端定義爲 owner, 另一段定義爲 inverse(對關聯表進行更新操作,這段被忽略)。  
[java] view plain copy
    @Entity    
    public class Employer implements Serializable {    
      @ManyToMany(    
        targetEntity=org.hibernate.test.metadata.manytomany.Employee.class,    
        cascade={CascadeType.PERSIST, CascadeType.MERGE}    
      )    
      @JoinTable(    
        name="EMPLOYER_EMPLOYEE",    
        joinColumns=@JoinColumn(name="EMPER_ID"),    
        inverseJoinColumns=@JoinColumn(name="EMPEE_ID")    
      )    
      public Collection getEmployees() {    
        return employees;    
      }    
      ...    
    }    
        
    @Entity    
    public class Employee implements Serializable {    
      @ManyToMany(    
        cascade = {CascadeType.PERSIST, CascadeType.MERGE},    
        mappedBy = "employees",    
        targetEntity = Employer.class    
      )    
      public Collection getEmployers() {    
        return employers;    
      }    
    }    
默認值:  
  
關聯表名:主表表名 下劃線 從表表名;關聯表到主表的外鍵:主表表名 下劃線 主表中主鍵列名;關聯表到從表的外鍵名:主表中用於關聯的屬性名 下劃線 從表的主鍵列名。  
  
用 cascading 實現傳播持久化(Transitive persistence)  
 
cascade 屬性接受值爲 CascadeType 數組,其類型如下:  
  
CascadeType.PERSIST: cascades the persist (create) operation to associated entities persist() is called or if the entity is managed 如果一個實體是受管狀態,或者當 persist() 函數被調用時,觸發級聯創建(create)操作。  
  
CascadeType.MERGE: cascades the merge operation to associated entities if merge() is called or if the entity is managed 如果一個實體是受管狀態,或者當 merge() 函數被調用時,觸發級聯合並(merge)操作。  
  
CascadeType.REMOVE: cascades the remove operation to associated entities if delete() is called 當 delete() 函數被調用時,觸發級聯刪除(remove)操作。  
  
CascadeType.REFRESH: cascades the refresh operation to associated entities if refresh() is called  當 refresh() 函數被調用時,出發級聯更新(refresh)操作。  
    
CascadeType.ALL: all of the above  以上全部  

映射二級列表  

  
使用類一級的 @SecondaryTable 和 @SecondaryTables 註解可以實現單個實體到多個表的映射。使用 @Column 或者 @JoinColumn 註解中的 table 參數可以指定某個列所屬的特定表。  
[java] view plain copy
    @Entity    
    @Table(name="MainCat")    
    @SecondaryTables({    
        @SecondaryTable(name="Cat1", pkJoinColumns={    
               @PrimaryKeyJoinColumn(name="cat_id", referencedColumnName="id")}),    
        @SecondaryTable(name="Cat2", uniqueConstraints={    
               @UniqueConstraint(columnNames={"storyPart2"})})    
     })    
    public class Cat implements Serializable {    
      private Integer id;    
      private String name;    
        
      private String storyPart1;    
      private String storyPart2;    
      @Id @GeneratedValue    
      public Integer getId() {    
        return id;    
      }    
      public String getName() {    
        return name;    
      }    
      @Column(table="Cat1")    
      public String getStoryPart1() {    
        return storyPart1;    
      }    
      @Column(table="Cat2")    
      public String getStoryPart2() {    
        return storyPart2;    
      }    
上述例子中, name 保存在 MainCat 表中,storyPart1保存在 Cat1 表中,storyPart2 保存在 Cat2 表中。 Cat1 表通過外鍵 cat_id 和 MainCat 表關聯, Cat2 表通過 id 列和 MainCat 表關聯。對storyPart2 列還定義了唯一約束。  

映射查詢  

使用註解可以映射 EJBQL/HQL 查詢,@NamedQuery 和 @NamedQueries 是可以使用在類級別或者JPA的XML文件中的註解。  
[java] view plain copy
    <entity-mappings>    
     <named-query name="plane.getAll">    
      <query>select p from Plane p</query>    
     </named-query>    
     ...    
    </entity-mappings>    
    ...    
    @Entity    
    @NamedQuery(name="night.moreRecentThan", query="select n from Night n where n.date >= :date")    
    public class Night {    
     ...    
    }    
    public class MyDao {    
     doStuff() {    
       Query q = s.getNamedQuery("night.moreRecentThan");    
       q.setDate( "date", aMonthAgo );    
       List results = q.list();    
       ...    
     }    
     ...    
    }    
可以通過定義 QueryHint 數組的 hints 屬性爲查詢提供一些 hint 信息。下圖是一些 Hibernate hints:  
映射本地化查詢  
通過@SqlResultSetMapping 註解來描述 SQL 的 resultset 結構。如果定義多個結果集映射,則用 @SqlResultSetMappings。  
[java] view plain copy
    @NamedNativeQuery(name="night&area", query="select night.id nid, night.night_duration, "    
         + " night.night_date, area.id aid, night.area_id, area.name "    
         + "from Night night, Area area where night.area_id = area.id", resultSetMapping="joinMapping")    
        
    @SqlResultSetMapping( name="joinMapping", entities={    
      @EntityResult(entityClass=org.hibernate.test.annotations.query.Night.class, fields = {    
       @FieldResult(name="id", column="nid"),    
       @FieldResult(name="duration", column="night_duration"),    
       @FieldResult(name="date", column="night_date"),    
       @FieldResult(name="area", column="area_id"),    
       discriminatorColumn="disc"    
      }),    
          
      @EntityResult(entityClass=org.hibernate.test.annotations.query.Area.class, fields = {    
       @FieldResult(name="id", column="aid"),    
       @FieldResult(name="name", column="name")    
      })    
     }    
    )    
上面的例子,名爲“night&area”的查詢和 "joinMapping"結果集映射對應,該映射返回兩個實體,分別爲 Night 和 Area, 其中每個屬性都和一個列關聯,列名通過查詢獲取。  
[java] view plain copy
    @Entity    
    @SqlResultSetMapping(name="implicit",     
      entities=@EntityResult(    
        entityClass=org.hibernate.test.annotations.@NamedNativeQuery(    
          name="implicitSample", query="select * from SpaceShip",     
          resultSetMapping="implicit")    
    public class SpaceShip {    
     private String name;    
     private String model;    
     private double speed;    
     @Id    
     public String getName() {    
      return name;    
     }    
     public void setName(String name) {    
      this.name = name;    
     }    
     @Column(name="model_txt")    
     public String getModel() {    
      return model;    
     }    
     public void setModel(String model) {    
      this.model = model;    
     }    
     public double getSpeed() {    
      return speed;    
     }    
     public void setSpeed(double speed) {    
      this.speed = speed;    
     }    
    }    
上例中 model1 屬性綁定到 model_txt 列,如果和相關實體關聯設計到組合主鍵,那麼應該使用 @FieldResult 註解來定義每個外鍵列。@FieldResult的名字組成:定義這種關係的屬性名字 "." 主鍵名或主鍵列或主鍵屬性。  
[java] view plain copy
    @Entity    
    @SqlResultSetMapping(name="compositekey",    
     entities=@EntityResult(entityClass=org.hibernate.test.annotations.query.SpaceShip.class,    
      fields = {    
       @FieldResult(name="name", column = "name"),    
       @FieldResult(name="model", column = "model"),    
       @FieldResult(name="speed", column = "speed"),    
       @FieldResult(name="captain.firstname", column = "firstn"),    
       @FieldResult(name="captain.lastname", column = "lastn"),    
       @FieldResult(name="dimensions.length", column = "length"),    
       @FieldResult(name="dimensions.width", column = "width")    
      }),    
     columns = { @ColumnResult(name = "surface"),    
         
    @ColumnResult(name = "volume") } )    
     @NamedNativeQuery(name="compositekey",    
     query="select name, model, speed, lname as lastn, fname as firstn, length, width, length * width as resultSetMapping="compositekey")    
    })    
        
如果查詢返回的是單個實體,或者打算用系統默認的映射,這種情況下可以不使用 resultSetMapping,而使用resultClass屬性,例如:  
  
@NamedNativeQuery(name="implicitSample", query="select from SpaceShip",  
                                            resultClass=SpaceShip.class)  
public class SpaceShip  
  
Hibernate 獨有的註解擴展  
  
Hibernate 提供了與其自身特性想吻合的註解,org.hibernate.annotations package包含了這些註解。  
  
實體  
  
org.hibernate.annotations.Entity 定義了  Hibernate 實體需要的信息。  
  
mutable: whether this entity is mutable or not  此實體是否可變  
  
dynamicInsert: allow dynamic SQL for inserts   用動態SQL新增  
  
dynamicUpdate: allow dynamic SQL for updates   用動態SQL更新  
  
selectBeforeUpdate: Specifies that Hibernate should never perform an SQL UPDATE unless it is certain that an object is actually modified.指明Hibernate從不運行SQL Update,除非能確定對象已經被修改  
  
polymorphism: whether the entity polymorphism is of PolymorphismType.IMPLICIT (default) or PolymorphismType.EXPLICIT 指出實體多態是 PolymorphismType.IMPLICIT(默認)還是PolymorphismType.EXPLICIT   
  
optimisticLock: optimistic locking strategy (OptimisticLockType.VERSION, OptimisticLockType.NONE, OptimisticLockType.DIRTY or OptimisticLockType.ALL) 樂觀鎖策略  
  

標識符  

  
[java] view plain copy
    @org.hibernate.annotations.GenericGenerator和@org.hibernate.annotations.GenericGenerators允許你定義hibernate特有的標識符。    
        
    @Id @GeneratedValue(generator="system-uuid")    
    @GenericGenerator(name="system-uuid", strategy = "uuid")    
    public String getId() {    
    @Id @GeneratedValue(generator="hibseq")    
    @GenericGenerator(name="hibseq", strategy = "seqhilo",    
       parameters = {    
         @Parameter(name="max_lo", value = "5"),    
         @Parameter(name="sequence", value="heybabyhey")    
       }    
    <pre name="code" class="java" style="font-size: 14px; line-height: 26px;">)  </pre> <span style="font-family:Arial; font-size:14px; line-height:26px">  
    public</span><span style="font-family:Arial; font-size:14px; line-height:26px"> <wbr>Integer <wbr>getId() <wbr>{ </span>  
    <pre></pre>  
    <span style="font-family:Arial; font-size:14px; line-height:26px">新例子 </span>  
[java] view plain copy
    @GenericGenerators(    
     {    
      @GenericGenerator(    
       name="hibseq",    
       strategy = "seqhilo",    
       parameters = {    
        @Parameter(name="max_lo", value = "5"),    
        @Parameter(name="sequence", value="heybabyhey")    
       }    
      ),    
      @GenericGenerator(...)    
     }    
    )    

自然ID  
用 @NaturalId 註解標識  
  
公式  
  
讓數據庫而不是JVM進行計算。  
  
@Formula("obj_length obj_height obj_width")  
public long getObjectVolume()  
  
索引  
  
通過在列屬性(property)上使用@Index註解,可以指定特定列的索引,columnNames屬性(attribute)將隨之被忽略。  
[java] view plain copy
    @Column(secondaryTable="Cat1")    
    @Index(name="story1index")    
    public String getStoryPart1() {    
      return storyPart1;    
    }    

辨別符 

[java] view plain copy
    @Entity    
    @DiscriminatorFormula("case when forest_type is null then 0 else forest_type end")    
    public class Forest { ... }   

過濾 查詢 ...  
其中一個實體通過外鍵關聯到另一個實體的主鍵。注:一對一,則外鍵必須爲唯一約束。  
[java] view plain copy
    @Entity    
    public class Customer implements Serializable {    
       @OneToOne(cascade = CascadeType.ALL)    
       @JoinColumn(name="passport_fk")    
       public Passport getPassport() {    
       ...    
    }    
        
    @Entity    
    public class Passport implements Serializable {    
       @OneToOne(mappedBy = "passport")    
       public Customer getOwner() {    
       ...    
    }    
通過@JoinColumn註解定義一對一的關聯關係。如果沒有@JoinColumn註解,則系統自動處理,在主表中將創建連接列,列名爲:主題的關聯屬性名 下劃線 被關聯端的主鍵列名。上例爲 passport_id, 因爲Customer 中關聯屬性爲 passport, Passport 的主鍵爲 id.  
通過關聯表來保存兩個實體之間的關聯關係。注:一對一,則關聯表每個外鍵都必須是唯一約束。  
[java] view plain copy
    @Entity    
    public class Customer implements Serializable {    
       @OneToOne(cascade = CascadeType.ALL)    
       @JoinTable(name = "CustomerPassports",    
            joinColumns = @JoinColumn(name="customer_fk"),    
            inverseJoinColumns = @JoinColumn(name="passport_fk")    
       )    
       public Passport getPassport() {    
       ...    
    }    
        
        
    @Entity public class Passport implements Serializable {    
       @OneToOne(mappedBy = "passport")    
       public Customer getOwner() {    
       ...    
    }    

Customer 通過 CustomerPassports 關聯表和 Passport 關聯。該關聯表通過 passport_fk 外鍵指向 Passport 表,該信心定義爲 inverseJoinColumns 的屬性值。 通過 customer_fk 外鍵指向 Customer 表,該信息定義爲 joinColumns 屬性值。

參考:http://blog.csdn.net/ljhabc1982/article/details/6556349
annotations官方文檔:  http://docs.jboss.org/hibernate/annotations/

發佈了210 篇原創文章 · 獲贊 288 · 訪問量 286萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章