解决FastJson中“$ref 循环引用检测”的问题的几种方式

简介: 解决FastJson中“$ref 循环引用检测”的问题的几种方式

 

一、现象:

项目中用json形式来存储一个集合对象,用fastjson发现多了一些东西:$ref,了解之后才发现是重复引用的问题。

[
  {
    "id":"1",
    "orderList":[
      {
        "id":2,
        "date":"2020-08-17 12:57:21",
        "name":"帽子"
      },
      {
        "id":3,
        "date":"2020-08-17 12:57:21",
        "name":"鞋子"
      }
    ],
    "remarks":""
  },
  {
    "id":"2",
    "orderList":[
      {"$ref":"$[0].orderList[0]"},
      {"$ref":"$[0].orderList[1]"}
    ],
    "remarks":"111"
  },
]

image.gif

二、问题分析:$ref

    • 接口返回的api通过fastjson将实体转化为json字符串时,在传输的数据中如果出现相同的对象,fastjson默认开启引用检测会将相同的对象写成引用的形式
    • 引用是通过"$ref"来表示的
    • 引用分两种,循环引用和重复引用
    引用 描述
    "$ref":".." 上一级
    "$ref":"@" 当前对象,也就是自引用
    "$ref":"$" 根对象
    "$ref":"$.children.0" 基于路径的引用,相当于 root.getChildren().get(0)

    三、循环引用和重复引用

      1. 循环引用:即A对象引用B对象,B对象又引用A对象,这种情况是要极力避免的,因为会导致堆栈溢出(StackOverflowError);
      2. 重复引用:上面的例子就是因为相同的订单对象出现在两个集合中,所以第二个orderList集合中直接返回的是$ref。一般大家在写代码的过程中,如果出现$ref,通常应该是重复引用问题。

      四、$ref问题的解决

      网上能找到的解决方案有:

      1.局部关闭

      将该对象在后端转换为json字符串返回给前端,使用SerializerFeature.DisableCircularReferenceDetect关闭循环引用。

      String jsonString=JSON.toJSONString(object, SerializerFeature.DisableCircularReferenceDetect);

      image.gif

      正常来说,我们的接口返回给前端的是List<Object>这种格式,如果采用这个方式,就要将返回值改为String,不优雅。当然也可以把这个字符串再次转换为对象,这样循环引用的问题就没有了。

      2.全局配置关闭

      可以在SpringBoot项目的json配置中将循环引用关闭。FastJson的.java配置增加以下项:

      fastConverter.setFeatures(SerializerFeature.DisableCircularReferenceDetect);

      image.gif

      但是因为全局配置是在我们项目的基础jar包中配置的,改动基础jar包会有风险,会对前面所有的依赖项目产生影响。所以也不采用这种方式。

      大家想想为什么fastjson默认是开启这个功能的就知道原因了。如果全局关闭,性能也会有极大影响。

      3.new新的对象来避免

      我们可以将List中的对象使用BeanUtil这样的工具,拷贝为新的对象,然后放到新的集合中返回。

      List<Object> orderListNew = new ArrayList<>();
         orderList.forEach(i->{
             Order target=new Order();
             BeanUtils.copyProperties(i,target);
             orderListNew.add(target);
         });
         return orderListNew;

      image.gif

      BeanUtil创建出来的对象跟原来的对象不是同一个对象。需要额外的代码,有点丑。

      4.禁止序列化

      如果循环引用的数据,前端用不到,那可以在实体类对应的字段加注解禁止序列化,这样前端就不会接收到这个字段的引用数据了。

      @JSONField(serialize = false)
        private List<Order> orderList;

      image.gif

      这样在转换的时候,orderList就不会被转换了。

      5.在该字段的注解上指定序列化时关闭循环引用

      但是很多时候,我们又需要这个数据,所以禁止序列化也是不行滴,接下来看另外一种注解解决方式。

      @JSONField(serialzeFeatures = {SerializerFeature.DisableCircularReferenceDetect})
        private List<Object> objectList;

      image.gif

      此种方法才是我项目中的解决办法。

      参考资料:

        1. fastjson:对象转化成json出现$ref_琦彦的博客-CSDN博客
        相关文章
        |
        JSON fastjson Java
        fastjson:对象转化成json出现$ref
        fastjson:对象转化成json出现$ref
        |
        Java 数据库连接 数据库
        探究Java中的MyBatis Plus注解 @TableField:灵活处理字段映射与自动填充
        在数据库操作中,字段映射和字段填充是开发者经常需要处理的问题。MyBatis Plus作为一款优秀的ORM框架,提供了注解 `@TableField`,能够帮助开发者更加灵活地处理字段映射,以及在特定场景下实现自动填充功能。本文将深入探讨 `@TableField` 注解的用法及其在持久层开发中的应用。
        6735 1
        |
        JSON Java 数据格式
        |
        数据可视化 Java Nacos
        OpenFeign + Sentinel 实现微服务熔断限流实战
        本文介绍如何在Spring Cloud微服务架构中,结合OpenFeign与阿里巴巴开源组件Sentinel,实现服务调用的熔断、降级与限流。通过实战步骤搭建user-service与order-service,集成Nacos注册中心与Sentinel Dashboard,演示服务异常熔断、QPS限流控制,并支持自定义限流响应。借助Fallback降级机制与可视化规则配置,提升系统稳定性与高可用性,助力构建健壮的分布式应用。
        1429 155
        |
        前端开发 fastjson Java
        我的字段被FastJson给干掉了?!
        本文记录作者升级到 JDK 11 后遇到的 FastJSON 序列化问题,以及详细的排查过程。
        739 12
        |
        XML Java 测试技术
        使用 @Transactional 控制事务边界:传播和隔离解释
        本文深入解析了 Spring 框架中的 `@Transactional` 注解,重点介绍了事务管理中的传播行为与隔离级别。内容涵盖事务的基本概念、声明式事务管理、回滚机制、传播模式(如 REQUIRED、REQUIRES_NEW 等)及隔离级别(如 READ_COMMITTED、SERIALIZABLE),并通过示例说明如何在实际开发中灵活应用这些特性,以确保数据一致性与系统性能的平衡。适合 Java 开发人员深入理解 Spring 事务机制。
        909 1
        使用 @Transactional 控制事务边界:传播和隔离解释
        |
        存储 JSON fastjson
        再也不用心惊胆战地使用FastJSON了——序列化篇
        本篇将主要介绍json序列化的详细流程。本文阅读的FastJSON源码版本为2.0.31。
        4876 49
        |
        NoSQL Java Redis
        [已解决]报异常java.io.InvalidClassException的解决方法|对象序列化实现Serializable会出现java.io.InvalidClassException的异常
        [已解决]报异常java.io.InvalidClassException的解决方法|对象序列化实现Serializable会出现java.io.InvalidClassException的异常
        |
        Java API 微服务
        微服务——SpringBoot使用归纳——Spring Boot中的切面AOP处理——Spring Boot 中的 AOP 处理
        本文详细讲解了Spring Boot中的AOP(面向切面编程)处理方法。首先介绍如何引入AOP依赖,通过添加`spring-boot-starter-aop`实现。接着阐述了如何定义和实现AOP切面,包括常用注解如`@Aspect`、`@Pointcut`、`@Before`、`@After`、`@AfterReturning`和`@AfterThrowing`的使用场景与示例代码。通过这些注解,可以分别在方法执行前、后、返回时或抛出异常时插入自定义逻辑,从而实现功能增强或日志记录等操作。最后总结了AOP在实际项目中的重要作用,并提供了课程源码下载链接供进一步学习。
        1921 0

        热门文章

        最新文章