Spring JPA 注解@Id @GeneratedValue @GenericGenerator

mqiqe2024-09-13 17:35

在Spring JPA中，通常使用@Id和@GeneratedValue注解来指定实体的主键及其生成策略。然而，@GeneratedValue注解默认支持的生成策略（如IDENTITY, SEQUENCE, AUTO, TABLE等）可能不完全满足所有数据库或特定场景下的需求。在某些情况下，可能需要更复杂的生成策略，这时可以使用Hibernate特有的@GenericGenerator注解来定义。

@GenericGenerator是Hibernate提供的一个高级特性，允许自定义主键的生成策略。它可以通过XML配置或注解的方式来实现。以下是如何在Spring JPA的实体类中使用@GenericGenerator注解的一个例子：
示例

假设想要使用自定义的序列（或类似的机制）来生成主键，但数据库并不直接支持JPA标准的SEQUENCE生成策略，或者想要在生成主键时执行一些额外的逻辑。

java 复制代码 
import javax.persistence.Entity;  
import javax.persistence.GeneratedValue;  
import javax.persistence.GenerationType;  
import javax.persistence.Id;  
import org.hibernate.annotations.GenericGenerator;  
  
@Entity  
public class MyEntity {  
  
    @Id  
    @GeneratedValue(strategy = GenerationType.IDENTITY, generator = "myCustomGenerator") // 注意这里strategy的值仅为占位符，Hibernate会忽略它  
    @GenericGenerator(name = "myCustomGenerator",   
                      strategy = "com.example.MyCustomGeneratorStrategy",  
                      parameters = {  
                          @Parameter(name = "param1", value = "value1"),  
                          @Parameter(name = "param2", value = "value2")  
                      })  
    private Long id;  
  
    // 其他字段和getter/setter方法  
}

注意：

  1. @GeneratedValue注解中的strategy属性在这里实际上被Hibernate忽略了，因为通过@GenericGenerator定义了自己的生成策略。但是，由于JPA规范的要求，不能省略@GeneratedValue注解。
  2. 在@GenericGenerator注解中，name属性指定了生成器的名称，这个名称需要与@GeneratedValue中的generator属性相匹配。
  3. strategy属性指定了自定义生成策略的实现类。这个类需要实现Hibernate的org.hibernate.id.IdentifierGenerator接口。
  4. parameters属性允许传递额外的参数到自定义生成策略实现中。

@ID

@Id 注解在 Spring JPA（或更准确地说，在 JPA 规范中）扮演着至关重要的角色，它用于标识实体类中的主键字段。主键是数据库表中用于唯一标识每一行记录的列或列的组合。在 JPA 实体类中，通过使用 @Id 注解，可以明确指定哪个字段应该被视为实体的唯一标识符。

基本用法

java 复制代码 
import javax.persistence.Entity;  
import javax.persistence.Id;  
  
@Entity  
public class MyEntity {  
  
    @Id  
    private Long id;  
  
    // 其他字段和getter/setter方法  
}

在这个例子中，id 字段被 @Id 注解标记为 MyEntity 实体的主键。

与 @GeneratedValue 一起使用

通常，@Id 注解会与 @GeneratedValue 注解一起使用，以指定主键的生成策略。@GeneratedValue 注解允许定义主键是如何生成的，比如是由数据库自动递增（IDENTITY）、使用数据库序列（SEQUENCE）、使用一个特定的表来生成主键（TABLE），或者是由应用程序在持久化之前手动赋值（虽然这通常不是推荐的做法，因为它要求应用程序在分配主键时考虑唯一性）。

java 复制代码 
import javax.persistence.Entity;  
import javax.persistence.GeneratedValue;  
import javax.persistence.GenerationType;  
import javax.persistence.Id;  
  
@Entity  
public class MyEntity {  
  
    @Id  
    @GeneratedValue(strategy = GenerationType.IDENTITY)  
    private Long id;  
  
    // 其他字段和getter/setter方法  
}

复合主键

虽然大多数情况下实体会有一个单一的主键字段，但 JPA 也支持复合主键（即使用多个字段作为主键）。在这种情况下，不能直接在字段上使用 @Id 注解，而是需要使用 @Embeddable 类来定义复合主键，然后在实体类中使用 @IdClass 或 @EmbeddedId 注解来引用这个复合主键类。

使用 @IdClass

java 复制代码 
import javax.persistence.Entity;  
import javax.persistence.Id;  
import javax.persistence.IdClass;  
  
