0

0

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

幻夢星雲

幻夢星雲

发布时间:2026-01-26 08:22:03

|

154人浏览过

|

来源于php中文网

原创

在System.Text.Json中自定义转换器需继承JsonConverter并重写Read/Write方法,注册到JsonSerializerOptions或用[JsonConverter]特性绑定,注意类型判断、null处理及token手动推进。

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

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

创建基础自定义转换器

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

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

注册转换器到 JsonSerializerOptions

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

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

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

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

Artifact News
Artifact News

由AI驱动的个性化新闻推送

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

使用特性 [JsonConverter] 快速绑定

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

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

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

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

418

2023.08.07

json是什么
json是什么

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

535

2023.08.23

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

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

311

2023.10.13

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

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

76

2025.09.10

string转int
string转int

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

401

2023.08.02

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

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

235

2023.09.22

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

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

437

2024.03.01

登录token无效
登录token无效

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

6114

2023.09.14

c++ 根号
c++ 根号

本专题整合了c++根号相关教程,阅读专题下面的文章了解更多详细内容。

70

2026.01.23

热门下载

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

精品课程

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

共101课时 | 8.5万人学习

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

共39课时 | 3.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号