Hibernate4之主键映射机制

[size=medium]
[color=olive][b]关系型数据库中依靠主键来区分不同的记录，主键又有自然主键和代理主键之分。[/b][/color]

[color=red]自然主键[/color]：就是指充当主键的字段本身具有一定的含义，是构成记录的重要组成部分。

[color=red]代理主键[/color]：就是指主键字段本身不具有业务含义，只是起到标志的作用，比如自增长类型的ID。

在Hibernate应用方案中，极力推荐使用代理主键。
在Hibernate中，Hibernate依靠对象标识符（OID）来区分不同持久化对象。而对象标识符(OID)可以通过Hibernate内置的标识生成器来产生。

这里讨论的是代理主键，业务主键（比如说复合键等）这里不讨论。

一、JPA通用策略生成器
通过Annotation来映射hibernate实体的,基于Annotation的hibernate主键标识为@Id,
其生成规则由@GeneratedValue设定的.这里的@id和@GeneratedValue都是JPA的标准用法,
JPA提供四种标准用法,由@GeneratedValue的源代码可以明显看出.
[/size]

@Target({METHOD,FIELD})  
    @Retention(RUNTIME)  
    public @interface GeneratedValue{  
        GenerationType strategy() default AUTO;  
        String generator() default "";  
    } 

[size=medium]其中GenerationType:[/size]

public enum GenerationType{  
    TABLE,  
    SEQUENCE,  
    IDENTITY,  
    AUTO 
}

[size=medium]
[b]JPA提供的四种标准用法：[/b]
[/size]
[table]
|TABLE|使用一个特定的数据库表格来保存主键|
|SEQUENCE|根据底层数据库的序列来生成主键，条件是数据库支持序列|
|IDENTITY|主键由数据库自动生成（主要是自动增长型）|
|AUTO|主键由程序控制|
[/table]

[color=blue][size=medium][align=center]1、TABLE [/align][/size][/color]

@Entity
@Table(name = "TAB_PLAYER")
@TableGenerator(name = "tab-store", table = "AUTO_ID_GENERATOR", 
       pkColumnName = "G_KEY", pkColumnValue = "TAB_PLAYER_PK", 
       valueColumnName = "G_VALUE", allocationSize = 1)
public class Player {
   private Long id;

   @Id
   @GeneratedValue(strategy = GenerationType.TABLE, generator = "tab-store")
   @Column(unique = true, nullable = false) //unique指定是否唯一，nullable指定是否可以为空
   public Long getId() {
      return id;
   }
   ......
｝

[size=medium]看看源代码中@TableGenerator是如何定义的：[/size]

@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 {};
}

[size=medium]其中属性说明：
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标记中的用法类似。[/size]

[color=blue][size=medium][align=center]2、SEQUENCE [/align][/size][/color]

@Entity
@Table(name = "SMS_DEPT")
@SequenceGenerator(name="MyTableGenerator",sequenceName="SEQ_SMS_DEPT")
public class Dept {
   private Long id;

   @Id
   @GeneratedValue(strategy = GenerationType.SEQUENCE, generator="MyTableGenerator")
   @Column(unique = true, nullable = false)
   public Long getId() {
      return id;
   }
   ......

[size=medium]看看源代码中@SequenceGenerator是如何定义的：[/size]

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

[size=medium]
name属性表示该表主键生成策略的名称，它被引用在@GeneratedValue中设置的“generator”值中。
sequenceName属性表示生成策略用到的数据库序列名称。
initialValue表示主键初识值，默认为0。
allocationSize表示每次主键值增加的大小，例如设置成1，则表示每次创建新记录后自动加1，默认为50。[/size]

[color=blue][size=medium][align=center]3、IDENTITY [/align][/size][/color]
[size=medium]当数据库是SQL SERVER时可以用IDENTITY[/size]

@Entity
@Table(name = "SMS_DEPT")
public class Dept {
   private Long id;

   @Id
   @GeneratedValue(strategy = GenerationType.IDENTITY)
   @Column(unique = true, nullable = false)
   public Long getId() {
      return id;
   }
   ......

[color=blue][size=medium][align=center]4、AUTO [/align][/size][/color]
[size=medium]在指定主键时，如果不指定主键生成策略，默认为AUTO[/size]

@Entity
@Table(name = "SMS_DEPT")
public class Dept {
   private Long id;

   @Id
   @GeneratedValue(strategy = GenerationType.AUTO)
   public Long getId() {
      return id;
   }
   ......

[size=medium]
[align=center][b][color=red]Hibernate主键策略生成器[/color][/b][/align]

hibernate提供多种主键生成策略，有点是类似于JPA，有的是hibernate特有[/size]
[table]
|[align=center][b]生成器[/b][/align]|[align=center][b]描述[/b][/align]|
|native|根据底层的数据库对自动生成OID能力的支持，具体选择identity，sequence或者hilo生成器来产生OID，常用于跨平台应用， 对于 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|OID由底层的数据库自增主键生成机制产生，如MySql的auto_increment类型主键和SQL SERVER的identity类型主键，这个方法不能放到Oracle中，Oracle不支持自增字段|
|select|使用触发器生成主键（主要用于早期的数据库主键生成机制，少用）|
|sequence|调用底层数据库的序列来生成主键，要设定序列名，不然hibernate无法找到|
|seqhilo|通过hilo算法实现，但是主键历史保存在Sequence中，适用于支持 Sequence 的数据库，如 Oracle（比较少用）|
|increment|OID由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）版本|
[/table]

[size=medium]
[b][color=blue]自定义主键生成策略，由@GenericGenerator实现。[/color][/b]
hibernate在JPA的基础上进行了扩展，可以用一下方式引入hibernate独有的主键生成策略，就是通过@GenericGenerator加入的。
比如说，JPA标准用法
[/size]

@Id
@GeneratedValue(GenerationType.AUTO)

[size=medium]就可以用hibernate特有以下用法来实现[/size]

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

[size=medium]
在JPA源码中@GenericGenerator的定义:
name属性指定生成器名称。
strategy属性指定具体生成器的类名。
parameters得到strategy指定的具体生成器所用到的参数。
[/size]

@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 {};
}

[size=medium]对于这些hibernate主键生成策略和各自的具体生成器之间的关系,在org.hibernate.id.IdentifierGeneratorFactory中指定了。
下面十二种策略，加上native，Hibernate一共默认支持十三种生成策略
[/size]

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);
}

[size=medium]1、native[/size]

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

[size=medium]2、uuid[/size]

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

[size=medium]3、hilo[/size]

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

[size=medium]4、assigned[/size]

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

[size=medium]5、identity[/size]

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

[size=medium]6、select[/size]

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

[size=medium]7、sequence[/size]

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

[size=medium]8、seqhilo[/size]

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

[size=medium]9、increment[/size]

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

[size=medium]10、foreign[/size]

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

  @OneToOne
  EmployeeInfo info;
  ...
}

[size=medium]11、guid[/size]

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

[size=medium]12、uuid.hex[/size]

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

[size=medium]13、sequence-identity[/size]

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