SpringBoot之Json的序列化和反序列化問題
更新時間：2022年06月15日 11:58:31 作者：harrychinese
這篇文章主要介紹了SpringBoot之Json的序列化和反序列化問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
控制json序列化/反序列化
1. @JsonIgnoreProperties的用法
@JsonIgnoreProperties(value = { "prop1","prop2" })用來修飾Pojo類, 在序列化和反序列化的時候忽略指定的屬性, 可以忽略一個或多個屬性.
@JsonIgnoreProperties(ignoreUnknown = true)
用來修飾Pojo類, 在反序列化的時候忽略那些無法被設(shè)置的屬性, 包括無法在構(gòu)造子設(shè)置和沒有對應(yīng)的setter方法.
2. @JsonProperty 注解
如果 json field 的名稱和Pojo 的屬性名不一致的時, 可以用 @JsonProperty 來注解 getter() 或 setter() 方法, 該注解設(shè)定json 對應(yīng)的屬性名, 另外@JsonProperty也經(jīng)常用來注解構(gòu)造子的形參, 這時候構(gòu)造子應(yīng)該加@JsonCreator 注解.
3. @JsonCreator 注解
如果 Pojo 類定義有參數(shù)的構(gòu)造子, 但沒有提供無參構(gòu)造子時, 在反序列化時是會報錯. 有下面兩個辦法:
- 方法1：增加一個無參構(gòu)造子
- 方法2：為這個有參數(shù)的構(gòu)造子, 加上 @JsonCreator 注解, 同時參數(shù)需要加上 @JsonProperty 注解.
4. @JsonSetter 和 @JsonGetter 注解
如果 json field 的名稱和Pojo 的屬性名不一致的時, 可以使用@JsonGetter來注解 getter(), 使用 @JsonSetter 來注解setter() 方法. 這兩個注解都可以指定一個屬性名. 這兩個注解都可以用 @JsonProperty 替換.
5. @JsonAnySetter 注解
一般對象屬性名都是確定的, 比如 Car 這個對象, 有 brand/price 等具名屬性, 但有時候我們還需要為Car這個對象設(shè)定一些擴(kuò)展屬性, 這些擴(kuò)展屬性名稱暫時不好確定, 通常使用 Map<String, String> 來存放這些擴(kuò)展屬性的K/V. 要把json 數(shù)據(jù)中的這些屬性反序列化到類的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 數(shù)據(jù)反序列化到Map中:
{
"brand":"Benz",
"attr2":"val2",
"attr1":"val1"
}6. @JsonAnyGetter 注解
和@JsonAnySetter 注解相對應(yīng), 如果要將類中的Map K/V屬性序列化到j(luò)son中, 需要在類上增加一個 @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注解可以為類屬性設(shè)定專門的序列化函數(shù), @JsonDeserialize注解用來為json屬性定制化反序列化函數(shù)
SpringBoot序列化規(guī)則
Include.Include.ALWAYS默認(rèn)Include.NON_DEFAULT屬性為默認(rèn)值不序列化Include.NON_EMPTY屬性為 空（“”） 或者為 NULL 都不序列化Include.NON_NULL屬性為NULL 不序列化
1.全局設(shè)置
/**
* 〈返回json空值去掉null和""〉 〈功能詳細(xì)描述〉
*
* @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對象進(jìn)行設(shè)置，所有序列化的對象都將按改規(guī)則進(jìn)行系列化
// Include.Include.ALWAYS 默認(rèn)
// Include.NON_DEFAULT 屬性為默認(rèn)值不序列化
// 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_null2.局部設(shè)置
在需要設(shè)置的實體類或者字段上加上注解
@JsonInclude(Include.NON_NULL)
3.自定義局部序列化
（1）、自定義一個序列化工具類，需要實現(xiàn)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值的處理，或者轉(zhuǎn)換
@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 轉(zhuǎn)換 序列化
SpringBoot返回Json數(shù)據(jù)中null值處理，將字符串類型null值轉(zhuǎn)換為""，將集合數(shù)組類型null值轉(zhuǎn)換為[]，將原始數(shù)據(jù)類型null值轉(zhuǎn)換為0，將布爾類型null值轉(zhuǎn)換為false，將實體對象null值轉(zhuǎn)換為{}。
（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 {
/**
* 處理數(shù)組集合類型的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("");
}
}
/**
* 處理數(shù)值類型的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.當(dāng)序列化類型為數(shù)組集合時，當(dāng)值為null時，序列化成[]
* 2.String類型值序列化為""
*
* </pre>
*/
public class MyBeanSerializerModifier extends BeanSerializerModifier {
@Override
public List<BeanPropertyWriter> changeProperties(SerializationConfig config,
BeanDescription beanDesc,
List<BeanPropertyWriter> beanProperties) {
// 循環(huán)所有的beanPropertyWriter
for (int i = 0; i < beanProperties.size(); i++) {
BeanPropertyWriter writer = beanProperties.get(i);
// 判斷字段的類型，如果是數(shù)組或集合則注冊nullSerializer
if (isArrayType(writer)) {
// 給writer注冊一個自己的nullSerializer
writer.assignNullSerializer(new CustomizeNullJsonSerializer.NullArrayJsonSerializer());
}
if (isStringType(writer)) {
writer.assignNullSerializer(new CustomizeNullJsonSerializer.NullStringJsonSerializer());
}
}
return beanProperties;
}
/**
* 是否是數(shù)組
*/
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);
}
/**
* 是否是數(shù)值類型
*/
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;
}
}以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關(guān)文章
在很多情況下我們都需要將一個對象轉(zhuǎn)換為String類型。一般來說有三種方法可以實現(xiàn)：Object.toString()、(String)Object、String.valueOf(Object)。下面對這三種方法一一分析2013-11-11
《Pong》是美國雅達(dá)利公司（ATARI）開發(fā)的視頻游戲，該作模擬了兩個打乒乓球的人，就是在兩條線中間有一個點在動，操縱器就是一個搖桿上有一個按鈕的那種。本文就來用Java Swing制作一個Pong小游戲吧2023-01-01
Java并發(fā)編程中使用Executors類創(chuàng)建和管理線程的用法
這篇文章主要介紹了Java并發(fā)編程中使用Executors類創(chuàng)建和管理線程的用法,文中舉了用其啟動線程和設(shè)置線程優(yōu)先級的例子,需要的朋友可以參考下2016-03-03
SpringBoot基于RabbitMQ實現(xiàn)消息可靠性的方法
RabbitMQ 提供了 publisher confirm 機(jī)制來避免消息發(fā)送到 MQ 過程中丟失,這種機(jī)制必須給每個消息指定一個唯一ID,消息發(fā)送到MQ以后,會返回一個結(jié)果給發(fā)送者,表示消息是否處理成功,本文給大家介紹了SpringBoot基于RabbitMQ實現(xiàn)消息可靠性的方法,需要的朋友可以參考下2024-04-04
在本篇內(nèi)容里小編給大家分享了一篇關(guān)于java多線程數(shù)據(jù)分頁處理實例講解內(nèi)容，有興趣的朋友們可以學(xué)習(xí)下。2021-01-01
linux下idea、pycharm等輸入中文拼音時滿3個字母后無法繼續(xù)拼音輸入的問題
這篇文章主要介紹了linux下idea、pycharm等輸入中文拼音時滿3個字母后無法繼續(xù)拼音輸入的問題,本文通過圖文并茂的形式給大家分享解決方法，需要的朋友可以參考下2021-04-04
idea2020.1無法自動加載maven依賴的jar包問題及解決方法
這篇文章主要介紹了idea2020.1無法自動加載maven依賴的jar包問題及解決方法，本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-07-07
這篇文章主要介紹了Java stringBuilder的使用方法及實例解析,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2019-09-09
這篇文章主要介紹了Java如何修改.class文件變量，幫助大家更好的理解和學(xué)習(xí)Java，感興趣的朋友可以了解下2020-09-09
簡單易懂的java8新特性之lambda表達(dá)式知識總結(jié)
一直想針對lambda表達(dá)式作一個總結(jié),借助于這次公司安排的考試作一個入門式的總結(jié),對正在學(xué)習(xí)java的小伙伴們非常有幫助,需要的朋友可以參考下2021-05-05