基於按annotation的hibernate主鍵生成策略[轉載]

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

比如說，JPA標準用法
Java代碼
@Id
@GeneratedValue(GenerationType.AUTO)

就可以用hibernate特有以下用法來實現
Java代碼
@GeneratedValue(generator = "paymentableGenerator")
@GenericGenerator(name = "paymentableGenerator", strategy = "assigned")


@GenericGenerator的定義:
Java代碼
@Target({PACKAGE, TYPE, METHOD, FIELD})
@Retention(RUNTIME)
public @interface GenericGenerator {

String name();

String strategy();

Parameter[] parameters() default {};
}


name屬性指定生成器名稱。
strategy屬性指定具體生成器的類名。
parameters得到strategy指定的具體生成器所用到的參數。

對於這些hibernate主鍵生成策略和各自的具體生成器之間的關係,在org.hibernate.id.IdentifierGeneratorFactory中指定了,
Java代碼
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 對於orcale採用Sequence方式，對於MySQL和SQL Server採用identity(處境主鍵生成機制)，native就是將主鍵的生成工作交給資料庫本身，hibernate不管。（很常用）
Java代碼
@GeneratedValue(generator = "paymentableGenerator")
@GenericGenerator(name = "paymentableGenerator", strategy = "native")

2、uuid 採用128位元的uuid演算法生成主鍵，uuid被編碼為一個32位元16進制數位的字串。佔用空間大（字串類型）。
Java代碼
@GeneratedValue(generator = "paymentableGenerator")
@GenericGenerator(name = "paymentableGenerator", strategy = "uuid")

3、hilo 要在資料庫中建立一張額外的表，默認表名為hibernate_unque_key，默認欄位為integer類型，名稱是next_hi（比較少用）
Java代碼
@GeneratedValue(generator = "paymentableGenerator")
@GenericGenerator(name = "paymentableGenerator", strategy = "hilo")

4、assigned 在插入資料的時候主鍵由程式處理（很常用），這是元素沒有指定時的預設生成策略。等同於JPA中的AUTO。
Java代碼
@GeneratedValue(generator = "paymentableGenerator")
@GenericGenerator(name = "paymentableGenerator", strategy = "assigned")

5、identity 使用SQL Server和MySQL的自增欄位，這個方法不能放到Oracle中，Oracle不支持自增欄位，要設定sequence(MySQL和SQL Server中很常用)。等同於JPA中的IDENTITY
Java代碼
@GeneratedValue(generator = "paymentableGenerator")
@GenericGenerator(name = "paymentableGenerator", strategy = "identity")

6、select 使用觸發器生成主鍵（主要用於早期的資料庫主鍵生成機制，少用）
Java代碼
@GeneratedValue(generator = "paymentableGenerator")
@GenericGenerator(name="select", strategy="select",
parameters = { @Parameter(name = "key", value = "idstoerung") })

7、sequence 調用謹慎資料庫的序列來生成主鍵，要設定序列名，不然hibernate無法找到。
Java代碼
@GeneratedValue(generator = "paymentableGenerator")
@GenericGenerator(name = "paymentableGenerator", strategy = "sequence",
parameters = { @Parameter(name = "sequence", value = "seq_payablemoney") })

8、seqhilo 通過hilo演算法實現，但是主鍵歷史保存在Sequence中，適用於支援Sequence的資料庫，如Orcale(比較少用）
Java代碼
@GeneratedValue(generator = "paymentableGenerator")
@GenericGenerator(name = "paymentableGenerator", strategy = "seqhilo",
parameters = { @Parameter(name = "max_lo", value = "5") })

9、increment 插入資料的時候hibernate會給主鍵添加一個自增的主鍵，但是一個hibernate實例就維護一個計數器，所以在多個實例運行的時候不能使用這個方法。
Java代碼
@GeneratedValue(generator = "paymentableGenerator")
@GenericGenerator(name = "paymentableGenerator", strategy = "increment")

10、foreign
Java代碼
@GeneratedValue(generator = "idGenerator")
@GenericGenerator(name = "idGenerator", strategy = "foreign",
parameters = { @Parameter(name = "property", value = "employee") })


注意：直接使用@PrimaryKeyJoinColumn 報錯（?）
Java代碼
@OneToOne(cascade = CascadeType.ALL)
@PrimaryKeyJoinColumn
例如
Java代碼
@Entity
public class Employee {
@Id Integer id;

@OneToOne @PrimaryKeyJoinColumn
EmployeeInfo info;

}
應該為
Java代碼
@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 採用資料庫底層的guid演算法機制，對應MySQL的uuid()函數，SQL Server的newid()函數，ORCALE的rawtohex(sys_guid())函數等
Java代碼
@GeneratedValue(generator = "paymentableGenerator")
@GenericGenerator(name = "paymentableGenerator", strategy = "guid")

12、uuid.hex 看uudi,建議用uuid替換
Java代碼
@GeneratedValue(generator = "paymentableGenerator")
@GenericGenerator(name = "paymentableGenerator", strategy = "uuid.hex")

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

四、通過@GenericGenerator自訂主鍵生成策略
如果實際應用中，主鍵策略為程式指定了就用程式指定的主鍵（assigned），沒有指定就從sequence中取。
明顯上面所討論的策略都不滿足，只好自己擴展了，集成assigned和sequence兩種策略。

Java代碼
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。
Java代碼
@GeneratedValue(generator = "paymentableGenerator")
@GenericGenerator(name = "paymentableGenerator", strategy = "AssignedSequenceGenerator",
parameters = { @Parameter(name = "sequence", value = "seq_payablemoney") })


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