在Spring中使用Hibernate-Types时如何配置自定义ObjectMapper实例

我来帮你理清这个问题，其实在Spring环境下用Hibernate-Types结合自定义ObjectMapper Bean有几种靠谱的方式，我一个个给你说清楚：

方法一：全局配置（最简单，推荐大多数场景） #

这种方式会把你的自定义ObjectMapper全局应用到所有Hibernate-Types的JSON类型上，不用在每个实体里重复配置。

步骤1：确保你的ObjectMapper是Spring Bean #

先定义好你的自定义ObjectMapper Bean，比如：

@Bean
public ObjectMapper customObjectMapper() {
    ObjectMapper mapper = new ObjectMapper();
    // 这里添加你的自定义配置，比如Java 8时间模块、序列化规则等
    mapper.registerModule(new JavaTimeModule());
    mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
    mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
    return mapper;
}

步骤2：在Spring启动时绑定到Hibernate-Types #

创建一个配置类，利用@PostConstruct在Spring上下文初始化完成后，把自定义ObjectMapper设置到Hibernate-Types的JSON类型中：

@Component
public class HibernateTypesObjectMapperConfigurer {

    private final ObjectMapper customObjectMapper;

    // 构造注入Spring管理的自定义ObjectMapper
    public HibernateTypesObjectMapperConfigurer(ObjectMapper customObjectMapper) {
        this.customObjectMapper = customObjectMapper;
    }

    @PostConstruct
    public void configure() {
        // 全局设置JsonType使用自定义ObjectMapper
        JsonType.setObjectMapper(customObjectMapper);
        // 如果用的是二进制JSON类型（比如PostgreSQL的jsonb），同样设置
        JsonBinaryType.setObjectMapper(customObjectMapper);
    }
}

这样一来，所有使用@Type(type = "json")或者JsonType的实体字段，都会自动用你的自定义ObjectMapper来序列化/反序列化。

方法二：自定义Hibernate Type（适合多ObjectMapper场景） #

如果你的项目需要针对不同实体使用不同的ObjectMapper，或者不想全局覆盖默认配置，可以自定义一个Hibernate Type来绑定特定的ObjectMapper。

步骤1：自定义JSON Type #

继承Hibernate-Types的JsonType，并重写获取ObjectMapper的方法：

public class CustomJsonType extends JsonType {

    private static ObjectMapper customMapper;

    // 提供静态方法让Spring注入自定义ObjectMapper
    public static void setCustomObjectMapper(ObjectMapper mapper) {
        customMapper = mapper;
    }

    @Override
    protected ObjectMapper getObjectMapper() {
        // 优先使用注入的自定义Mapper， fallback到默认实现
        return customMapper != null ? customMapper : super.getObjectMapper();
    }
}

步骤2：注入ObjectMapper到自定义Type #

同样用@Component和@PostConstruct来完成注入：

@Component
public class CustomJsonTypeConfigurer {

    private final ObjectMapper customObjectMapper;

    public CustomJsonTypeConfigurer(ObjectMapper customObjectMapper) {
        this.customObjectMapper = customObjectMapper;
    }

    @PostConstruct
    public void configureCustomType() {
        CustomJsonType.setCustomObjectMapper(customObjectMapper);
    }
}

步骤3：在实体中使用自定义Type #

在实体字段上指定你自定义的Type即可：

@Entity
public class UserPreference {

    @Id
    private Long id;

    // 使用自定义的JSON Type
    @Type(type = "com.yourpackage.CustomJsonType")
    @Column(columnDefinition = "jsonb")
    private PreferenceData data;

    // getter、setter省略
}

方法三：通过LocalContainerEntityManagerFactoryBean传递属性（你提到的方式） #

你问到的是否要把properties传入LocalContainerEntityManagerFactoryBean，这种方式也是可行的，直接把自定义ObjectMapper放到Hibernate的属性配置中：

@Bean
@Primary
public LocalContainerEntityManagerFactoryBean entityManagerFactory(
        EntityManagerFactoryBuilder builder,
        DataSource dataSource,
        ObjectMapper customObjectMapper) {

    Map<String, Object> hibernateProps = new HashMap<>();
    // 配置Hibernate-Types使用自定义ObjectMapper
    hibernateProps.put(JsonType.OBJECT_MAPPER, customObjectMapper);
    // 若使用JsonBinaryType，对应属性为JsonBinaryType.OBJECT_MAPPER

    return builder
            .dataSource(dataSource)
            .packages("com.yourpackage.entity") // 你的实体包路径
            .properties(hibernateProps)
            .build();
}

不过要注意，这种方式需要确保你使用的Hibernate-Types版本支持通过该属性传递ObjectMapper实例，部分旧版本可能不支持这种方式。

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