前言
Source Generators顧名思義代碼生成器，可進行創建編譯時代碼，也就是所謂的編譯時元編程，這可讓一些運行時映射的代碼改為編譯時，同樣也加快了速度，我們可避免那種昂貴的開銷，這是有價值的，
實作ISourceGenerator
集成ISourceGenerator介面，實作介面用于代碼生成策略，它的生命周期由編譯器控制，它可以在編譯時創建時創建并且添加到編譯中的代碼，它為我們提供了編譯時元編程，從而使我們對C#代碼或者非C#源檔案進行內部的檢查，
[Generator]
class CustomGenerator: ISourceGenerator
{
public void Initialize(GeneratorInitializationContext context)
{
throw new NotImplementedException();
}
public void Execute(GeneratorExecutionContext context)
{
throw new NotImplementedException();
}
}
public void Execute(GeneratorExecutionContext context)
{
var compilation = context.Compilation;
var simpleCustomInterfaceSymbol = compilation.GetTypeByMetadataName("SourceGeneratorDemo.ICustom");
const string code = @"
using System;
namespace SourceGeneratorDemo
{
public partial class Program{
public static void Display(){
Console.WriteLine(""Hello World!"");
}
}
}";
if (!(context.SyntaxReceiver is CustomSyntaxReceiver receiver))
return;
//語法樹可參考Roslyn Docs
SyntaxTree syntaxTree = CSharpSyntaxTree.ParseText(code);
//context.AddSource("a.class", code);
context.AddSource("a.class", SourceText.From(text: code, encoding: Encoding.UTF8));
//https://github.com/gfoidl-Tests/SourceGeneratorTest
{
StringBuilder sb = new();
sb.Append(@"using System;
using System.Runtime.CompilerServices;
#nullable enable
[CompilerGenerated]
public static class ExportDumper
{
public static void Dump()
{");
foreach (BaseTypeDeclarationSyntax tds in receiver.Syntaxes)
{
sb.Append($@"
Console.WriteLine(""type: {GetType(tds)}\tname: {tds.Identifier}\tfile: {Path.GetFileName(tds.SyntaxTree.FilePath)}"");");
}
sb.AppendLine(@"
}
}");
SourceText sourceText = SourceText.From(sb.ToString(), Encoding.UTF8);
context.AddSource("DumpExports.generated", sourceText);
static string GetType(BaseTypeDeclarationSyntax tds) => tds switch
{
ClassDeclarationSyntax => "class",
RecordDeclarationSyntax => "record",
StructDeclarationSyntax => "struct",
_ => "-"
};
}
}
context.AddSource字串形式的原始碼添加到編譯中，SourceText原文本抽象類，SourceText.From靜態方法,Code指定要創建的原始碼內容，Encoding設定保存的編碼格式，默認為UTF8，context.SyntaxReceiver可以獲取在初始化期間注冊的ISyntaxReceiver，獲取創建的實體
實作ISyntaxReceiver
ISyntaxReceiver介面作為一個語法收集器的定義，可實作該介面，通過對該介面的實作，可過濾生成器所需
public class CustomSyntaxReceiver : ISyntaxReceiver
{
public List<BaseTypeDeclarationSyntax> Syntaxes { get; } = new();
/// <summary>
/// 訪問語法樹
/// </summary>
/// <param name="syntaxNode"></param>
public void OnVisitSyntaxNode(SyntaxNode syntaxNode)
{
if (syntaxNode is BaseTypeDeclarationSyntax cds)
{
Syntaxes.Add(cds);
}
}
}
可以再此處進行過濾，如通過ClassDeclarationSyntax過濾Class類，當然也可以改為BaseTypeDeclarationSyntax,或者也可以使用InterfaceDeclarationSyntax添加介面類等等
除錯
對于Source Generator可以通過添加Debugger.Launch()的形式進行對編譯時的生成器進行除錯，可以通過它很便捷的一步步除錯代碼.
public void Initialize(GeneratorInitializationContext context)
{
Debugger.Launch();
......
}
Library&Properties
<ItemGroup>
<ProjectReference Include="..\ClassLibrary1\ClassLibrary1.csproj"
OutputItemType="Analyzer"
ReferenceOutputAssembly="false" />
</ItemGroup>
ReferenceOutputAssembly：如果設定為false，則不包括參考專案的輸出作為此專案的參考，但仍可確保在此專案之前生成其他專案， 默認為 true，OutputItemType：可選項，將目標要輸出的型別，默認為空，如果參考值設定為true（默認值），那么目標輸出將為編譯器的參考，
Reference
https://github.com/hueifeng/BlogSample/tree/master/src/SourceGeneratorDemo
轉載請註明出處，本文鏈接：https://www.uj5u.com/net/270431.html
標籤：.NET Core