展开菜单
首页 精品内容 本月促销 装机必备 Windows PDF教程 macOS软件 IOS软件 Android AI 专题
全部分类

当前位置:

首页 > 编程开发 > 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#
    相关文章 更多
    精品专题 更多
    装机必备

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

    Windows

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

    PDF教程

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

    macOS软件

    正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

    IOS软件

    正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

    AI

    正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

    Mac软件 更多
    Postman macOS版
    Postman macOS版

    Postman是一套面向API全生命周期的开发与测试平台,可在Mac上发送和调试多种协议请求,管理集合、环境及认证信息,并完成脚本测试、模拟服务、监控、文档发布和团队协作。它适合开发、测试及运维人员使用,提供个人免费方案。

    Docker Desktop macOS版
    Docker Desktop macOS版

    Docker Desktop 是 Docker 官方为 Mac 提供的容器开发环境,集成 Docker Engine、命令行工具、Compose、Build、Kubernetes 与图形化管理界面。

    Android Studio macOS版
    Android Studio macOS版

    Android Studio 是 Google 面向安卓应用开发提供的官方集成开发环境,基于 IntelliJ IDEA 构建。它整合智能代码编辑、Gradle 构建、界面预览、设备模拟、性能分析、调试测试及 APK 分析等工具。

    Xcode macOS版
    Xcode macOS版

    Xcode 是苹果面向 Mac 提供的官方集成开发环境,将代码编辑、项目构建、SwiftUI 实时预览、设备模拟、自动化测试、断点调试、性能分析和应用分发整合在同一套工作流中,适合开发与维护 iPhone、iPad、Mac、Apple Wa

    JetBrains WebStorm macOS版
    JetBrains WebStorm macOS版

    JetBrains WebStorm 是面向 JavaScript、TypeScript 和现代 Web 技术的专业集成开发环境,可智能理解项目结构,提供代码补全、重构、错误检查、运行调试、测试及 Git 工具。

    PhpStorm macOS版
    PhpStorm macOS版

    PhpStorm 是 JetBrains 推出的专业 PHP 集成开发环境,可在 Mac 上完成代码编写、智能检查、重构、调试、测试和数据库管理。它支持主流 PHP 框架、Composer、Git、Docker 与远程解释器。

    JetBrains PyCharm macOS版
    JetBrains PyCharm macOS版

    JetBrains PyCharm 是面向 Python 开发者的集成开发环境,提供智能补全、代码检查、重构、调试、测试、版本控制及虚拟环境管理功能。Mac 版兼容 Intel 与 Apple 芯片,核心功能可免费使用。

    JetBrains IntelliJ IDEA macOS版
    JetBrains IntelliJ IDEA macOS版

    IntelliJ IDEA 是 JetBrains 推出的专业集成开发环境,重点服务于 Java、Kotlin 与 JVM 项目开发。软件集成代码补全、静态检查、重构、调试、测试、版本控制及构建工具,并可借助插件扩展语言和框架支持。

    Visual Studio Code macOS版
    Visual Studio Code macOS版

    Visual Studio Code 是微软提供的免费代码编辑器,支持 macOS,并为 Intel 与 Apple 芯片 Mac 提供适配版本。软件集代码编辑、调试、Git 源代码管理、集成终端和扩展市场于一体。

    REAPER macOS版
    REAPER macOS版

    REAPER是Cockos开发的数字音频工作站,提供多轨音频与MIDI录制、剪辑、处理、混音和母带制作工具。Mac版兼容Intel与Apple芯片,支持AU、VST、VST3、CLAP等插件格式,并提供高度可定制的工作流程。

    Adobe Audition macOS版
    Adobe Audition macOS版

    Adobe Audition 是面向播客、影视后期、音乐制作及内容创作者的专业音频工作站,提供波形精修、多轨录制与混音、频谱编辑、降噪修复、响度匹配和效果处理工具,并可与 Adobe Premiere 协同完成视频声音制作。

    Pro Tools macOS版
    Pro Tools macOS版

    Pro Tools 是 Avid 推出的专业数字音频工作站,覆盖多轨录音、无损剪辑、MIDI 编曲、插件处理、自动化混音及声音与画面同步等工作。它拥有 Intro、Artist、Studio 和 Ultimate 等方案。

    WINDOWS 更多
    PixPix 网页版
    PixPix 网页版

    PixPix 是面向品牌、卖家和内容团队的在线 AI 图片视频创作平台,提供图视频 Agent、无限画布、图片生成、视频生成、自然语言编辑及商品套图、产品精修和带货视频等电商工具。

    Postman Windows版
    Postman Windows版

    Postman 是面向 API 全生命周期的开发与协作平台。Windows 桌面版可用于构建和发送 HTTP、GraphQL、gRPC、WebSocket、MQTT 等请求,并提供环境变量、集合、脚本测试、模拟服务、监控、文档及团队工作区等

    Docker Desktop Windows版
    Docker Desktop Windows版

    Docker Desktop 为 Windows 开发者提供集成式容器环境,内置 Docker Engine、命令行工具、Compose、Build 与 Kubernetes 等组件,可在本机完成镜像构建、容器运行、日志查看和资源管理。

    Android Studio Windows版
    Android Studio Windows版

    Android Studio 是 Google 面向 Android 应用开发提供的官方集成开发环境,以 IntelliJ IDEA 为基础,集成智能代码编辑、Gradle 构建、设备模拟、界面预览、调试测试及性能分析工具,

    JetBrains WebStorm Windows版
    JetBrains WebStorm Windows版

    WebStorm 是 JetBrains 面向 JavaScript、TypeScript 和现代 Web 技术打造的集成开发环境。它提供项目级代码分析、智能补全、安全重构、导航搜索,并集成调试、测试、终端、Git 与常用前端工具,

    JetBrains PhpStorm Windows版
    JetBrains PhpStorm Windows版

    PhpStorm 是 JetBrains 面向 PHP 与现代 Web 开发打造的专业集成开发环境,提供代码补全、静态检查、重构、调试、测试、数据库、版本控制及前端语言支持。Windows 用户可直接下载安装程序,

    JetBrains PyCharm Windows版
    JetBrains PyCharm Windows版

    PyCharm 是 JetBrains 推出的 Python 集成开发环境,提供智能代码补全、错误检查、重构、调试、测试、Git、终端及 Jupyter Notebook 支持。统一版安装后可体验 30 天 Pro 功能,

    JetBrains IntelliJ IDEA Windows版
    JetBrains IntelliJ IDEA Windows版

    JetBrains IntelliJ IDEA 是以 Java、Kotlin 和 JVM 项目为核心的专业集成开发环境,提供智能补全、代码检查、安全重构、调试、测试、版本控制及构建工具集成。统一发行版的核心功能可免费用于商业和非商业项目,

    Visual Studio Code Windows版
    Visual Studio Code Windows版

    Visual Studio Code 是微软推出的免费代码编辑器,Windows 版集成智能补全、代码导航、调试、终端和版本控制,并可通过扩展添加语言、格式化及远程开发能力。它启动较快、配置灵活,

    REAPER Windows版
    REAPER Windows版

    REAPER 是 Cockos 推出的数字音频工作站,适用于录音、MIDI 编曲、音频编辑、混音、母带制作及声音设计。软件安装包小巧,支持多轨录制、灵活路由、自动化、第三方插件和脚本扩展,并提供完整功能的 60 天免费评估期。

    Adobe Audition Windows版
    Adobe Audition Windows版

    Adobe Audition 是面向播客、影视后期、广播与音乐制作的专业音频工作站,提供波形编辑、多轨混音、频谱分析、录音、降噪修复和效果处理等功能。Windows 版通过 Adobe Creative Cloud 安装和管理,

    Pro Tools Windows版
    Pro Tools Windows版

    Pro Tools 是 Avid 推出的专业数字音频工作站,提供多轨录音、音频剪辑、MIDI编曲、插件处理、自动化混音及影视声音制作能力。它适合音乐人、录音师、制作人和音频后期团队使用,并提供免费入门版、订阅方案及永久授权选择。