经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置：技术经验 » 程序设计 » C# » 查看文章
Rougamo、Fody 实现静态Aop
来源：cnblogs　　作者：Karl_Albright　　时间：2024/7/1 14:35:51　　对本文有异议

最近在看项目，看到别人使用Rougamo框架，好奇花了点时间仔细研究了，在这里记录一下。

0. 静态编织 Aop

首先，我们先了解什么是Aop? Aop 是指面向切面编程 (Aspect Oriented Programming)，而所谓的切面，可以认为是具体拦截的某个业务点。

我们常用的aop框架是 AspectCore，他是属于动态代理，也就是发生在运行时期间对代码进行“修改”。

Rougamo、Fody 是属于静态编织，是指在编译阶段将代码修改或额外的功能直接嵌入到程序集中，这个过程发生在源代码被编译成可执行文件或库之前。这意味着，一旦编译完成，插入的代码就已经是程序集的一部分，无需在运行时再进行额外的操作。

 

1. Rougamo 肉夹馍

Rougamo 是一个开源项目，github: https://github.com/inversionhourglass/Rougamo，他是通过Fody ->  Mono.Cecil 的方式实现静态编织 实现Aop功能。

创建控制台程序，Nuget安装 Rougamo.Fody

  1. [AttributeUsage(AttributeTargets.Method)]
  2. public class LoggingAttribute : MoAttribute
  3. {
  4.     public override void OnEntry(MethodContext context)
  5.     {
  6.         Console.WriteLine("执行方法 {0}() 开始，参数：{1}.", context.Method.Name, 
  7.             JsonConvert.SerializeObject(context.Arguments));
  8.     }
  9.     public override void OnException(MethodContext context)
  10.     {
  11.         Console.WriteLine("执行方法 {0}() 异常，{1}.", context.Method.Name, context.Exception.Message);
  12.     }
  13.     public override void OnExit(MethodContext context)
  14.     {
  15.         Console.WriteLine("执行方法 {0}() 结束.", context.Method.Name);
  16.     }
  17.     public override void OnSuccess(MethodContext context)
  18.     {
  19.         Console.WriteLine("执行方法 {0}() 成功.", context.Method.Name);
  20.     }
  21. }
  22. internal class Program
  23. {
  24.     static void Main(string[] args)
  25.     {
  26.         Add(1, 2);
  27.         AddAsync(1, 2);
  28.         Divide(1, 2);
  29.     }
  31.     [Logging]
  32.     static int Add(int a, int b) => a + b;
  34.     [Logging]
  35.     static Task<int> AddAsync(int a, int b) => Task.FromResult(a + b);
  37.     [Logging]
  38.     static decimal Divide(decimal a, decimal b) => a / b;
  39. }

运行后会指定创建FodyWeavers.xsd 和 FodyWeavers.xml

  1. <?xml version="1.0" encoding="utf-8"?>
  2. <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  3.   <!-- This file was generated by Fody. Manual changes to this file will be lost when your project is rebuilt. -->
  4.   <xs:element name="Weavers">
  5.     <xs:complexType>
  6.       <xs:all>
  7.         <xs:element name="Rougamo" minOccurs="0" maxOccurs="1" type="xs:anyType" />
  8.       </xs:all>
  9.       <xs:attribute name="VerifyAssembly" type="xs:boolean">
  10.         <xs:annotation>
  11.           <xs:documentation>'true' to run assembly verification (PEVerify) on the target assembly after all weavers have been executed.</xs:documentation>
  12.         </xs:annotation>
  13.       </xs:attribute>
  14.       <xs:attribute name="VerifyIgnoreCodes" type="xs:string">
  15.         <xs:annotation>
  16.           <xs:documentation>A comma-separated list of error codes that can be safely ignored in assembly verification.</xs:documentation>
  17.         </xs:annotation>
  18.       </xs:attribute>
  19.       <xs:attribute name="GenerateXsd" type="xs:boolean">
  20.         <xs:annotation>
  21.           <xs:documentation>'false' to turn off automatic generation of the XML Schema file.</xs:documentation>
  22.         </xs:annotation>
  23.       </xs:attribute>
  24.     </xs:complexType>
  25.   </xs:element>
  26. </xs:schema>
  1. <Weavers xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FodyWeavers.xsd">
  2.   <Rougamo />
  3. </Weavers>

