C# 源生成器(Source Generator)入门

C#9 引入了一个强盛的机制：源生成器(Source Generator)。通过创建源生成器，我们可以简化大量重复编写的代码，或是镌汰反射来获得更强的性能以及AOT支持
本文将介绍如何从零开始创建一个最简朴的源生成器
创建生成器项目

创建一个SourceGeneratorDemo.Generator项目，目的框架需要设置为.NET Standard 2.0

这大概由于Visual Studio尚未迁徙到.NET Core，Framework最高支持.NET Standard 2.0的项目

添加Microsoft.CodeAnalysis.Analyzers、Microsoft.CodeAnalysis.CSharp的nuget引用。
添加EnForceExtendedAnalyzerRules属性，逼迫禁用一些分析器不适用的API，否则IDE会有告诫
（此属性的详细作用可以看lindexi大佬的这篇文章）

1. <PropertyGroup>
2.         ...
3.     <EnForceExtendedAnalyzerRules>true</EnForceExtendedAnalyzerRules>
4. </PropertyGroup>

复制代码

最终csproj文件如下：

1. <Project Sdk="Microsoft.NET.Sdk">
3.     <PropertyGroup>
4.         <TargetFramework>netstandard2.0</TargetFramework>
5.         <LangVersion>preview</LangVersion>
6.         <Nullable>enable</Nullable>
7.         <EnForceExtendedAnalyzerRules>true</EnForceExtendedAnalyzerRules>
8.     </PropertyGroup>
10.     <ItemGroup>
11.       <PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="4.14.0">
12.         <PrivateAssets>all</PrivateAssets>
13.         <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
14.       </PackageReference>
15.       <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.14.0" />
16.     </ItemGroup>
18. </Project>

复制代码

编写源生成器

创建SampleGenerator.cs，添加[Generator]特性并实现IIncrementalGenerator接口

旧的源生成器ISourceGenerator在每次代码有更改时都会扫描整个语法树，开销很大。而新的增量生成器IIncrementalGenerator通过管道等方式遴选需要扫描的代码，大大镌汰生成开销。
因此这里我们选择IIncrementalGenerator进行实现

1. [Generator]
2. public class SampleGenerator : IIncrementalGenerator
3. {
4.         public void Initialize(IncrementalGeneratorInitializationContext context)
5.     {
6.         //在这里编写生成器逻辑
7.     }
8. }

复制代码

我们希望生成的代码如下，这里就放在一个常量中：

1. private const string HelloWorld =
2.     """
3.     //加上此行以防止编译器进行不必要的代码分析，避免出现警告
4.     //<auto-generated>
5.     using System;
6.     namespace SourceGeneratorDemo.Generator;
8.     public class HelloWorld
9.     {
10.         public static void SayHello()
11.         {
12.             Console.WriteLine("Hello, World!");
13.         }
14.     }
15.     """;

复制代码

如今来编写Initialize方法，这是源生成器的核心部分：

1. public void Initialize(IncrementalGeneratorInitializationContext context)
2. {
3.     //在编译时生成源代码
4.     //HelloWorld.g.cs就是生成代码的文件名称
5.     context.RegisterPostInitializationOutput(ctx => ctx.AddSource("HelloWorld.g.cs",SourceText.From(HelloWorld, Encoding.UTF8)));
6. }

复制代码

所有代码如下：

1. using System.Text;
2. using Microsoft.CodeAnalysis;
3. using Microsoft.CodeAnalysis.Text;
5. namespace SourceGeneratorDemo.Generator;
7. [Generator]
8. public class SampleGenerator : IIncrementalGenerator
9. {
10.     private const string HelloWorld =
11.         """
12.         //加上此行以防止编译器进行不必要的代码分析，避免出现警告
13.         //<auto-generated>
14.         using System;
15.         namespace SourceGeneratorDemo.Generator;
17.         public class HelloWorld
18.         {
19.             public static void SayHello()
20.             {
21.                 Console.WriteLine("Hello, World!");
22.             }
23.         }
24.         """;
26.     public void Initialize(IncrementalGeneratorInitializationContext context)
27.     {
28.         //在编译时生成源代码
29.         context.RegisterPostInitializationOutput(ctx =>
30.             ctx.AddSource("HelloWorld.g.cs",SourceText.From(HelloWorld, Encoding.UTF8)));
31.     }
32. }

复制代码

在其他项目中引用源生成器

创建一个控制台项目SourceGeneratorDemo.Console，设为我们的启动项目
添加项目引用后，我们还要在csproj文件里做出以下调整：

1. [/code]OutputItemType属性说明源生成器是作为一个分析器(Analyzer)引入项目；
2. ReferenceOutputAssembly阻止源生成器的程序集复制到输出文件夹，因为其只在编译时起作用
3. 重新生成解决方案后，以Rider为例，我们可以在项目的依赖项>.NET 9.0（取决于当前项目的.NET版本）>SourceGeneratorDemo.Generator.SampleGenerator中找到刚刚生成的HelloWorld.g.cs，其内容与刚刚常量中的代码完全一致
4. [align=center][img]https://dis.qidao123.com/imgproxy/aHR0cHM6Ly9pbWcyMDI0LmNuYmxvZ3MuY29tL2Jsb2cvMzI3NTY1Ny8yMDI1MDgvMzI3NTY1Ny0yMDI1MDgyNTE5MzMyNjgxNi0xMjk2NDUxOTMxLnBuZw==[/img][/align]
5. 若使用Visual Studio 2022，在项目的依赖项>分析器>SourceGeneratorDemo.Generator>SourceGeneratorDemo.Generator.SampleGenerator中也可以找到相同文件
6. [align=center][img]https://dis.qidao123.com/imgproxy/aHR0cHM6Ly9pbWcyMDI0LmNuYmxvZ3MuY29tL2Jsb2cvMzI3NTY1Ny8yMDI1MDgvMzI3NTY1Ny0yMDI1MDgyNTE5MzQxMTk0Ni03NzM4MzUwMzMucG5n[/img][/align]
7. 如今我们就可以在Program.cs引用生成的内容了:
8. [code]using SourceGeneratorDemo.Generator;
9. HelloWorld.SayHello();

复制代码

编译成功即可看到输出

源码

https://github.com/zxbmmmmmmmmm/SourceGeneratorDemo
引用

Roslyn 分析器 EnforceExtendedAnalyzerRules 属性的作用
源生成器：根据需要自动生成机械重复代码 | 扑克博客