Spring Boot – 自定义 Jackson ObjectMapper

在开发Web应用程序时，我们经常需要将Java对象转换为JSON字符串或将JSON字符串转换为Java对象。为了实现这个过程，我们可以使用Jackson库，它是一个流行的Java类库，用于处理JSON数据。

在Spring Boot应用程序中，默认情况下使用Jackson库。Spring Boot默认提供了一个ObjectMapper类，用于将Java对象转换为JSON和将JSON转换为Java对象。在某些情况下，我们需要对Jackson ObjectMapper进行自定义配置，例如在序列化和反序列化Java对象时，使用不同的日期格式。

下面将介绍如何自定义Jackson ObjectMapper。

配置文件中添加Jackson的配置

在Spring Boot应用程序的配置文件(application.yml或application.properties)中，我们可以设置Jackson的一些配置参数。例如，以下配置将日期格式设置为"yyyy-MM-dd"。

application.yml

spring:
  jackson:
    date-format: yyyy-MM-dd

或者使用application.properties

spring.jackson.date-format=yyyy-MM-dd

编写自定义Jackson配置类

如果您需要更加复杂的Jackson配置，您可以编写一个自定义的Jackson2ObjectMapperBuilderCustomizer。以下是一个例子:

@Configuration
public class JacksonConfig {

  @Bean
  public Jackson2ObjectMapperBuilderCustomizer customJson() {
    return new Jackson2ObjectMapperBuilderCustomizer() {
      @Override
      public void customize(Jackson2ObjectMapperBuilder builder) {
        builder.serializationInclusion(JsonInclude.Include.NON_NULL);
        builder.featuresToDisable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
        builder.indentOutput(true).dateFormat(new SimpleDateFormat("yyyy-MM-dd"));
      }
    };
  }

}

这段代码创建了一个名为“ JacksonConfig”的Java配置类，并定义了一个名为“ Jackson2ObjectMapperBuilderCustomizer”的bean。在这里，我们自定义Jackson的object mapper，包括以下三部分：

1. 我们使用了serializationInclusion(JsonInclude.Include.NON_NULL)来设置仅包含值不为null的属性。

2. featuresToDisable方法取消了日期的时间戳显示。

3. 最后，我们定义了一个日期格式。

测试自定义Jackson ObjectMapper

编写一个测试类，测试一下自定义的Jackson配置是否生效。以下是一个例子，它将一个Date类型的Java对象转换为JSON字符串。

@RunWith(SpringRunner.class)
@SpringBootTest
public class JacksonConfigTest {
    @Autowired
    private ObjectMapper objectMapper;

    @Test
    public void testObjectMapper() throws JsonProcessingException {
        Date date = new Date();
        String json = objectMapper.writeValueAsString(date);
        System.out.println(json);
    }
}

运行测试类，你能看到打印出来的日期就是“yyyy-MM-dd”格式的字符串。

总结

在本文中，我们介绍了如何自定义Jackson ObjectMapper，包括在配置文件中添加Jackson的配置，以及在Java配置类中编写自定义配置。通过定制Jackson的object mapper，可以更加灵活地处理Java对象和JSON数据。