下面是运行结果

 这时候我们可以看到 增加了LoggingAttribute 特性的方法在运行前、运行成功、运行结束 执行了 OnEntry(MethodContext context) 、OnSuccess(MethodContext context)、OnExit(MethodContext context) 方法，这时我们打开ILSpy工具，看看实际运行的代码

  1. internal class Program
  2. {
  3.     private static void Main(string[] args)
  4.     {
  5.         Add(1, 2);
  6.         AddAsync(1, 2);
  7.         Divide(1m, 2m);
  8.     }
  10.     [DebuggerStepThrough]
  11.     private static int Add(int a, int b)
  12.     {
  13.         LoggingAttribute loggingAttribute = new LoggingAttribute();
  14.         IMo[] mos = new IMo[1] { loggingAttribute };
  15.         MethodContext methodContext = new MethodContext(null, typeof(Program), MethodBase.GetMethodFromHandle((RuntimeMethodHandle)/*OpCode not supported: LdMemberToken*/, typeof(Program).TypeHandle), isAsync: false, isIterator: false, mosNonEntryFIFO: false, mos, new object[2] { a, b });
  16.         loggingAttribute.OnEntry(methodContext);
  17.         int result = default(int);
  18.         if (methodContext.ReturnValueReplaced)
  19.         {
  20.             result = (int)methodContext.ReturnValue;
  21.             loggingAttribute.OnExit(methodContext);
  22.             return result;
  23.         }
  24.         if (methodContext.RewriteArguments)
  25.         {
  26.             a = (int)methodContext.Arguments[0];
  27.             b = (int)methodContext.Arguments[1];
  28.         }
  29.         bool flag = default(bool);
  30.         do
  31.         {
  32.             try
  33.             {
  34.                 while (true)
  35.                 {
  36.                     try
  37.                     {
  38.                         flag = false;
  39.                         result = $Rougamo_Add(a, b);
  40.                     }
  41.                     catch (Exception exception)
  42.                     {
  43.                         methodContext.Exception = exception;
  44.                         methodContext.Arguments[0] = a;
  45.                         methodContext.Arguments[1] = b;
  46.                         loggingAttribute.OnException(methodContext);
  47.                         if (methodContext.RetryCount > 0)
  48.                         {
  49.                             continue;
  50.                         }
  51.                         if (methodContext.ExceptionHandled)
  52.                         {
  53.                             result = (int)methodContext.ReturnValue;
  54.                             break;
  55.                         }
  56.                         throw;
  57.                     }
  58.                     break;
  59.                 }
  60.             }
  61.             finally
  62.             {
  63.                 if (methodContext.HasException || methodContext.ExceptionHandled)
  64.                 {
  65.                     goto IL_0160;
  66.                 }
  67.                 methodContext.ReturnValue = result;
  68.                 methodContext.Arguments[0] = a;
  69.                 methodContext.Arguments[1] = b;
  70.                 loggingAttribute.OnSuccess(methodContext);
  71.                 if (methodContext.RetryCount <= 0)
  72.                 {
  73.                     if (methodContext.ReturnValueReplaced)
  74.                     {
  75.                         result = (int)methodContext.ReturnValue;
  76.                     }
  77.                     goto IL_0160;
  78.                 }
  79.                 flag = true;
  80.                 goto end_IL_00fc;
  81.                 IL_0160:
  82.                 loggingAttribute.OnExit(methodContext);
  83.                 end_IL_00fc:;
  84.             }
  85.         }
  86.         while (flag);
  87.         return result;
  88.     }
  90.     [DebuggerStepThrough]
  91.     private static Task<int> AddAsync(int a, int b)
  92.     {
  93.         LoggingAttribute loggingAttribute = new LoggingAttribute();
  94.         IMo[] mos = new IMo[1] { loggingAttribute };
  95.         MethodContext methodContext = new MethodContext(null, typeof(Program), MethodBase.GetMethodFromHandle((RuntimeMethodHandle)/*OpCode not supported: LdMemberToken*/, typeof(Program).TypeHandle), isAsync: false, isIterator: false, mosNonEntryFIFO: false, mos, new object[2] { a, b });
  96.         loggingAttribute.OnEntry(methodContext);
  97.         Task<int> result = default(Task<int>);
  98.         if (methodContext.ReturnValueReplaced)
  99.         {
  100.             result = (Task<int>)methodContext.ReturnValue;
  101.             loggingAttribute.OnExit(methodContext);
  102.             return result;
  103.         }
  104.         if (methodContext.RewriteArguments)
  105.         {
  106.             a = (int)methodContext.Arguments[0];
  107.             b = (int)methodContext.Arguments[1];
  108.         }
  109.         bool flag = default(bool);
  110.         do
  111.         {
  112.             try
  113.             {
  114.                 while (true)
  115.                 {
  116.                     try
  117.                     {
  118.                         flag = false;
  119.                         result = $Rougamo_AddAsync(a, b);
  120.                     }
  121.                     catch (Exception exception)
  122.                     {
  123.                         methodContext.Exception = exception;
  124.                         methodContext.Arguments[0] = a;
  125.                         methodContext.Arguments[1] = b;
  126.                         loggingAttribute.OnException(methodContext);
  127.                         if (methodContext.RetryCount > 0)
  128.                         {
  129.                             continue;
  130.                         }
  131.                         if (methodContext.ExceptionHandled)
  132.                         {
  133.                             result = (Task<int>)methodContext.ReturnValue;
  134.                             break;
  135.                         }
  136.                         throw;
  137.                     }
  138.                     break;
  139.                 }
  140.             }
  141.             finally
  142.             {
  143.                 if (methodContext.HasException || methodContext.ExceptionHandled)
  144.                 {
  145.                     goto IL_015b;
  146.                 }
  147.                 methodContext.ReturnValue = result;
  148.                 methodContext.Arguments[0] = a;
  149.                 methodContext.Arguments[1] = b;
  150.                 loggingAttribute.OnSuccess(methodContext);
  151.                 if (methodContext.RetryCount <= 0)
  152.                 {
  153.                     if (methodContext.ReturnValueReplaced)
  154.                     {
  155.                         result = (Task<int>)methodContext.ReturnValue;
  156.                     }
  157.                     goto IL_015b;
  158.                 }
  159.                 flag = true;
  160.                 goto end_IL_00fc;
  161.                 IL_015b:
  162.                 loggingAttribute.OnExit(methodContext);
  163.                 end_IL_00fc:;
  164.             }
  165.         }
  166.         while (flag);
  167.         return result;
  168.     }
  170.     [DebuggerStepThrough]
  171.     private static decimal Divide(decimal a, decimal b)
  172.     {
  173.         LoggingAttribute loggingAttribute = new LoggingAttribute();
  174.         IMo[] mos = new IMo[1] { loggingAttribute };
  175.         MethodContext methodContext = new MethodContext(null, typeof(Program), MethodBase.GetMethodFromHandle((RuntimeMethodHandle)/*OpCode not supported: LdMemberToken*/, typeof(Program).TypeHandle), isAsync: false, isIterator: false, mosNonEntryFIFO: false, mos, new object[2] { a, b });
  176.         loggingAttribute.OnEntry(methodContext);
  177.         decimal result = default(decimal);
  178.         if (methodContext.ReturnValueReplaced)
  179.         {
  180.             result = (decimal)methodContext.ReturnValue;
  181.             loggingAttribute.OnExit(methodContext);
  182.             return result;
  183.         }
  184.         if (methodContext.RewriteArguments)
  185.         {
  186.             a = (decimal)methodContext.Arguments[0];
  187.             b = (decimal)methodContext.Arguments[1];
  188.         }
  189.         bool flag = default(bool);
  190.         do
  191.         {
  192.             try
  193.             {
  194.                 while (true)
  195.                 {
  196.                     try
  197.                     {
  198.                         flag = false;
  199.                         result = $Rougamo_Divide(a, b);
  200.                     }
  201.                     catch (Exception exception)
  202.                     {
  203.                         methodContext.Exception = exception;
  204.                         methodContext.Arguments[0] = a;
  205.                         methodContext.Arguments[1] = b;
  206.                         loggingAttribute.OnException(methodContext);
  207.                         if (methodContext.RetryCount > 0)
  208.                         {
  209.                             continue;
  210.                         }
  211.                         if (methodContext.ExceptionHandled)
  212.                         {
  213.                             result = (decimal)methodContext.ReturnValue;
  214.                             break;
  215.                         }
  216.                         throw;
  217.                     }
  218.                     break;
  219.                 }
  220.             }
  221.             finally
  222.             {
  223.                 if (methodContext.HasException || methodContext.ExceptionHandled)
  224.                 {
  225.                     goto IL_0160;
  226.                 }
  227.                 methodContext.ReturnValue = result;
  228.                 methodContext.Arguments[0] = a;
  229.                 methodContext.Arguments[1] = b;
  230.                 loggingAttribute.OnSuccess(methodContext);
  231.                 if (methodContext.RetryCount <= 0)
  232.                 {
  233.                     if (methodContext.ReturnValueReplaced)
  234.                     {
  235.                         result = (decimal)methodContext.ReturnValue;
  236.                     }
  237.                     goto IL_0160;
  238.                 }
  239.                 flag = true;
  240.                 goto end_IL_00fc;
  241.                 IL_0160:
  242.                 loggingAttribute.OnExit(methodContext);
  243.                 end_IL_00fc:;
  244.             }
  245.         }
  246.         while (flag);
  247.         return result;
  248.     }
  250.     [Logging]
  251.     private static int $Rougamo_Add(int a, int b)
  252.     {
  253.         return a + b;
  254.     }
  256.     [Logging]
  257.     private static Task<int> $Rougamo_AddAsync(int a, int b)
  258.     {
  259.         return Task.FromResult(a + b);
  260.     }
  262.     [Logging]
  263.     private static decimal $Rougamo_Divide(decimal a, decimal b)
  264.     {
  265.         return a / b;
  266.     }
  267. }

