Source Generator實戰

weilence發表於2022-04-16

前言

最近刷B站的時候瀏覽到了老楊的關於Source Generator的簡介視訊。其實當初.Net 6剛釋出時候看到過微軟介紹這個東西，但並沒有在意。因為粗看覺得這東西限制蠻多的，畢竟C#是強型別語言，有些動態的東西不好操作，而且又有Fody、Natasha這些操作IL的庫。

最近寫前端比較多，看到這個和這個，都是自動引入相關包，極大的提高了我開發前端的舒適度。又聯想到隔壁Java的有Lombok，用起來都很香。搜了一下也沒看到C#有相關的東西，於是決定自己動手開發一個，提高C#開發體驗。

實現一個Source Generator

這裡不對Source Generator做基本的使用介紹，直接實操。如果需要了解相關資訊，建議直接看官方文件或者去搜尋相關文章。

首先我們看一下效果，假如我的程式碼是

namespace SourceGenerator.Demo
{
    public partial class UserClass
    {
        [Property]
        private string _test;
    }
}

那麼，最終生成的應該是

// Auto-generated code
namespace SourceGenerator.Demo
{
    public partial class UserClass
    {
        public string Test { get => _test; set => _test = value; }
    }
}

我們按最簡單的實現來考慮，那麼只需要

  1. 在語法樹中找到field
  2. 找到欄位的class、namespace
  3. 生成程式碼

第一步

首先我們來看第一步。第一步需要找到field，這個我們藉助Attribute的特性，能夠很快的找到，在SourceGenerator中只需要判斷一下Attribute的名字即可
定義一個SyntaxReciver，然後在SourceGenerator中註冊一下

// file: PropertyAttribute.cs
using System;

namespace SourceGenerator.Common
{
    [AttributeUsage(AttributeTargets.Field)]
    public class PropertyAttribute : Attribute
    {
        public const string Name = "Property";
    }
}
// file: AutoPropertyReceiver.cs
public class AutoPropertyReceiver : ISyntaxReceiver
{
    public List<AttributeSyntax> AttributeSyntaxList { get; } = new List<AttributeSyntax>();

    public void OnVisitSyntaxNode(SyntaxNode syntaxNode)
    {
        if (syntaxNode is AttributeSyntax cds && cds.Name is IdentifierNameSyntax identifierName &&
            (
                identifierName.Identifier.ValueText == PropertyAttribute.Name ||
                identifierName.Identifier.ValueText == nameof(PropertyAttribute))
           )
        {
            AttributeSyntaxList.Add(cds);
        }
    }
}

// file: AutoPropertyGenerator.cs
[Generator]
public class AutoPropertyGenerator : ISourceGenerator
{
    public void Initialize(GeneratorInitializationContext context)
    {
        context.RegisterForSyntaxNotifications(() => new AutoPropertyReceiver());
    }

    // other code
    ...
}

第二步

第二步就是SyntaxTree的查詢，熟悉SyncaxTree的話比較容易完成

public void Execute(GeneratorExecutionContext context)
{
    var syntaxReceiver = (AutoPropertyReceiver)context.SyntaxReceiver;
    var attributeSyntaxList = syntaxReceiver.AttributeSyntaxList;

    if (attributeSyntaxList.Count == 0)
    {
        return;
    }

    // 儲存一下類名，因為一個類中可能有有多個欄位生成，這裡去掉重複
    var classList = new List<string>();
    foreach (var attributeSyntax in attributeSyntaxList)
    {
        // 找到class，並且判斷一下是否有parital欄位
        var classDeclarationSyntax = attributeSyntax.FirstAncestorOrSelf<ClassDeclarationSyntax>();
        if (classDeclarationSyntax == null ||
            !classDeclarationSyntax.Modifiers.Any(m => m.IsKind(SyntaxKind.PartialKeyword)))
        {
            continue;
        }

        // 找到namespace
        var namespaceDeclarationSyntax =
            classDeclarationSyntax.FirstAncestorOrSelf<BaseNamespaceDeclarationSyntax>();

        if (classList.Contains(classDeclarationSyntax.Identifier.ValueText))
        {
            continue;
        }

        // 找到field
        var fieldDeclarationList = classDeclarationSyntax.Members.OfType<FieldDeclarationSyntax>().ToList();
        if (fieldDeclarationList.Count == 0)
        {
            continue;
        }
        // 其他程式碼
        ...
    }
}

