實現一個基於動態代理的 AOP

来源:https://www.cnblogs.com/weihanli/archive/2020/04/22/12754922.html
-Advertisement-
Play Games

實現一個基於動態代理的 AOP Intro 上次看基於動態代理的 AOP 框架實現,立了一個 Flag, 自己寫一個簡單的 AOP 實現示例,今天過來填坑了 目前的實現是基於 Emit 來做的,後面有時間再寫一個基於 Roslyn 來實現的示例 效果演示 演示代碼: 切麵邏輯定義: 測試服務定義 測 ...


實現一個基於動態代理的 AOP

Intro

上次看基於動態代理的 AOP 框架實現,立了一個 Flag, 自己寫一個簡單的 AOP 實現示例,今天過來填坑了

目前的實現是基於 Emit 來做的,後面有時間再寫一個基於 Roslyn 來實現的示例

效果演示

演示代碼:

切麵邏輯定義:

public class TryInvokeAspect : AbstractAspect
{
    public override void Invoke(MethodInvocationContext methodInvocationContext, Action next)
    {
        Console.WriteLine($"begin invoke method {methodInvocationContext.ProxyMethod.Name} in {GetType().Name}...");
        try
        {
            next();
        }
        catch (Exception e)
        {
            Console.WriteLine($"Invoke {methodInvocationContext.ProxyMethod.DeclaringType?.FullName}.{methodInvocationContext.ProxyMethod.Name} exception");
            Console.WriteLine(e);
        }
        Console.WriteLine($"end invoke method {methodInvocationContext.ProxyMethod.Name} in {GetType().Name}...");
    }
}

public class TryInvoke1Aspect : AbstractAspect
{
    public override void Invoke(MethodInvocationContext methodInvocationContext, Action next)
    {
        Console.WriteLine($"begin invoke method {methodInvocationContext.ProxyMethod.Name} in {GetType().Name}...");
        try
        {
            next();
        }
        catch (Exception e)
        {
            Console.WriteLine($"Invoke {methodInvocationContext.ProxyMethod.DeclaringType?.FullName}.{methodInvocationContext.ProxyMethod.Name} exception");
            Console.WriteLine(e);
        }
        Console.WriteLine($"end invoke method {methodInvocationContext.ProxyMethod.Name} in {GetType().Name}...");
    }
}

public class TryInvoke2Aspect : AbstractAspect
{
    public override void Invoke(MethodInvocationContext methodInvocationContext, Action next)
    {
        Console.WriteLine($"begin invoke method {methodInvocationContext.ProxyMethod.Name} in {GetType().Name}...");
        try
        {
            next();
        }
        catch (Exception e)
        {
            Console.WriteLine($"Invoke {methodInvocationContext.ProxyMethod.DeclaringType?.FullName}.{methodInvocationContext.ProxyMethod.Name} exception");
            Console.WriteLine(e);
        }
        Console.WriteLine($"end invoke method {methodInvocationContext.ProxyMethod.Name} in {GetType().Name}...");
    }
}

測試服務定義

// 測試介面定義
public interface ITestService
{
    [TryInvokeAspect]
    void Test();

    [TryInvokeAspect]
    [TryInvoke1Aspect]
    [TryInvoke2Aspect]
    void Test1(int a, string b);

    [TryInvokeAspect]
    string Test2();

    [TryInvokeAspect]
    int Test3();
}
// 測試介面實例定義
public class TestService : ITestService
{
    [TryInvokeAspect]
    public virtual string TestProp { get; set; }

    public void Test()
    {
        Console.WriteLine("test invoked");
    }

    public virtual void Test1(int a, string b)
    {
        Console.WriteLine($"a:{a}, b:{b}");
    }

    [TryInvoke1Aspect]
    public virtual string Test2()
    {
        return "Hello";
    }

    [TryInvokeAspect]
    public virtual int Test3()
    {
        return 1;
    }
}

測試代碼:

//var testService = ProxyGenerator.Instance.CreateInterfaceProxy<ITestService>();
var testService = ProxyGenerator.Instance.CreateInterfaceProxy<ITestService, TestService>();
// var testService = ProxyGenerator.Instance.CreateClassProxy<TestService>();
// testService.TestProp = "12133";
testService.Test();
Console.WriteLine();
testService.Test1(1, "str");