从实际运行的代码我们可以看到，原先Add(int a, int b)方法中的执行内容被移动到 $Rougamo_Add方法中，而Add(int a, int b)方法先是new LoggingAttribute() 和 new Rougamo.Context.MethodContext() -> 执行了 loggingAttribute.OnEntry(methodContext); -> 在do{}while(bool) 执行了$Rougamo_Add(a, b); -> 在 exception 中执行了loggingAttribute.OnException(methodContext); -> 在 finally中执行了 loggingAttribute.OnSuccess(methodContext); 和 loggingAttribute.OnExit(methodContext);

注：do{}while(bool) 执行了$Rougamo_Add(a, b); 是因为 Rougamo 可以实现方法执行失败重试功能

至此我们明白了 Rougamo 实现 Aop功能是通过编译时修改IL代码，往代码增加对应的生命周期代码。那他为什么可以做到呢？其实是借用了Fody ->  Mono.Cecil 的方式。

代码如下：https://gitee.com/Karl_Albright/csharp-demo/tree/master/FodyDemo/RougamoDemo

 

2. Fody ->  Mono.Cecil 

Fody 是一个开源项目，github: https://github.com/Fody/Fody，相关教程文档在 https://github.com/Fody/Home/tree/master/pages

创建类库，选择netstandard2.0，命名为HelloWorld，Nuget安装 Fody 和 FodyPackaging

