`
lp895876294
  • 浏览: 284315 次
  • 性别: Icon_minigender_1
  • 来自: 济南
社区版块
存档分类
最新评论

JPA主键生成方式

    博客分类:
  • JPA
 
阅读更多

原文->http://blog.csdn.net/yalove/article/details/6627732

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

Java代码  收藏代码
  1. @Target({METHOD,FIELD})    
  2.     @Retention(RUNTIME)    
  3.     public @interface GeneratedValue{    
  4.         GenerationType strategy() default AUTO;    
  5.         String generator() default "";    
  6.     }   



其中GenerationType:

Java代码  收藏代码
  1. public enum GenerationType{    
  2.     TABLE,    
  3.     SEQUENCE,    
  4.     IDENTITY,    
  5.     AUTO   
  6. }  



JPA提供的四种标准用法为TABLE,SEQUENCE,IDENTITY,AUTO.
TABLE:使用一个特定的数据库表格来保存主键。
SEQUENCE:根据底层数据库的序列来生成主键,条件是数据库支持序列。
IDENTITY:主键由数据库自动生成(主要是自动增长型)
AUTO:主键由程序控制。

1、TABLE

Java代码  收藏代码
  1. @Id  
  2. @GeneratedValue(strategy = GenerationType.TABLE, generator="payablemoney_gen")  
  3. @TableGenerator(name = "pk_gen",  
  4.     table="tb_generator",  
  5.     pkColumnName="gen_name",  
  6.     valueColumnName="gen_value",  
  7.     pkColumnValue="PAYABLEMOENY_PK",  
  8.     allocationSize=1  
  9. )  



这里应用表tb_generator,定义为

Sql代码  收藏代码
  1. CREATE TABLE  tb_generator (  
  2.   id NUMBER NOT NULL,  
  3.   gen_name VARCHAR2(255) NOT NULL,  
  4.   gen_value NUMBER NOT NULL,  
  5.   PRIMARY KEY(id)  
  6. )  



插入纪录,供生成主键使用,

Sql代码  收藏代码
  1. INSERT INTO tb_generator(id, gen_name, gen_value) VALUES (1,PAYABLEMOENY_PK', 1);  



在主键生成后,这条纪录的value值,按allocationSize递增。


@TableGenerator的定义:

Java代码  收藏代码
  1. @Target({TYPE, METHOD, FIELD})   
  2. @Retention(RUNTIME)  
  3. public @interface TableGenerator {  
  4.   String name();  
  5.   String table() default "";  
  6.   String catalog() default "";  
  7.   String schema() default "";  
  8.   String pkColumnName() default "";  
  9.   String valueColumnName() default "";  
  10.   String pkColumnValue() default "";  
  11.   int initialValue() default 0;  
  12.   int allocationSize() default 50;  
  13.   UniqueConstraint[] uniqueConstraints() default {};  
  14. }  



其中属性说明:
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

Java代码  收藏代码
  1. @Id  
  2. @GeneratedValue(strategy = GenerationType.SEQUENCE,generator="payablemoney_seq")  
  3. @SequenceGenerator(name="payablemoney_seq", sequenceName="seq_payment")  


@SequenceGenerator定义

Java代码  收藏代码
  1. @Target({TYPE, METHOD, FIELD})   
  2. @Retention(RUNTIME)  
  3. public @interface SequenceGenerator {  
  4.  String name();  
  5.  String sequenceName() default "";  
  6.  int initialValue() default 0;  
  7.  int allocationSize() default 50;  
  8. }  



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


3、IDENTITY

Java代码  收藏代码
  1. @Id  
  2. @GeneratedValue(strategy = GenerationType.IDENTITY)  


4、AUTO

Java代码  收藏代码
  1. @Id  
  2. @GeneratedValue(strategy = GenerationType.AUTO)  


在指定主键时,如果不指定主键生成策略,默认为AUTO。

Java代码  收藏代码
  1. @Id  



跟下面的定义是一样的。

Java代码  收藏代码
  1. @Id  
  2. @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的实现类,如果要实现自定义的主键生成策略也必须实现此接口.

Java代码  收藏代码
  1. public interface IdentifierGenerator {  
  2.     /** 
  3.      * The configuration parameter holding the entity name 
  4.      */  
  5.     public static final String ENTITY_NAME = "entity_name";  
  6.       
  7.   /** 
  8.    * Generate a new identifier. 
  9.    * @param session 
  10.    * @param object the entity or toplevel collection for which the id is being generated 
  11.    * 
  12.    * @return a new identifier 
  13.    * @throws HibernateException 
  14.    */  
  15.   public Serializable generate(SessionImplementor session, Object object)   
  16.     throws HibernateException;  
  17. }  



IdentifierGenerator提供一generate方法,generate方法返回产生的主键.


三、@GenericGenerator
自定义主键生成策略,由@GenericGenerator实现。
hibernate在JPA的基础上进行了扩展,可以用一下方式引入hibernate独有的主键生成策略,就是通过@GenericGenerator加入的。

比如说,JPA标准用法

Java代码  收藏代码
  1. @Id  
  2. @GeneratedValue(GenerationType.AUTO)  


就可以用hibernate特有以下用法来实现

Java代码  收藏代码
  1. @GeneratedValue(generator = "paymentableGenerator")    
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "assigned")  



@GenericGenerator的定义:

Java代码  收藏代码
  1. @Target({PACKAGE, TYPE, METHOD, FIELD})  
  2. @Retention(RUNTIME)  
  3. public @interface GenericGenerator {  
  4.  /** 
  5.   * unique generator name 
  6.   */  
  7.  String name();  
  8.  /** 
  9.   * Generator strategy either a predefined Hibernate 
  10.   * strategy or a fully qualified class name. 
  11.   */  
  12.  String strategy();  
  13.  /** 
  14.   * Optional generator parameters 
  15.   */  
  16.  Parameter[] parameters() default {};  
  17. }  



name属性指定生成器名称。
strategy属性指定具体生成器的类名。
parameters得到strategy指定的具体生成器所用到的参数。

对于这些hibernate主键生成策略和各自的具体生成器之间的关系,在org.hibernate.id.IdentifierGeneratorFactory中指定了,

注:在hibernate4.3中在类DefaultIdentifierGeneratorFactory注册了id生成方式。

Java代码  收藏代码
  1. static {  
  2.   GENERATORS.put("uuid", UUIDHexGenerator.class);  
  3.   GENERATORS.put("hilo", TableHiLoGenerator.class);  
  4.   GENERATORS.put("assigned", Assigned.class);  
  5.   GENERATORS.put("identity", IdentityGenerator.class);  
  6.   GENERATORS.put("select", SelectGenerator.class);  
  7.   GENERATORS.put("sequence", SequenceGenerator.class);  
  8.   GENERATORS.put("seqhilo", SequenceHiLoGenerator.class);  
  9.   GENERATORS.put("increment", IncrementGenerator.class);  
  10.   GENERATORS.put("foreign", ForeignGenerator.class);  
  11.   GENERATORS.put("guid", GUIDGenerator.class);  
  12.   GENERATORS.put("uuid.hex", UUIDHexGenerator.class); //uuid.hex is deprecated  
  13.   GENERATORS.put("sequence-identity", SequenceIdentityGenerator.class);  
  14. }  


上面十二种策略,加上native,hibernate一共默认支持十三种生成策略。

1、native

Java代码  收藏代码
  1. @GeneratedValue(generator = "paymentableGenerator")    
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "native")   


2、uuid

Java代码  收藏代码
  1. @GeneratedValue(generator = "paymentableGenerator")    
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "uuid")   


3、hilo

Java代码  收藏代码
  1. @GeneratedValue(generator = "paymentableGenerator")    
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "hilo")   


4、assigned

Java代码  收藏代码
  1. @GeneratedValue(generator = "paymentableGenerator")    
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "assigned")   


5、identity

Java代码  收藏代码
  1. @GeneratedValue(generator = "paymentableGenerator")    
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "identity")   


6、select

Java代码  收藏代码
  1. @GeneratedValue(generator = "paymentableGenerator")  
  2. @GenericGenerator(name="select", strategy="select",  
  3.      parameters = { @Parameter(name = "key", value = "idstoerung") })  


7、sequence

Java代码  收藏代码
  1. @GeneratedValue(generator = "paymentableGenerator")  
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "sequence",   
  3.          parameters = { @Parameter(name = "sequence", value = "seq_payablemoney") })  


8、seqhilo

Java代码  收藏代码
  1. @GeneratedValue(generator = "paymentableGenerator")  
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "seqhilo",   
  3.          parameters = { @Parameter(name = "max_lo", value = "5") })  


9、increment

Java代码  收藏代码
  1. @GeneratedValue(generator = "paymentableGenerator")    
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "increment")   


10、foreign

Java代码  收藏代码
  1. @GeneratedValue(generator = "idGenerator")  
  2. @GenericGenerator(name = "idGenerator", strategy = "foreign",   
  3.          parameters = { @Parameter(name = "property", value = "employee") })  



注意:直接使用@PrimaryKeyJoinColumn 报错(?)

Java代码  收藏代码
  1. @OneToOne(cascade = CascadeType.ALL)   
  2. @PrimaryKeyJoinColumn   



例如

Java代码  收藏代码
  1. @Entity  
  2. public class Employee {  
  3.   @Id Integer id;  
  4.       
  5.   @OneToOne @PrimaryKeyJoinColumn  
  6.   EmployeeInfo info;  
  7.   ...  
  8. }  



应该为

Java代码  收藏代码
  1. @Entity  
  2. public class Employee {  
  3.   @Id   
  4.   @GeneratedValue(generator = "idGenerator")  
  5.   @GenericGenerator(name = "idGenerator", strategy = "foreign",   
  6.          parameters = { @Parameter(name = "property", value = "info") })   
  7.   Integer id;  
  8.       
  9.   @OneToOne  
  10.   EmployeeInfo info;  
  11.   ...  
  12. }  



11、guid

Java代码  收藏代码
  1. @GeneratedValue(generator = "paymentableGenerator")    
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "guid")   


12、uuid.hex

Java代码  收藏代码
  1. @GeneratedValue(generator = "paymentableGenerator")    
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "uuid.hex")   


13、sequence-identity

Java代码  收藏代码
  1. @GeneratedValue(generator = "paymentableGenerator")  
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "sequence-identity",   
  3.          parameters = { @Parameter(name = "sequence", value = "seq_payablemoney") })  



四、通过@GenericGenerator自定义主键生成策略
如果实际应用中,主键策略为程序指定了就用程序指定的主键(assigned),没有指定就从sequence中取。
明显上面所讨论的策略都不满足,只好自己扩展了,集成assigned和sequence两种策略。

Java代码  收藏代码
  1. public class AssignedSequenceGenerator extends SequenceGenerator implements   
  2.  PersistentIdentifierGenerator, Configurable {  
  3.  private String entityName;  
  4.     
  5.  public void configure(Type type, Properties params, Dialect dialect) throws MappingException {  
  6.   entityName = params.getProperty(ENTITY_NAME);  
  7.   if (entityName==null) {  
  8.    throw new MappingException("no entity name");  
  9.   }  
  10.     
  11.   super.configure(type, params, dialect);    
  12.  }  
  13.    
  14.  public Serializable generate(SessionImplementor session, Object obj)   
  15.   throws HibernateException {  
  16.     
  17.   Serializable id = session.getEntityPersister( entityName, obj )   
  18.     .getIdentifier( obj, session.getEntityMode() );  
  19.     
  20.   if (id==null) {  
  21.    id = super.generate(session, obj);  
  22.   }  
  23.     
  24.   return id;  
  25.  }  
  26. }  



实际应用中,定义同sequence。

Java代码  收藏代码
  1. @GeneratedValue(generator = "paymentableGenerator")  
  2. @GenericGenerator(name = "paymentableGenerator", strategy = "AssignedSequenceGenerator",   
  3.      parameters = { @Parameter(name = "sequence", value = "seq_payablemoney") })  



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

分享到:
评论

相关推荐

    04_JPA详解_第一个JPA实例与JPA主键生成策略.zip

    本压缩包文件"04_JPA详解_第一个JPA实例与JPA主键生成策略.zip"包含了关于如何在实际项目中运用JPA,以及理解JPA主键生成策略的详细教程。 ### JPA基础 1. **JPA简介**: JPA是Java EE的一部分,它提供了一套规范,...

    JPA学习笔记-EJB-03JPA主键生成策略总结

    ### JPA主键生成策略详解 #### 一、概述 持久化对象的主键生成机制在JPA(Java Persistence API)中占据着重要的位置。它不仅关乎数据的唯一标识符如何确定,还与数据的存储效率及应用逻辑紧密相关。JPA通过`@...

    04_传智播客JPA详解_第一个JPA实例与JPA主键生成策略

    【标题】"04_传智播客JPA详解_第一个JPA实例与JPA主键生成策略"涉及的关键知识点主要包括Java Persistence API (JPA)的基础应用、首个JPA实例的创建以及JPA主键生成策略的理解和配置。JPA是Java平台上的一个标准,...

    JPA环境搭建及JPA实例与JPA主键生成策略

    **JPA主键生成策略** JPA提供了多种主键生成策略,以下是一些常见的策略: 1. **IDENTITY**:数据库负责生成主键,如MySQL的`AUTO_INCREMENT`。 2. **SEQUENCE**:使用数据库序列生成主键,适用于支持序列的数据库...

    JPA主键生成策略

    只要1分就可获得JPA主键生成策略,很全的哦

    真实项目中关于主键生成方式的剖析(JPA)

    而Hibernate提供了跨数据库的主键生成策略,例如`native`策略,它会根据底层数据库自动选择合适的主键生成方式(如MySQL的自动增长ID或Oracle的序列)。 在JPA中,通过`@GenericGenerator`注解可以定义主键的生成...

    JPA详解视频教程 第4讲 第一个JPA实例与JPA主键生成策略.avi

    JPA用于整合现有的ORM技术,可以简化现有Java EE和Java SE应用对象持久化的开发工作,实现ORM的统一。JPA详解视频教程 第4讲 第一个JPA实例与JPA主键生成策略.avi

    JPA主键策略(针对数据库自增字段重置后无效检查项)

    JPA主键策略详解 JPA(Java Persistence API)是一个Java标准,用于对象关系映射(ORM)。在JPA中,主键策略是指生成主键的机制,用于标识数据库表中的每一行记录。在本文中,我们将详细讨论JPA主键策略的类型、...

    持久化类主键生成策略+例子

    ### JPA主键生成策略 1. **`GenerationType.AUTO`**:这是最常用的策略,具体的生成方式由数据库供应商决定,通常对应于自动增长字段,例如在MySQL中的`AUTO_INCREMENT`。 2. **`GenerationType.IDENTITY`**:此...

    JPA联合主键

    - 在操作联合主键的实体时,需要特别注意主键的生成策略,因为JPA不会自动为联合主键生成值,除非明确指定。 ### 实践应用 在实际开发中,联合主键常常出现在需要多对多关联的场景,例如上述的`ProductCategory`...

    JPA 联合主键

    JPA提供了多种主键生成策略,如`GenerationType.AUTO`、`GenerationType.IDENTITY`等,但这些策略大多适用于单个主键字段。对于联合主键,通常需要手动设置主键值,因为没有自动化的生成机制。 ### 5. 联合主键与...

    JPA中的联合主键

    总结,JPA中的联合主键提供了一种灵活的方式来处理多字段主键的情况。通过`@IdClass`或`@EmbeddedId`,你可以根据项目需求选择合适的实现方式。理解和熟练使用联合主键是JPA开发中不可或缺的一部分,它能够帮助你...

    JPA_由数据库生成JavaBean

    - 通过使用JPA的注解,如`@Entity`(表示这是一个实体类)、`@Table`(指定数据库表名)、`@Id`(标识主键)、`@GeneratedValue`(主键生成策略)等,可以对JavaBean进行更精细的配置。 5. **使用生成的JavaBean**...

    15_传智播客JPA详解_JPA中的联合主键

    - 当使用联合主键时,JPA默认不会生成主键值,通常需要自定义生成策略或手动设置主键值。 - 在保存或更新实体时,确保联合主键的所有字段都有值,否则会抛出异常。 理解并正确使用JPA中的联合主键对于开发复杂的...

    springboot集成jpa代码,自动生成表

    `@Id`表示主键,`@GeneratedValue`定义主键生成策略,这里使用了数据库自增策略。 4. **创建Repository接口** Spring Data JPA允许我们通过接口来操作数据库,无需编写SQL。创建一个继承`JpaRepository`的接口: ...

    JAVA(SpringBoot) JPA 代码生成工具

    使用@Id注解定义主键字段,@GeneratedValue可以指定主键生成策略。例如: ```java @Entity public class User { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id; private String ...

    Myeclipse自动生成注解实体类O---JPA方式

    在这个教程中,我们将探讨如何使用MyEclipse通过JPA(Java Persistence API)方式来自动生成带有注解的实体类,这将极大地简化数据库表与Java对象之间的映射工作。 首先,我们需要配置MyEclipse的数据源。在...

    Eclipse下如何配置JPA生成数据库表对应的已注解实体类(图文详解)

    JPA(Java Persistence API)提供了一种标准的方式来管理这些对象,使得开发者可以从数据库表自动生成对应的实体类,减轻了手动编写代码的工作量。本文将详细介绍如何在Eclipse环境中配置JPA,以便自动生成数据库表...

    JPA注解 和hibernate 建表

    JPA的主要目标是提供一种简洁、易用的方式来访问、操作和管理Java应用程序中的数据。JPA的出现是为了解决传统的JDBC编程方式的缺陷,提供了更高级的抽象层次来访问和操作数据库。 二、JPA注解 JPA提供了一些注解来...

    使用表的id生成

    用户可能需要查看这些文件来深入理解JPA主键生成的实现细节。 综上所述,"使用表的id生成"这个主题涵盖了JPA中主键生成的基本原理、策略选择、源码解析以及可能的开发工具应用。通过学习和实践,开发者能够灵活地...

Global site tag (gtag.js) - Google Analytics