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

最近下作成绩分析的功能的时候，出现了$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>  
                        <!-- 全局关闭循环引用检查，最好是不要关闭，否则有可能会StackOverflowException -->
                        <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的“循环引用检测”特性的对比

如今的问题：

全局关闭引用检测确实是方便，可是有可能的之后的代码愈来愈多的状况出现StackOverflowError。可是局部的关闭引用检测的话也有些小问题。JSON.toJSONString(object, SerializerFeature.DisableCircularReferenceDetect) 这个方法是把对象转为String对象，若是在@ResponseBody注解的方法里返回这个String对象的话，就会像我以前那篇文章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默认开启引用检测的缘由。

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

一、重复引用
能够向上面的代码同样，建立新的对象，把要有重复须要的对象的属性复制给新对象，新对象再添加到json那里。
二、循环引用
循环引用这种逻辑自己就不合理，须要在编码时注意避免，这是逻辑错误而非编码技巧。

做者：carway 连接：https://www.jianshu.com/p/6041242405e8 來源：简书 简书著做权归做者全部，任何形式的转载都请联系做者得到受权并注明出处.