• Jackson精讲第7篇-类继承关系下的JSON序列化与反序列化JsonTypeInfo


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

    本篇文章是系列文章的第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;
    }
    

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

    • 本文转载注明出处(必须带连接,不能只转文字):字母哥博客

    觉得对您有帮助的话,帮我点赞、分享!您的支持是我不竭的创作动力! 。另外,笔者最近一段时间输出了如下的精品内容,期待您的关注。

  • 相关阅读:
    MY_HOME
    跨站请求伪造CSRF防护方法
    python中的函数参数
    python 中的闭包
    append追加元素绑定事件无效的解决办法
    webservice练习(cxf,axis,httpclient)
    hibernate5 mysql写入中文乱码
    今天面试中遇到的几个sql查询问题
    Eclipse运行maven项目是出现-Dmaven.multiModuleProjectDirectory system property is not set. Check $M2_HOME environment variable and mvn script match.这种问题解决办法
    模拟博客园登录java实现
  • 原文地址:https://www.cnblogs.com/zimug/p/13742920.html
Copyright © 2020-2023  润新知