基于SourceGenerators做个AOP静态编织小实验

**副标题&＃xff1a;**无价值人生记录.0&＃xff1a;浪费 1000% 时间去做一个用来节省 1% 时间的“轮子玩具”&＃xff08;下&＃xff1a;AOP实践2 Source Generators&＃xff09;

上接&＃xff1a;用 Roslyn 做个 JIT 的 AOP

作为第二篇&＃xff0c;我们基于Source Generators做个AOP静态编织小实验。

内容安排如下&＃xff1a;

• source generators 是什么&＃xff1f;

• 做个达到上篇Jit 一样的效果的demo

• source generators还存在什么问题&＃xff1f;

1.1 核心目的

开启dotnet平台的编译时元编程功能&＃xff0c;

让我们能在编译时期动态创建代码&＃xff0c;

同时考虑IDE的集成&＃xff0c;让体验更舒适。

展开我们思想的翅膀

我们能以此做各种事情&＃xff1a;

• 生成实体json 等序列化器代码

• AOP

• 接口定义生成httpclient调用代码

• 等等

如下是官方认为会受益的部分功能列表&＃xff1a;

• ASP.Net: Improve startup time

• Blazor and Razor: Massively reduce tooling burden

• Azure Functions: regex compilation during startup

• Azure SDK

• gRPC

• Resx file generation

• System.CommandLine

• Serializers

• SWIG

1.2 目前其设计和使用准则

• 允许开发者能在编译时动态创建添加新代码到我们程序里面

• 只能新增代码&＃xff0c;不能修改已有代码

• 当无法生成源时&＃xff0c;生成器应当产生诊断信息&＃xff0c;通知用户问题所在。

• 可能访问其他文件非c#源代码文件。

• 无序运行模式&＃xff0c;每个生成器都只能拥有相同的输入编译&＃xff0c;即不能用其他生成器的生成结果进行再次生成。

• 生成器的运行类似于分析器。

2.1 创建一个Source Generators项目


netstandard2.08.0https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet5/nuget/v3/index.json ;$(RestoreAdditionalProjectSources)

2.2 创建SourceGenerator

需要继承 Microsoft.CodeAnalysis.ISourceGenerator

namespace Microsoft.CodeAnalysis{public interface ISourceGenerator{void Initialize(InitializationContext context);void Execute(SourceGeneratorContext context);}}

并通过[Generator]标识启用

所以我们就可以做一个这样的代理生成器&＃xff1a;

