一站搞懂 GenerationType.TABLE 配合 TableGenerator Annotation 的配置技巧

使用 JPA 中的 GenerationType.TABLE 策略：深入指南

什么是 GenerationType.TABLE？

GenerationType.TABLE 是一种 JPA（Java 持久化 API）主键生成策略，它利用数据库表来生成主键。这种策略在多个应用程序实例之间共享主键，从而消除主键冲突。

TableGenerator Annotation

要在 JPA 中使用 GenerationType.TABLE 策略，我们需要在实体类上添加 @TableGenerator 注解。它指定主键生成器表的详细信息：

@TableGenerator(
    name = "generatorName",
    table = "generatorTable",
    pkColumnName = "pkColumnName",
    valueColumnName = "valueColumnName",
    pkColumnValue = "pkColumnValue",
    allocationSize = 1
)

• name： 生成器的名称
• table： 生成器表的名称
• pkColumnName： 生成器表的主键列名
• valueColumnName： 生成器表的值列名
• pkColumnValue： 生成器表的主键列值
• allocationSize： 每次分配主键的数量（通常为 1）

@Column Annotation

@Column 注解用于映射实体类属性和数据库列。对于使用 GenerationType.TABLE 策略的主键，需要指定 @Id 注解：

@Id
@GeneratedValue(strategy = GenerationType.TABLE, generator = "generatorName")
@Column(name = "column_name", nullable = false, unique = true)
private Long id;

• name： 列名称
• nullable： 指定列是否允许为 null
• unique： 指定列是否唯一

配置示例

以下是一个使用 GenerationType.TABLE 策略的示例：

@Entity
public class User {

    @Id
    @GeneratedValue(strategy = GenerationType.TABLE, generator = "user_id_generator")
    @TableGenerator(
        name = "user_id_generator",
        table = "user_id_generator",
        pkColumnName = "id",
        valueColumnName = "value",
        pkColumnValue = "user_id",
        allocationSize = 1
    )
    private Long id;

    @Column(name = "username", nullable = false, unique = true)
    private String username;

    @Column(name = "password", nullable = false)
    private String password;
}

好处

使用 GenerationType.TABLE 策略的主要好处是：

• 主键共享： 可以在多个应用程序实例之间共享主键，从而避免主键冲突。
• 易于维护： 生成器表可以集中管理主键生成，简化维护。

常见问题解答

1. 为什么使用 GenerationType.TABLE 策略？

如果您需要在多个应用程序实例之间共享主键，GenerationType.TABLE 策略是一个不错的选择。

2. 如何在实体类上应用 @TableGenerator 注解？

@TableGenerator 注解应该放在实体类上，并在其中指定生成器表的详细信息。

3. GenerationType.TABLE 策略如何工作？

它使用生成器表来生成主键，其中主键列的值按顺序递增。

4. 我应该使用 GenerationType.AUTO 还是 GenerationType.TABLE？

GenerationType.AUTO 由 JPA 实现决定生成策略，而 GenerationType.TABLE 明确指定使用数据库表生成主键。

5. 是否可以自定义主键列的名称？

是的，可以通过在 @TableGenerator 注解中指定 pkColumnName 和 valueColumnName 来自定义主键列的名称。

总结

GenerationType.TABLE 是 JPA 中一种强大的主键生成策略，在需要跨多个应用程序实例共享主键的情况下非常有用。通过理解 @TableGenerator 和 @Column 注解，您可以有效地配置和使用 GenerationType.TABLE 策略，从而简化主键管理并避免主键冲突。