var a = testService.Test2();

var b = testService.Test3();
Console.WriteLine($"a:{a}, b:{b}");
Console.ReadLine();

輸出效果:

整體結構

ProxyGenerator

ProxyGenerator 代理生成器,用來創建代理對象

public class ProxyGenerator
{
    public static readonly ProxyGenerator Instance = new ProxyGenerator();

    public object CreateInterfaceProxy(Type interfaceType)
    {
        var type = ProxyUtil.CreateInterfaceProxy(interfaceType);
        return Activator.CreateInstance(type);
    }

    public object CreateInterfaceProxy(Type interfaceType, Type implementationType)
    {
        var type = ProxyUtil.CreateInterfaceProxy(interfaceType, implementationType);
        return Activator.CreateInstance(type);
    }

    public object CreateClassProxy(Type classType, params Type[] interfaceTypes)
    {
        var type = ProxyUtil.CreateClassProxy(classType, interfaceTypes);
        return Activator.CreateInstance(type);
    }

    public object CreateClassProxy(Type classType, Type implementationType, params Type[] interfaceTypes)
    {
        var type = ProxyUtil.CreateClassProxy(implementationType, interfaceTypes);
        return Activator.CreateInstance(type);
    }
}

為了更方便的使用泛型,定義了幾個擴展方法:

public static class Extensions
{
    public static TInterface CreateInterfaceProxy<TInterface>(this ProxyGenerator proxyGenerator) =>
        (TInterface)proxyGenerator.CreateInterfaceProxy(typeof(TInterface));

    public static TInterface CreateInterfaceProxy<TInterface, TImplement>(this ProxyGenerator proxyGenerator) where TImplement : TInterface =>
        (TInterface)proxyGenerator.CreateInterfaceProxy(typeof(TInterface), typeof(TImplement));

    public static TClass CreateClassProxy<TClass>(this ProxyGenerator proxyGenerator) where TClass : class =>
        (TClass)proxyGenerator.CreateClassProxy(typeof(TClass));

    public static TClass CreateClassProxy<TClass, TImplement>(this ProxyGenerator proxyGenerator) where TImplement : TClass =>
        (TClass)proxyGenerator.CreateClassProxy(typeof(TClass), typeof(TImplement));
}

AbstractAspect

AbstractAspect 切麵抽象類,繼承了 Attribute,可以繼承它來實現自己的切麵邏輯

public abstract class AbstractAspect : Attribute
{
    public abstract void Invoke(MethodInvocationContext methodInvocationContext, Action next);
}

MethodInvocationContext

MethodInvocationContext 方法執行上下文,包含了執行方法時的原始方法信息以及代理方法信息,方法參數,方法返回值

public class MethodInvocationContext
{
    public MethodInfo ProxyMethod { get; }

    public MethodInfo MethodBase { get; }

    public object ProxyTarget { get; }

    public object Target { get; }

    public object[] Parameters { get; }

    public object ReturnValue { get; set; }

    public MethodInvocationContext(MethodInfo method, MethodInfo methodBase, object proxyTarget, object target, object[] parameters)
    {
        ProxyMethod = method;
        MethodBase = methodBase;
        ProxyTarget = proxyTarget;
        Target = target;
        Parameters = parameters;
    }
}

代理方法邏輯

生成代理的方法在上一節已經介紹,主要就是通過 Emit 生成代理類,要寫一些 Emit 代碼, Emit 不在今天的討論範圍內,這裡不多介紹,生成代理方法的時候,會檢查方法上的 Attribute ,如果是切麵邏輯就註冊切麵邏輯,最後像 asp.net core 中間件一樣組裝在一起拼成一個委托。

核心代碼如下:

// var invocation = new MethodInvocationContext(method, methodBase, this, parameters);
var localAspectInvocation = il.DeclareLocal(typeof(MethodInvocationContext));
il.Emit(OpCodes.Ldloc, localCurrentMethod);
il.Emit(OpCodes.Ldloc, localMethodBase);
il.Emit(OpCodes.Ldarg_0);
il.Emit(OpCodes.Ldloc, localTarget);
il.Emit(OpCodes.Ldloc, localParameters);
// 創建一個 MethodInvocationContext 實例
il.New(typeof(MethodInvocationContext).GetConstructors()[0]); 
il.Emit(OpCodes.Stloc, localAspectInvocation);

