基于按annotation的hibernate主键生成策略

最新推荐文章于 2024-03-19 02:27:58 发布
最新推荐文章于 2024-03-19 02:27:58 发布
阅读量65 收藏
点赞数
文章标签： java 数据库 runtime

一、JPA通用策略生成器

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

  1. @Target({METHOD,FIELD})
  2. @Retention(RUNTIME)
  3. public@interfaceGeneratedValue{
  4. GenerationTypestrategy()defaultAUTO;
  5. Stringgenerator()default"";
  6. }



其中GenerationType:

  1. publicenumGenerationType{
  2. TABLE,
  3. SEQUENCE,
  4. IDENTITY,
  5. AUTO
  6. }



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

1、TABLE

  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，定义为

  1. CREATETABLEtb_generator(
  2. idNUMBERNOTNULL,
  3. gen_nameVARCHAR2(255)NOTNULL,
  4. gen_valueNUMBERNOTNULL,
  5. PRIMARYKEY(id)
  6. )



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

  1. INSERTINTOtb_generator(id,gen_name,gen_value)VALUES(1,PAYABLEMOENY_PK',1);



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


@TableGenerator的定义：

  1. @Target({TYPE,METHOD,FIELD})
  2. @Retention(RUNTIME)
  3. public@interfaceTableGenerator{
  4. Stringname();
  5. Stringtable()default"";
  6. Stringcatalog()default"";
  7. Stringschema()default"";
  8. StringpkColumnName()default"";
  9. StringvalueColumnName()default"";
  10. StringpkColumnValue()default"";
  11. intinitialValue()default0;
  12. intallocationSize()default50;
  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

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


@SequenceGenerator定义

  1. @Target({TYPE,METHOD,FIELD})
  2. @Retention(RUNTIME)
  3. public@interfaceSequenceGenerator{
  4. Stringname();
  5. StringsequenceName()default"";
  6. intinitialValue()default0;
  7. intallocationSize()default50;
  8. }



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


3、IDENTITY

  1. @Id
  2. @GeneratedValue(strategy=GenerationType.IDENTITY)


4、AUTO

  1. @Id
  2. @GeneratedValue(strategy=GenerationType.AUTO)


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

  1. @Id



跟下面的定义是一样的。

  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的实现类,如果要实现自定义的主键生成策略也必须实现此接口.

  1. publicinterfaceIdentifierGenerator{
  2. /**
  3. *Theconfigurationparameterholdingtheentityname
  4. */
  5. publicstaticfinalStringENTITY_NAME="entity_name";
  7. /**
  8. *Generateanewidentifier.
  9. *@paramsession
  10. *@paramobjecttheentityortoplevelcollectionforwhichtheidisbeinggenerated
  11. *
  12. *@returnanewidentifier
  13. *@throwsHibernateException
  14. */
  15. publicSerializablegenerate(SessionImplementorsession,Objectobject)
  16. throwsHibernateException;
  17. }



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


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

比如说，JPA标准用法

  1. @Id
  2. @GeneratedValue(GenerationType.AUTO)


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

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



@GenericGenerator的定义:

  1. @Target({PACKAGE,TYPE,METHOD,FIELD})
  2. @Retention(RUNTIME)
  3. public@interfaceGenericGenerator{
  4. /**
  5. *uniquegeneratorname
  6. */
  7. Stringname();
  8. /**
  9. *GeneratorstrategyeitherapredefinedHibernate
  10. *strategyorafullyqualifiedclassname.
  11. */
  12. Stringstrategy();
  13. /**
  14. *Optionalgeneratorparameters
  15. */
  16. Parameter[]parameters()default{};
  17. }



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

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

  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.hexisdeprecated
  13. GENERATORS.put("sequence-identity",SequenceIdentityGenerator.class);
  14. }


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

1、native

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


2、uuid

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


3、hilo

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


4、assigned

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


5、identity

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


6、select

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


7、sequence

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


8、seqhilo

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


9、increment

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


10、foreign

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



注意：直接使用@PrimaryKeyJoinColumn 报错（?）

  1. @OneToOne(cascade=CascadeType.ALL)
  2. @PrimaryKeyJoinColumn



例如

  1. @Entity
  2. publicclassEmployee{
  3. @IdIntegerid;
  5. @OneToOne@PrimaryKeyJoinColumn
  6. EmployeeInfoinfo;
  7. ...
  8. }



应该为

  1. @Entity
  2. publicclassEmployee{
  3. @Id
  4. @GeneratedValue(generator="idGenerator")
  5. @GenericGenerator(name="idGenerator",strategy="foreign",
  6. parameters={@Parameter(name="property",value="info")})
  7. Integerid;
  9. @OneToOne
  10. EmployeeInfoinfo;
  11. ...
  12. }



11、guid

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


12、uuid.hex

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


13、sequence-identity

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



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

  1. publicclassAssignedSequenceGeneratorextendsSequenceGeneratorimplements
  2. PersistentIdentifierGenerator,Configurable{
  3. privateStringentityName;
  5. publicvoidconfigure(Typetype,Propertiesparams,Dialectdialect)throwsMappingException{
  6. entityName=params.getProperty(ENTITY_NAME);
  7. if(entityName==null){
  8. thrownewMappingException("noentityname");
  9. }
  11. super.configure(type,params,dialect);
  12. }
  14. publicSerializablegenerate(SessionImplementorsession,Objectobj)
  15. throwsHibernateException{
  17. Serializableid=session.getEntityPersister(entityName,obj)
  18. .getIdentifier(obj,session.getEntityMode());
  20. if(id==null){
  21. id=super.generate(session,obj);
  22. }
  24. returnid;
  25. }
  26. }



实际应用中，定义同sequence。

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



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

iteye_17779
关注
Jpa+Hibernate主键生成策略
weixin_38446891的博客
11-19 879
一、hibernate的uuid主键生成器（String） @Id @GenericGenerator(name="systemUUID",strategy="uuid")//这个是hibernate的注解 @GeneratedValue(generator="systemUUID") //使用uuid的生成策略 @Column(name ="ID",length=255) private String id; strategy–策略，hibernate有13种。Generator——生成器
理解JPA注解@GeneratedValue
不能说的秘密的博客
05-19 4万+
理解JPA注解
@GeneratedValue
dabiaoge33的博客
09-05 1211
@GeneratedValue注解出现的目的： 1，@GeneratedValue注解存在的意义主要就是为一个实体生成一个唯一标识的主键(JPA要求每一个实体Entity,必须有且只有一个主键),@GeneratedValue提供了主键的生成策略。 2，@GeneratedValue注解有两个属性,分别是strategy和generator,其中generator属性的值是一个字符串,默认为"...
HibernateAnnotation
06-21
- 主要的注解包括@Entity（表示一个实体类）、@Table（指定对应的数据库表）、@Id（标识主键）、@GeneratedValue（定义主键生成策略）等。 2. **实体类注解** - @Entity：标记一个Java类为数据库中的一个实体。...
hibernate annotation 中文文档
12-10
### Hibernate Annotation 中文文档知识点概览 #### 一、创建注解项目 ##### 1.1 系统需求 在创建一个使用 Hibernate 注解的项目之前，需要满足一定的系统环境需求，例如支持 Java 的开发环境、JDK 版本、支持 ...
SpringBoot的@GeneratedValue注解
RichardGeek的博客
07-24 7331
@GeneratedValue注解出现的目的： 1，@GeneratedValue注解存在的意义主要就是为一个实体生成一个唯一标识的主键(JPA要求每一个实体Entity,必须有且只有一个主键),@GeneratedValue提供了主键的生成策略。 2，@GeneratedValue注解有两个属性,分别是strategy和generator,其中generator属性的值是一个字符串,默认为"...
@Generated源码翻译
爱我所爱0505
10-17 5653
package javax.annotation; import static java.lang.annotation.ElementType.ANNOTATION_TYPE; import static java.lang.annotation.ElementType.CONSTRUCTOR; import static java.lang.annotation.ElementType.FI
hibernate中的@GeneratedValue与@GenericGenerator
热门推荐
fendo
05-16 7万+
1、GeneratedValue与GenericGenerator的区别 @GeneratorValue注解----JPA通用策略生成器 @GenericGenerator注解----自定义主键生成策略 一个是通用的一个是自定义的这就是他们的区别。 2、@GeneratorValue注解----JPA通用策略生成器 GeneratorValue属于
JPA之@GeneratedValue注解
coding_1994的博客
10-14 987
PA的@GeneratedValue注解,在JPA中,@GeneratedValue注解存在的意义主要就是为一个实体生成一个唯一标识的主键(JPA要求每一个实体Entity,必须有且只有一个主键),@GeneratedValue提供了主键的生成策略。@GeneratedValue注解有两个属性,分别是strategy和generator,其中generator属性的值是一个字符串,默认为"",其声...
JPA @Id 和 @GeneratedValue 注解详解
斜阳雨陌
10-19 3万+
@Id：  @Id 标注用于声明一个实体类的属性映射为数据库的主键列。该属性通常置于属性声明语句之前，可与声明语句同行，也可写在单独行上。  @Id标注也可置于属性的getter方法之前。 @GeneratedValue：  @GeneratedValue 用于标注主键的生成策略，通过strategy 属性指定。默认情况下，JPA 自动选择一个最适合底层数据库的主键生成策略：Sql
spring boot中@GeneratedValue 注解小白篇
码农的博客
10-23 978
springboot中@GeneratedValue的作用： @GeneratedValue注解存在的意义主要就是为一个实体生成一个唯一标识的主键、@GeneratedValue提供了主键的生成策略。 @GeneratedValue注解有两个属性,分别是strategy和generator **strategy属性：**提供四种值: -AUTO主键由程序控制, 是默认选项 ,不设置就是这个 -IDENTITY 主键由数据库生成, 采用数据库自增长, Oracle不支持这种方式 -SEQU
hibernate中的@GeneratedValue与，Java高级进阶学习资料
最新发布
m0_60606468的博客
03-19 295
GeneratorValue属于一个JPA接口，其接口下包含了两个抽象的参数，GenerationType类型的strategy和String类型的generator，并且两个参数都有相应的默认值。2、@GeneratorValue注解----JPA通用策略生成器。@GenericGenerator注解----自定义主键生成策略。@GeneratorValue注解----JPA通用策略生成器。(img-ffGTGAo2-1710786467167)]一个是通用的一个是自定义的这就是他们的区别。
JPA注解之“@GeneratedValue”详解
<时光的诗>的博客
06-29 4万+
一、JPA通用策略生成器  通过annotation来映射hibernate实体的，基于annotation的hibernate主键标识为@Id， 其生成规则是由@GeneratedValue设定的。这里的@id和@GeneratedValue都是JPA的标准用法， JPA提供四种标准用法,由@GeneratedValue的源代码可以明显看出。 @Target({METHOD,FIELD}
Java内置基本注解
mitnic87的专栏
05-11 136
1、@Deprecated：用该注解注释的程序元素，表明不鼓励程序员使用这样的元素，通常是它很危险或存在更好的选择。 2、@Override：表明当前的方法定义将覆盖超类中的方法。 3、@SuppressWarnings：表明关闭不当的编译器警告信息。 4、@Documented：表明某一类型的注释将通过javadoc和类似的默认工具进行文档化。 5、@Inheri...
Hibernate Annotation API中文版参考手册
5. 生成策略：@GeneratedValue注解用来指定主键生成策略，常见的有AUTO、SEQUENCE、TABLE和IDENTITY等。 6. 列级注解：比如@Temporal用于日期类型映射，@Enumerated用于枚举类型映射，@Lob用于大对象类型的映射。 ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值