【FastJSON】解决FastJson中“$ref 循环引用”的问题

本文详细介绍了如何解决FastJson在序列化多对一关系时遇到的循环引用问题,通过禁用循环引用检测和禁止对象获取集合数据的方法,实现了在前后端交互中正确获取贷款人信息的过程。

【需求与环境描述】

0、开发环境

  SSH,EasyUI,MySQL 

1、需求要求:

  (1)首先获取所有的贷款订单数据,即List <LoanOrder>。

  (2)然后从单个贷款订单实体LoanOrder去访问贷款人实体Loaner的信息。 

2、实体之间的关系描述

  (1)LoanOrder实体与Loaner实体是双向的多对一和一对多关系。

  (2)LoanOrder是“多方”,其中的关系属性为“private Loaner loaner”。

  (3)Loaner是“一方”,其中的关系属性为“Set<LoanOrder> orders”。 

3、代码示例

  (1) 贷款订单LoanOrder代码

1
2
3
4
5
6
7
8
9
10
11
12
13
<span style= "font-family: 'Microsoft YaHei';" > @Entity
@Table (name =  "t_bp_loan_order" )
public  class  LoanOrder  implements  java.io.Serializable {
     
     /*省略其他次要属性*/
     private  Loaner loaner;
 
     @ManyToOne (fetch = FetchType.LAZY)
     @JoinColumn (name =  "LOANER_ID" )
     public  Loaner getLoaner() {
         return  this .loaner;
     }
}</span>

  (2) Loaner方代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
<span style= "font-family: 'Microsoft YaHei';" > @Entity
@Table (name =  "t_bp_loaner" )
public  class  Loaner  implements  java.io.Serializable {
 
     /* 其他普通属性略去 */
     private  Set<LoanOrder> loanOrders =  new  HashSet<LoanOrder>( 0 );
 
     @OneToMany (fetch = FetchType.LAZY, mappedBy =  "loaner" )
     @JSONField (serialize =  true )
     public  Set<LoanOrder> getLoanOrders() {
         return  this .loanOrders;
     }
}
</span>

 

【障碍再现】

1、需求01:

首先获取所有的贷款订单数据,即List <LoanOrder>,发现贷款人“张三”有两个订单。

 

2、需求02:

  然后,依次在第一个和第二个贷款订单中点击“张三”,从而去访问“名字叫做‘张三’”贷款人实体Loaner的信息。

结果,第一个订单可以显示贷款人的数据,但是在第二个订单数据中,不能获取到“loaner(贷款人)”的数据,并且loaner中提示“$ref”。

经过两次点击后,服务器后台传送到前台页面上的JSON数据如下所示:

 

【解决方案】

第一步:禁用FastJson的“循环引用检测”特性。

1、核心代码

 

2、作用

决定了生成的“多个”JSON对象中,是否加载被引用的同一个对象的数据。

在此,决定了生成的“多个”贷款订单JSON对象中,是否加载被引用的同一个贷款人JSON对象的数据。

 

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

 

当从服务器端传来的多个LoanOrder对象通过FASTJSON被序列化到“前端”后,会被浏览器解析成“DOM”对象。 

(1) 开启FastJson的“循环引用检测”特性时:

1)对于第一个LoanOrder 01,fastjson会完全解析并加载它的所有数据,包括它所关联的Loaner贷款人信息,如下图所示。

 

2) 对于第二个LoanOrder 02,fastjson仅仅解析并加载其贷款订单部分的数据,对于“$ref”所指向的 Loaner贷款人的数据,fastjson会因为“开启了fastJson的‘循环引用检测’机制”而不去加载该贷款人数据。

当加载第二个贷款订单数据时,fastjson检测到已经在第一个订单LoanOrder 01中加载了“贷款人Loaner”的数据,fastjson会因为“开启了‘循环引用检测’机制”而不去再次加载该贷款人数据,而仅仅将一个指向第一个贷款订单LoanOrder01中“贷款人”的引用赋值给第二个贷款订单中的贷款人的位置。

