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

C# System.Text.Json源生成器方法 C#如何使用Source Generation模式提升JSON性能

千宇吖_6973

千宇吖_6973

发布时间:2026-03-10 13:08:03

|

707人浏览过

|

来源于php中文网

原创

System.Text.Json源生成器启用失败的常见原因包括未启用ImplicitUsings和Nullable、未引用正确版本包、未正确定义partial JsonSerializerContext类及[JsonSerializable]特性,且必须使用生成的上下文实例调用Serialize/Deserialize方法。

c# system.text.json源生成器方法 c#如何使用source generation模式提升json性能

System.Text.Json源生成器启用失败的常见原因

源生成器在 .NET 6+ 中默认不启用,即使项目 SDK 是 Microsoft.NET.Sdk,也必须显式开启源生成支持。最常被忽略的是未在 .csproj 中设置 ImplicitUsings 和 Nullable,或未引用正确的包版本。

  • System.Text.Json 源生成依赖 System.Text.Json.SourceGeneration 包(.NET 7+ 内置,但需确认 SDK 版本;.NET 6 需手动安装 System.Text.Json 6.0.3+)
  • 项目必须启用 <implicitusings>enable</implicitusings>,否则 JsonSerializerContext 相关类型无法解析
  • 若使用 partial 类型定义上下文,类名必须以 JsonSerializerContext 结尾,且标记 [JsonSerializable] —— 否则生成器不触发
  • 生成器输出在 obj/Debug/netX.X/ 下的 GeneratedSources/ 文件夹中,若该目录为空,说明生成未执行,可检查 dotnet build -v:d 日志中是否有 SourceGenerator 相关警告

如何正确定义 JsonSourceGenerationContext

源生成器不是自动扫描所有类型,而是基于你声明的 JsonSerializerContext 子类,显式列出需要序列化的类型。这个类必须是 partial,且每个 [JsonSerializable] 属性对应一个根类型(支持嵌套、泛型、接口,但不支持 object 或未标注的运行时类型)。

jm-jsjkxyjs02-zlm-405
jm-jsjkxyjs02-zlm-405

使用约定式提交(Conventional Commits)生成标准化的 Git 提交信息。适用于以下场景: (1) 暂存更改时需要提交信息; (2) 审查 diff 时希望获得结构化摘要; (3) 编写 PR 描述或变更日志(changelog)条目; (4) 用户明确要求“为本次更改编写提交信息”。 该功能会分析已暂存/未暂存的 diff,并生成按类型(type)划分范围的提交信息。

下载
[JsonSerializable(typeof(Person))]
[JsonSerializable(typeof(List<Person>))]
[JsonSerializable(typeof(Dictionary<string, Order>))]
internal partial class AppJsonContext : JsonSerializerContext
{
}
  • Person 和 Order 类本身不需要额外标记,但字段/属性访问必须为 public,或通过 [JsonInclude] 开放 private 成员
  • 若类型含 DateTimeOffset、Guid 等,无需额外配置,默认已优化;但自定义转换器(如 JsonConverter<t></t>)仍需在上下文中注册:[JsonSerializable(typeof(Person), TypeInfoPropertyName = "PersonInfo")] + 手动实现 PersonInfo 属性
  • 不支持动态类型(如 ExpandoObject)、dynamic、未闭合泛型(List)—— 这些会跳过生成,回退到反射路径

序列化/反序列化时如何正确使用生成的上下文

启用源生成后,不能继续用静态 JsonSerializer.Serialize<t>(value)</t>,那仍走反射路径。必须传入生成的 AppJsonContext.Default 实例,并使用其 Serialize/Deserialize 方法,才能命中编译期生成的代码路径。

var context = AppJsonContext.Default;
string json = context.Serialize(person); // ✅ 调用生成的代码
Person p = context.Deserialize<Person>(json); // ✅

// ❌ 以下仍走反射,完全绕过源生成
string json2 = JsonSerializer.Serialize(person);
Person p2 = JsonSerializer.Deserialize<Person>(json2);
  • AppJsonContext.Default 是线程安全的单例,可全局复用,无需缓存或池化
  • 若需不同选项(如 PropertyNamingPolicy),必须定义多个 partial 上下文类,每个带独立 [JsonSourceGenerationOptions] 特性;无法在运行时切换同一上下文的选项
  • 生成代码对 null 值处理与反射路径一致,但字段级 JsonIgnore 必须在类型定义时存在,运行时通过 JsonSerializerOptions 添加的忽略规则无效

性能差异在哪?什么场景下值得上源生成

源生成主要消除反射调用和运行时类型检查开销,在高频、小对象、固定结构的 JSON 场景下收益明显(如微服务间 DTO 通信、API 响应序列化)。但它的优势不是“绝对更快”,而是“更稳定”——避免 JIT 编译抖动和 GC 压力波动。

  • 典型提升:10–30% 吞吐量(Serialize),反序列化可达 2× 以上(尤其含集合或深层嵌套时)
  • 真正关键收益是首次调用无 JIT 延迟:反射路径首次 Serialize<t></t> 可能卡住 5–20ms;源生成代码在编译时就产出 IL,启动即可用
  • 不适合场景:类型结构高度动态(如配置驱动的 JSON Schema)、开发期频繁改模型(每次改都要 rebuild 才能更新生成代码)、或仅偶尔序列化大文件(此时 IO 或压缩才是瓶颈)
  • 调试时注意:生成的代码在 obj/ 下,VS 默认不加载,需在调试设置中启用 “Enable source server support” 并勾选 “Enable Just My Code” 外的符号加载,否则断点进不到生成方法里

相关文章

数码产品性能查询
数码产品性能查询

该软件包括了市面上所有手机CPU,手机跑分情况,电脑CPU,电脑产品信息等等,方便需要大家查阅数码产品最新情况,了解产品特性,能够进行对比选择最具性价比的商品。

下载

相关标签:

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

热门AI工具

更多
音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

咔片AIPPT

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

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

WorkBuddy

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

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

豆包大模型

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

立刻MV
立刻MV Hot

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

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

DeepSeek

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

相关专题

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

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

3729

2023.06.20

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

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

2468

2023.07.25

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

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

1420

2023.08.02

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

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

1358

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,随机排序。

1436

2023.09.05

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

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

2398

2023.09.20

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

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

4000

2023.09.20

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

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

19035

2023.09.22

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

0

2026.11.06

热门下载

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

精品课程

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

共101课时 | 21.3万人学习

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

共39课时 | 4.9万人学习

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

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