前言

嗨，大家好！

今天我們來聊一聊 C# 里的源代碼生成器，一個有趣的代碼生成工具。

源代碼生成器（Source Generators）是 C# 9.0 引入的一項強大功能，允許你在編譯時動態生成源代碼。

這意味著，你可以編寫代碼來自動生成其他代碼，從而減少手動重復的工作。

這個過程在編譯階段發生，生成的代碼會在編譯輸出中包含，從而使你的類庫或應用程序更輕便、更可維護。

首先我們通過一個 Step By Step 例子來感受一下它的魅力吧！

Step By Step 例子

我們來創建一個源生成器，它可以自動為一個類生成一個 ToString 方法，方便快速打印統一的對象信息

1. 創建項目

• 在 Visual Studio 2022 IDE 中，創建一個新的類庫項目，命名為 SourceGen

• 選擇 .NET Standard 2.0 版本，如圖:

2. 添加 NuGet 包

<PackageReference Include="Microsoft.CodeAnalysis.CSharp" Version="4.8.0" />

注意：

1. 不要選擇太高的版本，否則可能會出現編譯器版本太高的問題，比如：

   分析器程序集“...”引用了編譯器的版本 “4.12.0.0”，該版本高于當前正在運行的版本 “4.8.0.0”
   

2. 包 Microsoft.CodeAnalysis.CSharp 已經包含了 Microsoft.CodeAnalysis.Analyzers，所以無需繼續添加此包

3. 配置 EnforceExtendedAnalyzerRules 規則

打開項目文件 SourceGen.csproj，在 PropertyGroup 節點下手動增加 EnforceExtendedAnalyzerRules 配置，如圖：

4. 創建源生成器

在項目中，創建一個新的類文件，命名為 ToStringGenerator.cs，并編寫以下代碼：

using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Text;
using System;
using System.Text;
using System.IO;
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Microsoft.CodeAnalysis.CSharp.Syntax;

namespaceSourceGen
{
    [Generator]
    publicclassToStringGenerator : ISourceGenerator
    {
        public void Execute(GeneratorExecutionContext context)
        {
            var syntaxTrees = context.Compilation.SyntaxTrees;

            foreach (var tree in syntaxTrees)
            {
                var root = tree.GetRoot();
                var classes = root.DescendantNodes().OfType<ClassDeclarationSyntax>();

                foreach (var classDeclaration in classes)
                {
                    // 獲取類名
                    var className = classDeclaration.Identifier.Text;
                    // 獲取類成員
                    var properties = classDeclaration.Members.OfType<PropertyDeclarationSyntax>();
                    var propertiesList = string.Join(", ", properties.Select(p => $"{p.Identifier.Text} = {{{p.Identifier.Text}}}"));

                    // 寫 ToString 方法
                    // 注意這里用了 partial 修飾符
                    var toStringMethod = $@"
public partial class {className} {{
    public override string ToString() => ""{className} {{{propertiesList}}}"";
}}
                ";
                    context.AddSource($"{className}_ToString.g.cs", SourceText.From(toStringMethod, Encoding.UTF8));
                }
            }
        }

        public void Initialize(GeneratorInitializationContext context)
        {
            // 可以在這里初始化任何需要的對象或資源
        }
    }
}

編譯一下確定代碼沒問題。

5. 創建新控制臺項目

在解決方案中，添加一個新的控制臺項目，命名為 SourceGeneratorSample

6. 引用源代碼生成器項目 SourceGen

注意，引用后，需要打開 SourceGeneratorSample.csproj，修改項目引用節點內容，添加 OutputItemType 和 ReferenceOutputAssembly 配置：

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

7. 定義一個類

在 SourceGeneratorSample 項目中，創建一個簡單的類，例如 Person：

public partial class Person
{
    public string? Name { get; set; }
    public int Age { get; set; }
}

注意：

1. 不要放在任何命名空間下

2. 使用 partial 修飾符

8. 使用源代碼器生成的方法

在 Program.cs 文件中，創建一個 Person 實例對象并打印它的 ToString：

var person = new Person { Name = "Alice", Age = 30 };
Console.WriteLine(person.ToString()); 

9. 運行

按 Ctrl+F5 編譯并運行程序，你會在控制臺看到如下圖輸出：

優勢與劣勢

在上面的例子里，我們為項目中所有的類統一了 ToString 方法的輸出，從中我們可以看出一些源代碼生成器的優勢和劣勢：

優勢

1. 減少重復勞動：源代碼生成器可以自動生成一些繁瑣的重復性代碼，特別是那些不變的基本數據結構或方法，比如數據傳輸對象（DTO）或實體類。

2. 提高代碼一致性：生成的代碼遵循預設的邏輯，可以更好地保持一致性，減少了人為錯誤

3. 保持代碼整潔：將生成的代碼與手寫的代碼分開，主代碼會顯得更加清晰易讀

劣勢

1. 編譯時錯誤難以調試：因為代碼是在編譯階段生成的，如果生成的代碼有問題，定位和修復會相對比較困難

2. 學習成本：源代碼生成器的概念和使用方式跟傳統開發方式差別比較大，需要一定的學習時間來掌握其使用方法

3. 可能增加復雜性：源代碼生成器的實現需要對語法樹有深入的理解，這可能增加開發的復雜性。

4. 版本兼容性：如果使用的源生成器依賴于特定版本的編譯器或框架，升級時可能會有兼容性的問題

總結

隨著 .NET 8 的發布，源代碼生成器這一強大特性也逐漸走進了更多程序員的視野。

相比傳統的 T4 模板等代碼生成工具，源代碼生成器的最大魅力在于它能在編譯時動態生成代碼。

這意味著你生成的代碼能立刻融入項目中，無需反復編譯，就像魔法一樣——寫完代碼馬上就能看到結果，大大提升了開發效率。

不過，任何好東西都有它的 “小脾氣”，源代碼生成器也不例外，有時候調試它很讓人抓狂，特別是如果你對語法樹不太熟悉的話，剛開始接觸時，可能會覺得有點棘手，需要花點時間去適應和學習。

所以呢，要不要在你的項目里引入這個強大的特性，其實取決于具體情況。如果你的項目適合并且你能接受一點初期的學習成本，那么源代碼生成器絕對會讓你的開發體驗煥然一新。但如果項目時間緊迫或團隊成員對它還不夠熟悉，可能就需要再三考慮一下啦。