C# 源生成器入门
学习C#源生成器,在编译时自动生成代码 · 难度:入门 · +15XP
源生成器概述
C# 9 引入的源生成器(Source Generator)是一种 Roslyn 分析器,在编译期间检查用户代码并生成额外的 C# 源文件。它常用于减少样板代码。
工作原理
- 实现 ISourceGenerator 接口
- 在 Initialize 中注册语法接收器
- 在 Execute 中分析语法树并生成代码
- 生成的代码被编译到同一程序集中
典型应用
| 库 | 功能 |
|---|---|
| System.Text.Json | 生成序列化代码 |
| Regex 源生成器 | 编译时生成正则表达式 |
| INotifyPropertyChanged | 自动实现属性通知 |
示例(简化)
[Generator]
public class HelloGenerator : ISourceGenerator
{
public void Execute(GeneratorExecutionContext context)
{
var source = "namespace Generated { public static class Hello { public static string Say() => \"Hello from generator!\"; }}";
context.AddSource("HelloGenerator", source);
}
public void Initialize(GeneratorInitializationContext context) { }
}注意:实际使用需要创建 .NET Standard 2.0 项目并引用 Microsoft.CodeAnalysis.CSharp 包。
💡 练习提示:创建一个简单的源生成器,为标记了特定特性的类自动生成 Builder 模式代码。