SpringBoot中，ObjectMapper失效问题的修复方案

自定义 ObjectMapper 导致 Spring Boot 原生 ObjectMapper 失效

在 Spring Boot 应用中使用自定义 ObjectMapper 时，原生的 Spring Boot ObjectMapper 配置可能会失效，导致 JSON 序列化和反序列化出现问题。本文将深入探讨这一问题，并提供几种有效的修复方案。

现象

使用自定义 ObjectMapper 后，你会发现以下现象：

• @Autowired 注入的 ObjectMapper 是自定义的 ObjectMapper，而不是 Spring Boot 原生的。
• objectMapper.readValue() 和 objectMapper.writeValueAsString() 方法无法正常处理 JSON 数据。

原因

Spring Boot 使用 Jackson 库处理 JSON，并会在启动时自动配置一个 ObjectMapper Bean。当我们自定义 ObjectMapper 并将其注册为 Bean 时，Spring Boot 会覆盖默认的 ObjectMapper Bean，导致原有配置失效。

修复方案

有以下几种修复方案：

1. 使用 @Primary 注解

@Primary
@Bean
public ObjectMapper objectMapper() {
    return new ObjectMapper();
}

使用 @Primary 注解标注 Spring Boot 原生的 ObjectMapper Bean，使 Spring Boot 优先使用该 Bean。

2. 继承 Spring Boot 原生 ObjectMapper

@Bean
public ObjectMapper objectMapper() {
    ObjectMapper objectMapper = new ObjectMapper();
    objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
    return objectMapper;
}

继承 Spring Boot 原生的 ObjectMapper，并自定义其行为。

3. 使用 @Qualifier 注解

@Autowired
@Qualifier("objectMapper")
private ObjectMapper objectMapper;

使用 @Qualifier 注解指定要使用的 ObjectMapper Bean。

结论

本文分析了自定义 ObjectMapper 对 Spring Boot 原生 ObjectMapper 配置的影响，并给出了修复方案。通过理解这些机制，你可以正确配置 ObjectMapper，避免 JSON 处理问题。

常见问题解答

1. 为什么自定义 ObjectMapper 会影响 Spring Boot 原生的 ObjectMapper？

因为 Spring Boot 在启动时会自动配置一个 ObjectMapper Bean，当自定义 ObjectMapper 并注册为 Bean 时，它会覆盖默认 Bean。

2. 如何判断自定义 ObjectMapper 是否影响了 Spring Boot 原生的 ObjectMapper？

通过检查注入的 ObjectMapper 的类型或使用 objectMapper.readValue() 和 objectMapper.writeValueAsString() 方法进行测试。

3. @Primary 注解是如何工作的？

@Primary 注解用于指定首选 Bean，当有多个候选 Bean 时，Spring Boot 将优先使用带有 @Primary 注解的 Bean。

4. 什么时候应该继承 Spring Boot 原生的 ObjectMapper？

当需要对 Spring Boot 原生 ObjectMapper 进行少量修改时，例如自定义日期格式。

5. @Qualifier 注解有哪些好处？

@Qualifier 注解可以明确指定要使用的 Bean，避免依赖注入的歧义。