C# System.Text.Json高级用法 C#如何自定义JsonConverter

浅涛姑娘_5788

浅涛姑娘_5788

2026-02-27

867人浏览

原创

自定义 System.Text.Json.JsonConverter 需继承 JsonConverter 并重写 Read/Write,T 必为具体类型;注册方式影响作用域,日期类型需绕过内置逻辑;性能关键点在于避免反射、临时字符串和二次序列化。

c# system.text.json高级用法 c#如何自定义jsonconverter

如何为自定义类型编写 System.Text.Json.JsonConverter

直接继承 JsonConverter,重写 Read 和 Write 方法即可。关键不是“能不能写”,而是“怎么让序列化行为符合业务语义”。比如枚举用字符串名序列化、时间戳转为秒级整数、空字符串映射为 null 等场景,都得靠自定义转换器控制。

注意:泛型参数 T 必须是具体类型(如 JsonConverter),不能是基类或接口(如 JsonConverter)——否则运行时会抛 NotSupportedException。

  • Read 方法里用 ref Utf8JsonReader reader 逐字段解析,别直接调 JsonSerializer.Deserialize(reader),否则会递归触发自身转换器
  • Write 方法中用 Utf8JsonWriter 手动写入字段,避免调 JsonSerializer.Serialize(writer, value) 引发循环
  • 若需复用默认行为(例如只改某个字段),可在 Read 中先用 JsonSerializer.Deserialize(ref reader, options) 得到中间对象,再后处理

JsonConverter 怎么注册到 JsonSerializerOptions

注册方式决定作用域:全局生效还是局部覆盖。最常用的是往 JsonSerializerOptions.Converters 集合里加实例,但顺序很重要——靠前的转换器优先匹配类型。

JSON Toolkit
JSON Toolkit

JSON文件多功能工具。支持格式化、验证、压缩、键排序及点记法路径查询。零依赖。

下载
  • 添加 new DateTimeOffsetConverter() 会覆盖默认的 DateTimeOffset 处理逻辑
  • 若同时注册了 JsonConverter(不推荐),它会捕获所有未明确指定的类型,导致其他转换器失效
  • 局部使用时,可给属性加 [JsonConverter(typeof(MyConverter))] 特性,优先级高于全局注册项
  • 使用源生成器(JsonSerializerContext)时,转换器必须通过 JsonSerializerOptions 传入,特性注册无效

常见踩坑:DateTime / DateTimeOffset 转换器为什么没生效

不是写了转换器就自动生效。System.Text.Json 对日期类型有硬编码的内置处理逻辑,会绕过用户注册的转换器,除非你显式禁用默认行为。

  • 必须设置 options.DateTimeZoneHandling = DateTimeZoneHandling.Utc 或类似选项(实际是 JsonSerializerOptions 的 DefaultIgnoreCondition 不影响此行为)
  • 更可靠的做法:在转换器里检查 reader.TokenType == JsonTokenType.String,再手动解析 ISO 格式;避免依赖 reader.GetDateTimeOffset(),它可能已被内部逻辑拦截
  • 如果目标是把 "2023-01-01" 解析为 DateTime 而非报错,转换器里要用 reader.GetString() 拿原始字符串,再用 DateTime.TryParseExact 处理

性能敏感场景下 JsonConverter 的写法要点

高频序列化时,JsonConverter 是性能瓶颈点之一。避免反射、避免临时字符串分配、尽量复用 Utf8JsonWriter 内部缓冲区。

  • 不要在 Write 中拼接 JSON 字符串再写入(如 writer.WriteStringValue(JsonSerializer.Serialize(value))),这会触发二次序列化和 UTF-8 编码
  • 读取字符串字段时,优先用 reader.GetString(),而非 reader.ValueSpan.ToString() —— 后者会创建新字符串对象
  • 若转换逻辑简单(如布尔值映射为 "Y"/"N"),直接用 switch (reader.GetString()),比反序列化成中间对象快 3–5 倍
  • 调试时开启 options.WriteIndented = true 会显著拖慢速度,上线前务必关闭

自定义 JsonConverter 最容易被忽略的,是它和默认序列化路径的耦合关系——你以为自己接管了全部逻辑,其实某些类型(如 Dictionary 或含 object 成员的类)仍会走默认分支,导致行为不一致。动手前先用最小示例验证边界输入。

相关文章

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

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

下载

相关标签:

js json c#

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

相关专题

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

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

2023.08.07

2355

5

json是什么
json是什么

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

2023.08.23

3882

1

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

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

2023.10.13

1296

3

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

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

2025.09.10

4519

7

string转int
string转int

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

2023.08.02

7599

3

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

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

2023.09.22

569

3

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

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

2024.03.01

1698

6

switch语句用法
switch语句用法

switch语句用法:1、Switch语句只能用于整数类型,枚举类型和String类型,不能用于浮点数类型和布尔类型;2、每个case语句后面必须跟着一个break语句,以防止执行其他case的代码块,没有break语句,将会继续执行下一个case的代码块;3、可以在一个case语句中匹配多个值,使用逗号分隔;4、Switch语句中的default代码块是可选的等等。

2023.09.21

1071

6

Java switch的用法
Java switch的用法

Java中的switch语句用于根据不同的条件执行不同的代码块。想了解更多switch的相关内容,可以阅读本专题下面的文章。

2024.03.13

1457

13

热门下载

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

精品课程

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

共101课时 | 21.4万人学习

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

共39课时 | 4.9万人学习