第三步

第三步就是簡單粗暴的根據第二步中拿到的資訊，拼一下字串。

當然其實拼字串是很不好的行為，最好是用模板去實現，其次就算是拼字串也理應用StringBuilder，但這裡只是做一個Demo，無所謂了

public void Execute(GeneratorExecutionContext context)
{
        ...
        // 上面是第二步的程式碼
        // 拼原始碼字串
        var source = $@"// Auto-generated code

namespace {namespaceDeclarationSyntax.Name.ToString()}
{{
public partial class {classDeclarationSyntax.Identifier}
{{";
        var propertyStr = "";
        foreach (var fieldDeclaration in fieldDeclarationList)
        {
            var variableDeclaratorSyntax = fieldDeclaration.Declaration.Variables.FirstOrDefault();

            var fieldName = variableDeclaratorSyntax.Identifier.ValueText;
            var propertyName = GetCamelCase(fieldName);

            propertyStr += $@"
public string {propertyName} {{ get => {fieldName}; set => {fieldName} = value; }}";
        }

        source += propertyStr;
        source += @"
}
}
";
        // 新增到原始碼，這樣IDE才能感知
        context.AddSource($"{classDeclarationSyntax.Identifier}.g.cs", source);
        // 儲存一下類名，避免重複生成
        classList.Add(classDeclarationSyntax.Identifier.ValueText);
    }
}

使用

寫一個測試類

using SourceGenerator.Common;

namespace SourceGenerator.Demo;

public partial class UserClass
{
    [Property] private string _test = "test";

    [Property] private string _test2;
}

然後重啟IDE，可以看到效果，並且直接呼叫屬性是不報錯的
image
image

結尾

這裡僅演示了最基本的Source Generator的功能，限於篇幅也無法深入講解，上面的程式碼可以在這裡檢視，目前最新的程式碼還實現了欄位生成建構函式，appsettings.json生成AppSettings常量欄位類。

如果你只是想使用，可以直接nuget安裝SourceGenerator.Library。

以下為個人觀點

Source Generator在我看來最大的價值在於提供開發時的體驗。至於效能，可以用Fody等庫Emit IL程式碼，功能更強大更完善，且沒有分部類的限制。但此類IL庫最大的問題在Design-Time時無法拿到生成後的程式碼，導致需要用一些奇奇怪怪的方法去用生成程式碼。

Source Generator未來可以做的事情有很多，比如

  1. ORM實體對映
    如果資料庫是Code First，那麼其實還好。但如果說是Db First，主流的ORM庫都是通過命令去生成Model的，但命令通常我記不住，因為用的頻率並不高。
    如果後期加欄位，要麼我重新生成一次，我又得去找這個命令。要麼我手動去C#程式碼中加這個欄位，我能保證自己可以寫正確，但是團隊其他成員呢？
  2. 結合Emit IL技術
    上面其實說了Emit是無法在Design-Time中使用的，但如果我們使用Source Generator建立一些空的方法，然後用IL去改寫，應該可以解決這個問題
  3. 依賴注入
    目前而言我們在Asp.net Core中建立了服務，那麼我們需要AddSingleton等方法新增進去，這個其實很痛苦，因為首先會顯得程式碼很長，其次這個操作很無聊且容易遺漏。
    現在主流的框架都是通過Assembly掃描的方式去動態註冊，避免手動去新增服務。但如果通過Source Generator掃碼這些類，就可以在編譯時新增進DI容器
  4. 物件對映
    Java裡面有個庫叫做MapStruct，原理是用maven外掛生成靜態的java程式碼，然後按欄位賦值。C#裡面我好像沒有看到這種方法，目前我用過的Automapper和Tinymapper都是先去做Bind，然後再使用。（插個題外話，Tinymapper以前的版本是不需要Bind，直接用的，但後來就要了，似乎是為了解決多執行緒的問題）
    Bind其實很痛苦，我很討厭寫這種樣板程式碼，以至於我根本就不想用這類Mapper，直接Json Copy。

相關文章