深入解析SpringBoot默認JSON解析器及自定義字段序列化策略
作者：一安
SpringBoot? 中對依賴都做了很好的封裝，可以看到很多 spring-boot-starter-xxx?系列的依賴，這是 SpringBoot? 的特點之一，不需要人為去引入很多相關(guān)的依賴了，starter-xxx? 系列直接都包含了所必要的依賴，所以我們再次點進去上面這個 spring-boot-starter-json 依賴，
前言
在我們開發(fā)項目API接口的時候，一些沒有數(shù)據(jù)的字段會默認返回NULL,數(shù)字類型也會是NULL,這個時候前端希望字符串能夠統(tǒng)一返回空字符，數(shù)字默認返回0，那我們就需要自定義json序列化處理
默認的json解析方案
我們知道在SpringBoot中有默認的Json解析器，SpringBoot 中默認使用的 Json 解析技術(shù)框架是 jackson。
點開 pom.xml 中的 spring-boot-starter-web 依賴，可以看到一個 spring-boot-starter-json依賴：
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-json</artifactId>
<version>2.4.7</version>
<scope>compile</scope>
</dependency>SpringBoot 中對依賴都做了很好的封裝，可以看到很多 spring-boot-starter-xxx系列的依賴，這是 SpringBoot 的特點之一，不需要人為去引入很多相關(guān)的依賴了，starter-xxx 系列直接都包含了所必要的依賴，所以我們再次點進去上面這個 spring-boot-starter-json 依賴，可以看到：
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.11.4</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jdk8</artifactId>
<version>2.11.4</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jsr310</artifactId>
<version>2.11.4</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.module</groupId>
<artifactId>jackson-module-parameter-names</artifactId>
<version>2.11.4</version>
<scope>compile</scope>
</dependency>我們在返回json時候通過注解@ResponseBody就可以自動幫我們將服務(wù)端返回的對象序列化成json字符串，在傳遞json body參數(shù)時候 通過在對象參數(shù)上@RequestBody注解就可以自動幫我們將前端傳過來的json字符串反序列化成java對象，這些功能都是通過HttpMessageConverter這個消息轉(zhuǎn)換工具類來實現(xiàn)的
SpringMVC自動配置了Jackson和Gson的HttpMessageConverter，SpringBoot對此做了自動化配置
- JacksonHttpMessageConvertersConfiguration
@Configuration(proxyBeanMethods = false)
@ConditionalOnClass(ObjectMapper.class)
@ConditionalOnBean(ObjectMapper.class)
@ConditionalOnProperty(name = HttpMessageConvertersAutoConfiguration.PREFERRED_MAPPER_PROPERTY,
havingValue = "jackson", matchIfMissing = true)
static class MappingJackson2HttpMessageConverterConfiguration {
@Bean
@ConditionalOnMissingBean(value = MappingJackson2HttpMessageConverter.class,
ignoredType = {
"org.springframework.hateoas.server.mvc.TypeConstrainedMappingJackson2HttpMessageConverter",
"org.springframework.data.rest.webmvc.alps.AlpsJsonHttpMessageConverter" })
MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter(ObjectMapper objectMapper) {
return new MappingJackson2HttpMessageConverter(objectMapper);
}
}- GsonHttpMessageConvertersConfiguration
@Configuration(proxyBeanMethods = false)
@ConditionalOnBean(Gson.class)
@Conditional(PreferGsonOrJacksonAndJsonbUnavailableCondition.class)
static class GsonHttpMessageConverterConfiguration {
@Bean
@ConditionalOnMissingBean
GsonHttpMessageConverter gsonHttpMessageConverter(Gson gson) {
GsonHttpMessageConverter converter = new GsonHttpMessageConverter();
converter.setGson(gson);
return converter;
}
}正文
自定義JSON解析
日期格式解析
使用@JsonFormat注解自定義格式
@JsonFormat(pattern = "yyyy-MM-dd")
private Date birthday;但是這種要對每個實體類中的日期字段都需要添加此注解不夠靈活，在配置文件中直接添加spring.jackson.date-format=yyyy-MM-dd
NULL字段不返回
使用@JsonInclude注解
@JsonInclude(JsonInclude.Include.NON_NULL)
private String title;這種要對每個實體類中的字段都需要添加此注解不夠靈活，在配置文件中直接添加Spring.jackson.default-property-inclusion=non_null
自定義字段序列化
自定義null字符串類型字段返回空字符
public class NullStringJsonSerializer extends JsonSerializer {
@Override
public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
if (o == null) {
jsonGenerator.writeString("");
}
}
}自定義null數(shù)字類型字段返回0
public class NullIntegerJsonSerializer extends JsonSerializer {
@Override
public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
if (o == null) {
jsonGenerator.writeNumber(0);
}
}
}自定義浮點小數(shù)類型4舍5入保留2位小數(shù)
public class DoubleJsonSerialize extends JsonSerializer {
private DecimalFormat df = new DecimalFormat("##.00");
@Override
public void serialize(Object value, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
if (value != null) {
jsonGenerator.writeString(NumberUtil.roundStr(value.toString(), 2));
}else{
jsonGenerator.writeString("0.00");
}
}
}處理數(shù)組類型的null值
public class NullArrayJsonSerializer extends JsonSerializer {
@Override
public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
if(o==null){
jsonGenerator.writeStartArray();
}else {
jsonGenerator.writeObject(o);
}
}
}自定義BeanSerializerModifier
public class MyBeanSerializerModifier extends BeanSerializerModifier {
private JsonSerializer _nullArrayJsonSerializer = new NullArrayJsonSerializer();
private JsonSerializer _nullStringJsonSerializer = new NullStringJsonSerializer();
private JsonSerializer _nullIntegerJsonSerializer = new NullIntegerJsonSerializer();
private JsonSerializer _doubleJsonSerializer = new DoubleJsonSerialize();
@Override
public List changeProperties(SerializationConfig config, BeanDescription beanDesc,
List beanProperties) {
// 循環(huán)所有的beanPropertyWriter
for (int i = 0; i < beanProperties.size(); i++) {
BeanPropertyWriter writer = (BeanPropertyWriter) beanProperties.get(i);
// 判斷字段的類型，如果是array，list，set則注冊nullSerializer
if (isArrayType(writer)) {
//給writer注冊一個自己的nullSerializer
writer.assignNullSerializer(this.defaultNullArrayJsonSerializer());
}
if (isStringType(writer)) {
writer.assignNullSerializer(this.defaultNullStringJsonSerializer());
}
if (isIntegerType(writer)) {
writer.assignNullSerializer(this.defaultNullIntegerJsonSerializer());
}
if (isDoubleType(writer)) {
writer.assignSerializer(this.defaultDoubleJsonSerializer());
}
}
return beanProperties;
}
// 判斷是什么類型
protected boolean isArrayType(BeanPropertyWriter writer) {
Class clazz = writer.getPropertyType();
return clazz.isArray() || clazz.equals(List.class) || clazz.equals(Set.class);
}
protected boolean isStringType(BeanPropertyWriter writer) {
Class clazz = writer.getPropertyType();
return clazz.equals(String.class);
}
protected boolean isIntegerType(BeanPropertyWriter writer) {
Class clazz = writer.getPropertyType();
return clazz.equals(Integer.class) || clazz.equals(int.class) || clazz.equals(Long.class);
}
protected boolean isDoubleType(BeanPropertyWriter writer) {
Class clazz = writer.getPropertyType();
return clazz.equals(Double.class) || clazz.equals(BigDecimal.class);
}
protected JsonSerializer defaultNullArrayJsonSerializer() {
return _nullArrayJsonSerializer;
}
protected JsonSerializer defaultNullStringJsonSerializer() {
return _nullStringJsonSerializer;
}
protected JsonSerializer defaultNullIntegerJsonSerializer() {
return _nullIntegerJsonSerializer;
}
protected JsonSerializer defaultDoubleJsonSerializer() {
return _doubleJsonSerializer;
}
}應(yīng)用我們自己bean序列化使其生效
@Configuration
public class ClassJsonConfiguration {
@Bean
public MappingJackson2HttpMessageConverter mappingJacksonHttpMessageConverter() {
final MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
ObjectMapper mapper = converter.getObjectMapper();
// 為mapper注冊一個帶有SerializerModifier的Factory，此modifier主要做的事情為：判斷序列化類型，根據(jù)類型指定為null時的值
mapper.setSerializerFactory(mapper.getSerializerFactory().withSerializerModifier(new MyBeanSerializerModifier()));
return converter;
}
}此類會代替SpringBoot默認的json解析方案。事實上，此類中起作用的是ObjectMapper 類，因此也可直接配置此類
@Bean
public ObjectMapper om() {
ObjectMapper mapper = new ObjectMapper();
// 為mapper注冊一個帶有SerializerModifier的Factory，此modifier主要做的事情為：判斷序列化類型，根據(jù)類型指定為null時的值
mapper.setSerializerFactory(mapper.getSerializerFactory().withSerializerModifier(new MyBeanSerializerModifier()));
return mapper;
}jackson詳細配置
spring:
jackson:
# 設(shè)置屬性命名策略,對應(yīng)jackson下PropertyNamingStrategy中的常量值，SNAKE_CASE-返回的json駝峰式轉(zhuǎn)下劃線，json body下劃線傳到后端自動轉(zhuǎn)駝峰式
property-naming-strategy: SNAKE_CASE
# 全局設(shè)置@JsonFormat的格式pattern
date-format: yyyy-MM-dd HH:mm:ss
# 當(dāng)?shù)貢r區(qū)
locale: zh
# 設(shè)置全局時區(qū)
time-zone: GMT+8
# 常用，全局設(shè)置pojo或被@JsonInclude注解的屬性的序列化方式
default-property-inclusion: NON_NULL #不為空的屬性才會序列化,具體屬性可看JsonInclude.Include
# 常規(guī)默認,枚舉類SerializationFeature中的枚舉屬性為key，值為boolean設(shè)置jackson序列化特性,具體key請看SerializationFeature源碼
serialization:
WRITE_DATES_AS_TIMESTAMPS: true # 返回的java.util.date轉(zhuǎn)換成timestamp
FAIL_ON_EMPTY_BEANS: true # 對象為空時是否報錯，默認true
# 枚舉類DeserializationFeature中的枚舉屬性為key，值為boolean設(shè)置jackson反序列化特性,具體key請看DeserializationFeature源碼
deserialization:
# 常用,json中含pojo不存在屬性時是否失敗報錯,默認true
FAIL_ON_UNKNOWN_PROPERTIES: false
# 枚舉類MapperFeature中的枚舉屬性為key，值為boolean設(shè)置jackson ObjectMapper特性
# ObjectMapper在jackson中負責(zé)json的讀寫、json與pojo的互轉(zhuǎn)、json tree的互轉(zhuǎn),具體特性請看MapperFeature,常規(guī)默認即可
mapper:
# 使用getter取代setter探測屬性，如類中含getName()但不包含name屬性與setName()，傳輸?shù)膙o json格式模板中依舊含name屬性
USE_GETTERS_AS_SETTERS: true #默認false
# 枚舉類JsonParser.Feature枚舉類中的枚舉屬性為key，值為boolean設(shè)置jackson JsonParser特性
# JsonParser在jackson中負責(zé)json內(nèi)容的讀取,具體特性請看JsonParser.Feature，一般無需設(shè)置默認即可
parser:
ALLOW_SINGLE_QUOTES: true # 是否允許出現(xiàn)單引號,默認false
# 枚舉類JsonGenerator.Feature枚舉類中的枚舉屬性為key，值為boolean設(shè)置jackson JsonGenerator特性，一般無需設(shè)置默認即可
# JsonGenerator在jackson中負責(zé)編寫json內(nèi)容,具體特性請看JsonGenerator.Feature責(zé)任編輯：武曉燕
來源：
一安未來
