動手造輪子：實現一個簡單的 AOP 框架

来源:https://www.cnblogs.com/weihanli/archive/2020/06/14/13126235.html
-Advertisement-
Play Games

動手造輪子：實現一個簡單的 AOP 框架 Intro 最近實現了一個 AOP 框架 -- FluentAspects，API 基本穩定了，寫篇文章分享一下這個 AOP 框架的設計。 整體設計 概覽 IProxyTypeFactory 用來生成代理類型，預設提供了基於 Emit 動態代理的實現，基於接 ...


動手造輪子：實現一個簡單的 AOP 框架

Intro

最近實現了一個 AOP 框架 -- FluentAspects，API 基本穩定了，寫篇文章分享一下這個 AOP 框架的設計。

整體設計

概覽

IProxyTypeFactory

用來生成代理類型，預設提供了基於 Emit 動態代理的實現，基於介面設計，可以擴展為其他實現方式

介面定義如下：

public interface IProxyTypeFactory
{
    Type CreateProxyType(Type serviceType);

    Type CreateProxyType(Type serviceType, Type implementType);
}

IProxyFactory

用來生成代理實例，預設實現是基於 IProxyTypeFactory 生成代理類型之後創建實例

介面定義如下：

public interface IProxyFactory
{
    object CreateProxy(Type serviceType, object[] arguments);

    object CreateProxy(Type serviceType, Type implementType, params object[] arguments);

    object CreateProxyWithTarget(Type serviceType, object implement, object[] arguments);
}

IInvocation

執行上下文，預設實現就是方法執行的上下文，包含了代理方法信息、被代理的方法信息、方法參數，返回值以及用來自定義擴展的一個 Properties 屬性

public interface IInvocation
{
    MethodInfo ProxyMethod { get; }

    object ProxyTarget { get; }

    MethodInfo Method { get; }

    object Target { get; }

    object[] Arguments { get; }

    Type[] GenericArguments { get; }

    object ReturnValue { get; set; }

    Dictionary<string, object> Properties { get; }
}

IInterceptor

攔截器，用來定義公用的處理邏輯，方法攔截處理方法

介面定義如下：

public interface IInterceptor
{
    Task Invoke(IInvocation invocation, Func<Task> next);
}

invocation 是方法執行的上下文，next 代表後續的邏輯處理，類似於 asp.net core 里的 next ，如果不想執行方面的方法不執行 next 邏輯即可

IInterceptorResolver

用來根據當前的執行上下文獲取到要執行的攔截器，預設是基於 FluentAPI 的實現，但是如果你特別想用基於 Attribute 的也是可以的，預設提供了一個 AttributeInterceotorResovler，你也可以自定義一個適合自己的 InterceptorResolver

public interface IInterceptorResolver
{
    IReadOnlyList<IInterceptor> ResolveInterceptors(IInvocation invocation);
}

IInvocationEnricher

上面 IInvocation 的定義中有一個用於擴展的 Properties，這個 enricher 主要就是基於 Properties 來豐富執行上下文信息的，比如說記錄 TraceId 等請求鏈路追蹤數據，構建方法執行鏈路等

public interface IEnricher<in TContext>
{
    void Enrich(TContext context);
}
public interface IInvocationEnricher : IEnricher<IInvocation>
{
}

AspectDelegate

AspectDelegate 是用來將構建要執行的代理方法的方法體的，首先執行註冊的 InvocationEnricher，豐富上下文信息，然後根據執行上下文獲取要執行的攔截器，構建一個執行委托，生成委托使用了之前分享過的 PipelineBuilder 構建中間件模式的攔截器，執行攔截器邏輯

// apply enrichers
foreach (var enricher in FluentAspects.AspectOptions.Enrichers)
{
    try
    {
        enricher.Enrich(invocation);
    }
    catch (Exception ex)
    {
        InvokeHelper.OnInvokeException?.Invoke(ex);
    }
}

// get delegate
var builder = PipelineBuilder.CreateAsync(completeFunc);
foreach (var interceptor in interceptors)
{
    builder.Use(interceptor.Invoke);
}
return builder.Build();

更多信息可以參考源碼： https://github.com/WeihanLi/WeihanLi.Common/blob/dev/src/WeihanLi.Common/Aspect/AspectDelegate.cs

使用示例

推薦和依賴註入結合使用，主要分為以微軟的註入框架為例，有兩種使用方式，一種是手動註冊代理服務，一種是自動批量註冊代理服務，來看下麵的實例就明白了

手動註冊代理服務

使用方式一，手動註冊代理服務：

為了方便使用，提供了一些 AddProxy 的擴展方法：

IServiceCollection services = new ServiceCollection();
services.AddFluentAspects(options =>
    {
        // 註冊攔截器配置
        options.NoInterceptProperty<IFly>(f => f.Name);

        options.InterceptAll()
            .With<LogInterceptor>()
            ;
        options.InterceptMethod<DbContext>(x => x.Name == nameof(DbContext.SaveChanges)
                                                || x.Name == nameof(DbContext.SaveChangesAsync))
            .With<DbContextSaveInterceptor>()
            ;
        options.InterceptMethod<IFly>(f => f.Fly())
            .With<LogInterceptor>();
        options.InterceptType<IFly>()
            .With<LogInterceptor>();

        // 註冊 InvocationEnricher
        options
            .WithProperty("TraceId", "121212")
            ;
    });
