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

Jackson是Spring Boot(SpringBoot)默认的JSON数据处理框架，但是其并不依赖于任何的Spring 库。有的小伙伴以为Jackson只能在Spring框架内使用，其实不是的，没有这种限制。它提供了很多的JSON数据处理方法、注解，也包括流式API、树模型、数据绑定，以及复杂数据类型转换等功能。它虽然简单易用，但绝对不是小玩具，更多的内容我会写成一个系列，5-10篇文章，请您继续关注我。

• 《序列化与反序列化核心用法-JSON框架Jackson精解第1篇》
• 《特殊数据格式处理-JSON框架Jackson精解第2篇》
• 《属性序列化自定义排序与字母表排序-JSON框架Jackson精解第3篇》
• 《@JacksonInject与@JsonAlias注解-JSON框架Jackson精解第4篇》

本节继续为大家介绍在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注解加在构造方法上，可以达到一样的反序列化效果。