自定义 Jackson ObjectMapper-Spring Boot教程深入浅出系列

其他教程

初识 Spring Boot-Spring Boot教程深入浅出系列

Spring Boot 配置-Spring Boot教程深入浅出系列

Spring Boot Actuator 介绍-Spring Boot教程深入浅出系列

spring cloud 入门教程

1. 概述

 

当使用 JSON 格式时，Spring Boot 将使用一个ObjectMapper实例来序列化响应和反序列化请求。在本教程中，我们将了解配置序列化和反序列化选项的最常见方法。

 

2. 默认配置

 

默认情况下，Spring Boot 配置将：

• 禁用MapperFeature.DEFAULT_VIEW_INCLUSION
• 禁用反序列化Feature.FAIL_ON_UNKNOWN_PROPERTIES
• 禁用SerializationFeature.WRITE_DATES_AS_TIMESTAMPS

让我们从一个简单的例子开始：

• 客户端将向我们的/coffee?name=Lavazza发送 GET 请求
• 控制器将返回一个新的Coffee对象
• Spring 将使用ObjectMapper将我们的 POJO 序列化为 JSON

我们将使用String和LocalDateTime对象举例说明自定义选项：

 

public class Coffee {

    private String name;
    private String brand;
    private LocalDateTime date;

   //getters and setters
}

我们还将定义一个简单的 REST 控制器来演示序列化：

@GetMapping("/coffee")
public Coffee getCoffee(
        @RequestParam(required = false) String brand,
        @RequestParam(required = false) String name) {
    return new Coffee()
      .setBrand(brand)
      .setDate(FIXED_DATE)
      .setName(name);
}

默认情况下，调用 GET http://lolcahost:8080/coffee?brand=Lavazza时的响应将为：

{
  "name": null,
  "brand": "Lavazza",
  "date": "2020-11-16T10:21:35.974"
}

我们希望排除空值并使用自定义日期格式 (dd-MM-yyyy HH:mm)。最终回复将是：

{
  "brand": "Lavazza",
  "date": "04-11-2020 10:34"
}

使用 Spring Boot 时，我们可以选择自定义默认的ObjectMapper或覆盖它。我们将在接下来的部分中介绍这两个选项。

3. 自定义默认ObjectMapper

 

在本节中，我们将看到如何自定义Spring Boot 使用的默认ObjectMapper。

 

3.1. 应用程序属性和自定义 Jackson 模块

 

配置映射器的最简单方法是通过应用程序属性。配置的一般结构是：

spring.jackson.<category_name>.<feature_name>=true,false

例如，如果我们想禁用SerializationFeature.WRITE_DATES_AS_TIMESTAMPS，我们将添加：

spring.jackson.serialization.write-dates-as-timestamps=false

除了提到的特征类别，我们还可以配置属性包含：

spring.jackson.default-property-inclusion=always, non_null, non_absent, non_default, non_empty

配置环境变量是最简单的方法。这种方法的缺点是我们无法自定义高级选项，例如为LocalDateTime自定义日期格式。此时，我们将得到结果：

{
  "brand": "Lavazza",
  "date": "2020-11-16T10:35:34.593"
}

为了实现我们的目标，我们将使用自定义日期格式注册一个新的JavaTimeModule ：

 

@Configuration
@PropertySource("classpath:coffee.properties")
public class CoffeeRegisterModuleConfig {

    @Bean
    public Module javaTimeModule() {
        JavaTimeModule module = new JavaTimeModule();
        module.addSerializer(LOCAL_DATETIME_SERIALIZER);
        return module;
    }
}

此外，配置属性文件coffee.properties将包含：

spring.jackson.default-property-inclusion=non_null

Spring Boot 将自动注册com.fasterxml.jackson.databind.Module类型的任何 bean 。 最终结果将是：

{
  "brand": "Lavazza",
  "date": "16-11-2020 10:43"
}

3.2. Jackson2ObjectMapperBuilderCustomizer

 

