将 PostgreSQL JSON 列映射到 Hibernate 实体

使用 PostgreSQL 数据库时，经常会遇到以 JSON 格式存储数据的列。为了使用 Hibernate 有效地将这些列映射到 Java 实体，选择适当的数据类型至关重要。

在这种情况下，当前的问题围绕着将 PostgreSQL JSON 列映射到 Hibernate 实体字段。一种常见的方法是使用字符串字段，如提供的代码片段中所示：

@Entity
public class MyEntity {

    private String jsonPayload;

    public MyEntity() {
    }
}

但是，这种方法可能会在保存实体时导致异常，因为 Hibernate 会尝试将字符串转换为 JSON。

JSON 列的正确值类型

要正确地将 PostgreSQL JSON 列映射到 Hibernate 实体字段，请考虑使用自定义用户类型。通过创建 userType 实现（例如 StringJsonUserType），您可以处理 String 值和 JSON 数据库类型之间的映射。

以下是示例实现：

public class StringJsonUserType implements UserType {
    ...
    @Override
    public int[] sqlTypes() {
        return new int[] { Types.JAVA_OBJECT};
    }

    ...
}

然后您可以使用自定义 userType 注释实体属性：

@Type(type = "StringJsonObject")
public String getJsonPayload() {
    return jsonPayload;
}

附加配置

要完全实现此解决方案，您可能需要：

1. 扩展 PostgreSQL 方言以包含 JSON 类型:

public class JsonPostgreSQLDialect extends PostgreSQL9Dialect {
    ...
    this.registerColumnType(Types.JAVA_OBJECT, "json");
    ...
}

2. 用@TypeDefs注解实体类：

@TypeDefs({ @TypeDef( name= "StringJsonObject", typeClass = StringJsonUserType.class)})

3. 将必要的库注入到用户类型实现中以进行高级映射。

GitHub 参考项目

为了进一步探索，考虑提供的 GitHub 项目：https://github.com/timfulmer/hibernate-postgres-jsontype