ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

DotNet源生成器(Source Generators)Aop日志功能初试玩

2022-05-23 22:04:40  阅读:225  来源: 互联网

标签:代码 生成器 Source Generators context Aop SyntaxReceiver 方法 public


由于各种各样的原因,不得不暂时放下在我的 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找到自己需要的属性

标签:代码,生成器,Source,Generators,context,Aop,SyntaxReceiver,方法,public
来源: https://www.cnblogs.com/marvelTitile/p/16303502.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有