因此,在生成的第二个贷款订单的JSON串中,对于贷款人信息,仅仅只有一个“$ref”。

而jQuery这个前端技术又无法解析该引用,因此,就无法读取贷款人的数据,如下图所示。

 

第二步:禁止Loaner对象获取Set<LoanOrder>的数据。

方法一:将原来的“双向关系”修改为“单向关系”

1、原来:LoanOrder与Loaner之间是双向关系。

2、修改后:只能从LoanOrder访问Loaner,从Loaner无法访问到LoanOrder。

3、具体方法01

       重要前提:不删除Loaner中的“Set<LoanOrder> orders”属性。

  注意,若在采用注解映射实体类的方式中,没有使用“@Transient”注解,则数据库会报错。

4、具体方法02

       直接删除“Set<LoanOrder> orders”属性极其相关的setter()和getter()方法。

      

方法二:不修改关系的前提下,禁止序列化

在不修改LoanOrder和Loaner双向关系的情况下,Loaner对象中的Set<LoanOrder>集合完成数据的加载,当其向前端Browser传递JSON数据时,禁止序列化Set<LoanOrder>集合。

具体方法:

设置注解“@JSONField(serialize = false)”。

说明:

A.“@JSONField”是fastjson提供的注解标签,其作用为控制其所标注的属性“能否被序列化”。

B.在此其作用为:禁止"loanOrders"这个Set集合被序列化。

具体如下图所示。

 

 

【解决后的效果】 

 

读者如要转载,请标明出处和作者名,谢谢。
地址01:http://space.itpub.net/25851087
地址02:http://www.cnblogs.com/zjrodger

作者名:zjrodger  

