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

C#怎么使用Source Generator_C#源代码生成器教程【精通】

酷芳君_3262

酷芳君_3262

发布时间:2026-05-18 16:47:19

|

244人浏览过

|

来源于php中文网

原创

Source Generator 不会自动生效,因[Generator]特性是Roslyn唯一入口,若命名空间错误、缺少Microsoft.CodeAnalysis.CSharp引用、类非public或未设OutputItemType="Analyzer"等任一配置失误,均静默失效。

c#怎么使用source generator_c#源代码生成器教程【精通】

Source Generator 不会自动生效,哪怕代码写对了,只要项目配置、特性引用或类声明有一处错,它就完全不运行——连警告都没有。

为什么 [Generator] 特性不触发

这个特性不是装饰用的,它是 Roslyn 找到生成器的唯一入口。常见失效原因包括:

  • [Generator] 来自错误命名空间,比如手写成 MyGenerator.Attributes.Generator;必须是 Microsoft.CodeAnalysis.Generator
  • 生成器项目没引用 Microsoft.CodeAnalysis.Csharp(v4.0+),或版本与 SDK 内置 Roslyn 不匹配(如 .NET 6 项目用了 v3.x)
  • 类不是 public,或是 static、嵌套类(Roslyn 只扫描顶层 public 类)
  • 目标项目引用方式错误:只加 <ProjectReference> 不够,必须同时设 OutputItemType="Analyzer" 和 ReferenceOutputAssembly="false"

IIncrementalGenerator 是唯一推荐接口

旧式 ISourceGenerator 已被标记为过时,且在每次编译时全量遍历语法树,严重拖慢构建速度。增量模型强制你显式声明依赖项,避免无谓重执行。

C#
C#

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

下载
  • 必须在 Initialize 中用 context.SyntaxProvider.CreateSyntaxProvider() 过滤节点(例如只处理带 [AutoNotify] 的属性),不能在过滤阶段调用 GetSemanticModelAsync()
  • 语义分析必须放在后续管道中,通过 context.CompilationProvider 获取,再链式调用 .Select().Collect().SelectMany().RegisterSourceOutput()
  • Initialize 方法里禁止任何副作用(如 IO、日志、缓存初始化),它只负责注册管道

生成的代码怎么注入才有效

生成逻辑必须落在 Execute 或 RegisterSourceOutput 回调里,并调用 context.AddSource(),否则就是“写了但没生成”。

  • 文件名建议用 .g.cs 后缀(如 "INotifyPropertyChange.g.cs"),避免和手写文件冲突
  • 内容必须是合法 C# 语法,否则编译直接报错;不能引用尚未生成的类型(如自己生成的 partial class 在同一编译单元内不可见)
  • 别硬编码 compilation.SyntaxTrees[0] —— 多文件项目下索引越界,应遍历 compilation.SyntaxTrees 或用 SyntaxProvider 过滤
  • 出错不要 throw new Exception(),改用 context.ReportDiagnostic() 发送可定位的诊断信息

目标项目必须满足的最低条件

Source Generator 是编译时机制,不是运行时插件,它对项目结构极其敏感。

  • 目标项目必须是 SDK 风格项目(<Project Sdk="Microsoft.NET.Sdk">),不能是旧式 .csproj
  • <TargetFramework> 必须为 net5.0 或更高(netstandard2.0 不支持)
  • 生成器项目自身应设 <IsAnalyzer>true</IsAnalyzer>,目标框架推荐 netstandard2.0(兼容性最好)
  • 宿主项目若用 NuGet 引用生成器,包内需包含 analyzers/dotnet/cs/xxx.dll,且 PackagePath 配置正确

最容易被忽略的一点:生成器类的 public 修饰符和 [Generator] 特性必须同时存在,缺一不可;而 context.AddSource() 调用位置一旦不在增量管道末端或 Execute 内,生成就会静默跳过——你不会收到任何提示,只会发现 IDE 里找不到生成的类型、补全不出现、调试也进不去。这不是 bug,是设计使然。

热门AI工具

更多
DeepSeek

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

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

豆包大模型

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

PixTV
PixTV Hot

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

PixPix
PixPix Hot

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

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

WorkBuddy

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

Loomy
Loomy Hot

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

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

相关专题

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

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

3009

2023.06.20

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

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

2268

2023.07.25

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

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

1200

2023.08.02

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

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

1158

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

1336

2023.09.05

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

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

2098

2023.09.20

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

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

3320

2023.09.20

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

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

14855

2023.09.22

Kratos框架HTTP与gRPC服务开发教程
Kratos框架HTTP与gRPC服务开发教程

本专题围绕Kratos框架双协议服务开发,涵盖HTTP路由与处理器编写、参数获取、gRPC服务实现与客户端调用、metadata上下文传递、encoding编解码注册、统一响应封装、超时控制与流式响应实现方法。

0

2026.10.10

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
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