基于按annotation的hibernate主鍵生成政策

這裡讨論代理主鍵，業務主鍵（比如說複合鍵等）這裡不讨論。

一、JPA通用政策生成器

通過annotation來映射hibernate實體的,基于annotation的hibernate主鍵辨別為@Id,

其生成規則由@GeneratedValue設定的.這裡的@id和@GeneratedValue都是JPA的标準用法,

JPA提供四種标準用法,由@GeneratedValue的源代碼可以明顯看出.

@Target({METHOD,FIELD})     

    @Retention(RUNTIME)     

    public @interface GeneratedValue{     

        GenerationType strategy() default AUTO;     

        String generator() default "";     

    }   

其中GenerationType:

public enum GenerationType{     

    TABLE,     

    SEQUENCE,     

    IDENTITY,     

    AUTO    

}  

JPA提供的四種标準用法為TABLE,SEQUENCE,IDENTITY,AUTO.

TABLE：使用一個特定的資料庫表格來儲存主鍵。

SEQUENCE：根據底層資料庫的序列來生成主鍵，條件是資料庫支援序列。

IDENTITY：主鍵由資料庫自動生成（主要是自動增長型）

AUTO：主鍵由程式控制。

1、TABLE

@Id  

@GeneratedValue(strategy = GenerationType.TABLE, generator="payablemoney_gen")   

@TableGenerator(name = "pk_gen",   

    table="tb_generator",   

    pkColumnName="gen_name",   

    valueColumnName="gen_value",   

    pkColumnValue="PAYABLEMOENY_PK",   

    allocationSize=1  

)  

這裡應用表tb_generator，定義為