注：必须创建 netstandard2.0，因为FodyPackaging的目标是netstandard2.0，

 在HelloWorld项目中，我们只放 HWAttribute类，继承于 Attribute。代码如下

  1. [AttributeUsage(AttributeTargets.Assembly | AttributeTargets.Module | AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Constructor | AttributeTargets.Method | AttributeTargets.Property)]
  2. public class HWAttribute : Attribute
  3. {
  5. }

 

再次创建类库，选择netstandard2.0，命名为HelloWorld.Fody，Nuget安装 FodyHelpers，引用HelloWorld类库

在HelloWorld.Fody项目中，我们只放ModuleWeaver类（类名是固定的，详情见Fody文档），继承于 BaseModuleWeaver。代码如下

  1. using Fody;
  2. using Mono.Cecil;
  3. using Mono.Cecil.Cil;
  4. using System;
  5. using System.Collections.Generic;
  6. using System.Linq;
  7. using System.Reflection;
  9. namespace HelloWorld.Fody
  10. {
  11.     public partial class ModuleWeaver : BaseModuleWeaver
  12.     {
  13.         public override void Execute()
  14.         {
  15.             foreach (var type in ModuleDefinition.Types)
  16.             {
  17.                 foreach (var method in type.Methods)
  18.                 {
  19.                     var customerAttribute = method.CustomAttributes.FirstOrDefault(x => x.AttributeType.Name == nameof(HWAttribute));
  20.                     if (customerAttribute != null)
  21.                     {
  22.                         ProcessMethod(method);
  23.                     }
  24.                 }
  25.             }
  26.         }
  28.         public override IEnumerable<string> GetAssembliesForScanning()
  29.         {
  30.             yield return "mscorlib";
  31.             yield return "System";
  32.         }
  34.         private MethodInfo _writeLineMethod => typeof(Console).GetMethod("WriteLine", new Type[] { typeof(string) });
  36.         private void ProcessMethod(MethodDefinition method)
  37.         {
  38.             // 获取当前方法体中的第一个IL指令
  39.             var processor = method.Body.GetILProcessor();
  40.             var current = method.Body.Instructions.First();
  42.             // 插入一个 Nop 指令，表示什么都不做
  43.             var first = Instruction.Create(OpCodes.Nop);
  44.             processor.InsertBefore(current, first);
  45.             current = first;
  47.             // 构造 Console.WriteLine("Hello World")
  48.             foreach (var instruction in GetInstructions(method))
  49.             {
  50.                 processor.InsertAfter(current, instruction);
  51.                 current = instruction;
  52.             }
  53.         }
  54.         private IEnumerable<Instruction> GetInstructions(MethodDefinition method)
  55.         {
  56.             yield return Instruction.Create(OpCodes.Nop);
  57.             yield return Instruction.Create(OpCodes.Ldstr, "Hello World.");
  58.             yield return Instruction.Create(OpCodes.Call, ModuleDefinition.ImportReference(_writeLineMethod));
  59.         }
  60.     }
  61. }