// AspectDelegate.InvokeAspectDelegate(invocation);
il.Emit(OpCodes.Ldloc, localAspectInvocation);
var invokeAspectDelegateMethod =
    typeof(AspectDelegate).GetMethod(nameof(AspectDelegate.InvokeAspectDelegate));
// 執行方法以及註冊的切麵邏輯
il.Call(invokeAspectDelegateMethod);
il.Emit(OpCodes.Nop);

if (method.ReturnType != typeof(void))
{
    // 獲取方法返回值
    il.Emit(OpCodes.Ldloc, localAspectInvocation);
    var getMethod = typeof(MethodInvocationContext).GetProperty("ReturnValue").GetGetMethod();
    il.EmitCall(OpCodes.Callvirt, getMethod, Type.EmptyTypes);

    if (method.ReturnType.IsValueType)
    {
        // 如果是值類型,做一下類型轉換
        il.EmitCastToType(typeof(object), method.ReturnType);
    }
	
    il.Emit(OpCodes.Stloc, localReturnValue);
    il.Emit(OpCodes.Ldloc, localReturnValue);
}

il.Emit(OpCodes.Ret);

註冊並執行切麵邏輯代碼實現:

// 緩存方法體執行的委托,包含切麵邏輯的執行和方法的調用
private static readonly ConcurrentDictionary<string, Action<MethodInvocationContext>> _aspectDelegates = new ConcurrentDictionary<string, Action<MethodInvocationContext>>();

public static void InvokeAspectDelegate(MethodInvocationContext context)
{
    var action = _aspectDelegates.GetOrAdd($"{context.ProxyMethod.DeclaringType}.{context.ProxyMethod}", m =>
    {
        // 獲取切麵邏輯,這裡根據切麵類型做了一個去重
        var aspects = new List<AbstractAspect>(8);
        if (context.MethodBase != null)
        {
            // 獲取類方法上的切麵邏輯
            foreach (var aspect in context.MethodBase.GetCustomAttributes<AbstractAspect>())
            {
                if (!aspects.Exists(x => x.GetType() == aspect.GetType()))
                {
                    aspects.Add(aspect);
                }
            }
        }
        // 獲取介面方法上的切麵
        var methodParameterTypes = context.ProxyMethod.GetParameters().Select(p => p.GetType()).ToArray();
        foreach (var implementedInterface in context.ProxyTarget.GetType().GetImplementedInterfaces())
        {
            var method = implementedInterface.GetMethod(context.ProxyMethod.Name, methodParameterTypes);
            if (null != method)
            {
                foreach (var aspect in method.GetCustomAttributes<AbstractAspect>())
                {
                    if (!aspects.Exists(x => x.GetType() == aspect.GetType()))
                    {
                        aspects.Add(aspect);
                    }
                }
            }
        }

        // 構建切麵邏輯執行管道,類似於 asp.net core 里的請求管道, 以原始方法調用作為中間件的最後一步
        var builder = PipelineBuilder.Create<MethodInvocationContext>(x => x.Invoke());
        foreach (var aspect in aspects)
        {
            // 註冊切麵邏輯
            builder.Use(aspect.Invoke);
        }
        // 構建方法執行委托
        return builder.Build();
    });
    // 執行委托
    action.Invoke(context);

    // 檢查返回值,防止切麵邏輯管道的中斷執行導致值類型返回值沒有賦值
    if (context.ProxyMethod.ReturnType != typeof(void))
    {
        if (context.ReturnValue == null && context.ProxyMethod.ReturnType.IsValueType)
        {
            // 為值類型返回值設置預設值作為返回值
            context.ReturnValue = Activator.CreateInstance(context.ProxyMethod.ReturnType);
        }
    }
}

More

