Asp.net Core 3.1基於AspectCore實現AOP,實現事務、緩存攔截器

来源:https://www.cnblogs.com/caijt/archive/2020/07/27/13380455.html

最近想給我的框架加一種功能,就是比如給一個方法加一個事務的特性Attribute,那這個方法就會啟用事務處理。給一個方法加一個緩存特性,那這個方法就會進行緩存。 這個也是網上說的面向切麵編程AOP。 AOP的概念也很好理解,跟中間件差不多,說白了,就是我可以任意地在方法的前面或後面添加代碼,這很適合 ...


最近想給我的框架加一種功能,就是比如給一個方法加一個事務的特性Attribute,那這個方法就會啟用事務處理。給一個方法加一個緩存特性,那這個方法就會進行緩存。

這個也是網上說的面向切麵編程AOP。

AOP的概念也很好理解,跟中間件差不多,說白了,就是我可以任意地在方法的前面或後面添加代碼,這很適合用於緩存、日誌等處理。

 

在net core2.2時,我當時就嘗試過用autofac實現aop,但這次我不想用autofac,我用了一個更輕量級的框架,AspectCore。

用起來非常非常的簡單,但一開始還是走了一點彎路,主要是網上都是net core3以下的教程,3以下的使用方法跟之前有一些不同。

先安裝NuGet包,包名:AspectCore.Extensions.DependencyInjection

然後在Program.cs類中增加一行代碼,這是net core 3的不同之處,這句添加的代碼,意思就是用AspectCore的IOC容器替換內置的。因為AOP需要依靠IOC實現,所以必須得替換掉內置的IOC。

public class Program
    {
        public static void Main(string[] args)
        {
            CreateHostBuilder(args).Build().Run();
        }

        public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
            .ConfigureWebHostDefaults(webBuilder =>
            {
                webBuilder.UseStartup<Startup>();
                var dependAssemblyKey = BuildDependAssemblyKey();
                if (!string.IsNullOrEmpty(dependAssemblyKey))
                {
                    webBuilder.UseSetting(WebHostDefaults.HostingStartupAssembliesKey, dependAssemblyKey);
                }
            })
            //用AspectCore替換預設的IOC容器
            .UseServiceProviderFactory(new DynamicProxyServiceProviderFactory());
}

然後在Startup.cs類中的ConfigureServices中添加代碼。(其實這個加不加都可以,如果需要配置就加,例如全局的攔截器、只攔截哪些匹配的服務,因為我只用特性進行攔截,所以我就什麼也沒配置)

services.ConfigureDynamicProxy(o=> { 
      //添加AOP的配置
});

這樣AOP就配置好了,是不是很簡單。

當然使用方面也需要註意一下,可以在介面、介面的方法、類,類的virtual方法上進行攔截。還有如果你想攔截控制器的action的話,那需要在ConfigureService里AddControllerAsServices

services.AddControllers()
//把控制器當成服務
.AddControllersAsServices()

下麵我列出我的事務攔截器代碼,如果是特性攔截,就繼承AbstractInterceptorAttribute,如果要寫一個全局攔截器,就AbstractInterceptor,然後在ConfigureDynamicProxy中進行配置,這個我就不介紹了

public class TransactionInterceptorAttribute : AbstractInterceptorAttribute
    {
        public async override Task Invoke(AspectContext context, AspectDelegate next)
        {
            var dbContext = context.ServiceProvider.GetService<AppDbContext>();
            //先判斷是否已經啟用了事務
            if (dbContext.Database.CurrentTransaction == null)
            {
                await dbContext.Database.BeginTransactionAsync();
                try
                {
                    await next(context);
                    dbContext.Database.CommitTransaction();
                }
                catch (Exception ex)
                {
                    dbContext.Database.RollbackTransaction();
                    throw ex;
                }
            }
            else
            {
                await next(context);
            }
        }
    }

然後我就可以這麼優雅地使用事務了

我再列出我的緩存攔截器,(感謝網友的提醒,我做了一下修改,針對非同步方法返回值的處理),對了,下麵的ICacheHelper是我定義的一個緩存助手介面,用的是redis,我會在後面寫一篇博客

public class CacheInterceptorAttribute : AbstractInterceptorAttribute
{
    /// <summary>
    /// 緩存秒數
    /// </summary>
    public int ExpireSeconds { get; set; }

