如何使用@JsonCreator注解和@ConstructorProperties注解自定義反序列化函數(shù)

如何使用@JsonCreator注解和@ConstructorProperties注解自定義反序列化函數(shù)，針對這個問題，這篇文章詳細介紹了相對應的分析和解答，希望可以幫助更多想解決這個問題的小伙伴找到更簡單易行的方法。

下面為大家介紹在JSON反序列化過程中，如何使用@JsonCreator注解和@ConstructorProperties注解自定義反序列化函數(shù)。

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

對于Jackson的JSON數(shù)據(jù)格式，反序列化過程就是將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在反序列化過程中調用了哪些函數(shù)，給大家介紹一下

• 首先調用反序列化的目標類PlayerStar3的無參構造函數(shù)，構造一個java對象

• 然后調用該類的成員變量的set方法，為該對象的每一個成員變量賦值。

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

二、@JsonCreator注解

默認情況下，Jackson的反序列化過程是上面描述的那樣，使用無參構造函數(shù)及set方法。除此之外，我們還可以使用@JsonCreator注解自定義反序列化的過程，在我們自定義的反序列化函數(shù)里面，我們有更強的靈活性，可以完成更多的非規(guī)定動作。一共有兩種自定義反序列化渠道：

• @JsonCreator注解加在構造方法上

• @JsonCreator注解加在工廠靜態(tài)方法上

使用了@JsonCreator注解之后，將使用該注解標注的方法進行反序列化對象的構造，默認的使用無參構造函數(shù)及set方法進行反序列化的過程失效。

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

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

public class PlayerStar3 {

  private String name;
  private Integer age;
  private String[] hobbies;    //業(yè)余愛好,數(shù)組
  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()方法
}

我們使用第一小節(jié)中的反序列化代碼，將jsonInString反序列化構造PlayerStar3對象，控制臺輸出結果如下(對象的toString()方法輸出)：

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

在 @JsonCreator標注的構造方法里面下斷點，也的確證明在java 對象反序列化構造的過程中使用的是該方法。

2.2.@JsonCreator注解加在工廠靜態(tài)方法上

除了可以將@JsonCreator加在構造方法上，還可以使用靜態(tài)工廠函數(shù)反序列化構造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注解加在工廠靜態(tài)方法上，可以達到一樣的反序列化效果。

三、@ConstructorProperties注解

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

@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注解加在構造方法上，可以達到一樣的反序列化效果。

關于如何使用@JsonCreator注解和@ConstructorProperties注解自定義反序列化函數(shù)問題的解答就分享到這里了，希望以上內容可以對大家有一定的幫助，如果你還有很多疑惑沒有解開，可以關注億速云行業(yè)資訊頻道了解更多相關知識。