C#怎么使用System.Text.Json自定义转换器_C# JSON序列化自定义教程【进阶】

穿越時空

穿越時空

2026-05-25

795人浏览

原创

system.text.json自定义转换器需手动处理token推进、类型校验和null分支,read/write必须成对实现且不可依赖自动逻辑;注册转换器须类型完全匹配;只读属性需复用默认反序列化逻辑;多态需手动解析$type字段。

c#怎么使用system.text.json自定义转换器_c# json序列化自定义教程【进阶】

System.Text.Json 的自定义转换器不是“加个特性就能跑”,必须手动处理 token 推进、类型校验和 null 分支——漏掉任意一个,JsonSerializer 就会在运行时抛出 InvalidOperationException 或静默丢数据。

怎么写一个基础 JsonConverter<t></t>

继承 JsonConverter<t></t> 后,ReadWrite 方法必须成对实现,且不能依赖“自动跳过”逻辑。比如把 "enabled"/"disabled" 字符串转为 bool

  • Read 中先检查 reader.TokenType != JsonTokenType.String,否则直接 throw;再用 reader.GetString() 获取值,手动比对字符串(注意大小写)
  • Write 中必须调用 writer.WriteStringValue("enabled")"disabled",不能写 writer.WriteBooleanValue(value)
  • 遇到 reader.TokenType == JsonTokenType.Null 时,Read 应返回 default(T)null(若 T 是可空引用类型),否则反序列化 null 字段会崩溃

为什么 JsonSerializerOptions.Converters.Add() 不生效

注册转换器只是第一步,真正决定是否调用它的,是 typetoconvert 是否与泛型参数完全匹配——包括可空修饰、泛型实参、甚至是否是 ref struct。常见失效场景:

php版微信js-sdk支付接口类
php版微信js-sdk支付接口类

php版微信js-sdk支付接口类

下载
  • int? 注册了 JsonConverter<int></int>:不匹配,int? 需要 JsonConverter<int></int> 或泛型工厂
  • 类里有个 public List<person> Items { get; set; }</person>,但只注册了 PersonConverter:List 本身走默认 converter,不会递归调用 Person 的 converter
  • 使用 [JsonConverter(typeof(MyConverter))] 标记属性,但该属性类型是 object:System.Text.Json 不支持为 object 类型注册 converter,会忽略该特性

如何安全处理只读属性或私有字段

System.Text.Json 默认跳过只读属性和私有字段,强行启用 IncludeFields = trueAllowReadOnlyProperties = true 只是“让字段可见”,不代表能正确反序列化。关键在 converter 内部:

  • 反序列化只读属性时,Read 方法不能 new 对象再赋值,必须用 JsonSerializer.Deserialize(ref reader, options) 复用默认逻辑读取子结构,再手动构造目标对象
  • 私有字段若带 [field: JsonPropertyName("name")],需确保字段名与 JSON key 一致,否则 converter 里用 reader.ReadPropertyName() 匹配不到
  • .NET 6+ 支持 AllowReadOnlyProperties = true,但前提是类有无参构造函数或标记了 [JsonConstructor] 的构造函数;否则仍报 NotSupportedException: Cannot create an instance of type T

多态反序列化必须自己解析 $type 字段

Newtonsoft.Json 的 $type 是开箱即用的,System.Text.Json 没有等价机制。想支持接口/抽象类反序列化,必须在 Read 中手动读取 $type 字段,再根据字符串决定创建哪个具体类型:

  • 先调用 reader.ReadPropertyName() 判断是否为 "$type",再用 reader.GetString() 获取类型名
  • Type.GetType(typeName) 或预注册的类型映射表查到实际 Type,再调用 JsonSerializer.Deserialize(ref reader, targetType, options)
  • 注意:此时不能再用当前 converter 的 Read 方法递归调用,否则栈溢出;必须切换上下文,用新 targetType 触发对应 converter
  • 序列化时也要在 Write 开头手动写入 "$type" 字段,否则下游无法还原类型

最易被忽略的一点:所有手动推进 Utf8JsonReader 的操作都不可逆——reader.Skip() 会跳过整个 token,但如果你在判断分支里忘了调用它,下一次 Read 就会卡在同一个位置,导致无限循环或错位解析。写完 converter 必须用含嵌套对象、null、异常格式的 JSON 样本全覆盖测试。

相关文章

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

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

下载

相关标签:

js json c#

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

相关专题

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

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

2023.08.08

528

5

什么是c#
什么是c#

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

2023.08.31

1158

3

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

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

2024.03.13

556

8

C#Task用法
C#Task用法

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

2024.03.14

1050

11

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

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

2026.02.03

148

18

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

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

2026.02.06

202

20

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

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

2026.03.11

526

24

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

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

2026.04.13

137

20

json数据格式
json数据格式

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

2023.08.07

1536

5

热门下载

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

精品课程

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

共101课时 | 18.8万人学习

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

共39课时 | 4.3万人学习