SpringBoot中如何优雅地个性化定制Jackson
当使用 JSON 格式时，Spring Boot 将使用ObjectMApper实例来序列化响应和反序列化请求。
在本教程中，我们将了解配置序列化和反序列化选项的最常用方法。
一、默认配置
默认情况下，Spring Boot 配置将禁用以下功能：
- MapperFeature.DEFAULT_VIEW_INCLUSION
- DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES
- SerializationFeature.WRITE_DATES_AS_TIMESTAMPS
例子
让我们从一个简单的例子开始：
- 客户端将向我们的/boy?name=gotanks发送一个 GET 请求。
- 控制器将返回一个新的Boy对象。
- Spring 将使用 ObjectMapper 将我们的 POJO 序列化为 JSON。
我们将通过使用 String 和 LocalDateTime 对象来举例说明自定义选项：
@Data
public class Boy {
private String name;
private Integer age;
private LocalDateTime birth;
}
我们还将定义一个简单的 REST 控制器来演示序列化：
@GetMapping("/boy")
public Boy getBoy(
@RequestParam(required = false) Integer age,
@RequestParam(required = false) String name) {
return new Boy()
.setAge(age)
.setDate(LocalDateTime.now())
.setName(name);
}
默认情况下，这将是调用 GET http://localhost:8080/boy?name=gotanks 时的响应：
{
"name": "gotanks",
"age": null,
"date": "2023-12-19T10:21:35.974"
}
我们希望排除空值并使用自定义日期格式 yyyy-MM-dd HH:mm:ss。这是我们的最终回应:
{
"name": "gotanks",
"date": "2023-12-19 10:21:35"
}
二、自定义ObjectMapper
下面，我们将了解如何自定义 Spring Boot 使用的默认ObjectMapper。
1.应用程序属性
配置映射器的最简单方法是通过 application.properties
这是配置的一般结构：
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自定义日期格式。
2.自定义 Jackson 模块
为了实现我们的目标，我们将使用我们的自定义日期格式注册一个新的 JAVATimeModule ：
@Configuration
public class JacksonConfig {
@Bean
public Module javaTimeModule() {
JavaTimeModule module = new JavaTimeModule();
module.addSerializer(LOCAL_DATETIME_SERIALIZER);
return module;
}
}
SpringBoot 将自动注册com.fasterxml.jackson.databind.Module类型的任何 bean 。这是我们的最终结果：
{
"name": "gotanks",
"age": null,
"date": "2023-12-19 10:21:35"
}
3.Jackson2ObjectMapperBuilderCustomizer
这个函数接口的目的是允许我们创建配置bean。
它们将被应用到通过 Jackson2ObjectMapperBuilder 创建的默认 ObjectMapper：
@Bean
public Jackson2ObjectMapperBuilderCustomizer jsonCustomizer() {
return builder -> builder.serializationInclusion(JsonInclude.Include.NON_NULL)
.serializers(LOCAL_DATETIME_SERIALIZER);
}
配置bean以特定的顺序应用，我们可以使用 @Order 注解控制该顺序。如果我们想从不同的配置或模块配置ObjectMapper，那么这种优雅的方法非常适合。
三、覆盖默认配置
如果我们想完全控制配置，有几个选项可以禁用自动配置并只允许应用我们的自定义配置。
让我们仔细看看这些选项。
1.ObjectMapper
覆盖默认配置的最简单方法是定义一个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);
}
当我们想要完全控制序列化过程并且不想允许外部配置时，我们应该使用这种方法。
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
- 禁用 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。
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());
}
四、总结
在本文中，我们了解了在使用 SpringBoot 时配置 JSON 序列化选项的几种方法。
我们看到了两种不同的方法：配置默认选项或覆盖默认配置。
