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 來存放這些擴充屬性的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或JsonSerializer

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 class="brush:php;toolbar:false">
 * 此modifier主要做的事情为：
 * 1.当序列化类型为数组集合时，当值为null时，序列化成[]
 * 2.String类型值序列化为""
 *
 * 

 */ public class MyBeanSerializerModifier extends BeanSerializerModifier {    @Override  public List changeProperties(SerializationConfig config,                BeanDescription beanDesc,               List beanProperties) {   // 循环所有的beanPropertyWriter   for (int i = 0; i  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;
 }
}

以上是SpringBoot之Json的序列化與反序列化問題怎麼解決的詳細內容。更多資訊請關注PHP中文網其他相關文章！