C# 9 新特性：代碼生成器、編譯時反射

前言#

今天 .NET 官方部落格宣布 C# 9 Source Generators 第一個預覽版釋出，這是一個使用者已經喊了快 5 年特性，今天終于釋出了。

簡介#

Source Generators 顧名思義代碼生成器，它允許開發者在代碼編譯過程中擷取檢視使用者代碼并且生成新的 C# 代碼參與編譯過程，并且可以很好的與代碼分析器內建提供 Intellisense、調試資訊和報錯資訊，可以用它來做代碼生成，是以也相當于是一個加強版本的編譯時反射。

使用 Source Generators，可以做到這些事情：

擷取一個 Compilation 對象，這個對象表示了所有正在編譯的使用者代碼，你可以從中擷取 AST 和語義模型等資訊

可以向 Compilation 對象中插入新的代碼，讓編譯器連同已有的使用者代碼一起編譯

Source Generators 作為編譯過程中的一個階段執行：

編譯運作 -> [分析源代碼 -> 生成新代碼] -> 将生成的新代碼添加入編譯過程 -> 編譯繼續。

上述流程中，中括号包括的内容即為 Source Generators 所參與的階段和能做到的事情。

作用#

.NET 明明具備運作時反射和動态 IL 織入功能，那這個 Source Generators 有什麼用呢？

編譯時反射 - 0 運作時開銷#

拿 ASP.NET Core 舉例，啟動一個 ASP.NET Core 應用時，首先會通過運作時反射來發現 Controllers、Services 等的類型定義，然後在請求管道中需要通過運作時反射擷取其構造函數資訊以便于進行依賴注入。然而運作時反射開銷很大，即使緩存了類型簽名，對于剛剛啟動後的應用也無任何幫助作用，而且不利于做 AOT 編譯。

Source Generators 将可以讓 ASP.NET Core 所有的類型發現、依賴注入等在編譯時就全部完成并編譯到最終的程式集當中，最終做到 0 運作時反射使用，不僅利于 AOT 編譯，而且運作時 0 開銷。

除了上述作用之外，gRPC 等也可以利用此功能在編譯時織入代碼參與編譯，不需要再利用任何的 MSBuild Task 做代碼生成啦！

另外，甚至還可以讀取 XML、JSON 直接生成 C# 代碼參與編譯，DTO 編寫全自動化都是沒問題的。

AOT 編譯#

Source Generators 的另一個作用是可以幫助消除 AOT 編譯優化的主要障礙。

許多架構和庫都大量使用反射，例如System.Text.Json、System.Text.RegularExpressions、ASP.NET Core 和 WPF 等等，它們在運作時從使用者代碼中發現類型。這些非常不利于 AOT 編譯優化，因為為了使反射能夠正常工作，必須将大量額外甚至可能不需要的類型中繼資料編譯到最終的原生映像當中。

有了 Source Generators 之後，隻需要做編譯時代碼生成便可以避免大部分的運作時反射的使用，讓 AOT 編譯優化工具能夠更好的運作。

例子#

INotifyPropertyChanged#

寫過 WPF 或 UWP 的都知道，在 ViewModel 中為了使屬性變更可被發現，需要實作 INotifyPropertyChanged 接口，并且在每一個需要的屬性的 setter 處觸發屬性更改事件：

Copy

class MyViewModel : INotifyPropertyChanged

{

public event PropertyChangedEventHandler? PropertyChanged;

private string _text;
public string Text
{
    get => _text;
    set
    {
        _text = value;
        PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(nameof(Text)));
    }
}

}

當屬性多了之後将會非常繁瑣，先前 C# 引入了 CallerMemberName 用于簡化屬性較多時候的情況：

public event PropertyChangedEventHandler? PropertyChanged;

private string _text;
public string Text
{
    get => _text;
    set
    {
        _text = value;
        OnPropertyChanged();
    }
}

protected virtual void OnPropertyChanged([CallerMemberName] string? propertyName = null)
{
    PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
}

即，用 CallerMemberName 訓示參數，在編譯時自動填充調用方的成員名稱。

但是還是不友善。

如今有了 Source Generators，我們可以在編譯時生成代碼做到這一點了。

為了實作 Source Generators，我們需要寫個實作了 ISourceGenerator 并且标注了 Generator 的類型。

完整的 Source Generators 代碼如下：

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using Microsoft.CodeAnalysis;

using Microsoft.CodeAnalysis.CSharp;

using Microsoft.CodeAnalysis.CSharp.Syntax;

using Microsoft.CodeAnalysis.Text;

namespace MySourceGenerator

