Spring Boot – 自定义 Jackson ObjectMapper

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

让我们来看看默认配置。所以默认情况下，Spring Boot 的配置如下：

禁用 MapperFeature.DEFAULT_VIEW_INCLUSION
禁用反序列化功能。 FAIL_ON_UNKNOWN_PROPERTIES
禁用序列化功能。 WRITE_DATES_AS_TIMESTAMPS

让我们从一个更快的例子开始，实现相同的

执行：

客户端向 our/coffee?name=Lavazza 发送 GET 请求
控制器将返回一个新的 Coffee 对象
Spring 将通过使用 String 和 LocalDateTime 对象来使用自定义选项

如下，所以首先我们需要创建一个名为 Coffee 的类，如下所示：

// Class
public class Coffee {

  // Getters and setters
  private String name;
  private String brand;
  private LocalDateTime date;
}

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

@GetMapping ("/coffee")

public Coffee getCoffee(
  @RequestParam(required =  false) String brand,
  @RequiredParam(required = false) String name) {

  return new Coffee()
         .setBrand(brand)
         .setDate(FIXED_DATE)
         .setName(name);
}

默认情况下，当调用响应HTTP GET：//本地主机：8080 / cofffee品牌=拉瓦扎会像FOLLØWS：

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

现在我们想排除空值并使用自定义日期格式(dd-MM-yyy HH:mm) 。最终回复如下：

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

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

现在让我们通过自定义默认对象映射器滚动到文章中的偏心点。这里。我们将讨论如何自定义 Spring Boot 使用的默认 ObjectMapper。

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

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

spring.jackson..=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")

// Class
public class CoffeeRegisterModuleConfig {

  @Bean

  public Module javaTimeModule() {

    JavaTimeModule module = new JavaTimeModule();
    module.addSerializer(LOCAL_DATETIME_SERIALIZER);

    return module;
  }
}

Jackson2ObjectMapperBuilderCustomizer

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

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

The configuration beans are applied in a specific order, which we can control using the @Order annotations. This elegant approach is suitable if we want to configure the ObjectMapper from different configurations or modules.

编程需要懂一点英语

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 类和数据类

Note: The advantage of this approach is that the Jackson2ObjectMapperBuilder offers a simple and intuitive way to build an ObjectMapper.

编程需要懂一点英语

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

@Bean

// Convertor method
public MappingJackson2HttpMessageConverter() {

  Jackson2ObjectMapperBuilder builder = new
  Jackson2ObjectMapperBuilder().serializers(LOCAL_DATE_SERIALIZER)
  .serializationInclusion(JsonInlcude.Inlcude.NON_NULL);

  return new MappingJackson2HttpMessageConverter(builder.build());
}

Note: Make sure to check out our Spring Http Message Converters article to learn more.

编程需要懂一点英语

测试配置

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

@Test

public voif whenGetCoffee_thenSerializedWithDateAndNonNull() {

  String formattedDate =
    DateTimeFormatter.ofPattern(CoffeeConstants.dateTimeFormat).format(FIXED_DATE);

// Our strings
  String brand = "Lavazza";
  String url = "/coffee?branf=" + brand;
  String response = restTemplate.getForObject(url, String.class);

  assertThat(response).isEqualTo("{"brand\":\"" + brand +
                                "\",\"date\":\"" + formatedDate + "\"}");
}

Conclusion: We took a look at several methods to configure the JSON serialization options when using Spring Boot. Here we saw two different approaches:configuring the default options or overriding the default configuration.

编程需要懂一点英语