@JsonCreator自定義反序列化函式-JSON框架Jackson精解第5篇

字母哥部落格發表於2020-09-23
JSON函式框架

Jackson是Spring Boot(SpringBoot)預設的JSON資料處理框架，但是其並不依賴於任何的Spring 庫。有的小夥伴以為Jackson只能在Spring框架內使用，其實不是的，沒有這種限制。它提供了很多的JSON資料處理方法、註解，也包括流式API、樹模型、資料繫結，以及複雜資料型別轉換等功能。它雖然簡單易用，但絕對不是小玩具，更多的內容我會寫成一個系列，5-10篇文章，請您繼續關注我。

本節繼續為大家介紹在JSON反序列化過程中，如何使用@JsonCreator註解和@ConstructorProperties註解自定義反序列化函式。

一、Jackson反序列化過程做了什麼？

對於Jackson的JSON資料格式，反序列化過程就是將JSON字串反序列化為java 物件。

ObjectMapper mapper = new ObjectMapper();

//將JSON字串反序列化為java物件
String jsonInString = "{\"name\":\"喬丹\",\"age\":45,\"hobbies\":[\"高爾夫球\",\"棒球\"]}";
PlayerStar3 jordan = mapper.readValue(jsonInString, PlayerStar3.class);

System.out.println(jordan);

預設情況下，Jackson在反序列化過程中呼叫了哪些函式，給大家介紹一下

  • 首先呼叫反序列化的目標類PlayerStar3的無參建構函式，構造一個java物件
  • 然後呼叫該類的成員變數的set方法，為該物件的每一個成員變數賦值。

所以預設情況下，一個Java類使用Jackson做反序列化，必須有public無參建構函式(java中不寫也預設有)，必須有成員變數的set方法。

二、@JsonCreator註解

預設情況下，Jackson的反序列化過程是上面描述的那樣，使用無參建構函式及set方法。除此之外，我們還可以使用@JsonCreator註解自定義反序列化的過程，在我們自定義的反序列化函式裡面，我們有更強的靈活性，可以完成更多的非規定動作。一共有兩種自定義反序列化渠道：

  • @JsonCreator註解加在構造方法上
  • @JsonCreator註解加在工廠靜態方法上

使用了@JsonCreator註解之後，將使用該註解標註的方法進行反序列化物件的構造，預設的使用無參建構函式及set方法進行反序列化的過程失效。

2.1.@JsonCreator註解加在構造方法上

該PlayerStar3對應的JSON字串是第一小節中的jsonInString。下文的建構函式，你希望將哪些屬性值賦值給java 物件的成員變數，你就使用@JsonProperty("salary")去定義它。

public class PlayerStar3 {

  private String name;
  private Integer age;
  private String[] hobbies;    //業餘愛好,陣列
  private List<String> friends;   //  朋友
  private Map<String, BigDecimal> salary; //年收入 Map

  //這段是我們的核心程式碼，使用JsonCreator註解說明該方法是反序列化構造方法。
  @JsonCreator
  public PlayerStar3(@JsonProperty("name") String name,
                     @JsonProperty("age") Integer age,
                     @JsonProperty("hobbies") String[] hobbies,
                     @JsonProperty("friends") List<String> friends,
                     @JsonProperty("salary") Map<String, BigDecimal> salary) {
    this.name = name;
    this.age = age;
    this.hobbies = hobbies;
    this.friends = friends;
    this.salary = salary;
  }

  //這裡省略一個toString()方法
}

我們使用第一小節中的反序列化程式碼，將jsonInString反序列化構造PlayerStar3物件，控制檯輸出結果如下(物件的toString()方法輸出)：

PlayerStar3{name='喬丹', age=45, hobbies=[高爾夫球, 棒球], friends=null, salary=null}

在 @JsonCreator標註的構造方法裡面下斷點，也的確證明在java 物件反序列化構造的過程中使用的是該方法。

2.2.@JsonCreator註解加在工廠靜態方法上

除了可以將@JsonCreator加在構造方法上，還可以使用靜態工廠函式反序列化構造java物件。使用方法如下：

public class PlayerStar3 {

  //  省略若干成員變數的定義,和上文一樣

  @JsonCreator
  public static PlayerStar3 createPlayer(@JsonProperty("name") String name,
                                         @JsonProperty("age") Integer age,
                                         @JsonProperty("hobbies") String[] hobbies,
                                         @JsonProperty("friends") List<String> friends,
                                         @JsonProperty("salary") Map<String, BigDecimal> salary) {
    PlayerStar3 player = new PlayerStar3();  //new 一個java物件
    player.name = name;    //賦值
    player.age = age;
    player.hobbies = hobbies;
    player.friends = friends;
    player.salary = salary;
    return player;
  }
    //這裡省略一個toString()方法
}

使用@JsonCreator註解加在工廠靜態方法上，可以達到一樣的反序列化效果。

三、@ConstructorProperties註解

@ConstructorProperties註解的作用和@JsonCreator註解起到的作用是一致的，但是它只能加在構造方法上，作為反序列化函式。但是它的語法更簡潔，使用起來也更加方便，不用@JsonProperty註解。又提供了靈活性，我們可以在構造方法反序列化過程中，針對該物件做更多的非規定操作。

@ConstructorProperties({"name", "age","hobbies", "friends","salary"})
public PlayerStar3(String name,
                   Integer age,
                   String[] hobbies,
                   List<String> friends,
                   Map<String, BigDecimal> salary) {
  this.name = name;
  this.age = age;
  this.hobbies = hobbies;
  this.friends = friends;
  this.salary = salary;
}

使用@ConstructorProperties註解加在構造方法上，可以達到一樣的反序列化效果。

歡迎關注我的部落格，裡面有很多精品合集

  • 本文轉載註明出處（必須帶連線，不能只轉文字）：字母哥部落格。

覺得對您有幫助的話，幫我點贊、分享！您的支援是我不竭的創作動力！ 。另外，筆者最近一段時間輸出瞭如下的精品內容，期待您的關注。

相關文章