netcore 之動態代理（微服務專題）
動態代理配合rpc技術呼叫遠端服務，不用關注細節的實現，讓程式就像在本地呼叫以用。
因此動態代理在微服務系統中是不可或缺的一個技術。網上看到大部分案例都是通過反射自己實現，且相當複雜。編寫和除錯相當不易，我這裡提供裡一種簡便的方式來實現動態代理。
1、建立我們的空白.netcore專案
通過vs2017輕易的創建出一個.netcore專案
2、編寫Startup.cs檔案
預設Startup 沒有建構函式，自行新增建構函式，帶有 IConfiguration 引數的，用於獲取專案配置，但我們的示例中未使用配置
public Startup(IConfiguration configuration)
{
Configuration = configuration;
//註冊編碼提供程式
Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);
}在ConfigureServices 配置日誌模組，目前core更新的很快，日誌的配置方式和原來又很大出入，最新的配置方式如下
// For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940
public void ConfigureServices(IServiceCollection services )
{
services.AddLogging(loggingBuilder=> {
loggingBuilder.AddConfiguration(Configuration.GetSection("Logging"));
loggingBuilder.AddConsole();
loggingBuilder.AddDebug();
});
}新增路由過濾器，監控一個地址，用於呼叫我們的測試程式碼。netcore預設沒有UTF8的編碼方式，所以要先解決UTF8編碼問題，否則將在輸出中文時候亂碼。
這裡注意 Map 內部傳遞了引數 applicationBuilder ，千萬不要 使用Configure(IApplicationBuilder app, IHostingEnvironment env ) 中的app引數，否則每次請求api/health時候都將呼叫這個中介軟體（app.Run會短路期後邊所有的中介軟體），
app.Map("/api/health", (applicationBuilder) =>
{
applicationBuilder.Run(context =>
{
return context.Response.WriteAsync(uName.Result, Encoding.UTF8);
});
});
3、代理
netcore 已經為我們完成了一些工作，提供了DispatchProxy 這個類
#region 程式集 System.Reflection.DispatchProxy, Version=4.0.4.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a
// C:\Program Files\dotnet\sdk\NuGetFallbackFolder\microsoft.netcore.app\2.2.0\ref\netcoreapp2.2\System.Reflection.DispatchProxy.dll
#endregion
namespace System.Reflection
{
//
public abstract class DispatchProxy
{
//
protected DispatchProxy();
//
// 型別引數:
// T:
//
// TProxy:
public static T Create<T, TProxy>() where TProxy : DispatchProxy;
//
// 引數:
// targetMethod:
//
// args:
protected abstract object Invoke(MethodInfo targetMethod, object[] args);
}
}
View Code
這個類提供了一個例項方法，一個靜態方法：
Invoke(MethodInfo targetMethod, object[] args) （註解1）
Create<T, TProxy>()（註解2）
Create 建立代理的例項物件，例項物件在呼叫方法時候會自動執行Invoke
首先我們建立一個動態代理類 ProxyDecorator<T>：DispatchProxy 需要繼承DispatchProxy 。
在DispatchProxy 的靜態方法 Create<T, TProxy>()中要求 TProxy : DispatchProxy
ProxyDecorator 重寫 DispatchProxy的虛方法invoke
我們可以在ProxyDecorator 類中新增一些其他方法，比如：異常處理，MethodInfo執行前後的處理。
重點要講一下
ProxyDecorator 中需要傳遞一個 T型別的變數 decorated 。
因為 DispatchProxy.Create<T, ProxyDecorator<T>>(); 會建立一個新的T的例項物件 ，這個物件是代理物件例項，我們將 decorated 繫結到這個代理例項上
接下來這個代理例項在執行T型別的任何方法時候都會用到 decorated，因為 [decorated] 會被傳給 targetMethod.Invoke(decorated, args) （targetMethod 來自注解1） ，invoke相當於執行
這樣說的不是很明白，我們直接看程式碼
1 using System;
2 using System.Collections.Generic;
3 using System.Linq;
4 using System.Linq.Expressions;
5 using System.Reflection;
6 using System.Text;
7 using System.Threading.Tasks;
8
9 namespace TestWFW
10 {
11 public class ProxyDecorator<T> : DispatchProxy
12 {
13 //關鍵詞 RealProxy
14 private T decorated;
15 private event Action<MethodInfo, object[]> _afterAction; //動作之後執行
16 private event Action<MethodInfo, object[]> _beforeAction; //動作之前執行
17
18 //其他自定義屬性，事件和方法
19 public ProxyDecorator()
20 {
21
22 }
23
24
25 /// <summary>
26 /// 建立代理例項
27 /// </summary>
28 /// <param name="decorated">代理的介面型別</param>
29 /// <returns></returns>
30 public T Create(T decorated)
31 {
32
33 object proxy = Create<T, ProxyDecorator<T>>(); //呼叫DispatchProxy 的Create 建立一個新的T
34 ((ProxyDecorator<T>)proxy).decorated = decorated; //這裡必須這樣賦值，會自動未proxy 新增一個新的屬性
//其他的請如法炮製
35
return (T)proxy; 36 } 37 38 /// <summary> 39 /// 建立代理例項 40 /// </summary> 41 /// <param name="decorated">代理的介面型別</param> 42 /// <param name="beforeAction">方法執行前執行的事件</param> 43 /// <param name="afterAction">方法執行後執行的事件</param> 44 /// <returns></returns> 45 public T Create(T decorated, Action<MethodInfo, object[]> beforeAction, Action<MethodInfo, object[]> afterAction) 46 { 47 48 object proxy = Create<T, ProxyDecorator<T>>(); //呼叫DispatchProxy 的Create 建立一個新的T 49 ((ProxyDecorator<T>)proxy).decorated = decorated; 50 ((ProxyDecorator<T>)proxy)._afterAction = afterAction; 51 ((ProxyDecorator<T>)proxy)._beforeAction = beforeAction; 52 //((GenericDecorator<T>)proxy)._loggingScheduler = TaskScheduler.FromCurrentSynchronizationContext(); 53 return (T)proxy; 54 } 55 56 57 58 protected override object Invoke(MethodInfo targetMethod, object[] args) 59 { 60 if (targetMethod == null) throw new Exception("無效的方法"); 61 62 try 63 { 64 //_beforeAction 事件 65 if (_beforeAction != null) 66 { 67 this._beforeAction(targetMethod, args); 68 } 69 70 71 object result = targetMethod.Invoke(decorated, args); 72 System.Diagnostics.Debug.WriteLine(result); //列印輸出面板 73 var resultTask = result as Task; 74 if (resultTask != null) 75 { 76 resultTask.ContinueWith(task => //ContinueWith 建立一個延續，該延續接收呼叫方提供的狀態資訊並執行 當目標系統 tasks。 77 { 78 if (task.Exception != null) 79 { 80 LogException(task.Exception.InnerException ?? task.Exception, targetMethod); 81 } 82 else 83 { 84 object taskResult = null; 85 if (task.GetType().GetTypeInfo().IsGenericType && 86 task.GetType().GetGenericTypeDefinition() == typeof(Task<>)) 87 { 88 var property = task.GetType().GetTypeInfo().GetProperties().FirstOrDefault(p => p.Name == "Result"); 89 if (property != null) 90 { 91 taskResult = property.GetValue(task); 92 } 93 } 94 if (_afterAction != null) 95 { 96 this._afterAction(targetMethod, args); 97 } 98 } 99 }); 100 } 101 else 102 { 103 try 104 { 105 // _afterAction 事件 106 if (_afterAction != null) 107 { 108 this._afterAction(targetMethod, args); 109 } 110 } 111 catch (Exception ex) 112 { 113 //Do not stop method execution if exception 114 LogException(ex); 115 } 116 } 117 118 return result; 119 } 120 catch (Exception ex) 121 { 122 if (ex is TargetInvocationException) 123 { 124 LogException(ex.InnerException ?? ex, targetMethod); 125 throw ex.InnerException ?? ex; 126 } 127 else 128 { 129 throw ex; 130 } 131 } 132 133 } 134 135 136 /// <summary> 137 /// aop異常的處理 138 /// </summary> 139 /// <param name="exception"></param> 140 /// <param name="methodInfo"></param> 141 private void LogException(Exception exception, MethodInfo methodInfo = null) 142 { 143 try 144 { 145 var errorMessage = new StringBuilder(); 146 errorMessage.AppendLine($"Class {decorated.GetType().FullName}"); 147 errorMessage.AppendLine($"Method {methodInfo?.Name} threw exception"); 148 errorMessage.AppendLine(exception.Message); 149 150 //_logError?.Invoke(errorMessage.ToString()); 記錄到檔案系統 151 } 152 catch (Exception) 153 { 154 // ignored 155 //Method should return original exception 156 } 157 } 158 } 159 }
程式碼比較簡單，相信大家都看的懂，關鍵的程式碼和核心的系統程式碼已經加粗和加加粗+紅 標註出來了
DispatchProxy<T> 類中有兩種建立代理例項的方法
我們看一下第一種比較簡單的建立方法
// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IHostingEnvironment env )
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
// 新增健康檢查路由地址
app.Map("/api/health", (applicationBuilder) =>
{
applicationBuilder.Run(context =>
{
IUserService userService = new UserService();
//執行代理
var serviceProxy = new ProxyDecorator<IUserService>();
IUserService user = serviceProxy.Create(userService); //
Task<string> uName = user.GetUserName(222);
context.Response.ContentType = "text/plain;charset=utf-8";
return context.Response.WriteAsync(uName.Result, Encoding.UTF8);
});
});
}
程式碼中 UserService 和 IUserService 是一個class和interface 自己實現即可 ，隨便寫一個介面，並用類實現，任何一個方法就行，下面只是演示呼叫方法時候會執行什麼，這個方法本身在岩石中並不重要。
由於ProxyDecorator 中並未注入相關事件，所以我們在呼叫 user.GetUserName(222) 時候看不到任何特別的輸出。下面我們演示一個相對複雜的呼叫方式。
// 新增健康檢查路由地址
app.Map("/api/health2", (applicationBuilder) =>
{
applicationBuilder.Run(context =>
{
IUserService userService = new UserService();
//執行代理
var serviceProxy = new ProxyDecorator<IUserService>();
IUserService user = serviceProxy.Create(userService, beforeEvent, afterEvent); //
Task<string> uName = user.GetUserName(222);
context.Response.ContentType = "text/plain;charset=utf-8";
return context.Response.WriteAsync(uName.Result, Encoding.UTF8);
});
});
IUserService user = serviceProxy.Create(userService, beforeEvent, afterEvent); 在建立代理例項時候傳遞了beforEvent 和 afterEvent，這兩個事件處理
函式是我們在業務中定義的
void beforeEvent(MethodInfo methodInfo, object[] arges)
{
System.Diagnostics.Debug.WriteLine("方法執行前");
}
void afterEvent(MethodInfo methodInfo, object[] arges)
{
System.Diagnostics.Debug.WriteLine("執行後的事件");
}
在代理例項執行介面的任何方法的時候都會執行 beforeEvent,和 afterEvent 這兩個事件(請參考Invoke(MethodInfo targetMethod, object[] args) 方法的實現)
在我們的示例中將會在vs的 輸出 面板中看到
方法執行前
“方法輸出的值”
執行後事件
我們看下執行效果圖：
這是 user.GetUserName(222) 的執行結果
控制檯輸出結果