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);
}
- 默认情况下，调用 GET http://localhost:8080/coffee?brand=lavazza时的响应将如下所示：
{
"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.<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")
// 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);
}
配置 bean 以特定顺序应用，我们可以使用 @Order 注释来控制。 如果我们想从不同的配置或模块配置 ObjectMapper，这种优雅的方法很合适。
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
- 禁用 DeserializationFeature.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。
我们只需定义一个类型为 MappingJackson2HttpMessageConverter 的 bean，Spring Boot 就会自动使用它：
@Bean
// Convertor method
public MappingJackson2HttpMessageConverter() {
Jackson2ObjectMapperBuilder builder = new
Jackson2ObjectMapperBuilder().serializers(LOCAL_DATE_SERIALIZER)
.serializationInclusion(JsonInclude.Include.NON_NULL);
return new MappingJackson2HttpMessageConverter(builder.build());
}
注意：请务必查看我们的 Spring Http 消息转换器文章以了解更多信息。
测试配置
最后，为了测试我们的配置，我们将使用 TestRestTemplate 并将对象序列化为 String。通过这种方式，我们可以验证我们的 Coffee 对象是否已序列化且没有空值，并且具有自定义日期格式：
@Test
public void 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 + "\"}");
}
最后：我们了解了使用Spring Boot 时配置 JSON 序列化选项的几种方法。这里我们看到了两种不同的方法：配置默认选项或覆盖默认配置。