当前位置:

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

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

先说几个关键判断。System.Text.Json 的自定义转换器,说难不难,说简单也不简单,核心在于理解它的类型系统和运行机制。很多开发者卡在注册了却无效、读数据时异常、或者写出的转换器只能处理特定类型的死胡同里。这篇文章就来把这些坑一一填上。 为什么继承 JsonConverter 而不是直接写

本文目录
    先说几个关键判断。System.Text.Json 的自定义转换器,说难不难,说简单也不简单,核心在于理解它的类型系统和运行机制。很多开发者卡在注册了却无效、读数据时异常、或者写出的转换器只能处理特定类型的死胡同里。这篇文章就来把这些坑一一填上。

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

    为什么继承 JsonConverter 而不是直接写 JsonConverter

    一句话解释:JsonConverter 只是个不带泛型的抽象基类,它天然无法参与类型推导,也得不到编译期的检查;而 JsonConverter 才是真正干活的入口。System.Text.Json 在序列化时,靠的就是这个泛型参数来精准匹配类型。你不指定 T,那 Read 和 Write 方法里的 typeToConvert 参数就形同虚设,运行时要么报 NotSupportedException,要么直接跳过你的转换器——后者更隐蔽,更让人头疼。

    一个非常典型的错误场景:注册了转换器,但序列化结果毫无变化,JSON 依然按默认规则处理。大概率就是没继承 JsonConverter,而是误写了 JsonConverter。

    • 必须显式指定泛型类型,比如 JsonConverter、JsonConverter>。
    • 但注意,如果类型本身含泛型参数(比如 Dictionary),你不能直接写 JsonConverter> 来继承,编译根本过不了。这时候,就得请出 JsonConverterFactory 来动态构造。
    • 还有一点容易被忽略:Read 方法里拿到的 ref Utf8JsonReader 必须手动推进。漏掉 reader.Read(),或者误用 reader.Skip(),都会导致后续字段解析错位,整个 JSON 就乱了。

    如何正确处理 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) 比直接 GetInt32() 更安全,失败时不抛异常,给你留了处理空间。
    • 第四步:手动推进 reader。每次成功读一个值后,务必调用 reader.Read() 进入下一个 token,否则下次 Read() 会卡在原地。

    什么时候必须用 JsonConverterFactory 而不是普通 JsonConverter

    这个问题很关键。当你需要为开放泛型类型(比如 Dictionary、List)提供通用转换逻辑时,JsonConverterFactory 是唯一选择。普通 JsonConverter 只能绑定到闭合类型(比如 Dictionary),编译期就固定死了,没有灵活性。

    一个常见的错误做法:试图写 class DictEnumConverter : JsonConverter> —— 编译不过,而且运行时也无法实例化。

    • CanConvert(Type typeToConvert) 必须严格判断:检查 IsGenericType、GetGenericTypeDefinition()、泛型参数数量和约束(比如第一个是不是 Enum)。
    • CreateConverter(Type type, JsonSerializerOptions options) 里用 Type.MakeGenericType(...) 构造闭合类型,再通过 Activator.CreateInstance 创建对应转换器实例。
    • 内部实际转换器(比如 DictionaryEnumConverterInner)仍需继承 JsonConverter>,只是它的 TKey 和 TValue 在工厂里动态确定。
    • 别忘了在 CreateConverter 中复用 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 解析就偏移了。这才是关键所在。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发 JSON C#
    相关文章 更多
    漫蛙漫画最新网址链接进入
    漫蛙漫画最新网址链接进入

    漫蛙漫画官网全解析:资源、体验与稳定性深度评测 “漫蛙漫画最新网址是什么?”“官方的在线观看入口在哪里?”——最近,这类问题在漫画爱好者圈子里可谓不绝于耳。别急,2025年最新、最稳的官方访问途径,这就为你一一道来。 官网入口直通车:https://www.manwamh.top 平台资源覆盖广度

    winforms教程自学入门与基础开发步骤详解
    winforms教程自学入门与基础开发步骤详解

    本教程详细讲解如何使用Visual Studio创建WinForms项目,通过添加按钮和标签控件并编写点击事件代码,实现一个基础的计数器功能,适合C#初学者快速上手Windows窗体应用开发。

    Java发送post请求发送json数据的实现方法与代码示例
    Java发送post请求发送json数据的实现方法与代码示例

    深入解析Java发送JSON格式POST请求的实现机制,对比原生API与第三方库的代码差异,提供可复制的代码示例,并探讨超时设置、编码处理及微服务场景下的例外情况。

    个人学信档案在线入口
    个人学信档案在线入口

    学信网个人档案:您的官方教育信息枢纽 “学信网个人档案的入口究竟在哪儿?”这几乎是每位求职、升学或办理落户的朋友都会询问的问题。其实,官方查询路径非常明确,其核心在线入口为:https://my.chsi.com.cn/archive/index.jsp。通过这个门户,注册登录后,你便能一站式查询到

    抖音官网入口网页
    抖音官网入口网页

    抖音官网入口的正确打开方式 如果你在寻找抖音网页版的入口,那么直接访问 https://www.douyin.com 就是了。这不仅是通往海量短视频世界的门户,更是一个功能越来越专业的媒体素材库和创作工具箱。为什么这么说?看看它最近在功能上的深度拓展就知道了。 简单一个网址背后,其实是一个日益精密的

    在小说搜搜找不到想看的小说怎么办?小说搜搜换源功能使用详解【必学】
    在小说搜搜找不到想看的小说怎么办?小说搜搜换源功能使用详解【必学】

    小说搜搜搜索不到结果?五种实用解决方法帮你搞定 在小说搜搜里搜不到想看的书?这事儿其实挺常见。问题多半出在书源上——要么是默认的书源还没来得及收录,要么是原先的源数据失效了,更新没跟上。别急,下面这五条解决路径,基本能覆盖绝大多数情况,操作起来也不复杂。 一、通过阅读页调出换源入口手动切换 这个方法

    QQ安全中心解冻账号官网地址
    QQ安全中心解冻账号官网地址

    QQ账号被冻结?这份官方解冻指南请收好 遇到QQ账号突然被冻结,确实让人着急。不过别慌,腾讯官方的解冻通道其实相当清晰。核心入口就是QQ安全中心官网: 直接访问 https://aq.qq.com/cn2/index,就能找到全套解决方案。这个页面不仅提供多种验证方式,还集成了进度查询、原因说明等实

    米侠浏览器打不开网页
    米侠浏览器打不开网页

    米侠浏览器页面打不开,或者干脆显示一片空白?问题根源大概率出在内核上。比如内核和当前网页的兼容性出了岔子、页面渲染模块意外损坏,再或者,内核版本实在太旧了。别急,沿着切换内核、清理缓存、关闭硬件加速、替换核心文件这四步走,通常都能解决。 用米侠浏览器上网,碰到页面死活刷不出来,或者只显示一个空白屏幕

    Chrome浏览器JS脚本不运行怎么办
    Chrome浏览器JS脚本不运行怎么办

    Chrome中JavaScript未执行需依次检查:一、移除站点级禁用并添加允许域名;二、开启全局JavaScript开关;三、禁用干扰扩展;四、在开发者工具中启用JavaScript;五、重置内容设置为默认。 有时在Chrome里打开网页,会发现交互按钮点了没反应,数据加载不出来,页面仿佛“静止”

    IE浏览器怀旧版在线网址
    IE浏览器怀旧版在线网址

    IE浏览器怀旧版在线网址:一次精准的技术时光回溯 最近,不少老用户和怀旧爱好者在反复搜索一个问题:那个经典的Internet Explorer,如今还能在哪里原汁原味地体验到?答案指向一个特定的地址:https://ie.microsoft.com/legacy/。 这个网站远不止是一个简单的“皮肤

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。