BA--02 fastjson重複序列化(避免重複引用序列化時顯示$ref)
什麼是重複/迴圈引用
簡單說,重複引用就是一個集合/物件中的多個元素/屬性同時引用同一物件,迴圈引用就是集合/物件中的多個元素/屬性存在相互引用導致迴圈。
舉例說明
-
重複引用
-
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化後的輸出
-
重複引用 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”:”$.children.0” 基於路徑的引用,相當於root.getChildren().get(0)
關閉FastJson的引用檢測
1 |
JSON.toJSONString(object, SerializerFeature.DisableCircularReferenceDetect); |
FastJson提供了SerializerFeature.DisableCircularReferenceDetect這個序列化選項,用來關閉引用檢測。關閉引用檢測後,重複引用物件時就不會被$ref代替,但是在迴圈引用時也會導致StackOverflowError異常。
避免重複引用序列化時顯示$ref
- 在編碼時,使用新物件為集合或物件賦值,而非使用同一物件 不要在多處引用同一個物件,這可以說是一種java編碼規範,需要時刻注意。
- 不要關閉FastJson的引用檢測來避免顯示$ref 引用檢測是FastJson提供的一種避免執行時異常的優良機制,如果為了避免在重複引用時顯示$ref而關閉它,會有很大可能導致迴圈引用時發生StackOverflowError異常。這也是FastJson預設開啟引用檢測的原因。
避免重複/迴圈引用的正確姿勢
-
重複引用
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);
-
迴圈引用 迴圈引用這種邏輯本身就不合理,需要在編碼時注意避免,這是邏輯錯誤而非編碼技巧。
FROM:https://blog.csdn.net/z714359830/article/details/51527066