    public async override Task Invoke(AspectContext context, AspectDelegate next)
    {
        bool isAsync = false;
        //判斷是否是非同步方法
        if (context.ImplementationMethod.GetCustomAttribute(typeof(AsyncStateMachineAttribute)) != null)
        {
            isAsync = true;
        }
        //先判斷方法是否有返回值,無就不進行緩存判斷
        var returnType = context.GetReturnParameter().Type;
        if (returnType == typeof(void) || returnType == typeof(Task))
        {
            await next(context);
            return;
        }
        if (isAsync)
        {
            //取得非同步返回的類型
            returnType = returnType.GenericTypeArguments.FirstOrDefault();
        }

        //獲取方法參數名
        string param = CommonHelper.ObjectToJsonString(context.Parameters);
        //獲取方法名稱,也就是緩存key值
        string key = "Methods:" + context.ImplementationMethod.DeclaringType.FullName + "." + context.ImplementationMethod.Name;
        var cache = context.ServiceProvider.GetService<ICacheHelper>();
        //如果緩存有值,那就直接返回緩存值
        if (cache.HashExists(key, param))
        {
            //反射獲取緩存值,相當於cache.HashGet<>(key,param)
            var value = typeof(ICacheHelper).GetMethod(nameof(ICacheHelper.HashGet)).MakeGenericMethod(returnType).Invoke(cache, new[] { key, param });
            if (isAsync)
            {
                //反射獲取Task<>類型的返回值,相當於Task.FromResult(value)
                context.ReturnValue = typeof(Task).GetMethod(nameof(Task.FromResult)).MakeGenericMethod(returnType).Invoke(null, new[] { value });
            }
            else
            {
                context.ReturnValue = value;
            }
            return;
        }
        await next(context);
        object returnValue;
        if (isAsync)
        {
            //反射獲取非同步結果的值,相當於(context.ReturnValue as Task<>).Result
            returnValue = typeof(Task<>).MakeGenericType(returnType).GetProperty(nameof(Task<object>.Result)).GetValue(context.ReturnValue);
        }
        else
        {
            returnValue = context.ReturnValue;
        }
        cache.HashSet(key, param, returnValue);
        if (ExpireSeconds > 0)
        {
            cache.SetExpire(key, TimeSpan.FromSeconds(ExpireSeconds));
        }

    }
}

 

 

我還弄了一個緩存刪除攔截器,作用就是帶有這個特性的方法執行後,會刪除相關緩存值

為什麼有這個設計呢,比如說我給一個方法 GetUserList 加了緩存,那我數據改變了怎麼辦,我想在User數據改變時,把這個緩存刪除掉,那我就可以在SaveUser方法上加上我這個緩存刪除攔截器,那這個方法執行後,就會把相關的緩存刪除掉了

public class CacheDeleteInterceptorAttribute : AbstractInterceptorAttribute
{
    private readonly Type[] _types;
    private readonly string[] _methods;

    /// <summary>
    /// 需傳入相同數量的Types跟Methods,同樣位置的Type跟Method會組合成一個緩存key,進行刪除
    /// </summary>
    /// <param name="Types">傳入要刪除緩存的類</param>
    /// <param name="Methods">傳入要刪除緩存的方法名稱,必須與Types數組對應</param>
    public CacheDeleteInterceptorAttribute(Type[] Types, string[] Methods)
    {
        if (Types.Length != Methods.Length)
        {
            throw new ApiFailException(ApiFailCode.OPERATION_FAIL, "Types必須跟Methods數量一致");
        }
        _types = Types;
        _methods = Methods;
    }

    public async override Task Invoke(AspectContext context, AspectDelegate next)
    {
        var cache = context.ServiceProvider.GetService<ICacheHelper>();
        await next(context);
        for (int i = 0; i < _types.Length; i++)
        {
            var type = _types[i];
            var method = _methods[i];
            string key = "Methods:" + type.FullName + "." + method;
            cache.Delete(key);
        }
    }
}

 

AOP的實現原理我也想象了一下:

要實現AOP,需要依靠IOC容器,因為它是我們類的管家,那能被攔截的類必須是IOC註入的,自己new出來的是不受攔截的。如果我想在A方法前面添加點代碼,那我告訴IOC,把代碼給它,那IOC在註入A方法所在類時,會繼承它生成一個派生類,然後重寫A方法,所以攔截方法必須得為virtual,然後A方法里寫上我要添加的代碼,再base.A()這樣。


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

