IL编织器 --- Fody

尚斌

介绍

这个项目的名称“Fody”来源于属于织巢鸟科（Ploceidae）的小鸟（Fody），本身意义为编织。
核心Fody引擎的代码库地址 ：https://github.com/Fody/Fody
Github上是这样介绍的：
Fody 是一个用于织制 .NET 程序集的可扩展工具。它允许在构建过程中作为一部分来操纵程序集的中间语言（IL），这需要大量的底层代码编写。这些底层代码需要了解 MSBuild 和 Visual Studio 的 API。Fody 通过可扩展的插件模型试图消除这些底层代码。这种技术非常强大，例如，可以将简单属性转换为完整的 INotifyPropertyChanged 实现，添加对空参数的检查，添加方法计时，甚至使所有字符串比较都不区分大小写。
Fody 处理的底层任务包括：

• 将 MSBuild 任务注入到构建流程中。
  
• 解析程序集和 pdb 文件的位置。
  
• 抽象了与 MSBuild 日志记录的复杂性。
  
• 将程序集和 pdb 文件读入 Mono.Cecil 对象模型中。
  
• 根据需要重新应用强名称。
  
• 保存程序集和 pdb 文件。
  

Fody 使用 Mono.Cecil 和基于插件的方法在编译时修改 .NET 程序集的中间语言（IL）。

• 它不需要额外的安装步骤来构建。
  
• 属性是可选的，具体取决于所使用的编织器。
  
• 不需要部署运行时依赖项。
  

插件

从介绍就可以看出，理论上只要你想要，基于这个库基本上能做任何事情。
所以基于该库，诞生了非常非常多的插件库，下面简单介绍及编写Demo简单使用
插件描述Github URLFody编织.net程序集的可扩展工具https://github.com/Fody/FodyAutoProperties.Fody这个外接程序为您提供了对自动属性的扩展控制，比如直接访问backing字段或拦截getter和setter。https://github.com/tom-englert/AutoProperties.FodyPropertyChanged.Fody将属性通知添加到实现INotifyPropertyChanged的所有类。https://github.com/Fody/PropertyChangedInlineIL.Fody在编译时注入任意IL代码。https://github.com/ltrzesniewski/InlineIL.FodyMethodDecorator.Fody通过IL重写编译时间装饰器模式https://github.com/Fody/MethodDecoratorNullGuard.Fody将空参数检查添加到程序集https://github.com/Fody/NullGuardToString.Fody给属性生成ToString()方法https://github.com/Fody/ToStringRougamo.Fody在编译时生效的AOP组件，类似于PostSharp。https://github.com/inversionhourglass/RougamoAutoProperties.Fody

这个插件提供了对自动属性的扩展控制，比如直接访问backing字段或拦截getter和setter。

1. using System;
2. using AutoProperties;
3. using Xunit;
5. public class AutoPropertiesInterceptor
6. {
7.     [Fact]
8.     public void Run()
9.     {
10.         Assert.Equal(10, Property1);
11.         Assert.Equal("11", Property2);
13.         Property1 = 42;
15.         Assert.Equal(45, Property1);
16.         Assert.Equal("11", Property2);
18.         Property2 = "44";
20.         Assert.Equal(45, Property1);
21.         Assert.Equal("47", Property2);
22.     }
24.     [GetInterceptor]
25.     T GetInterceptor<T>(string propertyName, T fieldValue)
26.     {
27.         return (T)Convert.ChangeType(Convert.ToInt32(fieldValue) + 1, typeof(T));
28.     }
30.     [SetInterceptor]
31.     void SetInterceptor<T>(T value, string propertyName, out T field)
32.     {
33.         field = (T)Convert.ChangeType(Convert.ToInt32(value) + 2, typeof(T));
34.     }
36.     public int Property1 { get; set; } = 7;
38.     public string Property2 { get; set; } = "8";
39. }

复制代码

PropertyChanged.Fody

该插件在编译时将INotifyPropertyChanged代码注入属性中：

1. using System.ComponentModel;
2. using System.Runtime.CompilerServices;
3. using AutoProperties;
4. using Xunit;
6. public class AutoPropertiesSample : INotifyPropertyChanged
7. {
8.     int numberOfPropertyChangedCalls;
10.     public string AutoProperty1 { get; set; }
11.     public string AutoProperty2 { get; set; }
13.     public AutoPropertiesSample()
14.     {
15.         AutoProperty2.SetBackingField("42");
16.     }
18.     [Fact]
19.     public void Run()
20.     {
21.         // no property changed call was generated in constructor:
22.         Assert.Equal(0, numberOfPropertyChangedCalls);
23.         Assert.Equal("42", AutoProperty2);
25.         AutoProperty1 = "Test1";
26.         Assert.Equal(1, numberOfPropertyChangedCalls);
27.         Assert.Equal("Test1", AutoProperty1);
29.         AutoProperty1.SetBackingField("Test2");
30.         Assert.Equal(1, numberOfPropertyChangedCalls);
31.         Assert.Equal("Test2", AutoProperty1);
32.     }
35.     public event PropertyChangedEventHandler PropertyChanged;
37.     protected virtual void OnPropertyChanged([CallerMemberName] string propertyName = null)
38.     {
39.         numberOfPropertyChangedCalls += 1;
41.         PropertyChanged?.Invoke(this, new(propertyName));
42.     }
43. }

