hibernate、JPA主键生成策略及如何选择

一、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") })

值得注意的是，定义的这种策略，就像打开了潘多拉魔盒，非常不可控。正常情况下，不建议这么做。

五、Hibernate常用的主键生成策略的原理、特点、应用场合

    关于映射文件的问题下次再介绍，这次主要总结hibernate常用主键生成策略。

   （1）increment

       a)对主键值采取自动顺序增长的方式生成新的主键，值默认从1开始。

       b)原理:在当前应用实例中维持一个变量,以保存当前最大值,之后每次需要生成主键值的时候将此值加1作为主键.不依赖于底层的数据库，因此所有的数据库都可以使用

       c)缺点:通过increment的生成主键的原理可推断，此种主键生成策略不适用于集群、同一时段大量用户并发访问的系统，既当大量用户同一时间段同时进行插入操作的时候，可能存在取得相同的最大值然后再同时+1的情况,这个时候就会造成主键冲突。因此，如果同一数据库有多个实例访问，此方式必须避免使用。

   （2）UUID

       a)原理UUID使用128位UUID算法生成主键，能够保证网络环境下的主键唯一性，也就能够保证在不同数据库及不同服务器下主键的唯一性。所以使用于所有数据库。

       b)特点;能够保证数据库中的主键唯一性，但是在生成的主键占用比较多的存贮空间 

   （3）Hilo

　     a)原理:通过hi/lo 算法(Hilo使用高低位算法生成主键，高低位算法使用一个高位值和一个低位值，然后把算法得到的两个值拼接起来)实现的主键生成机制，需要额外的数据库表保存主键生成历史状态。

       b)特点：需要额外的数据库表和字段提供高位值来源。默认情况下使用的表是 　　hibernate_unique_key，默认字段叫作next_hi。next_hi必须有一条记录否则会出现错误。需要额外的数据库表的支持，能保证同一个数据库中主键的唯一性，但不能保证多个数据库之间主键的唯一性。Hilo主键生成方式由Hibernate 维护，所以Hilo方式与底层数据库无关。

   （4）sequence

       a)sequence实际是就是一张单行单列的表。

       b)实现原理:调用数据库中底层存在的sequence生成主键，需要底层数据库的支持序列，因此他是依赖于数据库的。

       c)支持sequence的数据库有:Oracle 、DB2(Mysql/SQlServer不支持)、PostgreSql、SAPDb等

   （5）identity

       a)根据底层数据库，来支持自动增长，不同的数据库用不同的主键增长方式。

       b)特点: 与底层数据库有关，要求数据库支持Identity，如MySQl中是auto_increment, SQL Server 中是Identity。支持的数据库有MySql、SQL Server、DB2、Sybase和HypersonicSQL。

       c)好处:在建表的时候指定了id为自动增长,实际开发中就不需要自己定义插入数据库的主键值,系统会自动顺序递增一个值 。Identity无需Hibernate和用户的干涉，使用较为方便，但由于依赖于数据库，所以不便于在不同的数据库之间移植程序。

   （6）native

       a)作用:根据数据库的类型,自动在sequence 、identity和,hilo进行切换。

       b)实现自动切换的依据:根据Hibernate配置文件中的方言来判断是Oracle还是Mysql、SqlServer,然后针对数据库的类型抉择 sequence还是identity作为主键生成策略。

       c)用处：由于Hibernate会根据底层数据库采用不同的映射方式，因此灵活性高，便于程序移植，项目中如果用到多个数据库时，可以使用这种方式。

   （7）assigned

       a)作用:用于手工分配主键生成器,一旦指定为这个了,Hibernate就不在自动为程序做主键生成器了。没有指定<generator>标签时，默认就是assigned主键的生成方式

       b)使用方法:在程序中session.save();之前,由程序员自己指定主键值为多少。

         例如:user.setId(1);这就是在程序中程序员手动为用户表指定主键值为1。

   （8）foreign

       只适用基于共享主键的一对一关联映射的时候使用。即一个对象的主键是参照的另一张表的主键生成的。

  

   对数据库的依赖性总结

    UUID，increment、Hilo、assigned：对数据库无依赖

    identity：依赖Mysql或sql server，主键值不由hibernate维护

    sequence：适合于oracle等支持序列的dbms，主键值不由hibernate维护，由序列产生。

    native：根据底层数据库的具体特性选择适合的主键生成策略，如果是mysql或sqlserver，选择identity，如果是oracle，选择sequence。

   关于主键生成策略的选择：

    一般来说推荐UUID，因为生成主键唯一，且对数据库无依赖，可移植性强。

    由于常用的数据库，如Oracle、DB2、SQLServer、MySql 等，都提供了易用的主键生成机制（Auto-Increase 字段或者Sequence）。我们可以在数据库提供的主键生成机制上，采用native，sequence或者identity的主键生成方式。

    不过值得注意的是，一些数据库提供的主键生成机制在效率上未必最佳大量并发insert数据时可能会引起表之间的互锁。

    因此，对于并发Insert要求较高的系统，推荐采用uuid作为主键生成机制。

    总之，hibernate主键生成器选择，还要具体情况具体分析。一般而言，利用uuid方式生成主键将提供最好的性能和数据库平台适应性。