哈嘍,大家好,我是了不起。
當(dāng)使用 JSON 格式時(shí),Spring Boot 將使用ObjectMapper實(shí)例來序列化響應(yīng)和反序列化請(qǐng)求。
在本教程中,我們將了解配置序列化和反序列化選項(xiàng)的最常用方法。
默認(rèn)情況下,Spring Boot 配置將禁用以下功能:
讓我們從一個(gè)簡單的例子開始:
我們將通過使用 String 和 LocalDateTime 對(duì)象來舉例說明自定義選項(xiàng):
@Datapublic class Boy { private String name; private Integer age; private LocalDateTime birth;}
我們還將定義一個(gè)簡單的 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);}
默認(rèn)情況下,這將是調(diào)用 GET http://localhost:8080/boy?name=gotanks 時(shí)的響應(yīng):
{ "name": "gotanks", "age": null, "date": "2023-12-19T10:21:35.974"}
我們希望排除空值并使用自定義日期格式 yyyy-MM-dd HH:mm:ss。這是我們的最終回應(yīng):
{ "name": "gotanks", "date": "2023-12-19 10:21:35"}
下面,我們將了解如何自定義 Spring Boot 使用的默認(rèn)ObjectMapper。
配置映射器的最簡單方法是通過 application.properties
這是配置的一般結(jié)構(gòu):
spring.jackson.<category_name>.<feature_name>=true,false
例如,我們將添加以下內(nèi)容以禁用 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
配置環(huán)境變量是最簡單的方法。這種方法的缺點(diǎn)是我們無法自定義高級(jí)選項(xiàng),例如為LocalDateTime自定義日期格式。
為了實(shí)現(xiàn)我們的目標(biāo),我們將使用我們的自定義日期格式注冊(cè)一個(gè)新的 JavaTimeModule :
@Configurationpublic class JacksonConfig { @Bean public Module javaTimeModule() { JavaTimeModule module = new JavaTimeModule(); module.addSerializer(LOCAL_DATETIME_SERIALIZER); return module; }}
SpringBoot 將自動(dòng)注冊(cè)com.fasterxml.jackson.databind.Module類型的任何 bean 。這是我們的最終結(jié)果:
{ "name": "gotanks", "age": null, "date": "2023-12-19 10:21:35"}
這個(gè)函數(shù)接口的目的是允許我們創(chuàng)建配置bean。
它們將被應(yīng)用到通過 Jackson2ObjectMapperBuilder 創(chuàng)建的默認(rèn) ObjectMapper:
@Beanpublic Jackson2ObjectMapperBuilderCustomizer jsonCustomizer() { return builder -> builder.serializationInclusion(JsonInclude.Include.NON_NULL) .serializers(LOCAL_DATETIME_SERIALIZER);}
配置bean以特定的順序應(yīng)用,我們可以使用 @Order 注解控制該順序。如果我們想從不同的配置或模塊配置ObjectMapper,那么這種優(yōu)雅的方法非常適合。
如果我們想完全控制配置,有幾個(gè)選項(xiàng)可以禁用自動(dòng)配置并只允許應(yīng)用我們的自定義配置。
讓我們仔細(xì)看看這些選項(xiàng)。
覆蓋默認(rèn)配置的最簡單方法是定義一個(gè)ObjectMapper bean 并將其標(biāo)記為 @Primary:
@Bean@Primarypublic ObjectMapper objectMapper() { JavaTimeModule module = new JavaTimeModule(); module.addSerializer(LOCAL_DATETIME_SERIALIZER); return new ObjectMapper() .setSerializationInclusion(JsonInclude.Include.NON_NULL) .registerModule(module);}
當(dāng)我們想要完全控制序列化過程并且不想允許外部配置時(shí),我們應(yīng)該使用這種方法。
另一種干凈的方法是定義一個(gè)Jackson2ObjectMapperBuilder bean 。
Spring Boot 實(shí)際上在構(gòu)建ObjectMapper時(shí)默認(rèn)使用這個(gè)構(gòu)建器,并且會(huì)自動(dòng)選擇定義的那個(gè):
@Beanpublic Jackson2ObjectMapperBuilder jackson2ObjectMapperBuilder() { return new Jackson2ObjectMapperBuilder().serializers(LOCAL_DATETIME_SERIALIZER) .serializationInclusion(JsonInclude.Include.NON_NULL);}
它會(huì)默認(rèn)配置兩個(gè)選項(xiàng):
根據(jù)Jackson2ObjectMapperBuilder文檔,如果它們存在于類路徑中,它還將注冊(cè)一些模塊:
這種方法的優(yōu)點(diǎn)是 Jackson2ObjectMapperBuilder 提供了一種簡單直觀的方式來構(gòu)建 ObjectMapper。
我們可以定義一個(gè)MappingJackson2HttpMessageConverter 類型的 bean ,Spring Boot 會(huì)自動(dòng)使用它:
@Beanpublic MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter() { Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder().serializers(LOCAL_DATETIME_SERIALIZER) .serializationInclusion(JsonInclude.Include.NON_NULL); return new MappingJackson2HttpMessageConverter(builder.build());}
在本文中,我們了解了在使用 SpringBoot 時(shí)配置 JSON 序列化選項(xiàng)的幾種方法。
我們看到了兩種不同的方法:配置默認(rèn)選項(xiàng)或覆蓋默認(rèn)配置。
本文鏈接:http://www.www897cc.com/showinfo-26-50760-0.htmlSpringBoot中如何優(yōu)雅地個(gè)性化定制Jackson
聲明:本網(wǎng)頁內(nèi)容旨在傳播知識(shí),若有侵權(quán)等問題請(qǐng)及時(shí)與本網(wǎng)聯(lián)系,我們將在第一時(shí)間刪除處理。郵件:2376512515@qq.com
下一篇: Linux從外到內(nèi)剝開動(dòng)態(tài)庫,一個(gè)簡單例子看懂Linux下的動(dòng)態(tài)庫開發(fā)原理