复制代码

除此之外，该插件附带了一个 C# 代码生成器，只需将实现 INotifyPropertyChanged 接口或包含  [AddINotifyPropertyChangedInterface] 属性的类标记为 partial，生成器将会自动添加必要的事件和事件触发器。
可以通过项目文件中的属性配置代码生成器：

1. <PropertyGroup>
2.   <PropertyChangedAnalyzerConfiguration>
3.     <IsCodeGeneratorDisabled>false</IsCodeGeneratorDisabled>
4.     <EventInvokerName>OnPropertyChanged</EventInvokerName>
5.   </PropertyChangedAnalyzerConfiguration>
6. </PropertyGroup>

复制代码

更多用法建议查看官方文档。
InlineIL.Fody

该插件允许在编译时将任意IL注入到程序集中。

示例代码

1. using System;
2. using Xunit;
3. using static InlineIL.IL.Emit;
4. public class Sample
5. {
6.     [Fact]
7.     public void Run()
8.     {
9.         var item = new MyStruct
10.         {
11.             Int = 42,
12.             Guid = Guid.NewGuid()
13.         };
15.         ZeroInit.InitStruct(ref item);
17.         Assert.Equal(0, item.Int);
18.         Assert.Equal(Guid.Empty, item.Guid);
19.     }
21.     struct MyStruct
22.     {
23.         public int Int;
24.         public Guid Guid;
25.     }
26. }
28. public static class ZeroInit
29. {
30.     public static void InitStruct<T>(ref T value)
31.         where T : struct
32.     {
33.         Ldarg(nameof(value));
35.         Ldc_I4_0();
37.         Sizeof(typeof(T));
39.         Unaligned(1);
41.         Initblk();
42.     }
43. }

复制代码

小技巧：这里可以借助ILDASM工具先生成想要的 IL 代码，在按照 IL 代码取编写要注入的 C# 代码，也可以参照我之前的文章工具 --- IL指令集解释，理解 IL 执行过程。

MethodDecorator.Fody

通过IL重写编译时装饰器模式。
定义拦截器属性：

1. using System;
2. using System.Reflection;
3. using MethodDecorator.Fody.Interfaces;
5. [AttributeUsage(AttributeTargets.Method | AttributeTargets.Constructor | AttributeTargets.Module)]
6. public class InterceptorAttribute : Attribute, IMethodDecorator
7. {
8.     public void Init(object instance, MethodBase method, object[] args)
9.     {
10.     }
12.     public void OnEntry()
13.     {
14.         InterceptionRecorder.OnEntryCalled = true;
15.     }
17.     public void OnExit()
18.     {
19.         InterceptionRecorder.OnExitCalled = true;
20.     }
22.     public void OnException(Exception exception)
23.     {
24.         InterceptionRecorder.OnExceptionCalled = true;
25.     }
26. }

复制代码

定义拦截记录器

1. public static class InterceptionRecorder
2. {
3.     public static bool OnEntryCalled;
4.     public static bool OnExitCalled;
5.     public static bool OnExceptionCalled;
7.     public static void Clear()
8.     {
9.         OnExitCalled= OnEntryCalled = OnExceptionCalled = false;
10.     }
11. }

复制代码

定义目标类

1. public static class Target
2. {
3.     [Interceptor]
4.     public static void MyMethod()
5.     {
7.     }
9.     [Interceptor]
10.     public static void MyExceptionMethod()
11.     {
12.         throw new("Foo");
13.     }
14. }

复制代码

示例：

1. using Xunit;
3. public class MethodDecoratorSample
4. {
5.     [Fact]
6.     public void SimpleMethodSample()
7.     {
8.         InterceptionRecorder.Clear();
9.         Target.MyMethod();
10.         Assert.True(InterceptionRecorder.OnEntryCalled);
11.         Assert.True(InterceptionRecorder.OnExitCalled);
12.         Assert.False(InterceptionRecorder.OnExceptionCalled);
13.     }
15.     [Fact]
16.     public void ExceptionMethodSample()
17.     {
18.         InterceptionRecorder.Clear();
19.         try
20.         {
21.             Target.MyExceptionMethod();
22.         }
23.         catch
24.         {
25.         }
26.         Assert.True(InterceptionRecorder.OnEntryCalled);
27.         Assert.False(InterceptionRecorder.OnExitCalled);
28.         Assert.True(InterceptionRecorder.OnExceptionCalled);
29.     }
30. }

