C#如何使用Source Generators C#源生成器入门教程-C#.Net教程-PHP中文网

C#如何使用Source Generators C#源生成器入门教程

星降

发布： 2025-12-13 22:21:21

原创

563人浏览过

Source Generators 是 C# 9 引入的编译时代码生成技术，可在编译阶段自动生成 C# 源文件，不依赖反射、不修改原代码，生成代码具备完整 IDE 支持。

c#如何使用source generators c#源生成器入门教程

Source Generators 是 C# 9 引入的编译时代码生成技术，它能在编译阶段自动为你生成 C# 源文件，不依赖运行时反射，也不修改原始代码——生成的代码会和手写代码一样参与编译、有完整 IDE 支持（跳转、补全、调试）。

一、确认环境与项目结构

确保你使用的是 .NET 5 或更高版本（推荐 .NET 6+），且 SDK 支持 Source Generator。你需要两个项目：

一个“生成器项目”（Class Library，目标框架为 netstandard2.0 或 net6.0，引用 Microsoft.CodeAnalysis.CSharp 和 Microsoft.CodeAnalysis.Analyzers）
一个“使用项目”（如 Console App，引用生成器项目作为 Analyzer，不是普通 ProjectReference）

关键点：生成器项目必须声明为 <packagereference include="Microsoft.CodeAnalysis.CSharp" version="4.0.1" privateassets="all"></packagereference>，并在使用项目中用 <projectreference include="路径\Generator.csproj" outputitemtype="Analyzer" referenceoutputassembly="false"></projectreference> 引入。

二、编写最简 Source Generator

新建一个类实现 ISourceGenerator，重写 Initialize 和 Execute 方法：

using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Text;
using System.Text;
<p>[Generator]
public class HelloGenerator : ISourceGenerator
{
public void Initialize(GeneratorInitializationContext context) { }</p><pre class="brush:php;toolbar:false;">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 实现。

Figma

Figma 是一款基于云端的 UI 设计工具，可以在线进行产品原型、设计、评审、交付等工作。

1371

查看详情

在 Initialize 中注册语法/语义回调（如 context.RegisterForSyntaxNotifications(() => new AutoNotifySyntaxReceiver())）
定义接收器类（ISyntaxContextReceiver）收集感兴趣节点（如 ClassDeclarationSyntax）
在 Execute 中通过 context.Compilation 获取语义模型，检查 Attribute 应用情况
用 SyntaxFactory 或字符串模板拼出新代码，再 AddSource

小技巧：调试生成器较难，可先用 Debugger.Launch()（需在开发机上允许调试），或把生成逻辑抽成独立方法 + 单元测试验证输出字符串是否符合预期。

四、发布与复用（可选但推荐）

想让团队或 NuGet 上其他人使用？把生成器打包成 NuGet 包：

生成器项目设置 <ispackable>true</ispackable>
在 .csproj 中添加 <none include="$(OutputPath)\$(AssemblyName).dll" pack="true" packagepath="analyzers/dotnet/cs"></none>
用 dotnet pack 打包，使用者安装该 NuGet 即自动启用生成器

无需额外配置，也不需要用户手动添加 ProjectReference —— 这是 NuGet 分发生成器的标准方式。

基本上就这些。Source Generator 不复杂但容易忽略细节：版本兼容性、引用方式、调试手段。写好一个能读属性、生成方法、支持泛型的生成器后，你会发现很多重复样板代码（如 DTO 映射、序列化契约、接口实现）都能自动化掉。

以上就是C#如何使用Source Generators C#源生成器入门教程的详细内容，更多请关注php中文网其它相关文章！