using Microsoft.CodeAnalysis;using Microsoft.CodeAnalysis.CSharp.Syntax;using Microsoft.CodeAnalysis.Text;using System;using System.Collections.Generic;using System.Linq;using System.Text;namespace AopAnalyzer{[Generator]public class ProxyGenerator : ISourceGenerator{public void Execute(SourceGeneratorContext context){// retreive the populated receiverif (!(context.SyntaxReceiver is SyntaxReceiver receiver))return;try{// 简单测试aop 生成Action beforeCall &＃61; (sb, method) &＃61;> { };Action afterCall &＃61; (sb, method) &＃61;> { sb.Append("r&＃43;&＃43;;"); };// 获取生成结果var code &＃61; receiver.SyntaxNodes.Select(i &＃61;> context.Compilation.GetSemanticModel(i.SyntaxTree).GetDeclaredSymbol(i) as INamedTypeSymbol).Where(i &＃61;> i !&＃61; null && !i.IsStatic).Select(i &＃61;> ProxyCodeGenerator.GenerateProxyCode(i, beforeCall, afterCall)).First();context.AddSource("code.cs", SourceText.From(code, Encoding.UTF8));}catch (Exception ex){// 失败汇报context.ReportDiagnostic(Diagnostic.Create(new DiagnosticDescriptor("n001", ex.ToString(), ex.ToString(), "AOP.Generate", DiagnosticSeverity.Warning, true), Location.Create("code.cs", TextSpan.FromBounds(0, 0), new LinePositionSpan())));}}public void Initialize(InitializationContext context){// Register a syntax receiver that will be created for each generation passcontext.RegisterForSyntaxNotifications(() &＃61;> new SyntaxReceiver());}///

具体的代理代码生成逻辑&＃xff1a;


using Microsoft.CodeAnalysis;using System;using System.Linq;using System.Text;namespace AopAnalyzer{public static class ProxyCodeGenerator{public static string GenerateProxyCode(INamedTypeSymbol type, Action beforeCall, Action afterCall){var sb &＃61; new StringBuilder();sb.Append($"namespace {type.ContainingNamespace.ToDisplayString()} {{");sb.Append($"{type.DeclaredAccessibility.ToString().ToLower()} class {type.Name}Proxy : {type.ToDisplayString()} {{ ");foreach (var method in type.GetMembers().Select(i &＃61;> i as IMethodSymbol).Where(i &＃61;> i !&＃61; null && i.MethodKind !&＃61; MethodKind.Constructor)){GenerateProxyMethod(beforeCall, afterCall, sb, method);}sb.Append(" } }");return sb.ToString();}private static void GenerateProxyMethod(Action beforeCall, Action afterCall, StringBuilder sb, IMethodSymbol method){var ps &＃61; method.Parameters.Select(p &＃61;> $"{p.Type.ToDisplayString()} {p.Name}");sb.Append($"{method.DeclaredAccessibility.ToString().ToLower()} override {method.ReturnType.ToDisplayString()} {method.Name}({string.Join(",", ps)}) {{");sb.Append($"{method.ReturnType.ToDisplayString()} r &＃61; default;");beforeCall(sb, method);sb.Append($"r &＃61; base.{method.Name}({string.Join(",", method.Parameters.Select(p &＃61;> p.Name))});");afterCall(sb, method);sb.Append("return r; }");}}}


可以看到和之前jit的代码非常相似

2.3 测试一下

2.3.1 新建测试项目

Exenetcoreapp3.1preview //新版本才有哦&＃xff0c;现在还未正式发布 //设置为分析器项目


2.3.2 测试代码

using System;namespace StaticWeaving_SourceGenerators{static class Program{static void Main(string[] args){var proxy &＃61; new RealClassProxy(); // 对&＃xff0c;生成的新代码可以ide里面直接用&＃xff0c;就是这么强大&＃xff0c;只要编译一次就看的到了var i &＃61; 5;var j &＃61; 10;Console.WriteLine($"{i} &＃43; {j} &＃61; {(i &＃43; j)}, but proxy is {proxy.Add(i, j)}");Console.ReadKey();}}public class RealClass{public virtual int Add(int i, int j){return i &＃43; j;}}}


输出结果&＃xff1a;

5 &＃43; 10 &＃61; 15, but proxy is 16

cpu 和内存&＃xff0c;自然完美&＃xff1a;

3.1 不能引入其他程序集&＃xff0c;比如nuget包

比如我们引入Newtonsoft.Json&＃xff0c;就会造成如下编译异常&＃xff1a;

System.IO.FileNotFoundException: 未能加载文件或程序集“Newtonsoft.Json, Version&＃61;12.0.0.0, Culture&＃61;neutral, PublicKeyToken&＃61;30ad4fe6b2a6aeed”或它的某一个依赖项。系统找不到指定的文件。

这就造成我们很难利用现有的包做各种事情&＃xff0c;以及怎么把我们的代码生成器提供给别人使用了

3.2 不能debug&＃xff08;其实我接受这点&＃xff09;

可以通过UT测试 debug的

3.3 生成结果不能查看

对使用生成器的人会比较麻烦&＃xff0c;他不知道具体成什么样子了&＃xff0c;特别是生成有错误的时候。

毕竟该功能还是实验特性&＃xff0c;距离完成还有一定距离&＃xff0c;

不过这样可以让语言的发展。