使用fastjson时出现$ref: "$.list[2]"的解决办法（重复引用）

港控/mmm° 2022-04-25 01:28 580阅读 0赞

作者：carway  
链接：https://www.jianshu.com/p/6041242405e8  
来源：简书

最近下做成绩分析的功能的时候，出现了$ref: "$.list\[2\]"的情况。  
然后我查了一下出现这种情况的原因和解决办法。

出现$ref: "$.list\[2\]"的原因是因为循环引用/内存对象重复

那么什么是重复/循环引用？

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

举例说明

重复引用

List<Object> list = new ArrayList<>();  
    Object obj = new Object();  
    list.add(obj);  
    list.add(obj);

循环引用

// 循环引用的特殊情况，自引用  
    Map<String,Object> map = new HashMap<>();  
    map.put("map",map);  
    //  
    // map1引用了map2，而map2又引用map1，导致循环引用  
    Map<String,Object> map1 = new HashMap<>();  
    Map<String,Object> map2 = new HashMap<>();  
    map1.put("map",map2);  
    map2.put("map",map1);

循环引用会触发的问题

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

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

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

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

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

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

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

[  
        {},  //obj的实体  
        {  
            "$ref": "$[0]"   //对obj的重复引用的处理  
        }  
    ]

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

{  
    // map1的key:value对  
        "map": {  
             // map2的key:value对  
            "map": {  
                 // 指向map1，对循环引用的处理  
                "$ref": ".."  
            }  
        }  
    }

引用标识说明：

“$ref”:”..” 上一级  
“$ref”:”@” 当前对象，也就是自引用  
“$ref”:”$” 根对象  
\{"$ref":"../.."\} 引用父对象的父对象  
“$ref”:”$.children.0” 基于路径的引用，相当于root.getChildren().get(0)

解决方法：

知道出现的原因后，我发现我写那个接口是确实有重复引用的，因为需求要有个最低科的详细情况，还有挂科的各个科详细情况，所以当某个学生挂科了，那么他最低科和挂科的那个list里面的对象就重复了。当时这个需求是这样，也只能寻找其他方法了。

关闭FastJson的引用检测  
查看一下fastjson的API，有两种关闭方法。

局部的

JSON.toJSONString(object, SerializerFeature.DisableCircularReferenceDetect);

全局的

普通的spring项目的话，用xml配置

<mvc:annotation-driven>  
            <mvc:message-converters register-defaults="true">  
                <bean  
                    class="com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter">  
                    <property name="supportedMediaTypes">  
                        <array>  
                            <value>text/html;charset=UTF-8</value>  
                        </array>  
                    </property>  
                    <property name="features">  
                        <array>  
                            <value>WriteMapNullValue</value>  
                            <value>WriteNullStringAsEmpty</value>  
                            
                            <value>DisableCircularReferenceDetect</value>
                        </array>  
                    </property>  
                </bean>  
            </mvc:message-converters>  
        </mvc:annotation-driven>

如果springboot的话

public class FastJsonHttpMessageConverterEx extends FastJsonHttpMessageConverter{
        public FastJsonHttpMessageConverterEx(){
            //在这里配置fastjson特性(全局设置的)
            FastJsonConfig fastJsonConfig = new FastJsonConfig();
            //fastJsonConfig.setDateFormat("yyyy-MM-dd HH:mm:ss");    //自定义时间格式
            //fastJsonConfig.setSerializerFeatures(SerializerFeature.WriteMapNullValue);  //正常转换null值
            //fastJsonConfig.setSerializerFeatures(SerializerFeature.DisableCircularReferenceDetect);     //关闭循环引用
            this.setFastJsonConfig(fastJsonConfig);
        }
    
        @Override
        protected boolean supports(Class<?> clazz) {
            return super.supports(clazz);
        }
    }
    
    @Configuration
    public class WebMvcConfigurer extends WebMvcConfigurerAdapter {
        .....
        @Bean
        public FastJsonHttpMessageConverterEx fastJsonHttpMessageConverterEx(){
            return new FastJsonHttpMessageConverterEx();
        }
    }

配置这个DisableCircularReferenceDetect的作用是：决定了生成的“多个”JSON对象中，是否加载被引用的同一个对象的数据。

开启和关闭FastJson的“循环引用检测”特性的对比

![Image 1][]

开启和关闭FastJson的“循环引用检测”特性的对比.png

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

现在的问题：

全局关闭引用检测确实是方便，但是有可能的以后的代码越来越多的情况出现StackOverflowError。但是局部的关闭引用检测的话也有些小问题。JSON.toJSONString(object, SerializerFeature.DisableCircularReferenceDetect) 这个方法是把对象转为String对象，如果在@ResponseBody注解的方法里返回这个String对象的话，就会像我之前那篇文章[springMVC源码分析--HttpMessageConverter（三）之写write操作][springMVC_--HttpMessageConverter_write]所说那些样  
在加了@ResponseBody注解的Controller中使用

String result = JSON.toJSONString(obj);
    return result;

这种情况就相当于JSON.toJSONString() 这句话执行了两次。  
当然你也可以HttpServletResponse 输出流的方法输出这个字符串，不然为了代码风格统一，还是不采用这种。

有没有更好的解决方法？最终还回到那个原因上，因为我们重复引用同一个对象，所以现在解决方法应该是把那个挂科成绩对象score 转到另外一个新的对象。

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

**BeanUtils**可以通过反射机制将两个对象进行属性的拷贝，但是他们不是指向同一个地址，相当好用，假如你的bean有很多个属性，你就不用逐个复制属性了。

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

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

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

1、重复引用  
可以向上面的代码一样，创建新的对象，把要有重复需要的对象的属性复制给新对象，新对象再添加到json那里。  
2、循环引用  
循环引用这种逻辑本身就不合理，需要在编码时注意避免，这是逻辑错误而非编码技巧。

参考文章：

[http://www.cnblogs.com/zjrodger/p/4630237.html][http_www.cnblogs.com_zjrodger_p_4630237.html]  
[http://blog.csdn.net/z714359830/article/details/51527066][http_blog.csdn.net_z714359830_article_details_51527066]  
[http://blog.csdn.net/weixiaodedao/article/details/51790790][http_blog.csdn.net_weixiaodedao_article_details_51790790]

作者：carway  
链接：https://www.jianshu.com/p/6041242405e8  
来源：简书  
若文章涉及侵权，请联系我删除。

[Image 1]: 
[springMVC_--HttpMessageConverter_write]: https://www.jianshu.com/p/6de5f84a1d85
[http_www.cnblogs.com_zjrodger_p_4630237.html]: https://link.jianshu.com?t=http://www.cnblogs.com/zjrodger/p/4630237.html
[http_blog.csdn.net_z714359830_article_details_51527066]: https://link.jianshu.com?t=http://blog.csdn.net/z714359830/article/details/51527066
[http_blog.csdn.net_weixiaodedao_article_details_51790790]: https://link.jianshu.com?t=http://blog.csdn.net/weixiaodedao/article/details/51790790