AOP從靜態代理到動態代理 Emit實現

本文轉載自查看原文 2018-09-16 23:22 4951 C#/ C#/.Net/NetCore

【前言】

　　AOP為Aspect Oriented Programming的縮寫，意思是面向切面編程的技術。

　　何為切面？

　　一個和業務沒有任何耦合相關的代碼段，諸如：調用日志，發送郵件，甚至路由分發。一切能為代碼所有且能和代碼充分解耦的代碼都可以作為一個業務代碼的切面。

　　我們為什么要AOP？

　　那我們從一個場景舉例說起：

　　如果想要采集用戶操作行為，我們需要掌握用戶調用的每一個接口的信息。這時候的我們要怎么做?

　　如果不采用AOP技術，也是最簡單的，所有方法體第一句話先調用一個日志接口將方法信息傳遞記錄。

　　有何問題？

　　實現業務沒有任何問題，但是隨之而來的是代碼臃腫不堪，難以調整維護的諸多問題（可自行腦補）。

　　如果我們采用了AOP技術，我們就可以在系統啟動的地方將所有將要采集日志的類注入，每一次調用方法前，AOP框架會自動調用我們的日志代碼。

　　是不是省去了很多重復無用的勞動？代碼也將變得非常好維護（有朝一日不需要了，只需將切面代碼注釋掉即可）

　　接下來我們看看AOP框架的工作原理以及實過程。

【實現思路】

　　AOP框架呢，一般通過靜態代理和動態代理兩種實現方式。

　　何為靜態代理？

　　靜態代理，又叫編譯時代理，就是在編譯的時候，已經存在代理類，運行時直接調用的方式。說的通俗一點，就是自己手動寫代碼實現代理類的方式。

　　我們通過一個例子來展現一下靜態代理的實現過程：

　　我們這里有一個業務類，里面有方法Test()，我們要在Test調用前和調用后分別輸出日志。

　　我們既然要將Log當作一個切面，我們肯定不能去動原有的業務代碼，那樣也違反了面向對象設計之開閉原則。

　　那么我們要怎么做呢？我們定義一個新類 BusinessProxy 去包裝一下這個類。為了便於在多個方法的時候區分和辨認，方法也叫 Test（）

　　這樣，我們如果要在所有的Business類中的方法都添加Log，我們就在BusinessProxy代理類中添加對應的方法去包裝。既不破壞原有邏輯，又可以實現前后日志的功能。

　　當然，我們可以有更優雅的實現方式：

　　我們可以定義代理類，繼承自業務類。將業務類中的方法定義為虛方法。那么我們可以重寫父類的方法並且在加入日志以后再調用父類的原方法。

　　當然，我們還有更加優雅的實現方式：

　　我們可以使用發射的技術，寫一個通用的Invoke方法，所有的方法都可以通過該方法調用。

　　我們這樣便實現了一個靜態代理。

　　那我們既然有了靜態代理，為什么又要有動態代理呢？

　　我們仔細回顧靜態代理的實現過程。我們要在所有的方法中添加切面，我們就要在代理類中重寫所有的業務方法。更有甚者，我們有N個業務類，就要定義N個代理類。這是很龐大的工作量。

　　這就是動態代理出現的背景，相比都可以猜得到，動態代理就是將這一系列繁瑣的步驟自動化，讓程序自動為我們生成代理類。

　　何為動態代理？

　　動態代理，又成為運行時代理。在程序運行的過程中，調用了生成代理類的代碼，將自動生成業務類的代理類。不需要我們手共編寫，極高的提高了工作效率和調整了程序員的心態。

　　原理不必多說，就是動態生成靜態代理的代碼。我們要做的，就是選用一種生成代碼的方式去生成。

　　今天我分享一個簡單的AOP框架，代碼使用Emit生成。當然，Emit 代碼的寫法不是今天要講的主要內容，需要提前去學習。

　　先說效果：

　　定義一個Action特性類 ActionAttribute 繼承自 ActionBaseAttribute，里面在Before和After方法中輸出兩條日志；

　　定義一個Action特性類 InterceptorAttribute 繼承自 InterceptorBaseAttribute，里面捕獲了方法調用異常，以及執行前后分別輸出日志；

