C#怎么自定义JSON转换器 System.Text.Json自定义Converter教程

千磊同学_6181

千磊同学_6181

2026-01-26

174人浏览

原创

在system.text.json中自定义转换器需继承jsonconverter并重写read/write方法,注册到jsonserializeroptions或用[jsonconverter]特性绑定,注意类型判断、null处理及token手动推进。

c#怎么自定义json转换器 system.text.json自定义converter教程

System.Text.Json 中自定义 JSON 转换器,核心是继承 JsonConverter<t></t> 并重写 ReadWrite 方法。它比 Newtonsoft.Json 更轻量、更安全,但灵活性略低——所以明确类型、处理好 null 和边界情况特别重要。

创建基础自定义转换器

比如你想把字符串 "yes"/"no" 映射为 bool,而默认解析不支持:

  • 新建类继承 JsonConverter<bool></bool>
  • 重写 Read:从 ref Utf8JsonReader 读取 token,判断值并返回 bool;注意调用 reader.Skip() 或正确消费 token
  • 重写 Write:用 Utf8JsonWriter 写入 "yes" 或 "no"
  • 务必检查 reader.TokenType(如 String),避免解析非预期类型时报错

注册转换器到 JsonSerializerOptions

转换器不会自动生效,必须显式添加:

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载
  • 创建 JsonSerializerOptions 实例
  • options.Converters.Add(new YesNoBoolConverter()) 注册
  • 序列化/反序列化时传入该 options:JsonSerializer.Serialize(obj, options)
  • 也可全局配置(如 ASP.NET Core 中在 Program.cs 里用 services.AddControllers().AddJsonOptions(...)

处理复杂类型(如泛型或嵌套对象)

若要为自定义类(如 Person)控制序列化逻辑:

  • 继承 JsonConverter<person></person>,在 Read 中手动读字段:reader.ReadPropertyName() + reader.GetString()
  • JsonSerializer.Deserialize<t>(ref reader, options)</t> 复用默认行为处理子属性(避免重复造轮子)
  • Write 中先 writer.WriteStartObject(),再逐个写字段,最后 WriteEndObject()
  • 注意 null 值处理:reader.TokenType == JsonTokenType.Null 时应返回 null 或 throw

使用特性 [JsonConverter] 快速绑定

不想全局注册?可以按类型或属性粒度启用:

  • 加在类上:[JsonConverter(typeof(PersonConverter))],整个类都走该转换器
  • 加在属性上:[JsonConverter(typeof(DateFormatConverter))],仅该字段生效
  • 支持泛型转换器,例如 [JsonConverter(typeof(NullableConverter<datetime>))]</datetime>
  • 特性方式优先级高于全局注册的转换器

基本上就这些。关键不是写得多,而是读得准、写得稳、null 判断到位。System.Text.Json 的 converter 没有“上下文”对象,所有逻辑都靠 Utf8JsonReader/Writer 手动推进,习惯后反而更可控。

相关文章

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

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

下载

相关标签:

js json c#

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

相关专题

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

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

2023.08.07

1935

5

json是什么
json是什么

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

2023.08.23

2542

1

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

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

2023.10.13

896

3

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

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

2025.09.10

2839

7

string转int
string转int

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

2023.08.02

4999

3

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

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

2023.09.22

509

3

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

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

2024.03.01

1638

6

登录token无效
登录token无效

登录token无效解决方法:1、检查token的有效期限,如果token已经过期,需要重新获取一个新的token;2、检查token的签名,如果签名不正确,需要重新获取一个新的token;3、检查密钥的正确性,如果密钥不正确,需要重新获取一个新的token;4、使用HTTPS协议传输token,建议使用HTTPS协议进行传输 ;5、使用双因素认证,双因素认证可以提高账户的安全性。

2023.09.14

11666

6

登录token无效怎么办
登录token无效怎么办

登录token无效的解决办法有检查Token是否过期、检查Token是否正确、检查Token是否被篡改、检查Token是否与用户匹配、清除缓存或Cookie、检查网络连接和服务器状态、重新登录或请求新的Token、联系技术支持或开发人员等。本专题为大家提供token相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.14

1425

5

热门下载

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

精品课程

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

共101课时 | 20.4万人学习

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

共39课时 | 4.6万人学习