.Net Core 你必須知道的source-generators

chester·chen發表於2024-03-16

源生成器是 C# 9 中引入的一項功能，允許在編譯過程中動態生成程式碼。

它們直接與 C# 編譯器整合(Roslyn)並在編譯時執行，分析原始碼並根據分析結果生成附加程式碼。

源生成器提供了一種簡化的自動化程式碼生成方法，無需外部工具或單獨的預編譯步驟。

透過無縫整合到編譯過程中，源生成器可以提高生產力、減少錯誤並實現更高效的開發工作流程。

如何使用

建立 .NET 控制檯應用程式。 此示例使用 .NET 6。將 Program 類替換為以下程式碼。 

namespace ConsoleApp;

partial class Program
{
    static void Main(string[] args)
    {
        HelloFrom("Generated Code");
    }

    static partial void HelloFrom(string name);
}

接下來，我們將建立一個源生成器專案來實現 partial void HelloFrom 方法對應項。

建立一個以 netstandard2.0 目標框架名字物件為目標的 .NET 類庫。 新增以下 NuGet 包

<ItemGroup>
    <PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.8.0" PrivateAssets="all" />
    <PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.4" PrivateAssets="all" />
</ItemGroup>

然後，建立一個名為 HelloSourceGenerator.cs 的新 C# 檔案，該檔案指定你自己的源生成器，如下所示：

using Microsoft.CodeAnalysis;

namespace SourceGeneratorInCSharp
{
    [Generator]
    public class SourceGenerator : ISourceGenerator
    {
        public void Execute(GeneratorExecutionContext context)
        {
            // Find the main method
            var mainMethod = context.Compilation.GetEntryPoint(context.CancellationToken);

            // Build up the source code
            string source = $@"// <auto-generated/>
using System;

namespace {mainMethod.ContainingNamespace.ToDisplayString()}
{{
    public static partial class {mainMethod.ContainingType.Name}
    {{
        static partial void HelloFrom(string name) =>
            Console.WriteLine($""Generator says: Hi from '{{name}}'"");
    }}
}}
";
            var typeName = mainMethod.ContainingType.Name;

            // Add the source code to the compilation
            context.AddSource($"{typeName}.g.cs", source);
        }

        public void Initialize(GeneratorInitializationContext context)
        {
            // No initialization required for this one
        }
    }
}

現在，我們有一個正常執行的生成器，但需要將其引用到控制檯應用程式。

新引用不是傳統的專案引用，必須手動編輯以包含 OutputItemType 和 ReferenceOutputAssembly 屬性。

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

現在，執行控制檯應用程式時，應會看到生成的程式碼執行並列印到螢幕。

控制檯應用程式本身不實現 HelloFrom 方法，而是在編譯過程中從源生成器專案生成的源。

如果使用的是 Visual Studio，則可以看到源生成的檔案。

在“解決方案資源管理器”視窗中，展開“依賴項”>“分析器”>“SourceGenerator”>“SourceGenerator.HelloSourceGenerator”，然後雙擊“Program.g.cs”檔案即可看到生成的內容。

https://learn.microsoft.com/zh-cn/dotnet/csharp/roslyn-sdk/source-generators-overview

相關文章