乐趣区

关于spring:Jaskson精讲第7篇类继承关系下的JSON序列化与反序列化JsonTypeInfo

jiezi

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 篇》
  • 《@JsonCreator 自定义反序列化函数 -JSON 框架 Jackson 精解第 5 篇》
  • 《Jaskson 精讲第 6 篇 - 自定义 JsonSerialize 与 Deserialize 实现数据类型转换》

本篇文章是系列文章的第 7 篇，次要是为大家介绍一下，在 Java 类继承的状况下如何实现父类及子类的 JSON 序列化与反序列化。

一、继承关系对象构建

首先构建一个 ClsShape 类示意形态。

public class ClsShape {}

构建一个 ClsCircle 类示意圆形。并增加了一系列的 lombok 注解，Data 示意提供 get、set、toString、hashCode 等办法；EqualsAndHashCode 注解在有继承关系的字类中应用；AllArgsConstructor 和 NoArgsConstructor 别离提供全参和无参构造方法。

@Data
@EqualsAndHashCode(callSuper = true)
@AllArgsConstructor
@NoArgsConstructor
public class ClsCircle extends ClsShape {Integer radius;    // 弧度}

构建一个长方形类 ClsRectangle，成员变量 width 宽度，height 高度。

@Data
@EqualsAndHashCode(callSuper = true)
@AllArgsConstructor
@NoArgsConstructor
public class ClsRectangle extends ClsShape {
  private Integer width;
  private Integer height;
}

构建一个 ClsView 类, 示意画面。画面中有很多的 ClsShape 形态，所以用一个 List 封装。

@Data
public class ClsView {private List<ClsShape> shapes;}

二、序列化与反序列化测试

根底的形态类及画面类写完之后，上面的代码是用来实现：对象到 Json 字符串的序列化过程，和 Json 字符串反序列化为 Java 对象的过程代码。

@Test
void testJSON2Object() throws IOException {ClsRectangle rectangle = new ClsRectangle(7,9); // 构建正方形对象
  ClsCircle circle = new ClsCircle(8); // 构建长方形对象
  List<ClsShape> shapes = new ArrayList<>();  //List< 多种形态 >
  shapes.add(circle);
  shapes.add(rectangle);
  ClsView view = new ClsView();  // 将 List 放入画面 View
  view.setShapes(shapes);

  ObjectMapper mapper = new ObjectMapper();
  System.out.println("-- 序列化 --");
  String jsonStr = mapper.writeValueAsString(view);
  System.out.println(jsonStr);

  System.out.println("-- 反序列化 --");
  ClsView deserializeView = mapper.readValue(jsonStr, ClsView.class);
  System.out.println(deserializeView);

}

大家看最终在控制台的输入后果如下：序列化的过程是失常的，然而反序列化的时候报错了。

-- 序列化 --
{"shapes":[{"radius":8},{"width":7,"height":9}]}

-- 反序列化 --
com.fasterxml.jackson.databind.exc.UnrecognizedPropertyException: Unrecognized field "radius" (class com.example.demo.javabase.ClsShape), not marked as ignorable (0 known properties:])
 at [Source: (String)"{"shapes":[{"radius":8},{"width":7,"height":9}]}"; line: 1, column: 23] (through reference chain: com.example.demo.javabase.ClsView["shapes"]->java.util.ArrayList[0]->com.example.demo.javabase.ClsShape["radius"])

抛出异样的次要起因是咱们用来接管反序列化的后果时，应用的是List<ClsShape>,Java 程序并不明确的晓得，这个 ClsShape 形态是圆形 ClsCircle, 还是正方形 ClsRectangle。所以无奈将字符串正确的反序列化为 java 对象。

三、@JsonTypeInfo注解加到父类定义上

为了解决下面的这种继承关系对象的反序列化呈现的问题，jackson 为咱们提供了 JsonTypeInfo 注解，把它加在父类定义下面即可。

@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS)
public class ClsShape {}

在父类定义下面加上 @JsonTypeInfo 注解之后，序列化与反序列化的输入后果如下。

-- 序列化 --
{"shapes":[{"@class":"com.example.demo.javabase.ClsCircle","radius":8},
{"@class":"com.example.demo.javabase.ClsRectangle","width":7,"height":9}
]}
-- 反序列化 --
ClsView(shapes=[ClsCircle(radius=8), ClsRectangle(width=7, height=9)])

值得注意的是在序列化之后的 java 字符串中，每个 Json 对象都蕴含了一个新的属性 @class, 这也是该对象在继承关系下可能反序列化为正确的 java 对象(@class 的值的类对象) 的关键所在。

四、@JsonTypeInfo注解加到蕴含父类的成员变量下面

@JsonTypeInfo注解不仅能够加在父类的定义下面，也能够加到蕴含父类的成员变量下面。序列化和反序列化的后果和第三大节中的内容是一样的。

@Data
public class ClsView {@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS)
  private List<ClsShape> shapes;
}

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

本文转载注明出处（必须带连贯，不能只转文字）：字母哥博客 – zimug.com

感觉对您有帮忙的话，帮我点赞、分享！您的反对是我不竭的创作能源！。另外，笔者最近一段时间输入了如下的精品内容，期待您的关注。

  • 《手摸手教你学 Spring Boot2.0》
  • 《Spring Security-JWT-OAuth2 一本通》
  • 《实战前后端拆散 RBAC 权限管理系统》
  • 《实战 SpringCloud 微服务从青铜到王者》
  • 《VUE 深入浅出系列》
退出移动版