0

0

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

星降

星降

发布时间:2025-12-05 17:07:02

|

914人浏览过

|

来源于php中文网

原创

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,并配置:

Tellers AI
Tellers AI

Tellers是一款自动视频编辑工具,可以将文本、文章或故事转换为视频。

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

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

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

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

412

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

533

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

310

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

74

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

318

2023.08.02

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

231

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

436

2024.03.01

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

318

2023.08.02

高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

72

2026.01.16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
MongoDB 教程
MongoDB 教程

共17课时 | 2.1万人学习

Swoft2.x速学之http api篇课程
Swoft2.x速学之http api篇课程

共16课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号