由于各种各样的原因,不得不暂时放下在我的 Blazor 项目添加Aop日志记录
功能。
但是又在偶然的情况下,得知了Source Generators
即源码生成器,能在编译期间,自己构建 cs 源码进行编译。
这让我又燃起了添加Aop日志记录
功能的希望!!SG 官方文档
具体的项目创建、项目引用、项目文件编辑等等细节问题在官方文档上都有很详细的说明,这里就不再赘述了。直接看代码。
ISourceGenerator
只有两个方法
在本例中,Initialize
注册了一个SyntaxReceiver
,可以接收从引用项目中代码更改时,得到的Syntax Tree
接着在Execute
方法中,进行代码的拼装组合(小声吐槽一句,字符串写代码太蛋疼了)
[Generator] public class LogGenerator : ISourceGenerator { internal class SyntaxReceiver : ISyntaxReceiver { internal List<ClassDeclarationSyntax> ClassSyntaxNodes { get; } = new List<ClassDeclarationSyntax>(); public void OnVisitSyntaxNode(SyntaxNode syntaxNode) { if (syntaxNode is ClassDeclarationSyntax @class) { ClassSyntaxNodes.Add(@class); } } } public void Initialize(GeneratorInitializationContext context) { context.RegisterForSyntaxNotifications(() => new SyntaxReceiver()); } public void Execute(GeneratorExecutionContext context) { if (!(context.SyntaxReceiver is SyntaxReceiver receiver)) return; }
首先,我的 Aop 思路很简单,伪代码如下
private Task internal接口方法() { //方法体很暴力,直接从 MethodDeclarationSyntax 类型的 Body.ToFullString() } public Task 接口方法() { // aop before....... internal接口方法(); // aop after....... }
从 context 获得SyntaxReceiver
之后,就是从SyntaxReceiver
中的每个ClassDeclarationSyntax
获取类的名称、命名空间、Usings、继承的接口、所有的方法以及方法的返回值、参数列表、方法体等等,进行字符串层面的代码的拼接。
拼接完成后,再调用 context 上的AddSource
方法即可
string proxyClassTemplate = "........."; context.AddSource($"{名称}Proxy.cs", proxyClassTemplate);
完整代码可以查看GithubLogAopCodeGenerator 项目
最后,强烈建议安装Syntax Visualizer
在 VS 的工具管理中安装 .NET Compiler Platform SDK
可以查看类文件的语法树,方便从 context 的SyntaxNode
找到自己需要的属性