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屬性定制化反序列化函數

=============================
參考
=============================
https://www.baeldung.com/jackson
https://www.baeldung.com/jackson-annotations