添加SQL Server支持时，Hypersistence Utils JsonType与PostgreSQL JsonBinaryType数据兼容性

问题场景 #

我正在开发一个Spring Boot 2.7.7项目，使用PostgreSQL和Hypersistence Utils（hibernate-types-52:2.20.0）处理JSON数据，依赖Hibernate 5.6.14.Final及spring-boot-starter-jdbc:2.7.7。当前使用JsonBinaryType将JSON列映射为PostgreSQL的jsonb类型，实体代码如下：

import com.vladmihalcea.hibernate.type.json.JsonBinaryType;
import org.hibernate.annotations.Type;
import org.hibernate.annotations.TypeDefs;
import org.hibernate.annotations.TypeDef;

import jakarta.persistence.*;

@TypeDefs({
    @TypeDef(name = "jsonb", typeClass = JsonBinaryType.class)
})
@Entity
@Table(name = "migration_varchar_compress")
public class MigrationVarcharCompress {
    @Id
    private String id;

    @Column(name = "name", length = 200, nullable = false)
    private String name;

    @Type(type = "jsonb")
    @Column(name = "body", nullable = false, columnDefinition = "jsonb")
    private Customer body;

    @Type(type = "jsonb")
    @Column(name = "metadata", nullable = false, columnDefinition = "jsonb")
    private String metadata;

    // Getters and setters omitted for brevity
}

目前项目在PostgreSQL下运行正常，但需新增SQL Server支持。了解到JsonBinaryType不兼容SQL Server，切换至JsonType可能支持双数据库，核心疑问如下：

1. 数据兼容性：JsonType能否无问题读取PostgreSQL中由JsonBinaryType存储的现有jsonb数据？
2. 数据库无关映射：如何实现实体的数据库无关映射以无缝兼容PostgreSQL和SQL Server？例如是否需移除PostgreSQL专属的columnDefinition="jsonb"，改用通用的JsonType？应如何配置映射以避免数据库特定代码？
3. 备选方案：若切换至JsonType不可行（如兼容性问题或限制），在保留现有jsonb数据访问的前提下，支持双数据库的可行方案有哪些？维护独立实体映射是否可行？

解答 #

1. 数据兼容性：JsonType读取现有jsonb数据的可行性 #

• 可以正常读取。JsonBinaryType在PostgreSQL中是将二进制序列化后的JSON存入jsonb列，而JsonType内部会根据数据库方言自动适配读写逻辑——在PostgreSQL环境下，它能正确解析jsonb格式的二进制JSON数据，直接切换后现有数据可正常反序列化为Customer实体或字符串类型。
• 注意：若Customer实体包含复杂嵌套结构，需确保Jackson序列化/反序列化的注解配置前后一致，避免反序列化失败。

2. 数据库无关映射的实现方案 #

要实现无数据库特定代码的映射，按以下步骤调整：

• 替换Type定义：移除原JsonBinaryType相关配置，改用JsonType：

  @TypeDefs({
      @TypeDef(name = "json", typeClass = JsonType.class)
  })
  

  同时将实体中@Type(type = "jsonb")改为@Type(type = "json")。
• 移除数据库专属列定义：删除columnDefinition = "jsonb"，让Hibernate根据当前数据库方言自动生成对应列类型：
  • PostgreSQL下会自动使用jsonb（JsonType适配PostgreSQL方言时优先选择该类型）
  • SQL Server下会自动映射为NVARCHAR(MAX)或原生JSON类型（取决于SQL Server版本和Hibernate方言）
• 统一序列化配置：确保JsonType使用的Jackson序列化器在双数据库下行为一致，可通过@Type参数指定：

  @Type(
      type = "json",
      parameters = {
          @Parameter(name = JsonType.JSON_SERIALIZER, value = "com.fasterxml.jackson.databind.ser.DefaultSerializer"),
          @Parameter(name = JsonType.JSON_DESERIALIZER, value = "com.fasterxml.jackson.databind.deser.DefaultDeserializer")
      }
  )
  

• 验证方言配置：确保Spring Boot针对不同数据库加载对应Hibernate方言：
  • PostgreSQL：org.hibernate.dialect.PostgreSQLDialect（或对应版本方言如PostgreSQL10Dialect）
  • SQL Server：org.hibernate.dialect.SQLServer2012Dialect及以上版本（原生支持JSON类型处理）

3. 切换JsonType不可行时的备选方案 #

如果因业务或技术限制无法切换到JsonType，可采用以下方案：

方案一：基于环境的条件实体映射

利用Spring的@Profile注解，为不同数据库提供专属实体映射：

• 创建两个版本的实体类：一个用JsonBinaryType适配PostgreSQL，另一个用JsonStringType或SQL Server原生JSON映射适配SQL Server
• 分别为实体添加@Profile("postgresql")和@Profile("sqlserver")，启动时通过激活对应Profile加载实体
• 可通过抽象基类封装公共字段和方法，减少代码重复，缺点是需要维护两份实体代码

方案二：自定义多数据库兼容的JsonType

继承Hypersistence Utils的JsonType，重写列类型逻辑：

public class MultiDbJsonType extends JsonType {
    @Override
    public String getColumnType(int sqlType) {
        Dialect dialect = getDialect();
        if (dialect instanceof PostgreSQLDialect) {
            return "jsonb";
        } else if (dialect instanceof SQLServerDialect) {
            return "nvarchar(max)";
        }
        return super.getColumnType(sqlType);
    }
}

在实体中使用该自定义类型，既能保留PostgreSQL的jsonb列，又能适配SQL Server的存储类型。

方案三：使用JPA Converter替代Hibernate Type

若无需Hypersistence Utils的JSON查询特性，可通过JPA的@Converter实现通用JSON序列化：

@Converter(autoApply = true)
public class JsonConverter implements AttributeConverter<Object, String> {
    private static final ObjectMapper objectMapper = new ObjectMapper();

    @Override
    public String convertToDatabaseColumn(Object attribute) {
        try {
            return objectMapper.writeValueAsString(attribute);
        } catch (JsonProcessingException e) {
            throw new RuntimeException("JSON序列化失败", e);
        }
    }

    @Override
    public Object convertToEntityAttribute(String dbData) {
        try {
            return objectMapper.readValue(dbData, Object.class);
        } catch (JsonProcessingException e) {
            throw new RuntimeException("JSON反序列化失败", e);
        }
    }
}

在实体字段上添加@Convert(converter = JsonConverter.class)即可，该方案兼容所有支持字符串存储的数据库，但无法使用Hibernate的JSON路径查询功能。

内容的提问来源于stack exchange，提问作者Romil Desai