fastjson 返回 $ref 数据

Myth丶恋晨 2024-03-26 18:55 98阅读 0赞

#### 文章目录 ####

*  问题描述：
 *   *  1、重复引用：
     *  2、循环引用：
 *  原因分析：
 *   *  1、重复引用：
     *  2、循环引用：
 *  反序列化：
 *   *  1、开启引用检测：
     *  2、关闭引用检测：
 *  小结：

--------------------

## 问题描述： ##

问题现象：

> 通过 fastjson 序列化的结果是这样的：`[{"name":"张三"},{"$ref":"$[0]"}]`

即 序列化结果中，出现了 $ref 这类引用信息，首先猜测是由于某些规则的限制导致。

我们来演示下问题是如何出现的，先定义实体类：

data class Person(
        var name: String,
        var rel: Person? = null
    )

### 1、重复引用： ###

@Test
        fun test() {
        
            val parseObject = JSONObject.parseObject("{\"name\":\"张三\"}")
    
            val list: ArrayList<JSONObject> = Lists.newArrayList()
    
            list.add(parseObject)
            list.add(parseObject)
    
            println(JSONArray.toJSONString(list))
    
        }

输出：`[{"name":"张三"},{"$ref":"$[0]"}]`

### 2、循环引用： ###

简单来说就是 A 引用了 B，B 又引用了 A，造成了环形依赖，fastjson 默认会处理成 引用的形式，总之，不会抛错：

@Test
        fun test() {
        
            val a = Person(name = "zs")
            val b = Person(name = "lisi")
            a.rel = b
            b.rel = a
            
            println(JSONArray.toJSONString(Lists.newArrayList(a, b)))
        }

输出：`[{"name":"zs","rel":{"name":"lisi","rel":{"$ref":".."}}},{"$ref":"$[0].rel"}]`

--------------------

## 原因分析： ##

先说结论：序列化结果中出现 $ref 这类关键字，是由 fastjson 特定的规则决定的。为什么要这样设计？

主要原因是循环引用本身就是错误的写法，你引用我、我引用你，什么时候到头？

所以，fastjson 就会直接往外抛 StackOverFlow 异常。虽然没得问题，但还是不算友好，为此，要想一种方法解决循环依赖的问题，这个部分在 fastjson 中就设计了 `引用检测机制`，并默认开启。

我们来看看有哪些解决方法：

### 1、重复引用： ###

这个能解决：

*  如果你代码写错了，本身不应该出现重复引用的情况，请直接改代码！
 *  如果你确实有重复引用这个需求，使用 SerializerFeature.DisableCircularReferenceDetect 特性关闭引用检测

改正后：

输出：`[{"name":"张三"},{"name":"张三"}]`

### 2、循环引用： ###

这个没法解决。循环引用本身就不该出现，这个时候你只能改正你的代码。

这里，我们把 SerializerFeature.DisableCircularReferenceDetect 特性关掉，然后看看效果：

@Test
        fun test() {
        
            val a = Person(name = "zs")
            val b = Person(name = "lisi")
            a.rel = b
            b.rel = a
    
            println(JSONArray.toJSONString(Lists.newArrayList(a, b), SerializerFeature.DisableCircularReferenceDetect))
        }

直接抛出了异常：

java.lang.StackOverflowError
    	at java.base/java.lang.String.getChars(String.java:863)
    	at com.alibaba.fastjson.serializer.SerializeWriter.writeFieldValueStringWithDoubleQuoteCheck(SerializeWriter.java:1884)
    	at com.alibaba.fastjson.serializer.ASMSerializer_1_Person.writeDirectNonContext(Unknown Source)
    	at com.alibaba.fastjson.serializer.ASMSerializer_1_Person.writeDirectNonContext(Unknown Source)
    	at com.alibaba.fastjson.serializer.ASMSerializer_1_Person.writeDirectNonContext(Unknown Source)
    	at com.alibaba.fastjson.serializer.ASMSerializer_1_Person.writeDirectNonContext(Unknown Source)
    	at com.alibaba.fastjson.serializer.ASMSerializer_1_Person.writeDirectNonContext(Unknown Source)
    	at com.alibaba.fastjson.serializer.ASMSerializer_1_Person.writeDirectNonContext(Unknown Source)
    	at com.alibaba.fastjson.serializer.ASMSerializer_1_Person.writeDirectNonContext(Unknown Source)
    	
    	...

## 反序列化： ##

fastjson 提供了这套引用机制，对相同的引用使用了 $ref 来代替，如果用这样的序列化结果，再反序列化，会得到什么样的效果？

### 1、开启引用检测： ###

即，我们直接使用 `[{"name":"张三"},{"$ref":"$[0]"}]` 字符串反序列化：

![在这里插入图片描述][b0f0efce3618444b96ba62dd23da8180.png]

可以直观的看到，得到的是同一个引用对象。

### 2、关闭引用检测： ###

即，直接使用 `[{"name":"张三"},{"name":"张三"}]` 进行序列化：

![在这里插入图片描述][206204531ae547c3a1cabdaff778db86.png]

可以看到，得到的就是不同的对象了。

--------------------

## 小结： ##

对于重复引用，加上SerializerFeature.DisableCircularReferenceDetect 可以解决 $.ref 显示问题。

对于循环引用，加上SerializerFeature.DisableCircularReferenceDetect 会抛 SOF 异常，没法解决，只能修改代码

[b0f0efce3618444b96ba62dd23da8180.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/2644ad68db664ba7a6232fa8d6c00f62.png
[206204531ae547c3a1cabdaff778db86.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/8622a7e6ede147ed9844063c3e372b21.png