Source Generators 是 C# 9 引入的编译时代码生成技术,可在编译阶段自动生成 C# 源文件,不依赖反射、不修改原代码,生成代码具备完整 IDE 支持。
Source Generators 是 C# 9 引入的编译时代码生成技术,它能在编译阶段自动为你生成 C# 源文件,不依赖运行时反射,也不修改原始代码——生成的代码会和手写代码一样参与编译、有完整 IDE 支持(跳转、补全、调试)。
确保你使用的是 .NET 5 或更高版本(推荐 .NET 6+),且 SDK 支持 Source Generator。你需要两个项目:
Microsoft.CodeAnalysis.CSharp 和 Microsoft.CodeAnalysis.Analyzers)关键点:生成器项目必须声明为 ,并在使用项目中用 引入。
新建一个类实现 ISourceGenerator,重写 Initialize 和 Execute 方法:
using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.Text; using System.Text;[Generator] public class HelloGenerator : ISourceGenerator { public void Initialize(GeneratorInitializationContext context) { }
public void Execute(GeneratorExecutionContext context) { var source = @"namespace Generated{ public static class Greeting { public static string SayHello() => ""Hello from generator!""; } }"; context.AddSource("Greeting.g.cs", SourceText.From(source, Encoding.UTF8)); } }
注意:
[Generator]特性标记必不可少;AddSource的文件名建议以.g.cs结尾,便于识别是生成代码;内容必须是合法 C# 语法,否则编译报错。三、读取用户代码并生成响应式内容
真正实用的生成器需要分析用户代码。比如:扫描所有标记了
[AutoNotify]的 partial class,自动生成 INotifyPropertyChanged 实现。
Initialize 中注册语法/语
义回调(如 context.RegisterForSyntaxNotifications(() => new AutoNotifySyntaxReceiver()))ISyntaxContextReceiver)收集感兴趣节点(如 ClassDeclarationSyntax)Execute 中通过 context.Compilation 获取语义模型,检查 Attribute 应用情况SyntaxFactory 或字符串模板拼出新代码,再 AddSource
小技巧:调试生成器较难,可先用 Debugger.Launch()(需在开发机上允许调试),或把生成逻辑抽成独立方法 + 单元测试验证输出字符串是否符合预期。
想让团队或 NuGet 上其他人使用?把生成器打包成 NuGet 包:
true
.csproj 中添加
dotnet pack 打包,使用者安装该 NuGet 即自动启用生成器无需额外配置,也不需要用户手动添加 ProjectReference —— 这是 NuGet 分发生成器的标准方式。
基本上就这些。Source Generator 不复杂但容易忽略细节:版本兼容性、引用方式、调试手段。写好一个能读属性、生成方法、支持泛型的生成器后,你会发现很多重复样板代码(如 DTO 映射、序列化契约、接口实现)都能自动化掉。