@Entity  
@IdClass(MyEntityId.class)  
public class MyEntity {  
  
    @Id  
    private Long part1;  
  
    @Id  
    private String part2;  
  
    // 其他字段和getter/setter方法  
}  
  
public class MyEntityId implements Serializable {  
    private Long part1;  
    private String part2;  
  
    // 构造函数、getter和setter方法  
}

使用 @EmbeddedId

java 复制代码 
import javax.persistence.Embeddable;  
import javax.persistence.EmbeddedId;  
import javax.persistence.Entity;  
  
@Entity  
public class MyEntity {  
  
    @EmbeddedId  
    private MyEntityId id;  
  
    // 其他字段和getter/setter方法  
}  
  
@Embeddable  
public class MyEntityId implements Serializable {  
    private Long part1;  
    private String part2;  
  
    // 构造函数、getter和setter方法  
}

注意事项

  • 主键字段必须是可序列化的（Serializable），因为 JPA 可能会将实体对象传输到远程会话中。
  • 如果实体使用复合主键，需要定义一个包含所有主键字段的类，并使用 @Embeddable 注解标记它，然后在实体类中使用 @EmbeddedId 或 @IdClass 注解来引用这个类。
  • 默认情况下，JPA 假定主键字段的值是由持久性提供者（如 Hibernate）在持久化过程中自动生成的，除非明确指定了其他生成策略或手动设置了主键值。

@GeneratedValue

@GeneratedValue 注解在 Spring JPA（实际上是在 JPA 规范中）用于指定主键的生成策略。这个注解通常与 @Id 注解一起使用，在 JPA 实体类中定义主键字段时指定主键值是如何生成的。

@GeneratedValue 注解提供了多种主键生成策略，允许开发者根据自己的需求和数据库的特性来选择最合适的生成方式。以下是一些常见的生成策略：

IDENTITY

IDENTITY：主键由数据库自动生成，通常是通过自增的方式。这种策略适用于支持自增字段的数据库（如 MySQL 的 AUTO_INCREMENT）。

java 复制代码 
@Id  
@GeneratedValue(strategy = GenerationType.IDENTITY)  
private Long id;

SEQUENCE

SEQUENCE：使用数据库中的序列来生成主键值。这种策略适用于支持序列的数据库（如 Oracle、PostgreSQL）。需要注意的是，在使用此策略时，可能还需要使用 @SequenceGenerator 注解来定义序列的生成规则。

java 复制代码 
@Id  
@GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "mySeq")  
@SequenceGenerator(name = "mySeq", sequenceName = "my_sequence_name", allocationSize = 1)  
private Long id;

TABLE

TABLE：通过数据库中的一个表来生成主键值。这种策略在不支持自增或序列的数据库中很有用，但通常不推荐使用，因为它可能会比其他策略更慢。

java 复制代码 
@Id  
@GeneratedValue(strategy = GenerationType.TABLE, generator = "myTableGen")  
@TableGenerator(name = "myTableGen", table = "my_generator_table",  
    pkColumnName = "gen_key", valueColumnName = "gen_value",  
    pkColumnValue = "MY_ENTITY_PK", allocationSize = 1)  
private Long id;

AUTO

AUTO：让 JPA 持久性提供者根据底层数据库自动选择最合适的生成策略。这是默认策略，但通常不推荐在生产环境中使用，因为它可能导致可移植性问题。

java 复制代码 
@Id  
@GeneratedValue(strategy = GenerationType.AUTO)  
private Long id;

需要注意的是，@GeneratedValue 注解中的 generator 属性是可选的，它用于指定一个生成器（如序列或表生成器）的名称。如果指定了 generator，则需要使用 @SequenceGenerator 或 @TableGenerator 注解来定义相应的生成器。

此外，虽然 @GeneratedValue 注解是 JPA 规范的一部分，但 Spring JPA（特别是当与 Hibernate 这样的 JPA 实现一起使用时）可能会提供额外的配置选项或扩展，以支持更复杂的场景。然而，上述的生成策略是 JPA 规范中定义的标准策略，适用于大多数情况。

@ GenericGenerator

在 Spring JPA 中，实际上 @GenericGenerator 注解并不是 JPA 标准规范的一部分，而是 Hibernate 特有的。Hibernate 作为 JPA 的一个实现，提供了许多额外的注解和功能，@GenericGenerator 就是其中之一。

