C#如何实现自定义JsonConverter_C# System.Text.Json转换器开发教程【高级】

阿丽大大_5338

阿丽大大_5338

2026-05-12

489人浏览

原创

因为jsonconverter是无泛型抽象基类,无法参与类型推导和编译检查;而jsonconverter是具体入口,支持精准类型匹配、编译时验证及read/write中typetoconvert的正确使用,避免notsupportedexception或转换器被跳过。

c#如何实现自定义jsonconverter_c# system.text.json转换器开发教程【高级】

为什么继承 JsonConverter<t></t> 而不是直接写 JsonConverter

因为 JsonConverter 是抽象基类,没有泛型参数,无法参与类型推导和编译时检查;而 JsonConverter<t></t> 是具体实现入口,System.Text.Json 在序列化时靠它精准匹配类型。不指定 T,Read 和 Write 方法里的 typeToConvert 参数就失去意义,运行时容易报 NotSupportedException 或跳过你的转换器。

常见错误现象:注册了转换器但毫无效果,JSON 仍按默认规则处理——大概率是没继承 JsonConverter<yourtype></yourtype>,而是误写了 JsonConverter。

  • 必须显式指定泛型类型,如 JsonConverter<datetime></datetime>、JsonConverter<dictionary string>></dictionary>
  • 若类型含泛型参数(如 Dictionary<tkey tvalue></tkey>),不能直接继承 JsonConverter<dictionary tvalue>></dictionary>,得用 JsonConverterFactory 动态构造
  • Read 方法里拿到的 ref Utf8JsonReader 必须手动推进;漏掉 reader.Read() 或误调 reader.Skip() 会导致后续字段解析错位

如何正确处理 null 值和意外 token 类型

System.Text.Json 不会帮你兜底:遇到 null、Number 却期待 String、或字段缺失时,Utf8JsonReader 的 TokenType 就是你唯一的判断依据。不检查,GetString() 会抛 InvalidOperationException,GetInt32() 会崩在 "true" 上。

典型场景:反序列化一个可为空的自定义对象,或兼容前后端字段类型不一致(比如后端传了 "123" 字符串,但 C# 属性是 int?)。

  • 先读 reader.TokenType:等于 JsonTokenType.Null 就直接 return null(对可空类型)或 throw(对非空类型)
  • 再判断是否为预期类型,例如要读字符串,就检查 reader.TokenType == JsonTokenType.String,否则 throw 或 fallback 处理
  • 用 reader.TryGet...() 系列方法(如 TryGetInt32(out int v))比直接取值更安全,失败时不抛异常
  • 手动推进 reader:每次成功读一个值后,务必调用 reader.Read() 进入下一个 token,否则下次 Read() 会卡在原地

什么时候必须用 JsonConverterFactory 而不是普通 JsonConverter<t></t>

当你需要为开放泛型类型(如 Dictionary<myenum t></myenum>、List<t></t>)提供通用转换逻辑时,JsonConverterFactory 是唯一选择。普通 JsonConverter<t></t> 只能绑定到闭合类型(如 Dictionary<status string></status>),编译期就固定死了。

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

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

下载

错误做法:试图写 class DictEnumConverter : JsonConverter<dictionary tvalue>></dictionary> —— 编译不过,且运行时无法实例化。

  • CanConvert(Type typeToConvert) 必须严格判断:检查 IsGenericType、GetGenericTypeDefinition()、泛型参数数量和约束(如第一个是不是 Enum)
  • CreateConverter(Type type, JsonSerializerOptions options) 里用 Type.MakeGenericType(...) 构造闭合类型,再通过 Activator.CreateInstance 创建对应转换器实例
  • 内部实际转换器(如 DictionaryEnumConverterInner<tkey tvalue></tkey>)仍需继承 JsonConverter<dictionary tvalue>></dictionary>,只是它的 TKey 和 TValue 在工厂里动态确定
  • 别忘了在 CreateConverter 中复用 options:把 options 传给内部转换器,让它能获取其他已注册的 converter(比如处理 TValue 的 converter)

[JsonConverter] 特性与全局注册的优先级冲突怎么解

特性方式永远高于全局注册。如果你在某个属性上加了 [JsonConverter(typeof(MyConverter))],哪怕你同时在 JsonSerializerOptions.Converters 里加了另一个转换器,也只会走特性的那个。

这在调试时容易误判:以为全局注册生效了,结果发现某字段行为异常——其实是类/属性上的特性悄悄覆盖了。

  • 特性可作用于三处:类(整个类型)、属性(仅该字段)、泛型类型参数(C# 12+ 支持)
  • 如果类和属性都标了不同转换器,属性级优先级更高
  • 工厂类(JsonConverterFactory)也能被特性引用,如 [JsonConverter(typeof(DictionaryEnumConverterFactory))]
  • ASP.NET Core 全局配置(AddJsonOptions)注册的转换器,对带特性的成员完全无效——这是设计使然,不是 bug

真正难的不是写出 Read 和 Write,而是每次推进 Utf8JsonReader 前,都想清楚当前 token 是什么、下一个应该是什么、null 怎么退、异常怎么抛。System.Text.Json 没有“上下文自动恢复”机制,错一步,整段 JSON 解析就偏移了。

相关文章

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

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

下载

相关标签:

js json c#

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

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2949

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2228

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1180

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1118

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1316

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2058

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3260

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

14515

6

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

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

2023.09.22

529

3

热门下载

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

精品课程

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

共101课时 | 20.8万人学习

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

共39课时 | 4.8万人学习