以上基本可以實現一個 AOP 功能,但是從擴展性以及功能上來說都還比較欠缺,基於 Attribute 的方式固然可以實現功能,但是太不靈活,如果我要在一個無法修改的介面上的某一個方法做一個切麵邏輯,顯然只使用 Attribute 是做不到的,還是 Fluent-API 的方式比較靈活。

想做一層 AOP 的抽象,切麵邏輯通過 Fluent-API 的方式來註冊,大概的 API 可能是這樣的:

var settings = FluentAspects.For<ITestService>();
setting.PropertySetter(x=>x.TestProp)
    .InterceptWith<TryInterceptor>()
    .InterceptWith<TryInterceptor1>();
setting.Method(x=> x.Test2())
    .InterceptWith<TryInterceptor>()
    .InterceptWith<TryInterceptor1>();
    

然後基於 AspectCoreCastle.Core 來實現具體的 AOP 功能,暫時先想一下,爭取儘快的發佈一個基本可用的版本,然後之前基於 EF Core 的自動審計也可以基於 AOP 來實現了,這樣就不需要顯示繼承 AuditDbContext 了~

文章所有源碼可以在 Github 上獲取到,Github 地址: https://github.com/WeihanLi/SamplesInPractice/tree/master/AopSample

Reference


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 當下,Python 比以往的任何時候都更加流行,人們每天都在實踐著 Python 是多麼的強大且易用。 我從事 Python 編程已經有幾年時間了,但是最近6個月才是全職的。下麵列舉的這些事情,是我最開始使用 Python 的時候,就希望清楚的: 字元串操作 列表推導 Lambda 和 Map 函數 ...
  • 什麼是 Opcache 每一次執行 PHP 腳本的時候,該腳本都需要被編譯成位元組碼,而 OPcache 可以對該位元組碼進行緩存,這樣,下次請求同一個腳本的時候,該腳本就不需要重新編譯,這極大節省了腳本的執行時間,從而讓應用運行速度更快,同時也節省了伺服器的開銷。 用數字說話 我們當然很想知道到底進行 ...
  • 【目錄】 一、操作系統發展史 二、進程發展史及演算法演變 三、多道技術 四、同步非同步/阻塞非阻塞概念 五、創建進程的兩種方式 一、操作系統發展史 1、第一代電腦(1940~1955):真空管和穿孔卡片 (1)特點: 沒有操作系統的概念 所有的程式設計都是直接操控硬體 (2)優點:程式員在申請的時間段 ...
  • 輸入一個1到7的數字,輸出對應的星期名的縮寫。1 Mon2 Tue3 Wed4 Thu5 Fri6 Sat7 Sun輸入格式:輸入1到7之間數字輸出格式:輸出對應的星期名的縮寫代碼如下:#!/usr/bin/python# -*- coding: utf-8 -*-n = int(input())i... ...
  • #創建一個文件,在該文件中創建兩個字典,一個保存名字和星座,另一個保存星座和性格特點,#最後從這兩個字典取出相應的信息組合成想要的結果:name = ['綺夢','冷伊一','香凝','黛蘭'] sign_person = ['水瓶座','射手座','雙魚座','雙子座'] sign_all =[' ...
  • 在經過前面八篇文章(abp(net core)+easyui+efcore實現倉儲管理系統——入庫管理之一(三十七) 至abp(net core)+easyui+efcore實現倉儲管理系統——入庫管理之八(四十四) )的學習之後,我們知道了已經基本完成了入庫管理功能。在這篇文章中我們來增加更新與刪... ...
  • 如題,納悶為什麼有空白子項並且Clear也沒用,所以搜了下,傳送門https://www.cnblogs.com/gc2013/p/4103910.html 使用的是ListView的Details視圖,提一下。 由於博主分析了很多我沒細看,因為我只是想解決這個簡單的問題,類似於直接把第一項給移除掉 ...
  • 在前面隨筆《利用微信公眾號實現商品的展示和支付(1)》介紹了商品的列表和明細信息的處理,本篇隨筆接著上一篇,繼續介紹關於商品的微信支付和購物車處理方面,其中微信支付裡面,也涉及到了獲取微信共用地址的處理,從而個更加方便錄入郵寄地址信息;購物車可以從本地的localStorage對象進行獲取和處理,也... ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...