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

C#怎么使用Source Generator C#源代码生成器怎么用如何在编译时自动生成代码【进阶】

老墨大大_4385

老墨大大_4385

发布时间:2026-03-31 15:46:03

|

996人浏览过

|

来源于php中文网

原创

Source Generator 必须在 .NET 5+ SDK 项目中启用,目标框架需为 net5.0 或更高,项目须引用 Microsoft.CodeAnalysis.Csharp 并显式引用生成器项目且设 OutputItemType="Analyzer" 和 ReferenceOutputAssembly="false";生成器类必须 public、非嵌套、实现 ISourceGenerator 并标记 [Generator] 特性;Execute 中需遍历用户源码 SyntaxTree、用 GetSemanticModel 获取语义模型、通过 context.AddSource 注入代码,避免依赖未生成类型或硬编码语法树索引。

c#怎么使用source generator c#源代码生成器怎么用如何在编译时自动生成代码【进阶】

Source Generator 必须在 .NET 5+ SDK 项目中启用

Source Generator 不是运行时特性,它只在编译阶段介入,所以旧版 .NET Framework 或未启用新 SDK 的项目根本不会触发。你写对了所有代码,但 Generate 方法压根不被调用,大概率是项目没“认出”这是个生成器项目。

实操建议:

  • 确认 .csproj 文件顶部是 <Project Sdk="Microsoft.NET.Sdk">(不是 Microsoft.NET.Sdk.Web 等子集 SDK,除非显式导入主 SDK)
  • 目标框架必须为 <TargetFramework>net5.0</TargetFramework> 或更高(如 net6.0、net8.0),netstandard2.0 不支持
  • 生成器项目自身需引用 Microsoft.CodeAnalysis.CSharp 和 Microsoft.CodeAnalysis.Analyzers,且版本与 SDK 内置的 Roslyn 匹配(例如 .NET 6 对应 Roslyn 4.0+,用错版本会静默失败)
  • 宿主项目(即要使用生成器的项目)需在 .csproj 中显式引用生成器项目,并设 OutputItemType="Analyzer" 和 ReferenceOutputAssembly="false"

Generator 类必须实现 ISourceGenerator 接口且标记 [Generator] 特性

很多人写了类、实现了 Initialize 和 Execute,却忘了加 [Generator] —— 这个特性是 Roslyn 找到你的生成器的唯一入口。没有它,整个类会被完全忽略,连编译警告都没有。

实操建议:

  • 类必须是 public,且不能是 static 或嵌套类(Roslyn 不扫描嵌套类型)
  • [Generator] 必须放在类声明前,且来自 Microsoft.CodeAnalysis 命名空间(别手误写成自己定义的同名特性)
  • Execute 方法里不能 throw 异常,否则会导致编译失败;出错应改用 context.ReportDiagnostic() 发送诊断信息
  • 生成的代码必须通过 context.AddSource("FileName.cs", SourceText.From(content, Encoding.UTF8)) 注入,文件名建议带 .g.cs 后缀,避免和手写代码冲突

获取语法树或语义模型时,别直接访问 Compilation.SyntaxTrees[0]

常见错误:在 Execute 中硬编码取第一个语法树,结果遇到多文件项目或 Razor/Designer 文件就崩——SyntaxTree 是按源文件来的,而 Compilation 包含所有输入(包括生成的、引用的、甚至 SDK 自带的)。

C#
C#

"避开 C# 常见错误——空陷阱、异步陷阱、LINQ 陷阱及资源泄漏。"

下载

实操建议:

  • 用 context.Compilation.SyntaxTrees 遍历,但优先过滤掉非用户源码的树:检查 tree.FilePath 是否以 .cs 结尾,且不包含 "obj/"、"Generated/"、"Razor/" 等路径片段
  • 需要语义信息(比如判断某个类型是否继承自 INotifyPropertyChanged)时,必须先调用 context.Compilation.GetSemanticModel(tree),不能复用其他树的模型
  • 大量遍历节点性能敏感,别在 Execute 里做深度递归;考虑用 CSharpSyntaxWalker + ShouldVisitXXX 控制范围
  • 别在生成器里调用 model.GetTypeInfo(node).Type 后直接 .ToString() 比对名称——泛型、可空引用类型、别名都会导致字符串不一致;改用 model.GetTypeInfo(node).Type.Equals(...) 或 IsNamedType("System.Collections.Generic.List`1")

生成的代码不能依赖尚未生成的类型,也不能覆盖已有成员

生成器跑在编译早期,此时用户代码还没编译完,所以你生成的类若引用了另一个正在被生成的类,就会报 CS0246:“找不到类型”。更隐蔽的是:生成的 partial class 若和手写部分有同名方法,C# 编译器会直接报 CS0111,而不是合并。

实操建议:

  • 所有生成代码中的类型引用,必须来自已编译的程序集(context.Compilation 能解析到的),不要试图“预测”用户将写的类名
  • 用 partial 类时,确保手写部分已存在且命名空间、类名完全一致;生成器只负责补全方法,不定义构造函数或字段(除非你明确控制手写部分不定义)
  • 避免生成 async 方法体——除非你手动写完整状态机或引用 System.Runtime.CompilerServices,否则生成的代码大概率编译不过
  • 调试时,在 Execute 开头加 Debugger.Launch() 并 attach 到 dotnet.exe(不是 VS 进程),因为生成器运行在独立的编译器进程中

最麻烦的其实是跨项目引用场景:生成器 A 依赖 B,B 又依赖 C,其中某一个没正确设 ReferenceOutputAssembly="false",整条链就失效——这种问题不会报错,只会“静默跳过”,得靠查看 dotnet build -v:d 日志里有没有 Executing generator 行来确认。

热门AI工具

更多
DeepSeek

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

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

豆包大模型

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

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

咔片AIPPT

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

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

WorkBuddy

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

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

相关专题

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

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

3229

2023.06.20

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

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

2328

2023.07.25

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

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

1260

2023.08.02

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

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

1218

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

1356

2023.09.05

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

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

2198

2023.09.20

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

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

3520

2023.09.20

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

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

16095

2023.09.22

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

40

2026.10.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
C++ Core Guidelines
C++ Core Guidelines

共0课时 | 0人学习

C++ Reference
C++ Reference

共0课时 | 0人学习

C++ 官方标准说明
C++ 官方标准说明

共0课时 | 0人学习

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

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