复制代码

NullGuard.Fody

该插件向程序集添加null参数检查，支持三种操作模式：隐式模式、显式模式和可为空引用类型模式。

• 在隐式模式下，假定一切都不为空，除非标记为 [AllowNull]。这是 NullGuard 一直以来的工作方式。
  
• 在显式模式下，假定一切都可为空，除非标记为 [NotNull]。这种模式旨在支持 ReSharper（R#）的可为空性分析，使用悲观模式。
  
• 在可为空引用类型模式下，使用 C# 8 可为空引用类型（NRT）注释来确定类型是否可为空。
  

如果没有显式配置，NullGuard 将按以下方式自动检测模式：

• 如果检测到 C# 8 可为空属性，则使用可为空引用类型模式。
  
• 引用 JetBrains.Annotations 并在任何地方使用 [NotNull] 将切换到显式模式。
  
• 如果不满足上述条件，则默认为隐式模式。
  

示例：

1. using Xunit;
3. public class NullGuardSample
4. {
5.     [Fact(Skip = "Explicit")]
6.     public void Run()
7.     {
8.         var targetClass = new TargetClass();
9.         Assert.Throws<ArgumentNullException>(() => targetClass.Method(null));
10.     }
11. }
13. public class TargetClass
14. {
15.     public void Method(string param)
16.     {
17.     }
18. }

复制代码

ToString.Fody

该插件可以从带有[ToString]属性修饰的类的公共属性中生成ToString方法。

1. using System.Diagnostics;
2. using Xunit;
4. public class ToStringSample
5. {
6.     [Fact]
7.     public void Run()
8.     {
9.         var target = new Person
10.                      {
11.                          GivenNames = "John",
12.                          FamilyName = "Smith"
14.                      };
15.         Debug.WriteLine(target.ToString());
16.         Assert.Equal("{T: "Person", GivenNames: "John", FamilyName: "Smith"}", target.ToString());
17.     }
18. }
20. [ToString]
21. class Person
22. {
23.     public string GivenNames { get; set; }
24.     public string FamilyName { get; set; }
26.     [IgnoreDuringToString]
27.     public string FullName => $"{GivenNames} {FamilyName}";
28. }

复制代码

Rougamo.Fody

Rougamo是一个静态代码织入的AOP组件，类似Postsharp的一个组件，具有 MethodDecorator.Fody的功能，但功能更加强大，我个人觉得最为突出，优秀的两个功能点：

• 匹配
  
• 编织
  

匹配指的是命中AOP要拦截的目标匹配，比如有特征匹配，表达式匹配，类型匹配，更细化到模糊匹配，正则匹配。
编制则指的是拦截后能做的操作，比如有重写方法参数，修改返回值，异常处理，重试等。
该插件很强大，示例代码太多，就不再本篇内列出示例代码，官方文档中文介绍非常详细，建议直接查看官方文档。
其他

在Github库中，它提供了一些插件使用的Demo，除以上简单介绍的部分插件以外，还有这些

1. <Weavers VerifyAssembly="true"
2.          VerifyIgnoreCodes="0x80131869"
3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4.          xsi:noNamespaceSchemaLocation="FodyWeavers.xsd">
6.   <Anotar.Catel />
7.   <Anotar.Splat />
8.   <Anotar.Serilog />
9.   <Anotar.NLog />
10.   <Anotar.Custom />
11.   <Anotar.CommonLogging />
12.   <AsyncErrorHandler />
13.   <BasicFodyAddin />
14.   <Caseless />
15.   <ConfigureAwait  ContinueOnCapturedContext="false" />
16.   <EmptyConstructor />
17.   <ExtraConstraints />
18.   <Equatable />
19.   <InfoOf />
20.   <Ionad />
21.   <Janitor />
22.   <MethodTimer />
23.   <ModuleInit />
24.   <Obsolete />
25.   <PropertyChanging />
26.   <PropertyChanged />
27.   <Validar />
28.   <Resourcer />
29.   <Publicize />
30.   <Virtuosity />
31.   <Visualize />
32. </Weavers>

复制代码

若是在 Visual Studio 的 NuGet 管理器中搜索 Fody 相关包，会有更多的一些三方或者小众的库，依旧值得尝试。
小结

从 Fody 实现原理上就能看出，这个库强，很强，非常强。加上现在已有的非常之多的插件，除了能够提升开发效率之外，以在一定程度上实现一些难以实现的功能。强烈推荐大家学习使用。

链接
Fody官方Demo：https://github.com/Fody/FodyAddinSamples
工具 --- IL指令集解释：https://niuery.com/post/61

来源:https://www.cnblogs.com/pandefu/archive/2023/10/19/17775991.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！