[Generator]
public class AutoNotifyGenerator : ISourceGenerator
{
    private const string attributeText = @"

namespace AutoNotify

[AttributeUsage(AttributeTargets.Field, Inherited = false, AllowMultiple = false)]
sealed class AutoNotifyAttribute : Attribute
{
    public AutoNotifyAttribute()
    {
    }
    public string PropertyName { get; set; }
}

public void Initialize(InitializationContext context)
    {
        // 注冊一個文法接收器，會在每次生成時被建立
        context.RegisterForSyntaxNotifications(() => new SyntaxReceiver());
    }

    public void Execute(SourceGeneratorContext context)
    {
        // 添加 Attrbite 文本
        context.AddSource("AutoNotifyAttribute", SourceText.From(attributeText, Encoding.UTF8));

        // 擷取先前的文法接收器 
        if (!(context.SyntaxReceiver is SyntaxReceiver receiver))
            return;

        // 建立處目标名稱的屬性
        CSharpParseOptions options = (context.Compilation as CSharpCompilation).SyntaxTrees[0].Options as CSharpParseOptions;
        Compilation compilation = context.Compilation.AddSyntaxTrees(CSharpSyntaxTree.ParseText(SourceText.From(attributeText, Encoding.UTF8), options));

        // 擷取新綁定的 Attribute，并擷取INotifyPropertyChanged
        INamedTypeSymbol attributeSymbol = compilation.GetTypeByMetadataName("AutoNotify.AutoNotifyAttribute");
        INamedTypeSymbol notifySymbol = compilation.GetTypeByMetadataName("System.ComponentModel.INotifyPropertyChanged");

        // 周遊字段，隻保留有 AutoNotify 标注的字段
        List<IFieldSymbol> fieldSymbols = new List<IFieldSymbol>();
        foreach (FieldDeclarationSyntax field in receiver.CandidateFields)
        {
            SemanticModel model = compilation.GetSemanticModel(field.SyntaxTree);
            foreach (VariableDeclaratorSyntax variable in field.Declaration.Variables)
            {
                // 擷取字段符号資訊，如果有 AutoNotify 标注則儲存
                IFieldSymbol fieldSymbol = model.GetDeclaredSymbol(variable) as IFieldSymbol;
                if (fieldSymbol.GetAttributes().Any(ad => ad.AttributeClass.Equals(attributeSymbol, SymbolEqualityComparer.Default)))
                {
                    fieldSymbols.Add(fieldSymbol);
                }
            }
        }

        // 按 class 對字段進行分組，并生成代碼
        foreach (IGrouping<INamedTypeSymbol, IFieldSymbol> group in fieldSymbols.GroupBy(f => f.ContainingType))
        {
            string classSource = ProcessClass(group.Key, group.ToList(), attributeSymbol, notifySymbol, context);
           context.AddSource($"{group.Key.Name}_autoNotify.cs", SourceText.From(classSource, Encoding.UTF8));
        }
    }