　　然后定義一個業務類 BusinessClass 實現了 IBusinessClass 接口，定義了各種類型的方法

　　多余的方法不貼圖了。

　　我們把上面定義的方法調用切面標簽放在業務類上，表示該類下所有的方法都執行異常過濾；

　　我們把Action特性放在Test方法上，表明要在 Test（）方法的 Before 和 After 調用時記錄日志；

　　我們定義測試類：

　　調用一下試試：

　　可見，全類方法標簽 Interceptor 在 Test 和 GetInt 方法調用前后都打出了對應的日志；

　　Action方法標簽只在 Test 方法上做了標記，那么Test 方法 Before 和 After 執行時打出了日志；

【實現過程】

　　實現的思路在上面已經有詳細的講解，可以參考靜態代理的實現思路。

　　我們定義一個動態代理生成類 DynamicProxy，用於原業務代碼的掃描和代理類代碼的生成；

　　定義兩個過濾器標簽，ActionBaseAttribute，提供 Before 和 After 切面方法；InterceptorBaseAttribute，提供 Invoke “全調用”包裝的切面方法；

　　Before可以獲取到當前調用的方法和參數列表，After可以獲取到當前方法調用以后的結果。

　　Invoke 可以拿到當前調用的對象和方法名，參數列表。在這里進行反射動態調用。

