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

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

C#如何使用Source Generators C#源生成器入门教程-第1张图片-佛山资讯网

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

一、确认环境与项目结构

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

  • 一个“生成器项目”(Class Library,目标框架为 netstandard2.0net6.0,引用 Microsoft.CodeAnalysis.CSharpMicrosoft.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,重写 InitializeExecute 方法:

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 实现。

标签: app microsoft c# .net

发布评论 0条评论)

还木有评论哦,快来抢沙发吧~