如何在 Hibernate 6 中为 JSONB 字段定义泛型实体？

2024-03-13 21:23:22

使用 Hibernate 6 泛型化 JSON 字段

引言

管理 JSONB 类型字段是使用 Hibernate 6 和 PostgreSQL 时的常见场景。通过使用泛型和区分公式，我们可以定义泛型实体，并在反序列化期间根据另一个枚举字段映射正确的类。

泛型实体

要为 JSONB 字段定义泛型实体，我们需要使用 @TypeDef 注解：

@TypeDef(
    name = "jsonb",
    typeClass = JsonBinaryType.class,
    parameters = {
        @Parameter(name = "type", value = "com.example.SettingEntity")
    }
)

此注解定义了一个名为 jsonb 的类型，该类型使用 JsonBinaryType 类，并指定泛型类型为 com.example.SettingEntity。

映射正确的类

为了在反序列化期间根据 type 字段映射正确的类，我们需要使用 @DiscriminatorFormula 注解：

@DiscriminatorFormula(
    "CASE " +
        "WHEN type = 'SETTING_1' THEN 'com.example.Setting1Entity' " +
        "WHEN type = 'SETTING_2' THEN 'com.example.Setting2Entity' " +
        "ELSE NULL " +
    "END"
)

此注解定义了一个区分公式，该公式根据 type 字段的值将 values 字段映射到正确的子类。在这种情况下，SETTING_1 映射到 Setting1Entity，SETTING_2 映射到 Setting2Entity。

示例

以下是一个完整的示例，展示了如何定义一个泛型实体并根据 type 字段映射正确的类：

@Getter
@Setter
@Entity
@Table(name = "setting")
public class SettingEntity<T> {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Enumerated(EnumType.STRING)
    private SettingType type;

    @TypeDef(
        name = "jsonb",
        typeClass = JsonBinaryType.class,
        parameters = {
            @Parameter(name = "type", value = "com.example.SettingEntity")
        }
    )
    @JdbcTypeCode(SqlTypes.JSON)
    private T values;

    @DiscriminatorFormula(
        "CASE " +
            "WHEN type = 'SETTING_1' THEN 'com.example.Setting1Entity' " +
            "WHEN type = 'SETTING_2' THEN 'com.example.Setting2Entity' " +
            "ELSE NULL " +
        "END"
    )
}

@Entity
public class Setting1Entity extends SettingEntity<Object> {}

@Entity
public class Setting2Entity extends SettingEntity<Object> {}

使用

现在，我们可以使用泛型实体来管理 JSONB 类型字段。例如：

SettingEntity<Setting1> setting1 = new SettingEntity<>();
setting1.setType(SettingType.SETTING_1);
setting1.setValues(new Setting1());

SettingEntity<Setting2> setting2 = new SettingEntity<>();
setting2.setType(SettingType.SETTING_2);
setting2.setValues(new Setting2());