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 序列化選項的幾種方法。
我們看到了兩種不同的方法：配置默認選項或覆蓋默認配置。
