C#如何解决循环引用问题_C# JSON序列化循环引用处理方法【技巧】

浅枫同学_6370

浅枫同学_6370

2026-05-06

1000人浏览

原创

system.text.json 默认拒绝循环引用并抛出异常,必须显式配置referencehandler.preserve或ignorecycles;前者保留完整对象图但json体积增大,后者静默截断导致关系链断裂。

c#如何解决循环引用问题_c# json序列化循环引用处理方法【技巧】

System.Text.Json 默认拒绝循环引用,直接抛出 InvalidOperationException: A possible object cycle was detected;Newtonsoft.Json 默认同样报错,但提供更灵活的控制入口。两者都**不能靠忽略属性或静默截断来真正“解决”**——那只是掩盖问题,会导致反序列化后对象图断裂、EF Core 变更追踪失效、前端无法还原导航关系。

用 System.Text.Json 处理循环引用(.NET 6+)

必须显式启用引用处理,且序列化与反序列化选项必须严格一致,否则反序列化会失败。

  • ReferenceHandler.Preserve:生成带 $id/$ref 的 JSON,保留完整对象图,可双向导航,但 JSON 体积增大、结构变复杂;反序列化时若没配相同 ReferenceHandler,会抛 JsonException:“Cannot resolve reference '1'”
  • ReferenceHandler.IgnoreCycles:跳过已见对象,不生成 $ref,JSON 更小,但反序列化后 child.Parent 为 null,关系链断裂
  • 仅在 .NET 6 及以上支持;.NET 5 或更早版本即使设了也会被忽略,仍报错
  • 示例:
    var options = new JsonSerializerOptions { ReferenceHandler = ReferenceHandler.Preserve, WriteIndented = true }; var json = JsonSerializer.Serialize(person, options); // 反序列化也必须用同一 options var restored = JsonSerializer.Deserialize<person>(json, options);</person>

用 Newtonsoft.Json 处理循环引用

它不依赖运行时版本,但配置项名称和行为细节容易混淆,尤其在升级项目时。

Feishu calendar sync, local ics to json data for AI agent
Feishu calendar sync, local ics to json data for AI agent

将ICS日历文件转为JSON格式,用于飞书日历导入导出及数据集成。

下载
  • PreserveReferencesHandling.Objects 是等效于 ReferenceHandler.Preserve 的安全选择;ReferenceLoopHandling.Ignore 则是静默丢弃,和 IgnoreCycles 类似
  • 必须同时设置 TypeNameHandling.Auto(或 TypeNameHandling.Objects)才能正确还原多态类型;否则反序列化时可能创建基类实例而非实际子类
  • 如果用了自定义 SerializationBinder,必须确保其 BindToType 能识别 JSON 中的 $type 字段,否则反序列化失败
  • 示例:
    var settings = new JsonSerializerSettings { PreserveReferencesHandling = PreserveReferencesHandling.Objects, TypeNameHandling = TypeNameHandling.Auto }; var json = JsonConvert.SerializeObject(person, settings); var restored = JsonConvert.DeserializeObject<person>(json, settings);</person>

别踩这些坑:常见错误现象与真实后果

很多“能跑通”的配置其实埋着隐患,上线后才暴露。

  • 只给 JsonSerializerOptions 设 DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,却没配 ReferenceHandler → 序列化仍崩,不是 null 导致的
  • 用 [JsonIgnore] 标记 Parent 属性 → 反序列化后 child.Parent == null,EF Core 认为该字段未修改,SaveChanges 不触发关联更新
  • Newtonsoft 中设了 PreserveReferencesHandling.Objects,但漏了 TypeNameHandling → 多态集合(如 List<animal></animal> 含 Dog 和 Cat)反序列化全变成 Animal 实例
  • 前后端共用同一套 DTO,但前端依赖 $id/$ref 做局部刷新 → 后端换用 IgnoreCycles 后,前端 JS 解析时报错“cannot read property 'parent' of null”

选 Preserve 还是 IgnoreCycles?关键看下游是否需要完整对象图

