解决fastjson内存对象重复/循环引用json错误

什么是重复/循环引用

简单说，重复引用就是一个集合/对象中的多个元素/属性同时引用同一对象，循环引用就是集合/对象中的多个元素/属性存在相互引用致使循环。

举例说明

1. 重复引用

   1. List<Object> list = new ArrayList<>();  
   2. Object obj = new Object();  
   3. list.add(obj);  
   4. list.add(obj);  

    

2. 循环引用

   1. // 循环引用的特殊状况，自引用  
   2. Map<String,Object> map = new HashMap<>();  
   3. map.put("map",map);  
   4. //  
   5. // map1引用了map2，而map2又引用map1，致使循环引用  
   6. Map<String,Object> map1 = new HashMap<>();  
   7. Map<String,Object> map2 = new HashMap<>();  
   8. map1.put("map",map2);  
   9. map2.put("map",map1);  

    

循环引用会触发的问题

暂时不说重复引用，单说循环引用。
通常来讲，存在循环引用问题的集合/对象在序列化时（好比Json化），若是不加以处理，会触发StackOverflowError异常。

 

分析缘由：

1. 当序列化引擎解析map1时，它发现这个对象持有一个map2的引用，转而去解析map2。解析map2时，发现他又持有map1的引用，又转回map1。如此产生StackOverflowError异常。  

FastJson对重复/循环引用的处理

首先，fastjson做为一款序列化引擎，不可避免的会遇到循环引用的问题，为了不StackOverflowError异常，fastjson会对引用进行检测。

若是检测到存在重复/循环引用的状况，fastjson默认会以“引用标识”代替同一对象，而非继续循环解析致使StackOverflowError。

以上文两例说明,查看json化后的输出

1. 重复引用 JSON.toJSONString(list)

2. [  
3.     {},  //obj的实体  
4.     {  
5.         "$ref": "$[0]"   //对obj的重复引用的处理  
6.     }  
7. ]  

 

     2.循环引用 JSON.toJSONString(map1)

 

1. {  
2. // map1的key:value对  
3.     "map": {  
4.          // map2的key:value对  
5.         "map": {  
6.              // 指向map1，对循环引用的处理  
7.             "$ref": ".."  
8.         }  
9.     }  
10. }  

引用标识说明：

“$ref”:”..” 上一级
“$ref”:”@” 当前对象，也就是自引用
“$ref”:”$” 根对象
“$ref”:”$.children.0” 基于路径的引用，至关于root.getChildren().get(0)

关闭FastJson的引用检测

1	JSON.toJSONString(object, SerializerFeature.DisableCircularReferenceDetect);

FastJson提供了SerializerFeature.DisableCircularReferenceDetect这个序列化选项，用来关闭引用检测。关闭引用检测后，重复引用对象时就不会被$ref代替，可是在循环引用时也会致使StackOverflowError异常。

避免重复引用序列化时显示$ref

1. 在编码时，使用新对象为集合或对象赋值，而非使用同一对象
   不要在多处引用同一个对象，这能够说是一种java编码规范，须要时刻注意。
2. 不要关闭FastJson的引用检测来避免显示$ref
   引用检测是FastJson提供的一种避免运行时异常的优良机制，若是为了不在重复引用时显示$ref而关闭它，会有很大可能致使循环引用时发生StackOverflowError异常。这也是FastJson默认开启引用检测的缘由。

避免重复/循环引用的正确姿式

1. 重复引用

   1 2 3 4 5 6 7 8

   List<Object> list = new ArrayList<>(); Object obj = new Object(); list.add(obj); // 建立新的对象 Object newObj = new Object(); // 使用org.springframework.beans.BeansUtils复制属性值 BeansUtils.copy(obj, newObj); list.add(obj);

2. 循环引用 循环引用这种逻辑自己就不合理，须要在编码时注意避免，这是逻辑错误而非编码技巧。