fastjson:对象转化成json出现$ref

文章介绍了在使用Fastjson时遇到的对象重复引用问题,导致json字符串中出现$ref。分析了循环引用和重复引用的区别,并提供了五种解决方案,包括局部关闭引用检测、全局配置、创建新对象、禁止序列化以及字段注解指定序列化方式。

问题现象

/**
 * fastjson中$ref对象重复引用问题
 */
public class TestFastJson {
 
    List<Person> list = new ArrayList<Person>();
    Person p = new Person("FLY", 25);
 
    /**
     *  测试main
     */
    public static void main(String[] args) {
        new TestFastJson().test1();
 
    }
 
    /**
     * 未关闭引用检测,转化字符串时会出现$ref
     */
    public void test1() {
        list.add(p);
        list.add(p);
        String jsonStr = JSON.toJSONString(list);
        System.out.println(jsonStr);
        // [{"age":25,"name":"FLY"},{"$ref":"$[0]"}]
 
    }
 
    
 
}
 
class Person {
    private String name;
    private int age;
 
    // 构造函数
    public Person(String name, int age) {
        super();
        this.name = name;
        this.age = age;
    }
 
    public String getName() {
        return name;
    }
 
    public void setName(String name) {
        this.name = name;
    }
 
    public int getAge() {
        return age;
    }
 
    public void setAge(int age) {
        this.age = age;
    }
 
    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

问题分析

  • 实体转化为json字符串后出现了$ref字样的东西,这是因为在传输的数据中出现相同的对象时,fastjson默认开启引用检测将相同的对象写成引用的形式
  • 引用是通过"$ref"来表示的
引用描述
“$ref”:“…”上一级
“$ref”:“@”当前对象,也就是自引用
r e f " : " ref":" ref":"根对象
r e f " : " ref":" ref":".children.0”基于路径的引用,相当于 root.getChildren().get(0)
  • 说到引用分为两种,重复引用和循环引用

循环引用:即A对象引用B对象,B对象又引用A对象,这种情况是要极力避免的,因为会导致堆栈溢出(StackOverflowError);
重复引用:上面的例子就是因为相同的订单对象出现在两个集合中,所以第二个orderList集合中直接返回的是$ref。一般大家在写代码的过程中,如果出现$ref,通常应该是重复引用问题。

问题解决

1.局部关闭

将该对象在后端转换为json字符串返回给前端,使用SerializerFeature.DisableCircularReferenceDetect关闭循环引用。

String jsonString=JSON.toJSONString(object, SerializerFeature.DisableCircularReferenceDetect);

2.全局配置关闭

可以在SpringBoot项目的json配置中将循环引用关闭。FastJson的.java配置增加以下项:

fastConverter.setFeatures(SerializerFeature.DisableCircularReferenceDetect);

or

JSON.DEFAULT_GENERATE_FEATURE |= SerializerFeature.DisableCircularReferenceDetect.getMask();

但是因为全局配置是在我们项目的基础jar包中配置的,改动基础jar包会有风险,会对前面所有的依赖项目产生影响。所以也不采用这种方式。

大家想想为什么fastjson默认是开启这个功能的就知道原因了。如果全局关闭,性能也会有极大影响。

3.new新的对象来避免

我们可以将List中的对象使用BeanUtil这样的工具,拷贝为新的对象。(BeanUtil创建出来的对象跟原来的对象不是同一个对象)

4.禁止序列化

如果循环引用的数据,前端用不到,那可以在实体类对应的字段加注解禁止序列化,这样前端就不会接收到这个字段的引用数据了。

    @JSONField(serialize = false)
	private List<Order> orderList;

5.在该字段的注解上指定序列化时关闭循环引用

但是很多时候,前端又需要这个数据,所以禁止序列化也是不行滴,接下来看另外一种注解解决方式。

    @JSONField(serialzeFeatures = {SerializerFeature.DisableCircularReferenceDetect})
	private List<Object> objectList;
在将包含元素的 `List` 集合转换为 JSON 格式时出现 `$ref` 的问题,通常是由于 Fastjson 检测到对象之间的重复引用或循环引用所导致的。Fastjson 默认开启了循环引用检测机制,当序列化过程中发现对象之间存在嵌套引用关系时,会通过 `$ref` 来标记引用路径,以避免无限递归和栈溢出异常(`StackOverflowError`)[^3]。 ### 出现 `$ref` 的原因 1. **重复引用**:某个对象在集合中被多次引用,Fastjson 为了节省空间和避免重复序列化,会使用 `$ref` 来标记该对象的首次出现位置。 2. **循环引用**:对象之间存在互相引用关系,例如 A 引用 B,B 又引用 A,Fastjson 检测到这种情况后会通过 `$ref` 来避免无限递归。 3. **嵌套结构复杂**:当 `List` 中包含多层嵌套的对象结构时,Fastjson 会尝试通过路径表达式(如 `$.list[0]`)来标识对象的引用位置[^2]。 ### 解决方法 #### 方法一:关闭循环引用检测 可以通过关闭 Fastjson 的循环引用检测功能来避免 `$ref` 的出现。在序列化配置中设置 `DisableCircularReferenceDetect` 参数: ```java import com.alibaba.fastjson.JSON; import com.alibaba.fastjson.serializer.SerializerFeature; public class JsonUtil { public static String toJson(Object object) { return JSON.toJSONString(object, SerializerFeature.DisableCircularReferenceDetect); } } ``` 这种方式适用于对象结构中存在合理循环引用的情况,但需要注意关闭检测后可能导致输出的 JSON 数据量增大,甚至在极端情况下引发内存问题[^1]。 #### 方法二:配置 Spring Boot 中的 Fastjson 转换器 如果是在 Spring Boot 项目中使用 Fastjson 进行 HTTP 消息转换,可以在配置类中设置 `FastJsonConfig` 来禁用循环引用检测: ```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.Collections; @Configuration public class FastJsonConfigSetup { @Bean public HttpMessageConverters fastJsonHttpMessageConverters() { FastJsonHttpMessageConverter fastConverter = new FastJsonHttpMessageConverter(); FastJsonConfig fastJsonConfig = new FastJsonConfig(); fastJsonConfig.setSerializerFeatures( SerializerFeature.PrettyFormat, SerializerFeature.DisableCircularReferenceDetect ); fastConverter.setFastJsonConfig(fastJsonConfig); return new HttpMessageConverters(Collections.singletonList(fastConverter)); } } ``` 此配置方式适用于全局控制 Fastjson 在 Spring Boot 中的序列化行为,确保返回的 JSON 不包含 `$ref` 引用标记[^4]。 #### 方法三:深拷贝对象 如果对象结构中存在重复引用,但不需要保留引用关系,可以考虑在序列化前对对象进行深拷贝,以消除引用关系。这种方式较为复杂,适用于需要严格控制输出格式的场景。 --- ###
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值