关于spring:JsonCreator自定义反序列化函数JSON框架Jackson精解第5篇

45次阅读

共计 3208 个字符,预计需要花费 9 分钟才能阅读完成。

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 注解加在构造方法上,能够达到一样的反序列化成果。

欢送关注我的博客,外面有很多精品合集

本文转载注明出处(必须带连贯,不能只转文字):字母哥博客 – zimug.com

正文完
 0