SpringBoot之Json的序列化和反序列化問題
控制json序列化/反序列化
1. @JsonIgnoreProperties的用法
@JsonIgnoreProperties(value = { "prop1","prop2" })
用來修飾Pojo類, 在序列化和反序列化的時候忽略指定的屬性, 可以忽略一個或多個屬性.
@JsonIgnoreProperties(ignoreUnknown = true)
用來修飾Pojo類, 在反序列化的時候忽略那些無法被設置的屬性, 包括無法在構造子設置和沒有對應的setter方法.
2. @JsonProperty 註解
如果 json field 的名稱和Pojo 的屬性名不一致的時, 可以用 @JsonProperty 來註解 getter() 或 setter() 方法, 該註解設定json 對應的屬性名, 另外@JsonProperty也經常用來註解構造子的形參, 這時候構造子應該加@JsonCreator 註解.
3. @JsonCreator 註解
如果 Pojo 類定義有參數的構造子, 但沒有提供無參構造子時, 在反序列化時是會報錯. 有下面兩個辦法:
- 方法1：增加一個無參構造子
- 方法2：為這個有參數的構造子, 加上 @JsonCreator 註解, 同時參數需要加上 @JsonProperty 註解.
4. @JsonSetter 和 @JsonGetter 註解
如果 json field 的名稱和Pojo 的屬性名不一致的時, 可以使用@JsonGetter來註解 getter(), 使用 @JsonSetter 來註解setter() 方法. 這兩個註解都可以指定一個屬性名. 這兩個註解都可以用 @JsonProperty 替換.
5. @JsonAnySetter 註解
一般對象屬性名都是確定的, 比如 Car 這個對象, 有 brand/price 等具名屬性, 但有時候我們還需要為Car這個對象設定一些擴展屬性, 這些擴展屬性名稱暫時不好確定, 通常使用 Map<String, String> 來存放這些擴展屬性的K/V. 要把json 數據中的這些屬性反序列化到類的Map中, 需要在類上增加一個K/V的setter方法, 而且這個setter方法要加上@JsonAnySetter註解.
public class Car {
public String brand;
private Map<String, String> properties;
@JsonAnySetter
public void add(String key, String value) {
properties.put(key, value);
}
}
一旦類加上瞭@JsonAnySetter後可將下面的 json 數據反序列化到Map中:
{
"brand":"Benz",
"attr2":"val2",
"attr1":"val1"
}
6. @JsonAnyGetter 註解
和@JsonAnySetter 註解相對應, 如果要將類中的Map K/V屬性序列化到json中, 需要在類上增加一個 @JsonAnyGetter 方法, 該方法直接返回KV map就行.
public class Car {
public String brand;
private Map<String, String> properties;
@JsonAnyGetter
public Map<String, String> getProperties() {
return properties;
}
}
序列化後的json為:
{
"brand":"Benz",
"attr2":"val2",
"attr1":"val1"
}
7. @JsonFormat 註解
通常明確Date/Time 屬性序列化用的時間格式.
public class Event {
public String name;
@JsonFormat(
shape = JsonFormat.Shape.STRING, pattern = "dd-MM-yyyy hh:mm:ss")
public Date eventDate;
}
8.@JsonSerialize 和 @JsonDeserialize 註解
@JsonSerialize註解可以為類屬性設定專門的序列化函數, @JsonDeserialize註解用來為json屬性定制化反序列化函數
SpringBoot序列化規則
Include.Include.ALWAYS默認Include.NON_DEFAULT屬性為默認值不序列化Include.NON_EMPTY屬性為 空（“”） 或者為 NULL 都不序列化Include.NON_NULL屬性為NULL 不序列化
1.全局設置
/**
* 〈返回json空值去掉null和""〉 〈功能詳細描述〉
*
* @author gogym
* @version 2017年10月13日
* @see JacksonConfig
* @since
*/
@Configuration
public class JacksonConfig
{
@Bean
@Primary
@ConditionalOnMissingBean(ObjectMapper.class)
public ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder)
{
ObjectMapper objectMapper = builder.createXmlMapper(false).build();
// 通過該方法對mapper對象進行設置，所有序列化的對象都將按改規則進行系列化
// Include.Include.ALWAYS 默認
// Include.NON_DEFAULT 屬性為默認值不序列化
// Include.NON_EMPTY 屬性為 空（""） 或者為 NULL 都不序列化，則返回的json是沒有這個字段的。這樣對移動端會更省流量
// Include.NON_NULL 屬性為NULL 不序列化,就是為null的字段不參加序列化
//objectMapper.setSerializationInclusion(Include.NON_EMPTY);
objectMapper.setSerializationInclusion(JsonInclude.Include.NON_EMPTY);
return objectMapper;
}
}
或者
spring.jackson.default-property-inclusion=non_null
spring:
jackson:
default-property-inclusion: non_null
2.局部設置
在需要設置的實體類或者字段上加上註解
@JsonInclude(Include.NON_NULL)
3.自定義局部序列化
（1）、自定義一個序列化工具類，需要實現StdSerializer<T>或者JsonSerializer<T>
public class ClientObjectSerialize extends JsonSerializer<CreditBorrowerRepaymentRequestDto>{
@Override
public void serialize(CreditBorrowerRepaymentRequestDto dto, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException, JsonProcessingException {
jsonGenerator.writeStartObject();
try {
Field[] fields = dto.getClass().getDeclaredFields();
for (Field field : fields) {
field.setAccessible(true);
if(null == field.get(dto)){
continue;
}
jsonGenerator.writeFieldName(field.getName());
jsonGenerator.writeObject(field.get(dto));
}
} catch (Exception e) {
e.printStackTrace();
}
jsonGenerator.writeEndObject();
}
}
（2）使用註解作用在實體類上
@JsonSerialize(using = ClientObjectSerialize.class)
public class CreditBorrowerRepaymentRequestDto{
}
（3）可以作用在實體對象字段上，對NULL值的處理，或者轉換
@JsonSerialize(using = ClientStringSerialize.class)
private String name;
@JsonSerialize(using = ClientDtaeSerialize.class)
private Date date;
public class ClientStringSerialize extends JsonSerializer<String> {
@Override
public void serialize(String string, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
if(string == null){
jsonGenerator.writeString(string + "[NULL]");
}else{
jsonGenerator.writeString(string);
}
}
}
public class ClientDtaeSerialize extends JsonSerializer<Date> {
@Override
public void serialize(Date createDate, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
jsonGenerator.writeString(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(createDate));
}
}
4.自定義全局 null 轉換 序列化
SpringBoot返回Json數據中null值處理，將字符串類型null值轉換為""，將集合數組類型null值轉換為[]，將原始數據類型null值轉換為0，將佈爾類型null值轉換為false，將實體對象null值轉換為{}。
（1）自定義null值序列化處理器
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.SerializerProvider;
import java.io.IOException;
/**
* 自定義null值序列化處理器
*/
public class CustomizeNullJsonSerializer {
/**
* 處理數組集合類型的null值
*/
public static class NullArrayJsonSerializer extends JsonSerializer<Object> {
@Override
public void serialize(Object value, JsonGenerator jsonGenerator,
SerializerProvider serializerProvider) throws IOException {
jsonGenerator.writeStartArray();
jsonGenerator.writeEndArray();
}
}
/**
* 處理字符串類型的null值
*/
public static class NullStringJsonSerializer extends JsonSerializer<Object> {
@Override
public void serialize(Object value, JsonGenerator jsonGenerator,
SerializerProvider serializerProvider) throws IOException {
jsonGenerator.writeString("");
}
}
/**
* 處理數值類型的null值
*/
public static class NullNumberJsonSerializer extends JsonSerializer<Object> {
@Override
public void serialize(Object value, JsonGenerator jsonGenerator,
SerializerProvider serializerProvider) throws IOException {
jsonGenerator.writeNumber(0);
}
}
/**
* 處理boolean類型的null值
*/
public static class NullBooleanJsonSerializer extends JsonSerializer<Object> {
@Override
public void serialize(Object value, JsonGenerator jsonGenerator,
SerializerProvider serializerProvider) throws IOException {
jsonGenerator.writeBoolean(false);
}
}
/**
* 處理實體對象類型的null值
*/
public static class NullObjectJsonSerializer extends JsonSerializer<Object> {
@Override
public void serialize(Object value, JsonGenerator jsonGenerator,
SerializerProvider serializerProvider) throws IOException {
jsonGenerator.writeStartObject();
jsonGenerator.writeEndObject();
}
}
}
（2）序列化程序修改器
import com.fasterxml.jackson.databind.BeanDescription;
import com.fasterxml.jackson.databind.SerializationConfig;
import com.fasterxml.jackson.databind.ser.BeanPropertyWriter;
import com.fasterxml.jackson.databind.ser.BeanSerializerModifier;
import java.util.Collection;
import java.util.List;
/**
* <pre>
* 此modifier主要做的事情為：
* 1.當序列化類型為數組集合時，當值為null時，序列化成[]
* 2.String類型值序列化為""
*
* </pre>
*/
public class MyBeanSerializerModifier extends BeanSerializerModifier {
@Override
public List<BeanPropertyWriter> changeProperties(SerializationConfig config,
BeanDescription beanDesc,
List<BeanPropertyWriter> beanProperties) {
// 循環所有的beanPropertyWriter
for (int i = 0; i < beanProperties.size(); i++) {
BeanPropertyWriter writer = beanProperties.get(i);
// 判斷字段的類型，如果是數組或集合則註冊nullSerializer
if (isArrayType(writer)) {
// 給writer註冊一個自己的nullSerializer
writer.assignNullSerializer(new CustomizeNullJsonSerializer.NullArrayJsonSerializer());
}
if (isStringType(writer)) {
writer.assignNullSerializer(new CustomizeNullJsonSerializer.NullStringJsonSerializer());
}
}
return beanProperties;
}
/**
* 是否是數組
*/
private boolean isArrayType(BeanPropertyWriter writer) {
Class<?> clazz = writer.getType().getRawClass();
return clazz.isArray() || Collection.class.isAssignableFrom(clazz);
}
/**
* 是否是String
*/
private boolean isStringType(BeanPropertyWriter writer) {
Class<?> clazz = writer.getType().getRawClass();
return CharSequence.class.isAssignableFrom(clazz) || Character.class.isAssignableFrom(clazz);
}
/**
* 是否是數值類型
*/
private boolean isNumberType(BeanPropertyWriter writer) {
Class<?> clazz = writer.getType().getRawClass();
return Number.class.isAssignableFrom(clazz);
}
/**
* 是否是boolean
*/
private boolean isBooleanType(BeanPropertyWriter writer) {
Class<?> clazz = writer.getType().getRawClass();
return clazz.equals(Boolean.class);
}
}
（3）配置Jackson實體
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializerProvider;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
/**
* 配置Jackson實體
*/
@Configuration
public class JacksonConfig {
@Bean
@Primary
@ConditionalOnMissingBean(ObjectMapper.class)
public ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) {
ObjectMapper objectMapper = builder.createXmlMapper(false).build();
/** 為objectMapper註冊一個帶有SerializerModifier的Factory */
objectMapper.setSerializerFactory(objectMapper.getSerializerFactory()
.withSerializerModifier(new MyBeanSerializerModifier()));
SerializerProvider serializerProvider = objectMapper.getSerializerProvider();
serializerProvider.setNullValueSerializer(new CustomizeNullJsonSerializer
.NullObjectJsonSerializer());
return objectMapper;
}
}
以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。
推薦閱讀：
- springboot響應json null值過濾方式
- springboot @JsonSerialize的使用講解
- springboot配置Jackson返回統一默認值的實現示例
- 基於@JsonSerialize和@JsonInclude註解使用方法
- SpringBoot @JsonDeserialize自定義Json序列化方式