C# 如何处理JSON中的循环引用 - JsonSerializerSettings配置-C#.Net教程-PHP中文网

C# 如何处理JSON中的循环引用 - JsonSerializerSettings配置

星降

发布： 2025-12-05 17:07:02

原创

869人浏览过

System.Text.Json 默认不支持循环引用，会抛出异常以避免栈溢出和内存问题；推荐通过断开引用、[JsonIgnore] 特性或自定义 Converter 显式处理。

c# 如何处理json中的循环引用 - jsonserializersettings配置

在 C# 中使用 System.Text.Json（.NET Core 3.0+ 默认 JSON 库）时，它默认不支持循环引用检测与处理，也不会像旧版 Newtonsoft.Json 那样通过 JsonSerializerSettings.ReferenceLoopHandling 自动跳过或序列化引用。如果你遇到“A possible object cycle was detected”异常，说明你正在用 System.Text.Json 序列化含有循环引用的对象（比如父子双向导航属性），而它直接抛出异常来阻止不安全行为。

为什么 System.Text.Json 不允许循环引用？

这是出于安全与设计哲学的考虑：
– 避免无限递归导致栈溢出或内存耗尽
– 不引入隐式引用跟踪机制，保持轻量和可预测性
– 强制开发者显式建模数据结构，而非依赖运行时“兜底”

解决循环引用的实用方法

没有“全局设置开关”，但有几种清晰可控的方式：

方式一：移除/断开循环引用（推荐）
在序列化前，临时清空或置空引发循环的引用属性。例如：

// 假设有 Order → Customer → Orders 循环 order.Customer.Orders = null; // 断开反向引用 var json = JsonSerializer.Serialize(order);

方式二：使用 [JsonIgnore] 特性标记
在模型定义时，对不需要序列化的导航属性加特性：

public class Customer { public int Id { get; set; } public string Name { get; set; } [JsonIgnore] // 关键：跳过该属性 public List Orders { get; set; } }

方式三：自定义 Converter 控制序列化逻辑
适用于需要更精细控制（如只序列化 ID、或按需展开一层）的场景：

public class CustomerConverter : JsonConverter { public override Customer Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => JsonSerializer.Deserialize(ref reader, options);

public override void Write(Utf8JsonWriter writer, Customer value, JsonSerializerOptions options)  
{  
    writer.WriteStartObject();  
    writer.WriteString("name", value.Name);  
    writer.WriteNumber("id", value.Id);  
    // 不写 Orders 属性，避免循环  
    writer.WriteEndObject();  
}

登录后复制

}

// 使用时注册：
var options = new JsonSerializerOptions();
options.Converters.Add(new CustomerConverter());

注意：Newtonsoft.Json 仍支持 ReferenceLoopHandling

如果你必须用老方式（比如维护旧项目），可继续用 Newtonsoft.Json，并配置：

Convai Technologies Inc.

对话式 AI API，用于设计游戏和支持端到端的语音交互

查看详情

var settings = new JsonSerializerSettings { ReferenceLoopHandling = ReferenceLoopHandling.Ignore, // 或 Serialize PreserveReferencesHandling = PreserveReferencesHandling.Objects }; string json = JsonConvert.SerializeObject(obj, settings);

但这会生成 $id/$ref 元数据，前端解析需额外处理，且增加 payload 大小。

基本上就这些。System.Text.Json 的设计取舍明确：不妥协安全性，也不隐藏复杂性。处理循环引用不是靠“开个开关”，而是靠你主动梳理对象关系——这反而让数据契约更清晰。

以上就是C# 如何处理JSON中的循环引用 - JsonSerializerSettings配置的详细内容，更多请关注php中文网其它相关文章！