1 [AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
2     public class ActionBaseAttribute : Attribute
3     {
4         public virtual void Before(string @method, object[] parameters) { }
5 
6         public virtual object After(string @method, object result) { return result; }
7     }

1 [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
2     public class InterceptorBaseAttribute : Attribute
3     {
4         public virtual object Invoke(object @object, string @method, object[] parameters)
5         {
6             return @object.GetType().GetMethod(@method).Invoke(@object, parameters);
7         }
8     }

　　代理生成類采用Emit的方式生成運行時IL代碼。

　　先把代碼放在這里：

  1 public class DynamicProxy
  2     {
  3         public static TInterface CreateProxyOfRealize<TInterface, TImp>() where TImp : class, new() where TInterface : class
  4         {
  5             return Invoke<TInterface, TImp>();
  6         }
  7 
  8         public static TProxyClass CreateProxyOfInherit<TProxyClass>() where TProxyClass : class, new()
  9         {
 10             return Invoke<TProxyClass, TProxyClass>(true);
 11         }
 12 
 13         private static TInterface Invoke<TInterface, TImp>(bool inheritMode = false) where TImp : class, new() where TInterface : class
 14         {
 15             var impType = typeof(TImp);
 16 
 17             string nameOfAssembly = impType.Name + "ProxyAssembly";
 18             string nameOfModule = impType.Name + "ProxyModule";
 19             string nameOfType = impType.Name + "Proxy";
 20 
 21             var assemblyName = new AssemblyName(nameOfAssembly);
 22 
 23             var assembly = AppDomain.CurrentDomain.DefineDynamicAssembly(assemblyName, AssemblyBuilderAccess.Run);
 24             var moduleBuilder = assembly.DefineDynamicModule(nameOfModule);
 25 
 26             //var assembly = AppDomain.CurrentDomain.DefineDynamicAssembly(assemblyName, AssemblyBuilderAccess.RunAndSave);
 27             //var moduleBuilder = assembly.DefineDynamicModule(nameOfModule, nameOfAssembly + ".dll");
 28 
 29             TypeBuilder typeBuilder;
 30             if (inheritMode)
 31                 typeBuilder = moduleBuilder.DefineType(nameOfType, TypeAttributes.Public, impType);
 32             else
 33                 typeBuilder = moduleBuilder.DefineType(nameOfType, TypeAttributes.Public, null, new[] { typeof(TInterface) });
 34 
 35             InjectInterceptor<TImp>(typeBuilder, impType.GetCustomAttribute(typeof(InterceptorBaseAttribute))?.GetType(), inheritMode);
 36 
 37             var t = typeBuilder.CreateType();
 38 
 39             //assembly.Save(nameOfAssembly + ".dll");
 40 
 41             return Activator.CreateInstance(t) as TInterface;
 42         }
 43 
 44         private static void InjectInterceptor<TImp>(TypeBuilder typeBuilder, Type interceptorAttributeType, bool inheritMode = false)
 45         {
 46             var impType = typeof(TImp);
 47             // ---- define fields ----
 48             FieldBuilder fieldInterceptor = null;
 49             if (interceptorAttributeType != null)
 50             {
 51                 fieldInterceptor = typeBuilder.DefineField("_interceptor", interceptorAttributeType, FieldAttributes.Private);
 52             }
 53             // ---- define costructors ----
 54             if (interceptorAttributeType != null)
 55             {
 56                 var constructorBuilder = typeBuilder.DefineConstructor(MethodAttributes.Public, CallingConventions.Standard, null);
 57                 var ilOfCtor = constructorBuilder.GetILGenerator();
 58 
 59                 ilOfCtor.Emit(OpCodes.Ldarg_0);
 60                 ilOfCtor.Emit(OpCodes.Newobj, interceptorAttributeType.GetConstructor(new Type[0]));
 61                 ilOfCtor.Emit(OpCodes.Stfld, fieldInterceptor);
 62                 ilOfCtor.Emit(OpCodes.Ret);
 63             }
 64 
 65             // ---- define methods ----
 66 
 67             var methodsOfType = impType.GetMethods(BindingFlags.Public | BindingFlags.Instance);
 68 
 69             string[] ignoreMethodName = new[] { "GetType", "ToString", "GetHashCode", "Equals" };
 70 
 71             foreach (var method in methodsOfType)
 72             {
 73                 //ignore method
 74                 if (ignoreMethodName.Contains(method.Name))
 75                     return;
 76 
 77                 var methodParameterTypes = method.GetParameters().Select(p => p.ParameterType).ToArray();
 78 
 79                 MethodAttributes methodAttributes;
 80 
 81                 if (inheritMode)
 82                     methodAttributes = MethodAttributes.Public | MethodAttributes.Virtual;
 83                 else
 84                     methodAttributes = MethodAttributes.Public | MethodAttributes.HideBySig | MethodAttributes.NewSlot | MethodAttributes.Virtual | MethodAttributes.Final;
 85 
 86                 var methodBuilder = typeBuilder.DefineMethod(method.Name, methodAttributes, CallingConventions.Standard, method.ReturnType, methodParameterTypes);
 87 
 88                 var ilMethod = methodBuilder.GetILGenerator();
 89 
 90                 // set local field
 91                 var impObj = ilMethod.DeclareLocal(impType);                //instance of imp object
 92                 var methodName = ilMethod.DeclareLocal(typeof(string));     //instance of method name
 93                 var parameters = ilMethod.DeclareLocal(typeof(object[]));   //instance of parameters
 94                 var result = ilMethod.DeclareLocal(typeof(object));         //instance of result
 95                 LocalBuilder actionAttributeObj = null;
 96 
 97                 //attribute init
 98                 Type actionAttributeType = null;
 99                 if (method.GetCustomAttribute(typeof(ActionBaseAttribute)) != null || impType.GetCustomAttribute(typeof(ActionBaseAttribute)) != null)
100                 {
101                     //method can override class attrubute
102                     if (method.GetCustomAttribute(typeof(ActionBaseAttribute)) != null)
103                     {
104                         actionAttributeType = method.GetCustomAttribute(typeof(ActionBaseAttribute)).GetType();
105                     }
106                     else if (impType.GetCustomAttribute(typeof(ActionBaseAttribute)) != null)
107                     {
108                         actionAttributeType = impType.GetCustomAttribute(typeof(ActionBaseAttribute)).GetType();
109                     }
110 
111                     actionAttributeObj = ilMethod.DeclareLocal(actionAttributeType);
112                     ilMethod.Emit(OpCodes.Newobj, actionAttributeType.GetConstructor(new Type[0]));
113                     ilMethod.Emit(OpCodes.Stloc, actionAttributeObj);
114                 }
115 
116                 //instance imp
117                 ilMethod.Emit(OpCodes.Newobj, impType.GetConstructor(new Type[0]));
118                 ilMethod.Emit(OpCodes.Stloc, impObj);
119 
120                 //if no attribute
121                 if (fieldInterceptor != null || actionAttributeObj != null)
122                 {
123                     ilMethod.Emit(OpCodes.Ldstr, method.Name);
124                     ilMethod.Emit(OpCodes.Stloc, methodName);
125 
126                     ilMethod.Emit(OpCodes.Ldc_I4, methodParameterTypes.Length);
127                     ilMethod.Emit(OpCodes.Newarr, typeof(object));
128                     ilMethod.Emit(OpCodes.Stloc, parameters);
129 
130                     // build the method parameters
131                     for (var j = 0; j < methodParameterTypes.Length; j++)
132                     {
133                         ilMethod.Emit(OpCodes.Ldloc, parameters);
134                         ilMethod.Emit(OpCodes.Ldc_I4, j);
135                         ilMethod.Emit(OpCodes.Ldarg, j + 1);
136                         //box
137                         ilMethod.Emit(OpCodes.Box, methodParameterTypes[j]);
138                         ilMethod.Emit(OpCodes.Stelem_Ref);
139                     }
140                 }
141 
142                 //dynamic proxy action before
143                 if (actionAttributeType != null)
144                 {
145                     //load arguments
146                     ilMethod.Emit(OpCodes.Ldloc, actionAttributeObj);
147                     ilMethod.Emit(OpCodes.Ldloc, methodName);
148                     ilMethod.Emit(OpCodes.Ldloc, parameters);
149                     ilMethod.Emit(OpCodes.Call, actionAttributeType.GetMethod("Before"));
150                 }
151 
152                 if (interceptorAttributeType != null)
153                 {
154                     //load arguments
155                     ilMethod.Emit(OpCodes.Ldarg_0);//this
156                     ilMethod.Emit(OpCodes.Ldfld, fieldInterceptor);
157                     ilMethod.Emit(OpCodes.Ldloc, impObj);
158                     ilMethod.Emit(OpCodes.Ldloc, methodName);
159                     ilMethod.Emit(OpCodes.Ldloc, parameters);
160                     // call Invoke() method of Interceptor
161                     ilMethod.Emit(OpCodes.Callvirt, interceptorAttributeType.GetMethod("Invoke"));
162                 }
163                 else
164                 {
165                     //direct call method
166                     if (method.ReturnType == typeof(void) && actionAttributeType == null)
167                     {
168                         ilMethod.Emit(OpCodes.Ldnull);
169                     }
170 
171                     ilMethod.Emit(OpCodes.Ldloc, impObj);
172                     for (var j = 0; j < methodParameterTypes.Length; j++)
173                     {
174                         ilMethod.Emit(OpCodes.Ldarg, j + 1);
175                     }
176                     ilMethod.Emit(OpCodes.Callvirt, impType.GetMethod(method.Name));
177                     //box
178                     if (actionAttributeType != null)
179                     {
180                         if (method.ReturnType != typeof(void))
181                             ilMethod.Emit(OpCodes.Box, method.ReturnType);
182                         else
183                             ilMethod.Emit(OpCodes.Ldnull);
184                     }
185                 }
186 
187                 //dynamic proxy action after
188                 if (actionAttributeType != null)
189                 {
190                     ilMethod.Emit(OpCodes.Stloc, result);
191                     //load arguments
192                     ilMethod.Emit(OpCodes.Ldloc, actionAttributeObj);
193                     ilMethod.Emit(OpCodes.Ldloc, methodName);
194                     ilMethod.Emit(OpCodes.Ldloc, result);
195                     ilMethod.Emit(OpCodes.Call, actionAttributeType.GetMethod("After"));
196                 }
197 
198                 // pop the stack if return void
199                 if (method.ReturnType == typeof(void))
200                 {
201                     ilMethod.Emit(OpCodes.Pop);
202                 }
203                 else
204                 {
205                     //unbox,if direct invoke,no box
206                     if (fieldInterceptor != null || actionAttributeObj != null)
207                     {
208                         if (method.ReturnType.IsValueType)
209                             ilMethod.Emit(OpCodes.Unbox_Any, method.ReturnType);
210                         else
211                             ilMethod.Emit(OpCodes.Castclass, method.ReturnType);
212                     }
213                 }
214                 // complete
215                 ilMethod.Emit(OpCodes.Ret);
216             }
217         }
218     }