基於annotation的JPA和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

@Id
@GeneratedValue(strategy = GenerationType.SEQUENCE,generator="payablemoney_seq")
@SequenceGenerator(name="payablemoney_seq", sequenceName="seq_payment")

@SequenceGenerator定義

@Target({TYPE, METHOD, FIELD})
@Retention(RUNTIME)
public @interface SequenceGenerator {
 String name();
 String sequenceName() default "";
 int initialValue() default 0;
 int allocationSize() default 50;
}

name屬性表示該表主鍵生成策略的名稱，它被引用在@GeneratedValue中設置的“generator”值中。
sequenceName屬性表示生成策略用到的數據庫序列名稱。
initialValue表示主鍵初識值，默認爲0。
allocationSize表示每次主鍵值增加的大小，例如設置成1，則表示每次創建新記錄後自動加1，默認爲50。


3、IDENTITY

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)

4、AUTO

@Id
@GeneratedValue(strategy = GenerationType.AUTO)

在指定主鍵時，如果不指定主鍵生成策略，默認爲AUTO。

@Id

跟下面的定義是一樣的。

@Id
@GeneratedValue(strategy = GenerationType.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標準用法

@Id
@GeneratedValue(GenerationType.AUTO)

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

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

@GenericGenerator的定義:

@Target({PACKAGE, TYPE, METHOD, FIELD})
@Retention(RUNTIME)
public @interface GenericGenerator {
 /**
  * unique generator name
  */
 String 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

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

2、uuid

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

3、hilo

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

4、assigned

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

5、identity

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

6、select

@GeneratedValue(generator = "paymentableGenerator")
@GenericGenerator(name="select", strategy="select",
     parameters = { @Parameter(name = "key", value = "idstoerung") })

7、sequence

@GeneratedValue(generator = "paymentableGenerator")
@GenericGenerator(name = "paymentableGenerator", strategy = "sequence",
         parameters = { @Parameter(name = "sequence", value = "seq_payablemoney") })

8、seqhilo

@GeneratedValue(generator = "paymentableGenerator")
@GenericGenerator(name = "paymentableGenerator", strategy = "seqhilo",
         parameters = { @Parameter(name = "max_lo", value = "5") })

9、increment

@GeneratedValue(generator = "paymentableGenerator")
@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;
  ...
}

應該爲

@Entity
public class Employee {
  @Id
  @GeneratedValue(generator = "idGenerator")
  @GenericGenerator(name = "idGenerator", strategy = "foreign",
         parameters = { @Parameter(name = "property", value = "info") })
  Integer id;

  @OneToOne
  EmployeeInfo info;
  ...
}

11、guid

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

12、uuid.hex

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

13、sequence-identity

@GeneratedValue(generator = "paymentableGenerator")
@GenericGenerator(name = "paymentableGenerator", strategy = "sequence-identity",
         parameters = { @Parameter(name = "sequence", value = "seq_payablemoney") })

四、通過@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。

@GeneratedValue(generator = "paymentableGenerator")
@GenericGenerator(name = "paymentableGenerator", strategy = "AssignedSequenceGenerator",
     parameters = { @Parameter(name = "sequence", value = "seq_payablemoney") })

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