使用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默認開啓引用檢測的原因。

避免重複/循環引用的正確姿勢

1、重複引用
可以向上面的代碼一樣，創建新的對象，把要有重複需要的對象的屬性複製給新對象，新對象再添加到json那裏。
2、循環引用
循環引用這種邏輯本身就不合理，需要在編碼時注意避免，這是邏輯錯誤而非編碼技巧。

作者：carway
鏈接：https://www.jianshu.com/p/6041242405e8
來源：簡書
簡書著作權歸作者所有，任何形式的轉載都請聯繫作者獲得授權並註明出處.