在代码中，我们遍历了所有类型的所有方法，如果方法标注了 HWAttribute特性，则增加 Console.WriteLine("Hello World."); 代码。

 

创建控制台应用程序，命名为HelloWorldFodyDemo，添加 HelloWorld 和 HelloWorld.Fody 项目引用，并且手动增加 WeaverFiles标签，目标是HelloWorld.Fody.dll

 在控制台中，我们需要一个方法，方法上有 HWAttribute 特性就可以了，代码如下

  1. internal class Program
  2. {
  3.     static void Main(string[] args)
  4.     {
  5.         Echo();
  6.         Console.ReadKey();
  7.     }
  9.     [HW]
  10.     public static void Echo()
  11.     {
  12.         Console.WriteLine("Hello Fody.");
  13.     }
  14. }

在控制台项目中，我们还需要 FodyWeavers.xml 和 FodyWeavers.xsd 文件，（我也是从上面Rougamo项目中复制的），内容如下

  1. <Weavers xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FodyWeavers.xsd">
  2.     <HelloWorld />
  3. </Weavers>
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
  3.   <xs:element name="Weavers">
  4.     <xs:complexType>
  5.       <xs:all>
  6.         <xs:element name="HelloWorld" minOccurs="0" maxOccurs="1" type="xs:anyType" />
  7.       </xs:all>
  8.       <xs:attribute name="VerifyAssembly" type="xs:boolean">
  9.         <xs:annotation>
  10.           <xs:documentation>'true' to run assembly verification (PEVerify) on the target assembly after all weavers have been executed.</xs:documentation>
  11.         </xs:annotation>
  12.       </xs:attribute>
  13.       <xs:attribute name="VerifyIgnoreCodes" type="xs:string">
  14.         <xs:annotation>
  15.           <xs:documentation>A comma-separated list of error codes that can be safely ignored in assembly verification.</xs:documentation>
  16.         </xs:annotation>
  17.       </xs:attribute>
  18.       <xs:attribute name="GenerateXsd" type="xs:boolean">
  19.         <xs:annotation>
  20.           <xs:documentation>'false' to turn off automatic generation of the XML Schema file.</xs:documentation>
  21.         </xs:annotation>
  22.       </xs:attribute>
  23.     </xs:complexType>
  24.   </xs:element>
  25. </xs:schema>

