Spring Boot 自定義Jackson ObjectMapper，你學會了嗎？
在Spring Boot Web 項目中，當使用JSON格式接收數據和返回數據的時候，Spring Boot 默認使用一個ObjectMapper實例來序列化響應和反序列化請求。
在本文中，我們將看看配置序列化和反序列化選項的最常用方法。
默認配置
默認情況下，Spring Boot的配置將禁用以下配置項。
- MapperFeature.DEFAULT_VIEW_INCLUSION
- DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES
- SerializationFeature.WRITE_DATES_AS_TIMESTAMPS。
舉個例子
- 客戶端將發送一個GET請求到我們的/coffee?name=Javazzz。
- 控制器將返回一個新的Coffee對象。
- Spring將使用ObjectMapper將我們的POJO序列化為JSON。
我們將通過使用String和LocalDateTime對象來示范定制選項。
public class Coffee {
private String name;
private String brand;
private LocalDateTime date;
//getter and setter
}
我們還將定義一個簡單的REST控制器來演示序列化。
@GetMapping("/coffee")
public Coffee getCoffee(
@RequestParam(required = false) String brand,
@RequestParam(required = false) String name) {
return new Coffee()
.setBrand(brand)
.setDate(FIXED_DATE)
.setName(name);
}
默認情況下，這將是調用GET http://lolcahost:8080/coffee?brand=javazzz 時的響應。
{
"name": null,
"brand": "javazzz",
"date": "2022-06-16T10:21:35.974"
}
我們希望排除空值，并有一個自定義的日期格式（dd-MM-yyyy HH:mm）。這就是我們的響應結果。
{
"brand": "javazzz",
"date": "06-11-2022 10:34"
}
在使用Spring Boot時，我們可以選擇定制默認的ObjectMapper或覆蓋它。我們將在接下來的章節中介紹這兩個選項。
自定義默認的ObjectMapper
在本節中，我們將看到如何定制Spring Boot使用的默認ObjectMapper。
1.應用程序屬性和自定義 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": "javazzz",
"date": "2022-06-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.fastxml.jackson.databind.Module的bean。下面是我們的最終結果。
{
"brand": "Javazzz",
"date": "16-06-2022 10:43"
}
2.Jackson2ObjectMapperBuilderCustomizer
這個功能接口的目的是讓我們創建配置。
它們將被應用于通過Jackson2ObjectMapperBuilder創建的默認ObjectMapper。
@Bean
public Jackson2ObjectMapperBuilderCustomizer jsonCustomizer() {
return builder -> builder.serializationInclusion(JsonInclude.Include.NON_NULL)
.serializers(LOCAL_DATETIME_SERIALIZER);
}
配置得以特定的順序應用，我們可以使用@Order annotation來控制。如果我們想從不同的配置或模塊來配置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
另一種干凈的方法是定義一個Jackson2ObjectMapperBuilderbean。
實際上，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 文檔，如果classpath上有一些模塊，它也會注冊這些模塊。
- jackson-datatype-jdk8：支持其他Java 8類型，如Optional
- jackson-datatype-jsr310：支持Java 8 Date and Time 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());
}
測試配置
為了測試我們的配置，我們將使用TestRestTemplate并將對象序列化為String。
通過這種方式，我們可以驗證我們的Coffee對象在序列化時沒有null值，并且具有自定義的日期格式。
@Test
public void whenGetCoffee_thenSerializedWithDateAndNonNull() {
String formattedDate = DateTimeFormatter.ofPattern(CoffeeConstants.dateTimeFormat).format(FIXED_DATE);
String brand = "Javazza";
String url = "/coffee?brand=" + brand;
String response = restTemplate.getForObject(url, String.class);
assertThat(response).isEqualTo("{\"brand\":\"" + brand + "\",\"date\":\"" + formattedDate + "\"}");
}
總結
在這篇文章中，我們看了使用Spring Boot時配置JSON序列化選項的幾種方法。
我們看到了兩種不同的方法：配置默認選項或重寫默認配置。