<think>首先,用户的问题是关于FastJSON中出现"$ref"问题的原因及解决方案。根据系统指令,我需要使用中文回答,确保回答结构清晰,并引用提供的参考内容。 关键点从引用中提取: - 引用[^1]:提到"$ref"是由于FastJSON在重复引用循环引用时产生的,目的是为了性能优化。 - 引用[^2]:详细解释了"$ref"是FastJSON默认开启引用检测的结果,会导致相同的对象被写成引用形式。给出了循环引用和重复引用的区别,并提供了示例。 - 引用[^3]:提供了解决方案,包括通过配置FastJsonConfig来禁用某些特性,如设置SerializerFeature。 - 引用[^4]:展示了如何通过禁用循环引用检测来解决这个问题。 现在,构建回答结构: 1. **解释问题原因**:基于引用,说明"$ref"是由于FastJSON引用检测特性导致的,当有重复引用循环引用时,会生成"$ref"标记。 2. **提供解决方案**: - 禁用循环引用检测:使用`SerializerFeature.DisableCircularReferenceDetect`。 - 全局配置:在Spring项目中配置FastJsonHttpMessageConverter。 - 其他建议:避免在数据结构中出现重复对象。 3. **添加相关问题**:根据指令,生成相关问题。 确保回答格式: - 行内数学表达式用$...$(但这里可能不涉及数学)。 - 独立公式用$$...$$(同样,可能不适用)。 - 代码块用```包裹。 - 引用末尾添加引用标识,如[^1]。 最终回答大纲: - 开头简述问题。 - 原因部分。 - 解决方案部分,包括代码示例。 - 相关问题。</think>### FastJSON 出现 "$ref" 问题的原因及解决方案 在使用 FastJSON 序列化 Java 对象为 JSON 字符串时,如果遇到输出中包含 `$ref` 标记(例如 `"$ref":"$[0].orderList[0]"`),这通常是由 FastJSON引用检测机制引起的。以下是详细的原因分析和解决方案,基于实际开发中的常见场景。 #### 一、问题原因 FastJSON 默认启用了引用检测特性,旨在优化性能(减少重复对象的序列化开销)[^1]。当 JSON 数据结构中出现重复引用循环引用时,FastJSON 会自动生成 `$ref` 标记来替代重复对象,以避免无限递归或数据冗余[^2]。 - **重复引用**:同一个对象实例在多个地方被引用(例如,一个 `HashMap` 对象被多个列表引用)。FastJSON 会为后续引用生成 `$ref` 路径,而不是重新序列化整个对象[^2]。 - **循环引用**:对象 A 引用对象 B,而对象 B 又引用对象 A(可能导致堆栈溢出错误)。但 `$ref` 问题更常见于重复引用场景[^2]。 例如,在以下代码中,`list2` 包含两个相同的 `map1` 对象,序列化后会输出 `$ref`: ```java import com.alibaba.fastjson.JSON; import java.util.ArrayList; import java.util.HashMap; import java.util.List; public class Main { public static void main(String[] args) { HashMap<String, String> map1 = new HashMap<>(); map1.put("key", "value"); List<HashMap<String, String>> list2 = new ArrayList<>(); list2.add(map1); list2.add(map1); // 重复引用同一个对象 System.out.println(JSON.toJSONString(list2)); // 输出: [{"key":"value"},{"$ref":"$[0]"}] } } ``` 这会导致前端解析 JSON 时出错,因为 `$ref` 不是标准 JSON 格式[^1][^2]。 #### 二、解决方案 解决 `$ref` 问题的核心是禁用 FastJSON引用检测特性。以下是两种常用方法: ##### 1. **局部禁用(推荐)** 在序列化时显式添加 `SerializerFeature.DisableCircularReferenceDetect` 参数。这仅影响当前序列化操作,避免全局配置的潜在风险[^4]。 ```java import com.alibaba.fastjson.JSON; import com.alibaba.fastjson.serializer.SerializerFeature; public class Solution { public static void main(String[] args) { // 示例对象(同上) HashMap<String, String> map1 = new HashMap<>(); map1.put("key", "value"); List<HashMap<String, String>> list2 = new ArrayList<>(); list2.add(map1); list2.add(map1); // 禁用引用检测 String json = JSON.toJSONString(list2, SerializerFeature.DisableCircularReferenceDetect); System.out.println(json); // 输出: [{"key":"value"},{"key":"value"}],无$ref } } ``` - **优点**:简单直接,适用于特定场景。 - **缺点**:需在每个序列化调用处添加参数[^4]。 ##### 2. **全局禁用(谨慎使用)** 在 Spring Boot 项目中,通过配置 `FastJsonConfig` 全局禁用引用检测。但需注意,这可能引发循环引用问题(如堆栈溢出)[^3]。 ```java import com.alibaba.fastjson.serializer.SerializerFeature; import com.alibaba.fastjson.support.config.FastJsonConfig; import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.http.converter.HttpMessageConverter; import java.util.List; @Configuration public class FastJsonConfig { @Bean public HttpMessageConverter<?> fastJsonConverter() { FastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter(); FastJsonConfig config = new FastJsonConfig(); // 禁用引用检测 config.setSerializerFeatures(SerializerFeature.DisableCircularReferenceDetect); converter.setFastJsonConfig(config); return converter; } } ``` - **优点**:一劳永逸,适用于整个项目。 - **缺点**:可能掩盖循环引用错误,导致程序崩溃;建议仅在确认无循环引用时使用[^3]。 ##### 3. **其他优化建议** - **避免重复对象**:重构代码,确保集合中不包含相同实例(例如,使用 `new` 创建新对象)。 - **使用 `@JSONField(serialize = false)`**:对特定字段禁用序列化,减少引用机会。 - **升级 FastJSON**:新版 FastJSON 可能优化了引用检测逻辑。 #### 三、注意事项 - **性能权衡**:禁用引用检测会增加序列化开销(尤其是大对象),但能保证 JSON 兼容性[^1][^4]。 - **测试覆盖**:修改后需测试循环引用场景,避免 `StackOverflowError`[^2]。 - **前端兼容**:确保前端库(如 JavaScript 的 `JSON.parse()`)能处理无 `$ref` 的标准 JSON[^1]。 通过以上方法,您可以有效解决 FastJSON 中的 `$ref` 问题。如果涉及循环引用,建议重构数据结构以避免相互依赖[^2]。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值