    private string ProcessClass(INamedTypeSymbol classSymbol, List<IFieldSymbol> fields, ISymbol attributeSymbol, ISymbol notifySymbol, SourceGeneratorContext context)
    {
        if (!classSymbol.ContainingSymbol.Equals(classSymbol.ContainingNamespace, SymbolEqualityComparer.Default))
        {
            // TODO: 必須在頂層，産生診斷資訊
            return null;
        }

        string namespaceName = classSymbol.ContainingNamespace.ToDisplayString();

        // 開始建構要生成的代碼
        StringBuilder source = new StringBuilder($@"

namespace {namespaceName}

{{

public partial class {classSymbol.Name} : {notifySymbol.ToDisplayString()}
{{

");

// 如果類型還沒有實作 INotifyPropertyChanged 則添加實作
        if (!classSymbol.Interfaces.Contains(notifySymbol))
        {
            source.Append("public event System.ComponentModel.PropertyChangedEventHandler PropertyChanged;");
        }

        // 生成屬性
        foreach (IFieldSymbol fieldSymbol in fields)
        {
            ProcessField(source, fieldSymbol, attributeSymbol);
        }

        source.Append("} }");
        return source.ToString();
    }

    private void ProcessField(StringBuilder source, IFieldSymbol fieldSymbol, ISymbol attributeSymbol)
    {
        // 擷取字段名稱
        string fieldName = fieldSymbol.Name;
        ITypeSymbol fieldType = fieldSymbol.Type;

        // 擷取 AutoNotify Attribute 和相關的資料
        AttributeData attributeData = fieldSymbol.GetAttributes().Single(ad => ad.AttributeClass.Equals(attributeSymbol, SymbolEqualityComparer.Default));
        TypedConstant overridenNameOpt = attributeData.NamedArguments.SingleOrDefault(kvp => kvp.Key == "PropertyName").Value;

        string propertyName = chooseName(fieldName, overridenNameOpt);
        if (propertyName.Length == 0 || propertyName == fieldName)
        {
            //TODO: 無法處理，産生診斷資訊
            return;
        }

        source.Append($@"

public {fieldType} {propertyName}

get 
{{
    return this.{fieldName};
}}
set
{{
    this.{fieldName} = value;
    this.PropertyChanged?.Invoke(this, new System.ComponentModel.PropertyChangedEventArgs(nameof({propertyName})));
}}

}}

string chooseName(string fieldName, TypedConstant overridenNameOpt)
        {
            if (!overridenNameOpt.IsNull)
            {
                return overridenNameOpt.Value.ToString();
            }

            fieldName = fieldName.TrimStart('_');
            if (fieldName.Length == 0)
                return string.Empty;

            if (fieldName.Length == 1)
                return fieldName.ToUpper();

            return fieldName.Substring(0, 1).ToUpper() + fieldName.Substring(1);
        }

    }

    // 文法接收器，将在每次生成代碼時被按需建立
    class SyntaxReceiver : ISyntaxReceiver
    {
        public List<FieldDeclarationSyntax> CandidateFields { get; } = new List<FieldDeclarationSyntax>();

        // 編譯中在通路每個文法節點時被調用，我們可以檢查節點并儲存任何對生成有用的資訊
        public void OnVisitSyntaxNode(SyntaxNode syntaxNode)
        {
            // 将具有至少一個 Attribute 的任何字段作為候選
            if (syntaxNode is FieldDeclarationSyntax fieldDeclarationSyntax
                && fieldDeclarationSyntax.AttributeLists.Count > 0)
            {
                CandidateFields.Add(fieldDeclarationSyntax);
            }
        }
    }
}

有了上述代碼生成器之後，以後我們隻需要這樣寫 ViewModel 就會自動生成通知接口的事件觸發調用：

public partial class MyViewModel

[AutoNotify]
private string _text = "private field text";

[AutoNotify(PropertyName = "Count")]
private int _amount = 5;

上述代碼将會在編譯時自動生成以下代碼參與編譯：

public partial class MyViewModel : System.ComponentModel.INotifyPropertyChanged

public event System.ComponentModel.PropertyChangedEventHandler PropertyChanged;

public string Text
{
    get 
    {
        return this._text;
    }
    set
    {
        this._text = value;
        this.PropertyChanged?.Invoke(this, new System.ComponentModel.PropertyChangedEventArgs(nameof(Text)));
    }
}

public int Count
{
    get 
    {
        return this._amount;
    }
    set
    {
        this._amount = value;
        this.PropertyChanged?.Invoke(this, new System.ComponentModel.PropertyChangedEventArgs(nameof(Count)));
    }
}

非常友善！

使用時，将 Source Generators 部分作為一個獨立的 .NET Standard 2.0 程式集（暫時不支援 2.1），用以下方式引入到你的項目即可：

注意需要最新的 .NET 5 preview（寫文章時還在 artifacts 裡沒正式 release），并指定語言版本為 preview：

preview

另外，Source Generators 需要引入兩個 nuget 包：

限制#

Source Generators 僅能用于通路和生成代碼，但是不能修改已有代碼，這有一定原因是出于安全考量。

文檔#

Source Generators 處于早期預覽階段，docs.microsoft.com 上暫時沒有相關文檔，關于它的文檔請通路在 roslyn 倉庫中的文檔：

設計文檔

使用文檔

後記#

目前 Source Generators 仍處于非常早期的預覽階段，API 後期還可能會有很大的改動，是以現階段不要用于生産。

另外，關于與 IDE 的內建、診斷資訊、斷點調試資訊等的開發也在進行中，請期待後續的 preview 版本吧。

作者： hez2010

出處：

https://www.cnblogs.com/hez2010/p/12810993.html

C# 9 新特性：代碼生成器、編譯時反射

繼續閱讀

underscore 模闆标簽修改。

Ajax——模闆引擎

使用underscore的template自定義模闆

underscore模闆功能的使用和學習

對于VS中scanf報錯永久解決，建立源檔案自動添加#define _CRT_SECURE_NO_WARNINGS 1

什麼是BNF範式

《C#進階程式設計》讀書筆記 -索引

CQ V1.0分詞bates(基于雙數組tire樹)—應該是目前最快的中文分詞算法

C#多線程——前台線程和背景線程

QName是什麼

C#+ArcEngine代碼檢測ArcEngine Runtime是否安裝以及是否授權

[HTML5]自定義屬性 data-* 和 jQuery.data 詳解

七牛雲-C#SDK-上傳-前期準備

vue-cli簡介（中文翻譯）

Ajax發送和擷取json資料到Spring mvc 1.spring mvc後端2.web前段

JSONObject包導入異常 java.lang.NoClassDefFoundErrorweb項目的導入包的問題