Spring Boot: 自定义 Jackson ObjectMapper
最后更新:2024年2月29日
1. 概述
在使用 JSON 格式时,Spring Boot 将使用一个 ObjectMapper 实例来序列化响应和反序列化请求。
在本教程中,我们将了解配置序列化和反序列化选项的最常见方法。
要了解更多关于 Jackson 的信息,请务必查看我们的 Jackson 教程。
更多阅读
2. 默认配置
默认情况下,Spring Boot 配置将禁用以下设置
- MapperFeature.DEFAULT_VIEW_INCLUSION
- DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES
- SerializationFeature.WRITE_DATES_AS_TIMESTAMPS
让我们从一个简单的示例开始
- 客户端将发送一个 GET 请求到我们的 /coffee?name=Lavazza。
- 控制器将返回一个新的 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(name = "brand", required = false) String brand,
@RequestParam(name = "name", 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"
}
我们希望排除 null 值并拥有自定义日期格式(dd-MM-yyyy HH:mm)。这是我们的最终响应
{
"brand": "Lavazza",
"date": "04-11-2020 10:34"
}
在使用 Spring Boot 时,我们有选择自定义默认 ObjectMapper 或覆盖它的选项。我们将在下一节中介绍这两种选项。
3. 自定义默认 ObjectMapper
在本节中,我们将了解如何自定义 Spring Boot 使用的默认 ObjectMapper。
3.1. 应用程序属性和自定义 Jackson 模块
配置 mapper 最简单的方法是通过应用程序属性。
这是配置的一般结构
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
覆盖默认配置最简单的方法是定义一个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时实际上默认使用这个 builder,并且会自动选择定义的 builder
@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。
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());
}
请务必查看我们的 Spring Http Message Converters 文章以了解更多信息。
5. 测试配置
为了测试我们的配置,我们将使用TestRestTemplate并将对象序列化为String。
这样,我们可以验证我们的Coffee对象是否在没有null值的情况下,并使用自定义日期格式进行序列化
@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 序列化选项的方法。
我们看到了两种不同的方法:配置默认选项或覆盖默认配置。
支持本文的代码可在 GitHub 上获取。 一旦你以 Baeldung Pro 会员 身份登录,就开始学习并在项目上进行编码。