CREATE TABLE  tb_generator (   

  id NUMBER NOT NULL,   

  gen_name VARCHAR2(255) NOT NULL,   

  gen_value NUMBER NOT NULL,   

  PRIMARY KEY(id)   

插入紀錄，供生成主鍵使用，

INSERT INTO tb_generator(id, gen_name, gen_value) VALUES (1,PAYABLEMOENY_PK', 1);  

在主鍵生成後，這條紀錄的value值，按allocationSize遞增。

@TableGenerator的定義：

@Target({TYPE, METHOD, FIELD})    

@Retention(RUNTIME)   

public @interface TableGenerator {   

  String name();   

  String table() default "";   

  String catalog() default "";   

  String schema() default "";   

  String pkColumnName() default "";   

  String valueColumnName() default "";   

  String pkColumnValue() default "";   

  int initialValue() default 0;   

  int allocationSize() default 50;   

  UniqueConstraint[] uniqueConstraints() default {};   

其中屬性說明：

name屬性表示該表主鍵生成政策的名稱，它被引用在@GeneratedValue中設定的“generator”值中。

table屬性表示表生成政策所持久化的表名，例如，這裡表使用的是資料庫中的“tb_generator”。

catalog屬性和schema具體指定表所在的目錄名或是資料庫名。

pkColumnName屬性的值表示在持久化表中，該主鍵生成政策所對應鍵值的名稱。例如在“tb_generator”中将“gen_name”作為主鍵的鍵值

valueColumnName屬性的值表示在持久化表中，該主鍵目前所生成的值，它的值将會随着每次建立累加。例如，在“tb_generator”中将“gen_value”作為主鍵的值

pkColumnValue屬性的值表示在持久化表中，該生成政策所對應的主鍵。例如在“tb_generator”表中，将“gen_name”的值為“CUSTOMER_PK”。

initialValue表示主鍵初識值，預設為0。

allocationSize表示每次主鍵值增加的大小，例如設定成1，則表示每次建立新記錄後自動加1，預設為50。

UniqueConstraint與@Table标記中的用法類似。

2、SEQUENCE

@GeneratedValue(strategy = GenerationType.SEQUENCE,generator="payablemoney_seq")   

@SequenceGenerator(name="payablemoney_seq", sequenceName="seq_payment")  

@SequenceGenerator定義

public @interface SequenceGenerator {   

 String name();   

 String sequenceName() default "";   

 int initialValue() default 0;   

 int allocationSize() default 50;   

sequenceName屬性表示生成政策用到的資料庫序列名稱。

3、IDENTITY

@GeneratedValue(strategy = GenerationType.IDENTITY)  

4、AUTO

@GeneratedValue(strategy = GenerationType.AUTO)  

在指定主鍵時，如果不指定主鍵生成政策，預設為AUTO。

跟下面的定義是一樣的。

二、hibernate主鍵政策生成器

hibernate提供多種主鍵生成政策，有點是類似于JPA，有的是hibernate特有：

native: 對于 oracle 采用 Sequence 方式，對于MySQL 和 SQL Server 采用identity（自增主鍵生成機制），native就是将主鍵的生成工作交由資料庫完成，hibernate不管（很常用）。

uuid: 采用128位的uuid算法生成主鍵，uuid被編碼為一個32位16進制數字的字元串。占用空間大（字元串類型）。

hilo: 使用hilo生成政策，要在資料庫中建立一張額外的表，預設表名為hibernate_unique_key,預設字段為integer類型，名稱是next_hi（比較少用）。

assigned: 在插入資料的時候主鍵由程式處理（很常用），這是 <generator>元素沒有指定時的預設生成政策。等同于JPA中的AUTO。

identity: 使用SQL Server 和 MySQL 的自增字段，這個方法不能放到 Oracle 中，Oracle 不支援自增字段，要設定sequence（MySQL 和 SQL Server 中很常用）。

          等同于JPA中的INDENTITY。

select: 使用觸發器生成主鍵（主要用于早期的資料庫主鍵生成機制，少用）。

sequence: 調用底層資料庫的序列來生成主鍵，要設定序列名，不然hibernate無法找到。

seqhilo: 通過hilo算法實作，但是主鍵曆史儲存在Sequence中，适用于支援 Sequence 的資料庫，如 Oracle（比較少用）

increment: 插入資料的時候hibernate會給主鍵添加一個自增的主鍵，但是一個hibernate執行個體就維護一個計數器，是以在多個執行個體運作的時候不能使用這個方法。

foreign: 使用另外一個相關聯的對象的主鍵。通常和<one-to-one>聯合起來使用。

guid: 采用資料庫底層的guid算法機制，對應MYSQL的uuid()函數，SQL Server的newid()函數，ORACLE的rawtohex(sys_guid())函數等。

uuid.hex: 看uuid，建議用uuid替換。

sequence-identity: sequence政策的擴充，采用立即檢索政策來擷取sequence值，需要JDBC3.0和JDK4以上（含1.4）版本

hibernate提供了多種生成器供選擇,基于Annotation的方式通過@GenericGenerator實作.

hibernate每種主鍵生成政策提供接口org.hibernate.id.IdentifierGenerator的實作類,如果要實作自定義的主鍵生成政策也必須實作此接口.

public interface IdentifierGenerator {   

    /**  

     * The configuration parameter holding the entity name  

     */  

    public static final String ENTITY_NAME = "entity_name";   

  /**  

   * Generate a new identifier.  

   * @param session  

   * @param object the entity or toplevel collection for which the id is being generated  

   *  

   * @return a new identifier  

   * @throws HibernateException  

   */  

  public Serializable generate(SessionImplementor session, Object object)    

    throws HibernateException;   

IdentifierGenerator提供一generate方法,generate方法傳回産生的主鍵.

三、@GenericGenerator

自定義主鍵生成政策，由@GenericGenerator實作。

hibernate在JPA的基礎上進行了擴充，可以用一下方式引入hibernate獨有的主鍵生成政策，就是通過@GenericGenerator加入的。

比如說，JPA标準用法

@GeneratedValue(GenerationType.AUTO)  

就可以用hibernate特有以下用法來實作

@GeneratedValue(generator = "paymentableGenerator")     

@GenericGenerator(name = "paymentableGenerator", strategy = "assigned")  

@GenericGenerator的定義:

@Target({PACKAGE, TYPE, METHOD, FIELD})   

public @interface GenericGenerator {   

 /**  

  * unique generator name  

  */  

  * Generator strategy either a predefined Hibernate  

  * strategy or a fully qualified class name.  

 String strategy();   

  * Optional generator parameters  

 Parameter[] parameters() default {};   

name屬性指定生成器名稱。

strategy屬性指定具體生成器的類名。

parameters得到strategy指定的具體生成器所用到的參數。

對于這些hibernate主鍵生成政策和各自的具體生成器之間的關系,在org.hibernate.id.IdentifierGeneratorFactory中指定了,

static {   

  GENERATORS.put("uuid", UUIDHexGenerator.class);   

  GENERATORS.put("hilo", TableHiLoGenerator.class);   

  GENERATORS.put("assigned", Assigned.class);   

  GENERATORS.put("identity", IdentityGenerator.class);   

  GENERATORS.put("select", SelectGenerator.class);   

  GENERATORS.put("sequence", SequenceGenerator.class);   

  GENERATORS.put("seqhilo", SequenceHiLoGenerator.class);   

  GENERATORS.put("increment", IncrementGenerator.class);   

  GENERATORS.put("foreign", ForeignGenerator.class);   

  GENERATORS.put("guid", GUIDGenerator.class);   

  GENERATORS.put("uuid.hex", UUIDHexGenerator.class); //uuid.hex is deprecated   

  GENERATORS.put("sequence-identity", SequenceIdentityGenerator.class);   

上面十二種政策，加上native，hibernate一共預設支援十三種生成政策。

1、native

@GenericGenerator(name = "paymentableGenerator", strategy = "native")   

2、uuid

@GenericGenerator(name = "paymentableGenerator", strategy = "uuid")   

3、hilo

@GenericGenerator(name = "paymentableGenerator", strategy = "hilo")   

4、assigned

@GenericGenerator(name = "paymentableGenerator", strategy = "assigned")   

5、identity

@GenericGenerator(name = "paymentableGenerator", strategy = "identity")   

6、select

@GeneratedValue(generator = "paymentableGenerator")   

@GenericGenerator(name="select", strategy="select",   

     parameters = { @Parameter(name = "key", value = "idstoerung") })  

7、sequence

@GenericGenerator(name = "paymentableGenerator", strategy = "sequence",    

         parameters = { @Parameter(name = "sequence", value = "seq_payablemoney") })  

8、seqhilo

@GenericGenerator(name = "paymentableGenerator", strategy = "seqhilo",    

         parameters = { @Parameter(name = "max_lo", value = "5") })  

9、increment

@GenericGenerator(name = "paymentableGenerator", strategy = "increment")   

10、foreign

@GeneratedValue(generator = "idGenerator")   

@GenericGenerator(name = "idGenerator", strategy = "foreign",    

         parameters = { @Parameter(name = "property", value = "employee") })  

注意：直接使用@PrimaryKeyJoinColumn 報錯（?）

@OneToOne(cascade = CascadeType.ALL)    

@PrimaryKeyJoinColumn   

例如

@Entity  

public class Employee {   

  @Id Integer id;   

  @OneToOne @PrimaryKeyJoinColumn  

  EmployeeInfo info;   

  ...   

應該為

  @Id    

  @GeneratedValue(generator = "idGenerator")   

  @GenericGenerator(name = "idGenerator", strategy = "foreign",    

         parameters = { @Parameter(name = "property", value = "info") })    

  Integer id;   

  @OneToOne  

11、guid

@GenericGenerator(name = "paymentableGenerator", strategy = "guid")   

12、uuid.hex

@GenericGenerator(name = "paymentableGenerator", strategy = "uuid.hex")   

13、sequence-identity

@GenericGenerator(name = "paymentableGenerator", strategy = "sequence-identity",    

四、通過@GenericGenerator自定義主鍵生成政策

如果實際應用中，主鍵政策為程式指定了就用程式指定的主鍵（assigned），沒有指定就從sequence中取。

明顯上面所讨論的政策都不滿足，隻好自己擴充了，內建assigned和sequence兩種政策。

public class AssignedSequenceGenerator extends SequenceGenerator implements    

 PersistentIdentifierGenerator, Configurable {   

 private String entityName;   

 public void configure(Type type, Properties params, Dialect dialect) throws MappingException {   

  entityName = params.getProperty(ENTITY_NAME);   

  if (entityName==null) {   

   throw new MappingException("no entity name");   

  }   

  super.configure(type, params, dialect);     

 }   

 public Serializable generate(SessionImplementor session, Object obj)    

  throws HibernateException {   

  Serializable id = session.getEntityPersister( entityName, obj )    

    .getIdentifier( obj, session.getEntityMode() );   

  if (id==null) {   

   id = super.generate(session, obj);   

  return id;   

實際應用中，定義同sequence。

@GenericGenerator(name = "paymentableGenerator", strategy = "AssignedSequenceGenerator",    

     parameters = { @Parameter(name = "sequence", value = "seq_payablemoney") })  

值得注意的是，定義的這種政策，就像打開了潘多拉魔盒，非常不可控。正常情況下，不建議這麼做。