目前，文件结构如下

  1. FodyDemo
  2. |--- HelloWorld
  3.      |--- HWAttribute.cs
  4.      |--- HelloWorld.csproj
  5. |--- HelloWorld.Fody
  6.      |--- HelloWorld.Fody.csproj
  7.      |--- ModuleWeaver.cs
  8. |--- HelloWorldFodyDemo
  9.      |--- FodyWeavers.xml
  10.      |--- FodyWeavers.xsd
  11.      |--- HelloWorldFodyDemo.csproj
  12.      |--- Program.cs

代码如下：https://gitee.com/Karl_Albright/csharp-demo/tree/master/FodyDemo

最后运行结果如下，很明显，HWAttribute生效了，我们成功的在Echo()方法前打印了Hello World。

 我们再次打开ILSpy工具，得到的结果如图，代码增加了Console.WriteLine("Hello World.");行代码

 4. Fody 有很多其他的“插件”，大家可以多试试

AutoProperties.Fody: 这个外接程序为您提供了对自动属性的扩展控制，比如直接访问backing字段或拦截getter和setter。

PropertyChanged.Fody: 将属性通知添加到实现INotifyPropertyChanged的所有类。

InlineIL.Fody: 在编译时注入任意IL代码。

MethodDecorator.Fody：通过IL重写编译时间装饰器模式。

NullGuard.Fody: 将空参数检查添加到程序集。

ToString.Fody: 给属性生成ToString()方法

Rougamo.Fody: 在编译时生效的AOP组件，类似于PostSharp。

 

原文链接：https://www.cnblogs.com/KarlAlbright/p/18277740

 友情链接：直通硅谷 　点职佳 　北美留学生论坛

C#热门文章

  • NPOI的Excel的读取和写入
  • 事务在c#中的使用
  • 基于欧姆龙PLC#FinsTcp协议上位机通讯(二)-C#通讯模块开发
  • C# 当前 .NET SDK 不支持将 .NET Core 2.1 设置为目标。请将 .NET Core 2.0 或更低版本设置为目标，或使用支持 .NET Core 2.1 的 .NET SDK 版本。
  • C#读写Excel的几种方法
  • C#NPOI操作Excel，实现Excel数据导入导出（支持多个sheet）
  • c#中token的使用方法实例
  • OrderBy和OrderByDescending排序
  • C#中的modbus&nbsp;Tcp协议的数据抓取和使用解析
  • C#Aspose操作Word &amp; Excel简版（后会研究补充更多功能）

    • C#推荐文章

  • .NET 9 优化，抢先体验 C# 13 新特性
  • 使用C#爬取快手作者主页，并下载视频/图集(附源码及软件下载链接)
  • 聊一聊 C# 中让人惶恐的 Bitmap
  • C#/.NET/.NET Core技术前沿周刊 | 第 2 期（2024年8.19-8.25）
  • Elsa V3学习之Flowchart详解（上）
  • C#模拟键盘输入、键状态和监听键盘消息
  • 可以调用Null的实例方法吗？
  • SemanticKernel/C#：实现接口，接入本地嵌入模型
  • C#.Net筑基-解密委托与事件
  • C#/.NET/.NET Core优秀项目和框架2024年7月简报

    • 本站QQ群：前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

    W3xue 的所有内容仅供测试，对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
    关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接（目前9元/月）请联系QQ：27243702 沸活量
    皖ICP备17017327号-2　皖公网安备34020702000426号