@GenericGenerator 注解用于在 Hibernate 中定义主键的生成策略，它比 JPA 的 @GeneratedValue 注解提供了更多的灵活性和配置选项。它允许定义一个生成器，该生成器可以在多个实体之间共享，并且具有可配置的参数。

然而，在使用 Spring Data JPA 时，通常推荐优先使用 JPA 标准注解（如 @GeneratedValue），以确保代码的可移植性和与不同 JPA 实现的兼容性。但是，如果正在使用 Hibernate 作为 JPA 提供者，并且需要利用 Hibernate 的特定功能，那么 @GenericGenerator 可以是一个有用的选项。

以下是一个使用 @GenericGenerator 注解的示例：

java 复制代码 
import javax.persistence.Entity;  
import javax.persistence.GeneratedValue;  
import javax.persistence.GenerationType;  
import javax.persistence.Id;  
import org.hibernate.annotations.GenericGenerator;  
  
@Entity  
public class MyEntity {  
  
    @Id  
    @GeneratedValue(strategy = GenerationType.IDENTITY, generator = "myGenerator")  
    @GenericGenerator(name = "myGenerator", strategy = "increment")  
    private Long id;  
  
    // 其他字段和getter/setter方法  
}

但是，请注意，上面的示例实际上是有问题的，因为 GenerationType.IDENTITY 和 increment 策略通常不兼容。GenerationType.IDENTITY 是用于数据库的自增字段，而 increment 是 Hibernate 的一种内存生成策略（尽管它也可以配置为使用数据库表或序列，但通常不是）。

如果意图是使用 Hibernate 的自定义生成策略（如 increment、uuid、sequence 等），应该这样做：

java 复制代码 
@Entity  
public class MyEntity {  
  
    @Id  
    @GeneratedValue(generator = "myGenerator")  
    @GenericGenerator(name = "myGenerator", strategy = "increment")  
    private Long id;  
  
    // 其他字段和getter/setter方法  
}

在这个修正后的示例中，移除了 GenerationType.IDENTITY，因为 @GenericGenerator 已经定义了生成策略。请注意，increment 策略在多线程环境中可能不是安全的，因为它依赖于 Hibernate 内部的内存计数器来生成主键值。在生产环境中，更安全的做法是使用数据库特定的生成策略，如 IDENTITY、SEQUENCE 或 TABLE。

另外，如果正在使用 Spring Boot 和 Spring Data JPA，并且已经配置了 Hibernate 作为 JPA 提供者，那么可以放心地使用 @GenericGenerator 注解，因为 Spring Boot 会自动配置 Hibernate。但是，请始终记得检查配置是否与选择的生成策略兼容。

相关推荐
睆小白8 分钟前
【springboot】实现文件上传和下载
java·spring boot·后端
ChinaRainbowSea13 分钟前
十六，Spring Boot 整合 Druid 以及使用 Druid 监控功能
java·spring boot·后端·spring·web
罗小爬EX25 分钟前
MySql批量迁移数据库
数据库·mysql
吴半杯25 分钟前
Mysql调优之性能监控（一）
java·linux·mysql
言成言成啊25 分钟前
PostgreSQL维护——解决索引膨胀和数据死行
数据库·postgresql
WZF-Sang26 分钟前
【MySQL】数据类型【mysql当中各自经典的数据类型的学习和使用】
linux·数据库·sql·学习·mysql·adb
挠背小能手26 分钟前
达梦DIsql使用方法
数据库
迷茫运维路30 分钟前
mysql5.7常用操作命令手册
运维·数据库
慢慢雨夜1 小时前
uniapp 苹果安全域适配
java·前端·uni-app
敲代码不忘补水1 小时前
二十种编程语言庆祝中秋节
java·javascript·python·golang·html
热门推荐
01RAG 实践- Ollama+RagFlow 部署本地知识库02组基轨迹建模 GBTM的介绍与实现（Stata 或 R）032024年高教社杯数学建模国赛C题超详细解题思路分析04【立创EDA-PCB设计基础】6.布线铺铜实战及细节详解05苍穹外卖面试总结06【2024数模国赛赛题思路公开】国赛B题思路丨附可运行代码丨无偿自提07【极空间NAS】使用WebDAV服务 + DDNSTO内网穿透 实现思源笔记的内外网同步08Coze扣子平台完整体验和实践（附国内和国际版对比）09【2024高教社杯全国大学生数学建模竞赛】B题 生产过程中的决策问题——解题思路 代码 论文1051-2 万字长文，深度解读端到端自动驾驶的挑战和前沿