这个功能接口的目的是允许我们创建配置bean。它们将应用于通过Jackson2ObjectMapperBuilder创建的默认ObjectMapper：

@Bean
public Jackson2ObjectMapperBuilderCustomizer jsonCustomizer() {
    return builder -> builder.serializationInclusion(JsonInclude.Include.NON_NULL)
      .serializers(LOCAL_DATETIME_SERIALIZER);
}

配置 bean 以特定的顺序应用，我们可以使用@Order 注释来控制。如果我们想从不同的配置或模块配置ObjectMapper，这种优雅的方法是合适的。

4. 覆盖默认配置

 

如果我们想完全控制配置，有几个选项可以禁用自动配置并只允许应用我们的自定义配置。让我们仔细看看这些选项。

4.1. 对象映射器

 

覆盖默认配置的最简单方法是定义一个ObjectMapper bean 并将其标记为@Primary：

@Bean
@Primary
public ObjectMapper objectMapper() {
    JavaTimeModule module = new JavaTimeModule();
    module.addSerializer(LOCAL_DATETIME_SERIALIZER);
    return new ObjectMapper()
      .setSerializationInclusion(JsonInclude.Include.NON_NULL)
      .registerModule(module);
}

当我们想要完全控制序列化过程并且我们不想允许外部配置时，我们应该使用这种方法。

4.2. Jackson2ObjectMapperBuilder

 

另一种干净的方法是定义一个Jackson2ObjectMapperBuilder bean 。实际上，Spring Boot 在构建ObjectMapper时默认使用此构建器，并会自动选择定义的构建器：

 

@Bean
public Jackson2ObjectMapperBuilder jackson2ObjectMapperBuilder() {
    return new Jackson2ObjectMapperBuilder().serializers(LOCAL_DATETIME_SERIALIZER)
      .serializationInclusion(JsonInclude.Include.NON_NULL);
}

它将默认配置两个选项：

• 禁用MapperFeature.DEFAULT_VIEW_INCLUSION
• 禁用反序列化Feature.FAIL_ON_UNKNOWN_PROPERTIES

根据Jackson2ObjectMapperBuilder文档，如果它们存在于类路径中，它还会注册一些模块：

• jackson-datatype-jdk8：支持其他 Java 8 类型，如Optional
• jackson-datatype-jsr310：支持 Java 8 日期和时间 API 类型
• jackson-datatype-joda：支持 Joda-Time 类型
• jackson-module-kotlin：支持 Kotlin 类和数据类

这种方法的优点是Jackson2ObjectMapperBuilder提供了一种简单直观的方法来构建ObjectMapper。

4.3. MappingJackson2HttpMessageConverter

 

我们可以定义一个类型为MappingJackson2HttpMessageConverter的 bean ，Spring Boot 会自动使用它：

@Bean
public MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter() {
    Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder().serializers(LOCAL_DATETIME_SERIALIZER)
      .serializationInclusion(JsonInclude.Include.NON_NULL);
    return new MappingJackson2HttpMessageConverter(builder.build());
}

5. 测试配置

 

为了测试我们的配置，我们将使用TestRestTemplate并将对象序列化为String。通过这种方式，我们可以验证我们的Coffee对象是在没有空值和自定义日期格式的情况下序列化的：

@Test
public void whenGetCoffee_thenSerializedWithDateAndNonNull() {
    String formattedDate = DateTimeFormatter.ofPattern(CoffeeConstants.dateTimeFormat).format(FIXED_DATE);
    String brand = "Lavazza";
    String url = "/coffee?brand=" + brand;
    
    String response = restTemplate.getForObject(url, String.class);
    
    assertThat(response).isEqualTo("{"brand":"" + brand + "","date":"" + formattedDate + ""}");
}

6. 结论

 

在本教程中，我们了解了使用 Spring Boot 时配置 JSON 序列化选项的几种方法。

我们看到了两种不同的方法：配置默认选项或覆盖默认配置。