讲师中心 微信公众号
AI工具推荐 视频效率加速

C#如何反序列化复杂JSON_C# System.Text.Json自定义Converter【进阶】

夏杰姑娘_9099

夏杰姑娘_9099

发布时间:2026-04-26 22:26:19

|

848人浏览过

|

来源于php中文网

原创

System.Text.Json 默认不支持混合类型字段,需自定义 JsonConverter<string> 处理 string/int 混合的 Id 字段;核心是重写 Read 方法,根据 token 类型分别调用 GetString() 或 TryGetInt64()/GetDouble() 转换,Write 保持字符串输出;推荐属性级标注注册,避免全局误伤。

c#如何反序列化复杂json_c# system.text.json自定义converter【进阶】

System.Text.Json 默认不支持混合类型字段(如 Id 既可能是 int 又可能是 string),必须靠自定义 JsonConverter<T> 解决,否则直接抛 JsonException。

为什么默认反序列化会失败

当 JSON 中某个字段在不同实例里类型不一致(例如 {"Id": 1} 和 {"Id": "abc"}),JsonSerializer.Deserialize<T> 在遇到类型不匹配时不会自动降级或尝试转换 —— 它严格按目标属性类型读取。比如声明为 string Id,但 JSON 给的是数字 token,Utf8JsonReader.GetString() 就会返回 null 或抛异常(取决于 JsonSerializerOptions.ReadCommentHandling 等配置)。

常见错误信息是:Cannot convert value to type 'System.String' 或更底层的 InvalidOperationException: Cannot get the value of a token type 'Number' as a string.

  • 不是 .NET 版本问题:.NET 5+ 的 JsonNumberHandling.AllowReadingFromString 只对数字类型(如 int、double)启用字符串兼容,不反向生效
  • 不是配置遗漏:加 PropertyNameCaseInsensitive = true 或 DefaultIgnoreCondition 都无法绕过类型校验
  • 真正卡点在于 Utf8JsonReader 的 token 类型和目标类型的硬匹配逻辑

写一个能处理 string/int 混合的 Converter

核心是重写 Read 方法,在读取时主动判断 token 类型并做适配转换。下面这个 StringOrIntConverter 是生产可用的最小实现:

Json Repair Kit
Json Repair Kit

使用 Node.js 评估修复格式错误的 JSON,自动纠正尾随逗号、单引号、未加引号的键等常见问题,实现文件规范化。

下载
public class StringOrIntConverter : JsonConverter<string>
{
    public override string Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        return reader.TokenType switch
        {
            JsonTokenType.String => reader.GetString() ?? string.Empty,
            JsonTokenType.Number => reader.TryGetInt64(out var i) ? i.ToString() : reader.GetDouble().ToString(),
            _ => throw new JsonException($"Unexpected token type {reader.TokenType} for string conversion")
        };
    }

    public override void Write(Utf8JsonWriter writer, string value, JsonSerializerOptions options)
    {
        writer.WriteStringValue(value);
    }
}
  • 别只用 GetInt32():JSON 数字可能超出 int 范围,用 TryGetInt64() 更安全;若还可能含小数,补 GetDouble()
  • GetString() 返回 null 是合法行为(比如 JSON 里是 "Id": null),需判空避免 NRE
  • Write 方法保持简单即可,输出始终是字符串,无需还原原始类型

两种注册方式的区别和选型建议

自定义 converter 可以通过特性或全局选项注册,二者行为差异明显:

  • 属性级([JsonConverter(typeof(StringOrIntConverter))]):仅对该字段生效,适合局部、异构场景;但无法复用到同类型其他字段,除非每个都加
  • 全局注册(options.Converters.Add(new StringOrIntConverter())):对所有 string 字段生效 —— 这通常不是你想要的,容易误伤正常字符串字段
  • 更稳妥的做法是注册「泛型 converter 工厂」:比如只对特定命名(如 Id)或特定泛型约束(如 class T : IIdentity)触发转换,但这需要继承 JsonConverterFactory

绝大多数情况推荐属性级标注,清晰、可控、无副作用。

DateTime 格式定制这类常见需求怎么搞

如果只是想把 DateTime 输出成 yyyy-MM-dd,不要自己从头写 Read/Write —— 直接用内置的 JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter()) 思路不适用,但可以复用 DateTime 的格式化能力:

public class ShortDateConverter : JsonConverter<DateTime>
{
    private readonly string _format = "yyyy-MM-dd";

    public override DateTime Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
        => DateTime.ParseExact(reader.GetString()!, _format, null);

    public override void Write(Utf8JsonWriter writer, DateTime value, JsonSerializerOptions options)
        => writer.WriteStringValue(value.ToString(_format));
}
  • 注意:输入 JSON 必须严格匹配该格式,否则 ParseExact 抛异常;如需容错,改用 DateTime.TryParseExact 并设默认值
  • 别在 Write 里调用 ToString("yyyy-MM-dd") 后再用 WriteStringValue —— 这没问题;但别用 WriteNumberValue,那会输出时间戳
  • 这种 converter 一旦注册到全局,所有 DateTime 都会被格式化,务必确认这是全局策略

真正容易被忽略的是:converter 实例是共享的,不能在 Read 里缓存状态(比如用字段存上次解析结果),也不要在里面 new 大对象 —— 它会被高频复用,影响性能和线程安全。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

相关专题

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

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

3389

2023.06.20

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

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

2368

2023.07.25

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

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

1320

2023.08.02

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

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

1258

2023.08.09

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

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

1396

2023.09.05

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

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

2258

2023.09.20

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

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

3680

2023.09.20

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

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

17035

2023.09.22

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

40

2026.10.22

热门下载

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

精品课程

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

共101课时 | 21.1万人学习

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

共39课时 | 4.9万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn