Springboot jackSon -序列化-詳解

在項目中有事需要對值為NULL的對象中Field不做序列化輸入配置方式如下：

[配置類型]：

源碼包中的枚舉類：

public static enum Include {
    ALWAYS,
    NON_NULL,
    NON_ABSENT,
    NON_EMPTY,
    NON_DEFAULT,
    USE_DEFAULTS;
 
    private Include() {
    }
}

Include.Include.ALWAYS 默認 
Include.NON_DEFAULT 屬性為默認值不序列化 
Include.NON_EMPTY 屬性為 空（“”） 或者為 NULL 都不序列化 
Include.NON_NULL 屬性為NULL 不序列化

 

方式一：全局配置，處理所有整個應用的實體對象

#對日期類型的轉換配置
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss 

# 配置 參數如下 always non_absent non_default non_empty non_null use_defaults

spring.jackson.default-property-inclusion=non_null   

方式二：在需要序列的話的實體類上加注解 ->[配置類型]所列

@JsonInclude(Include.NON_NULL) 

方式三：配置類型

  3.1自定義序列化實現類，可以作用在類上 自定義json序列化需要實現StdSerializer<T>或者JsonSerializer<T>

@JsonSerialize(using = ClientObjectSerialize.class)
public class CreditBorrowerRepaymentRequestDto{
}

實現類：對字段類型轉換，以及對值為null字段的過濾

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();
    }
}

 3.2自定義序列化實現類，可以作用在實體對象字段上，對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));
    }
}

實踐總結：

一當全局配置了NULL字段過濾的配置，但有的實體對象需要序列化出NULL的字段值，如何處理？

答： 1. 直接在對象上增加 @JsonInclude(JsonInclude.Include.ALWAYS)  類上的注解優先級比較高，會覆蓋全局的配置

         2.用自定義的類序列化注解（同上）

二直接在字段上加自定義序列化類會覆蓋全局配置嗎？

答：不會，有默認的   public class NullSerializer extends StdSerializer<Object> 來處理，當值不為Null的時候才會執行自定義字段上的序列化注解實現類