这不是性能或写法偏好问题,而是数据契约问题。

  • 如果你的 API 要被前端 Vue/React 组件消费,且组件靠 item.parent.id 渲染面包屑或树形控件 → 必须用 Preserve 模式,并确保前端 JSON 解析器支持 $ref(如 json-cycle)
  • 如果只是导出日志、审计快照、或写入只读报表数据库 → IgnoreCycles 更轻量,避免冗余字段干扰分析
  • EF Core + Web API 场景下,若 DTO 直接映射实体,又启用了延迟加载(virtual 导航属性),Preserve 是唯一能保证反序列化后仍可访问 child.Parent.Children 的方式
真正难的不是加一行 ReferenceHandler = ReferenceHandler.Preserve,而是确认整个调用链——从 Controller 返回、经中间件、到客户端解析——每一步都理解并接受这个引用语义。一旦某环擅自“优化”掉 $ref,对象图就不可逆地碎了。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

js json c#

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
c#是什么意思
c#是什么意思

C#是一种通用的面向对象编程语言,它在.NET框架上运行,可用于开发各种类型的应用程序。本专题为大家提供c#相关的各种文章、以及下载和课程。

2023.08.08

932

5

什么是c#
什么是c#

C#(读作C Sharp)是一种现代的、通用的、面向对象的编程语言。它由微软公司开发,于2000年首次发布,主要用于开发Windows桌面应用程序、Web应用程序、移动应用程序以及游戏开发等领域。C#是一种类型安全和托管的编程语言,它结合了C++的强大性能和C语言的简单易学特点,并引入了许多新的特性和概念,如委托、属性、泛型和异步编程等,以提高开发效率和代码可维护性。

2023.08.31

2611

3

C#中base关键字的用法
C#中base关键字的用法

在C#中,base关键字用于访问当前类的基类成员,这包括基类的字段、属性、方法、构造函数、索引器以及事件。想了解更多C#的相关内容,可以阅读本专题下面的文章。

2024.03.13

845

8

C#Task用法
C#Task用法

Task在C#中是用于表示异步操作的对象,它位于System.Threading.Tasks命名空间中。想了解更多C#中各种用法的相关内容,可以阅读本专题下面的文章。

2024.03.14

2595

11

C# 并发与异步编程
C# 并发与异步编程

本专题系统讲解 C# 异步编程与并发控制,重点介绍 async 和 await 关键字、Task 类、线程池管理、并发数据结构、死锁与线程安全问题。通过多个实战项目,帮助学习者掌握 如何在 C# 中编写高效的异步代码,提升应用的并发性能与响应速度。

2026.02.03

292

18

C# 多线程与异步编程
C# 多线程与异步编程

本专题深入讲解 C# 中多线程与异步编程的核心概念与实战技巧,包括线程池管理、Task 类的使用、async/await 异步编程模式、并发控制与线程同步、死锁与竞态条件的解决方案。通过实际项目,帮助开发者掌握 如何在 C# 中构建高并发、低延迟的异步系统,提升应用性能和响应速度。

2026.02.06

369

20

C# ASP.NET Core微服务架构与API网关实践
C# ASP.NET Core微服务架构与API网关实践

本专题围绕 C# 在现代后端架构中的微服务实践展开,系统讲解基于 ASP.NET Core 构建可扩展服务体系的核心方法。内容涵盖服务拆分策略、RESTful API 设计、服务间通信、API 网关统一入口管理以及服务治理机制。通过真实项目案例,帮助开发者掌握构建高可用微服务系统的关键技术,提高系统的可扩展性与维护效率。

2026.03.11

611

24

C# Unity游戏开发与ECS架构实践
C# Unity游戏开发与ECS架构实践

本专题聚焦 C# 在 Unity 游戏开发中的应用,系统讲解 ECS(Entity-Component-System)架构设计、游戏对象管理、性能优化与内存控制策略。通过实际游戏案例,帮助开发者构建高性能、结构清晰的游戏系统,提高游戏开发效率与运行性能。

2026.04.13

309

20

json数据格式
json数据格式

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

2023.08.07

2035

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 20.8万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.8万人学习