java中对象循环引用的思考

什么是循环引用

​ 循环引用就是循环依赖，就是两个或多个bean相互之前间的持有对方，比如对象CycleA,CycleB两个对象，如果CycleA引用了CycleB实例，CycleB引用了CycleA实例，它们最终反应为一个环

解决办法

1. 使用@JsonIgnore标注在属性或对应的get、set方法上，在序列化的时候将该属性忽略,避免循环引用，但是这种方式在反序列化时，此属性同样会被忽略，不会自动注入。如果需要反序列化时注入该属性，则用下面的方法

2. @JsonBackReference和@JsonManagedReference：这两个标注通常配对使用，通常用在父子关系中。

   • 序列化(serialization)

   @JsonBackReference标注的属性在序列化（serialization，即将对象转换为json数据）时，会被忽略（即结果中的json数据不包含该属性的内容）

   @JsonManagedReference标注的属性则会被序列化。在序列化时，@JsonBackReference的作用相当于@JsonIgnore，此时可以没有@JsonManagedReference。

   • 反序列化（deserialization）

   如果没有@JsonManagedReference，则不会自动注入@JsonBackReference标注的属性（被忽略的父或子）

   如果有@JsonManagedReference，则会自动注入自动注入@JsonBackReference标注的属性。

3. @JsonIgnoreProperties("xxx")标注在属性或对应的get、set方法上,忽略被标对象的某个属性

4. @JsonIdentityInfo(generator=ObjectIdGenerators.IntSequenceGenerator.class, property="id")

• generator:唯一标识的类型

• Property 对象的唯一标识 ，无特殊需求的，一般都是对象的主键

​ jackson从2.0 增加注解@JsonIdentityInfo解决无限递归的问题,这种方法是，如果发现循环引用，在形成环的最后一步，会将被引用的对象置空，序列化后的结果可能会缺失一部分数据，导致数据不完整。如A->B->A , 最后返回的结果是中，A-B->null

jakson解决循环依赖总结

• jackson提供的1，2，3方法，这种方式没有从根本上解决循环引用，只是避开了循环引用。
• 第4种方法是将循环引用形成的环断开，来避免序列化失败，会导数据丢失

血案现场回顾

最近在做一个项目，项目中使用到了图形数据库，从图形数据库中查询数据时候，因为查询返回的图中存在在一个环，导致下列异常

Servlet.service() for servlet [springDispatcherServlet] in context with path [/Shop] threw exception [Request processing failed; 
nested exception is org.springframework.http.converter.HttpMessageNotWritableException: Could not write JSON: Infinite recursion (StackOverflowError) (through reference chain:

看异常内容是因为环导致循环依赖，导致jackson在序列化的时候产生了无限递归。

本文解决方案

因为我遇到的问题是，在查询图形数据库时候存在环，父级子级为同一个对象，数据结构，类似于 GraphNode嵌套GraphNode这样的结构，而且这些结构是接口返回接口的重要数据，无法使用，上述的方法1，2，3，又不允许数据有丢失，所以4的方法也无法使用。

主要解决方法是在第4种方案的基础上，如果发生了A->B-A循环引用的时候，对返回结果整理成A->B->A1，A1是A对象的一个另一个实例，但是A1中保留了接口中必要的属性，引起循环引用的属性置为了空。

查询图时候不使用spring-data-neo4j框架，使用Cypher查询，对查询结果和关系，自己生成一个图结构，然后，对图结果进行遍历，找出图中存在的环，在环最后闭合的时候 ，生成一个新对象A1，被当前对象引用，避开了循环引用。

容易出现循环引用的场景

• [ ] ​ 在一些表设计不合理的系统中存在多对多关系的场景，然后使用JPA、 hibernate去查询时
• [ ] ​ 复杂的接口响应结果,对于一些接口响应结果不够精简，返回复杂的对象，也很容易出现
• [ ] ​ 图形数据库查询，比如，使用spring-data-neo4j 查询结果中有存在环，导致数据返回前端时候序列化失败

解决方案总结

• fastjson解决循环引用，使用的特殊标识代替循环引用对象

• Jackson循环依赖的解决方案不能从根本上解决问题，因为JAVA本身就是一个存在引用的语言，

• 考虑表设计上是否合理，是否存在问题

• 考虑接口的响应结构是否合理

  比如A依赖B，B依赖A中， 实际场景中，A中是不是可以只保留B的主键，B中保留A的主键。来避开循环引用

延伸阅读

java中引用无时无刻不在，在spring框架实例化对象的时候 ，也会出现循环依赖使容器抛出BeanCurrentlyCreationException,导致容器启动失败

spring检测循环依赖

spring窗口将每一个正在创建的bean标识符放在一个“当前创建bean池“，对象在创建过程中一直存在 于这个池中，创建完毕从池中清除掉相应的标识符，如果发现要创建的对象已经在池里存在，则说明发生了循环依赖

spring中循环依赖包括，构造器循环依赖和set方法循环依赖，对于构造器循环依赖是无法解决的，对于 set方法循环依赖，只能解决作用域为单例的循环依赖，通过提前暴露一个刚完成构造器注入，但未完成其它步骤单例工厂方法，让其它bean可以引用到