C# 源代码生成器方法 C#如何创建自己的Source Generator

Source Generator 是什么，它能做什么

Source Generator 是 C# 9+ 提供的编译时代码生成机制，不是运行时反射或模板引擎。它在 Roslyn 编译器执行语法分析阶段介入，通过实现

IIncrementalGenerator

partial class

它不能替代运行时代码生成（如

Reflection.Emit

创建一个最简 Source Generator 项目

需要两个分离的项目：一个是 generator 本身（类库），另一个是使用它的目标项目（通常为 .NET 6+ SDK 风格的 Console 或 Library）。

实操步骤：

netstandard2.0

Microsoft.CodeAnalysis.CSharp

Microsoft.CodeAnalysis.Analyzers

System.Collections.Immutable

IIncrementalGenerator

Initialize

ISourceGenerator

ProjectReference

OutputItemType="Analyzer"

ReferenceOutputAssembly="false"

关键配置示例（目标项目的 .csproj 中）：

<ItemGroup>
  <ProjectReference Include="..\MyGenerator\MyGenerator.csproj" 
                    OutputItemType="Analyzer" 
                    ReferenceOutputAssembly="false" />
</ItemGroup>

为什么 Initialize 方法里要用 IncrementalValueProvider

Roslyn 的增量编译模型要求 generator 显式声明依赖项（如语法树、语义模型、特定 Attribute），否则无法触发重生成。直接遍历

compilation.SyntaxTrees

正确做法是使用

context.SyntaxProvider

context.CompilationProvider

CreateSyntaxProvider

[AutoLog]

GetSemanticModelAsync

RegisterSourceOutput

错误写法（破坏增量性）：

foreach (var tree in context.Compilation.SyntaxTrees) { ... }

正确起点示例：

context.RegisterSourceOutput(
    context.SyntaxProvider
        .CreateSyntaxProvider(
            predicate: static (s, _) => s is MethodDeclarationSyntax m && 
                m.AttributeLists.Any(al => al.Attributes.Any(a => a.Name.ToString() == "AutoLog")),
            transform: static (ctx, _) => ctx.Node as MethodDeclarationSyntax)
        .Where(m => m != null),
    Execute);

生成的代码必须是 partial 且命名空间/类名严格匹配

Source Generator 输出的代码会被 Roslyn 当作普通源文件参与编译，但它不能定义“全新”的非 partial 类——否则会和用户手写的类冲突，报

CS0101: The namespace 'X' already contains a definition for 'Y'

所以必须遵守：

partial class

partial struct

partial record

public void Foo()

__autoLogHandler

生成内容示例（字符串拼接，非 Roslyn SyntaxFactory）：

var code = $$"""
namespace {{@namespace}};
partial class {{className}}
{
    private void <>__AutoLog_{{methodName}}() { /* ... */ }
}
""";

最容易被忽略的是命名空间嵌套层级和 using 指令缺失——generator 不自动继承目标文件的

using

using