// 使用 Castle 生成代理
services.AddFluentAspects(options =>
    {
        // 註冊攔截器配置
        options.NoInterceptProperty<IFly>(f => f.Name);

        options.InterceptAll()
            .With<LogInterceptor>()
            ;
        options.InterceptMethod<DbContext>(x => x.Name == nameof(DbContext.SaveChanges)
                                                || x.Name == nameof(DbContext.SaveChangesAsync))
            .With<DbContextSaveInterceptor>()
            ;
        options.InterceptMethod<IFly>(f => f.Fly())
            .With<LogInterceptor>();
        options.InterceptType<IFly>()
            .With<LogInterceptor>();

        // 註冊 InvocationEnricher
        options
            .WithProperty("TraceId", "121212")
            ;
    }, builder => builder.UseCastle());

services.AddTransientProxy<IFly, MonkeyKing>();
services.AddSingletonProxy<IEventBus, EventBus>();
services.AddDbContext<TestDbContext>(options =>
{
    options.UseInMemoryDatabase("Test");
});
services.AddScopedProxy<TestDbContext>();

var serviceProvider = services.BuildServiceProvider();

批量自動註冊代理服務

使用方式二，批量自動註冊代理服務：

IServiceCollection services = new ServiceCollection();
services.AddTransient<IFly, MonkeyKing>();
services.AddSingleton<IEventBus, EventBus>();
services.AddDbContext<TestDbContext>(options =>
{
    options.UseInMemoryDatabase("Test");
});

var serviceProvider = services.BuildFluentAspectsProvider(options =>
            {
                options.InterceptAll()
                    .With<TestOutputInterceptor>(output);
            });

// 使用 Castle 來生成代理
var serviceProvider = services.BuildFluentAspectsProvider(options =>
            {
                options.InterceptAll()
                    .With<TestOutputInterceptor>(output);
            }, builder => builder.UseCastle());

// 忽略命名空間為 Microsoft/System 的服務類型
var serviceProvider = services.BuildFluentAspectsProvider(options =>
            {
                options.InterceptAll()
                    .With<TestOutputInterceptor>(output);
            }, builder => builder.UseCastle(), t=> t.Namespace != null && (t.Namespace.StartWith("Microsft") ||t.Namespace.StartWith("Microsft")));

More

上面的兩種方式個人比較推薦使用第一種方式，需要攔截什麼就註冊什麼代理服務，自動註冊可能會生成很多不必要的代理服務，個人還是比較喜歡按需註冊的方式，更為可控。

這個框架還不是很完善，有一些地方還是需要優化的，目前還是在我自己的類庫中，因為我的類庫里要支持 net45，所以有一些不好的設計改起來不太方便，打算遷移出來作為一個單獨的組件，直接基於 netstandard2.0/netstandard2.1, 甩掉 netfx 的包袱。

Reference


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

-Advertisement-
Play Games
更多相關文章
  • 學習java第8課：idea新建項目
    new→ empty project→.......→.new→module→......→file→project structure →project→配置好project sdk→project language leval→選擇8開頭的（因為我們jdk是8）→apply→ok src→new ...
  • 使用SSH遠程管理時本地文件被修改了
    背景： 有兩個網段：1段作為工作網段即員工辦公用；2段作為專用網段配置了一系列需要的環境。 在Ubuntu 16.04用Python的SSH工具在對這兩個網段遠程管理，我寫了一個檢測環境的腳本，用SFTP將其分別上傳。 問題： 上傳2段時正常；上傳1段只成功上傳了1台之後我的文件內容就被修改為空了。 ...
  • 14.Django-JWT
    一、基於JWT的Token登錄認證 1. JWT簡介 json Web Token（縮寫JWT）是目前最流行的跨域認證解決方案 session登錄的認證方案是看，用戶從客戶端傳遞用戶名和密碼登錄信息，服務端認證後將信息儲存在session中，將session_id放入cookie中，以後訪問其他頁面 ...
  • C++ 複製構造函數
    ——複製構造函數用於將一個對象的值複製到新創建的對象中，用於初始化過程中（包括按值傳遞參數），而不是常規的賦值過程中 原型： Class_name(const Class_name &) 何時調用： 新建一個對象並將其初始化為同類現有對象時，複製構造函數都將被調用 StringBad ditto(m ...
  • odoo命名規範及常用函數
    odoo命名規範: 1.模塊命名使用業務相關的英文單詞或單詞的組合字元串.例如:school,school_inventory. ...
  • JAVA中的BIO,NIO與多路復用(select,poll,epoll)
    1.Socket鏈接的建立 java程式(server) 在應用空間中運行,當建立一個socket鏈接時,會向內核空間中的內核程式(sc)發送指令,內核程式中一定會執行Socket(AF_UNIX,SOCK_STAM,0) -> fd(文件標識符)6 --傳遞-> bind(6,9999) 綁定埠 ...
  • 學歷不夠技術來湊，大專生逆襲進阿裡拿百萬年薪
    2020年YQ爆發，股市動蕩各國家間關係不穩定，國內市場經濟低迷，再這樣的大環境下，各大公司採取了優化政策，以求自保。 本人履歷 高中沒考上，上了中專，在廣州工作兩年，16年來到杭州，已從事開發6年之久了，去過小公司、創業公司、國企都有待過，一直都是搬磚碼農，沒有正確的職業規劃，導致6年來還是一個小 ...
  • 【asp.net core 系列】9 實戰之 UnitOfWork以及自定義代碼生成
    0. 前言 在前一篇中我們創建了一個基於EF的數據查詢介面實現基類，這一篇我將帶領大家講一下為這EF補充一些功能，並且提供一個解決避免寫大量配置類的方案。 1. SaveChanges的外移 在之前介紹EF Core的時候，我們提到過使用EF需要在每次使用之後，調用一次SaveChanges將數據提 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 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 ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類