更多相關文章
  • 又是好久沒有寫題解了。。。。。 1.題意分析: P2299是一道非常經典的圖論最短路練習題。 圖論最短路是圖論中非常重要的一個知識模塊,其主要演算法有Dijkstra,Bellman-Ford,SPFA和Floyd。在這片題解中我們著重介紹Dijkstra演算法。 2.演算法詳解: Dijkstra應該是 ...
  • 一、Servlet 1. 什麼是Servlet Servlet 是 JavaEE 規範之一,規範就是介面 Servlet 就 JavaWeb 三大組件之一,三大組件分別是:Servlet 程式、Filter 過濾器、Listener 監聽器 Servlet 是運行在伺服器上的一個 java 小程式, ...
  • 本系列將和大家分享面向對象23種設計模式中常用的幾種設計模式,本章主要簡單介紹下行為型設計模式。 ...
  • 都0202年了,不會還有人在用WPF吧,不會吧不會吧~什麼qt啊,electron啊,flutter啊好多東西要學啊,我還是繼續用WPF吧。因為其它的還不太會;繼續學習吧~ 期待WinUI3和“MAUI”-2021 1.周末沒加班,閑來沒事做;模仿個東西好了;在模仿中學習(各位大佬不要嘲諷我就是~) ...
  • 首次發表,不太會寫,那點乾貨上個分,廢話不多說,不懂多看 1 public void Publist() 2 { 3 ResultListData resultData = new ResultListData(); 4 BLL.basic_project bllspro = new BLL.bas ...
  • .net core 和.net framework上傳文件還是有一些區別的有很多註意的地方 .net framework 上傳文件用httppostedfilebase .net core 上傳文件用 IFormFile 下麵廢話不多說了,直接上代碼 控制器裡面寫 using System; usi ...
  • 一、簡介 ABP vNext 在 v 2.9.x 版本當中添加了 BLOB 系統,主要用於存儲大型二進位文件。ABP 抽象了一套通用的 BLOB 體系,開發人員在存儲或讀取二進位文件時,可以忽略具體實現,直接使用 IBlobContainer 或 IBlobContainer<T> 進行操作。官方的 ...
  • 使用 .NET Core WebAPI 實現一個 VPS 下載中轉(加速)器 VPSDownloader.NET,暨 .NET Core 程式部署到 Linux 系統。 ...
一周排行
  • 比如要拆分“呵呵呵90909086676喝喝999”,下麵當type=0返回的是中文字元串“呵呵呵,喝喝”,type=1返回的是數字字元串“90909086676,999”, private string GetStrings(string str,int type=0) { IList<strin ...
  • Swagger一個優秀的Api介面文檔生成工具。Swagger可以可以動態生成Api介面文檔,有效的降低前後端人員關於Api介面的溝通成本,促進項目高效開發。 1、使用NuGet安裝最新的包:Swashbuckle.AspNetCore。 2、編輯項目文件(NetCoreTemplate.Web.c ...
  • 2020 年 7 月 30 日, 由.NET基金會和微軟 將舉辦一個線上和為期一天的活動,包括 微軟 .NET 團隊的演講者以及社區的演講者。本次線上大會 專註.NET框架構建微服務,演講者分享構建和部署雲原生應用程式的最佳實踐、模式、提示和技巧。有關更多信息和隨時瞭解情況:https://focu... ...
  • #abp框架Excel導出——基於vue #1.技術棧 ##1.1 前端採用vue,官方提供 UI套件用的是iview ##1.2 後臺是abp——aspnetboilerplate 即abp v1,https://github.com/aspnetboilerplate/aspnetboilerp ...
  • 前言 本文的文字及圖片來源於網路,僅供學習、交流使用,不具有任何商業用途,版權歸原作者所有,如有問題請及時聯繫我們以作處理。 作者:碧茂大數據 PS:如有需要Python學習資料的小伙伴可以加下方的群去找免費管理員領取 input()輸入 Python提供了 input() 內置函數從標準輸入讀入一 ...
  • 從12年到20年,python以肉眼可見的趨勢超過了java,成為了當今It界人人皆知的編程語言。 python為什麼這麼火? 網路編程語言搜索指數 適合初學者 Python具有語法簡單、語句清晰的特點,這就讓初學者在學習階段可以把精力集中在編程對象和思維方法上。 大佬都在用 Google,YouT ...
  • 在社會上存在一種普遍的對培訓機構的學生一種歧視的現象,具體表現在,比如:當你去公司面試的時候,一旦你說了你是培訓機構出來的,那麼基本上你就涼了,那麼你瞞著不說,然後又通過了面試成功入職,但是以後一旦在公司被髮現有培訓經歷,可能會面臨被降薪,甚至被辭退,培訓機構出來的學生,在用人單位眼裡就是能力低下的 ...
  • from typing import List# 這道題看了大佬寫的代碼,經過自己的理解寫出來了。# 從最外圍的四周找有沒有為O的,如果有的話就進入深搜函數,然後深搜遍歷# 判斷上下左右的位置是否為Oclass Solution: def solve(self, board: List[List[s ...
  • import requests; import re; import os; # 1.請求網頁 header = { "user-agent":'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, li ...
  • import requests; import re; import os; import parsel; 1.請求網頁 header = { "user-agent":'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537. ...