JSON序列化时如何处理循环引用？

Question

在进行JSON序列化时，如何处理对象间的循环引用是一个常见且关键的技术难题。例如，当对象A引用对象B，而对象B又引用对象A时，直接序列化会触发无限递归，导致栈溢出或报错。不同语言和库对此处理方式各异：JavaScript的`JSON.stringify()`可通过传入replacer函数跳过循环引用；Java的Jackson库支持使用`@JsonManagedReference`与`@JsonBackReference`注解打破循环；Gson则提供`ExclusionStrategy`机制。此外，也可通过构建引用映射表、标记已序列化对象等方式手动控制。合理选择策略对保障数据完整性与系统稳定性至关重要。

Answer 1

一、JSON序列化中的循环引用问题深度解析

1. 什么是循环引用？

在面向对象编程中，当两个或多个对象相互持有对方的引用时，就形成了循环引用。例如：

class Employee {
    public String name;
    public Department department; // A 引用 B
}

class Department {
    public String deptName;
    public Employee manager; // B 引用 A
}
    

若直接对Employee实例进行JSON序列化，序列化器会尝试遍历其所有字段，进入department，再访问manager，从而回到原始Employee，形成无限递归。

2. 循环引用带来的后果

• 栈溢出（StackOverflowError）：递归过深导致JVM或运行环境崩溃
• 内存泄漏风险：未妥善处理可能导致临时对象无法回收
• 序列化失败：多数标准库默认不支持自动检测循环引用
• 数据冗余与膨胀：即使成功输出，也可能产生重复嵌套结构

3. 常见语言和框架的解决方案对比

语言/库	机制	示例代码/注解	适用场景
JavaScript (原生)	replacer 函数 + WeakSet	JSON.stringify(obj, getCircularReplacer())	前端调试、轻量级数据导出
Java - Jackson	@JsonManagedReference / @JsonBackReference	正向关系保留，反向忽略	ORM实体如父子关系、双向导航属性
Java - Gson	ExclusionStrategy	实现shouldSkipField()判断字段是否跳过	复杂模型过滤策略
.NET - Newtonsoft.Json	JsonPropertyAttribute + ReferenceLoopHandling	ReferenceLoopHandling = ReferenceLoopHandling.Ignore	Web API 返回DTO时控制粒度
Python - json	自定义encoder + id()记录已访问对象	继承json.JSONEncoder	需要手动管理引用状态

4. 技术实现路径详解

1. 使用内置注解标记主从关系（以Jackson为例）

2. 
   @JsonManagedReference
   public Department getDepartment() { return department; }
   
   @JsonBackReference
   public Employee getManager() { return manager; }
           

3. 通过replacer函数处理JavaScript循环引用

4. 
   const getCircularReplacer = () => {
     const seen = new WeakSet();
     return (key, value) => {
       if (typeof value === "object" && value !== null) {
         if (seen.has(value)) return;
         seen.add(value);
       }
       return value;
     };
   };
   JSON.stringify(cyclicObj, getCircularReplacer());
           

5. Gson自定义排除策略

6. 
   Gson gson = new GsonBuilder()
       .setExclusionStrategies(new ExclusionStrategy() {
           @Override
           public boolean shouldSkipField(FieldAttributes f) {
               return f.getDeclaringClass() == Department.class 
                      && f.getName().equals("employees");
           }
   
           @Override
           public boolean shouldSkipClass(Class<?> clazz) {
               return false;
           }
       }).create();
           

5. 高级设计模式与架构考量

对于大型系统，建议采用以下分层策略：

graph TD A[原始领域模型] --> B{存在循环引用?} B -- 是 --> C[引入DTO层] B -- 否 --> D[直接序列化] C --> E[使用MapStruct等工具转换] E --> F[在DTO中消除双向引用] F --> G[安全序列化输出] style C fill:#f9f,stroke:#333 style G fill:#bbf,stroke:#333

6. 手动控制序列化流程：引用映射表法

核心思想是维护一个已访问对象的Set或Map，在序列化过程中检查是否已处理过该对象：

public class SafeJsonSerializer {
    private Set<Object> visited = new HashSet<>();

    public void serialize(Object obj) {
        if (obj == null || visited.contains(obj)) {
            System.out.print("..."); // 或输出ID引用
            return;
        }
        visited.add(obj);
        // 正常字段遍历逻辑...
    }
}
    

此方法灵活性高，但需注意线程安全及生命周期管理。

7. 最佳实践建议

• 优先使用成熟的序列化库而非手写递归逻辑
• 在领域模型与传输模型之间建立清晰边界（DDD思想）
• 避免在JSON中暴露完整对象图，考虑使用ID引用代替内联对象
• 对API响应做性能压测，验证大图结构下的表现
• 日志中捕获序列化异常并提供上下文信息以便排查
• 文档化各服务间的数据契约，明确哪些字段可能被省略