ASP.NET Core - 在ActionFilter中使用依賴註入

来源:https://www.cnblogs.com/kklldog/archive/2020/03/25/di-in-core-actionfilter.html

上次[ActionFilter引發的一個EF異常](https://www.cnblogs.com/kklldog/p/not-use-sync-in-actionfilter.html),本質上是對Core版本的ActionFilter的知識掌握不夠牢固造成的,所以花了點時間仔細閱讀了微軟的官方文... ...


上次ActionFilter引發的一個EF異常,本質上是對Core版本的ActionFilter的知識掌握不夠牢固造成的,所以花了點時間仔細閱讀了微軟的官方文檔。發現除了IActionFilter、IAsyncActionFilter的問題,還有一個就是依賴註入在ActionFilter上的使用也是需要註意的地方。
當我們的ActionFilter需要使用某個Service的時候,我們一般會通過構造函數註入。
演示一下,首先自定義一個ActionFilter,通過構造函數註入IMyService:

    public interface IMyService
    {
        string GetServiceName(); 
    }

    public class MyService : IMyService
    {
        public MyService ()
        {
            Console.WriteLine("Service {0} created .", GetServiceName());
        }

        public string GetServiceName()
        {
            return "MyService";
        }
    }

    public class FilterInjectAttribute: ActionFilterAttribute
    {
        public FilterInjectAttribute(IMyService myService)
        {
            if (myService == null)
            {
                throw new ArgumentNullException("myService");
            }

            Console.WriteLine("Service {0} was injected .", myService.GetServiceName());
        }
    }

但是我們在使用Attribute的時候VS直接給出紅色提示,需要傳入構造函數的參數,否則無法編譯過去。

當然我們可以直接new一個MyService來當做參數,但是很顯然這樣就失去了註入的那些好處了。

在ActionFilter中使用依賴註入

在ASP.NET Core的ActionFilter中使用依賴註入主要有兩種方式:

  1. ServiceFilterAttribute
  2. TypeFilterAttribute

ServiceFilterAttribute

使用ServiceFilterAttribute可以使你的ActionFilter完成依賴註入。其實就是把你要用的ActionFilter本身註冊為一個Service註冊到DI容器中。通過ServiceFilter從容器中檢索你的ActionFilter,並且註入到需要的地方。所以第一步就是要註冊你的ActionFilter:

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddScoped<IMyService,MyService>();
            services.AddScoped(typeof(FilterInjectAttribute));

            services.AddControllers();
            services.AddRazorPages();
        }

然後新建一個Controller,在Action上使用ServiceFilter:

        [ServiceFilter(typeof(FilterInjectAttribute))]
        public string DI()
        {
            Console.WriteLine("HomeController method DI running .");

            return "DI";
        }

運行一下,在瀏覽器里訪問下對應的path,可以看到MyService已經註入到FilterInjectAttribute中:

ServiceFilterAttribute的IsReusable屬性:

ServiceFilter有一個屬性叫IsReusable。從字面意思也很好理解,就是是否可重用的意思。顯而易見如果這個屬性設置為True,那麼多個請求就會復用這個ActionFilter,這就有點像是單例的意思了。

        [ServiceFilter(typeof(FilterInjectAttribute), IsReusable = true)]
        public string DI()
        {
            Console.WriteLine("HomeController method DI running .");

            return "DI";
        }

運行一下,多次在瀏覽器中訪問對應的action的path,可以看到FilterInjectAttribute的構造函數只會執行一次。

這裡有一個重要提示, ASP.NET Core runtime 並不保證這個filter是真正的單例。所以不要試圖使用這個屬性來實現單例,並且業務系統依賴這個單例。

TypeFilterAttribute

使用TypeFilterAttribute也可以使你的ActionFilter完成依賴註入。它跟ServiceFilterAttribute差不多,但是使用TypeFilterAttribute註入的ActionFilter並不從DI容器中查找,而是直接通過Microsoft.Extensions.DependencyInjection.ObjectFactory來實例化對象。所以我們的FilterInjectAttribute不需要提前註冊到DI容器中。
首先註釋掉FilterInjectAttribute的註冊代碼:

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddScoped<IMyService,MyService>();

            //services.AddScoped(typeof(FilterInjectAttribute));

            services.AddControllers();
            services.AddRazorPages();
        }

改用TypeFilterAttribute:

        [TypeFilter(typeof(FilterInjectAttribute))]
        public string DI()
        {
            Console.WriteLine("HomeController method DI running .");

            return "DI";
        }

運行一下,在瀏覽器里訪問下對應的path,可以看到MyService已經註入到FilterInjectAttribute中:

TypeFilterAttribute的IsReusable屬性:

跟上面的ServiceFilter一樣,ASP.NET Core runtime 並不保證這個filter是真正的單例,這裡就不多啰嗦了。

TypeFilterAttribute的Arguments屬性:

Arguments參數是TypeFilterAttribute跟ServiceFilterAttribute的一個重要區別,ServiceFilterAttribute並沒有這屬性。Arguments類型為object數組。通過TypeFilterAttribute實例化的ActionFilter,如果它的構造器中的參數類型在DI容器中找不到,會繼續在Arguments參數列表裡按順序獲取。
改一下FilterInjectAttribute構造器多加入2個參數,並且保證這2個參數無法從DI中取到:

    public class FilterInjectAttribute: ActionFilterAttribute
    {
        public FilterInjectAttribute(string arg1, IMyService myService, string arg2)
        {
            if (myService == null)
            {
                throw new ArgumentNullException("myService");
            }

            Console.WriteLine("Service {0} was injected .", myService.GetServiceName());
            Console.WriteLine("arg1 is {0} .", arg1);
            Console.WriteLine("arg2 is {0} .", arg2);

            Console.WriteLine("FilterInjectAttribute was created .");
        }
    }

在使用的時候傳入兩個參數:

        [TypeFilter(typeof(FilterInjectAttribute), Arguments  = new object[] { "HAHA", "HOHO" })]
        public string DI()
        {
            Console.WriteLine("HomeController method DI running .");

            return "DI";
        }

運行一下看到兩個參數被傳入了FilterInjectAttribute的構造器:

總結

  1. ActionFilterAttribute的依賴註入可以通過ServiceFilterAttribute,TypeFilterAttribute來實現
  2. ServiceFilterAttribute是通過DI容器來管理ActionFilterAttribute;TypeFilterAttribute則是通過一個工廠直接實例化,所以使用前不需要註冊到DI容器中。
  3. IsReusable屬性可以實現類似單例的功能,但是運行時並不保證唯一單例。
  4. TypeFilterAttribute的Arguments屬性可以作為參數列表。當實例化ActionFilterAttribute的時候如果構造器參數類型沒有在DI容器中註冊那麼會嘗試從Arguments列表中取。

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

更多相關文章
  • 我的LeetCode刷題源碼[GitHub]:https://github.com/izhoujie/Algorithmcii LeetCode 198. 打家劫舍 題目 你是一個專業的小偷,計劃偷竊沿街的房屋。每間房內都藏有一定的現金,影響你偷竊的唯一制約因素就是相鄰的房屋裝有相互連通的防盜系統, ...
  • 我的LeetCode刷題源碼[GitHub]:https://github.com/izhoujie/Algorithmcii LeetCode 面試題 17.16. 按摩師 題目 一個有名的按摩師會收到源源不斷的預約請求,每個預約都可以選擇接或不接。在每次預約服務之間要有休息時間,因此她不能接受相 ...
  • Android終端(車載,手機)等, 需要考慮進行隨意進行各類按鍵(車載方向盤按鍵,手機硬按鍵)的操作, 測試系統對按鍵事件的響應穩定性,一般測試2小時。 準備階段 一般是用adb shell input keyevent + keyCode 來模擬按鍵事件, 比如adb shell input k ...
  • 我們知道C++中非常重要的:1.全局函數、2.普通成員函數、3.靜態成員函數。 類中的成員函數構成的重載有這幾點: 1. 構造函數的重載。 2.普通成員函數的重載。 3.靜態成員函數的重載。 例子: 1 #include <stdio.h> 2 3 class Test 4 { 5 int i; 6 ...
  • 使用python下載音樂,小白也可以寫爬蟲 **簡介:使用BeautifulSoup和request模塊進行抓取和解析,最後保存音樂(註:音樂質量是普通品質的)在這裡順便給大家推薦一個資源很全的python學習免非解答.裙 :七衣衣九七七巴而五(數字的諧音)轉換下可以找到了,這裡有資深程式員分享以前 ...
  • 結果: ...
  • 1.bytes和str函數 那我接下來就簡述下他文章的意思吧: bytes格式時二進位型的文件,全為010101之類的,而str為字元串型的 bytes函數中的參數為bytes(字元串,encoding=' 括弧裡面經常填utf 8')其中encoding一定要填,str函數則為str()與其是一樣 ...
  • 第三章 Stream流 關註公眾號( CoderBuff )回覆“ stream ”獲取《Java8 Stream編碼實戰》PDF完整版。 《Java8 Stream編碼實戰》的代碼全部在 "https://github.com/yu linfeng/BlogRepositories/tree/ma ...
一周排行
  • 前幾天發佈了 "抄抄《CSS 故障藝術》的動畫" 這篇文章,在這篇文章里介紹瞭如何使用Win2D繪製文字然後配合BlendEffect製作故障藝術的動畫。本來打算就這樣收手不玩這個動畫了,但後來又發現性能不符合理想。明明只是做做Resize動畫和用BlendEffect混合,為什麼性能會這麼差呢? ...
  • 控制條控制項: progressBar 不能按照你程式的進程自動變化,需認為計算,調整變化量 private void progressBar1_Click(object sender, EventArgs e) { this.progressBar1.Maximum = 100;//設置進度條最大長 ...
  • 首先創建一個asp.net core web應用程式 第二步 目前官方預置了7種模板項目供我們選擇。從中我們可以看出,既有我們熟悉的MVC、WebAPI,又新添加了Razor Page,以及結合比較流行的Angular、React前端框架的模板項目。 空項目模板 Program.cs using S ...
  • 對閉包的理解 1.對於成員變數和局部變數:成員變數就是方法外部,類的內部定義的變數;局部變數就是方法或語句塊內部定義的變數。局部變數必須初始化。 形式參數是局部變數,局部變數的數據存在於棧記憶體中。棧記憶體中的局部變數隨著方法的消失而消失。成員變數存儲在堆中的對象裡面,由垃圾回收器負責回收。 成員變數它 ...
  • Xamarin.Forms讀取並展示Android和iOS通訊錄 TerminalMACS客戶端 本文同步更新地址: https://dotnet9.com/11520.html https://terminalmacs.com/861.html 閱讀導航: 一、功能說明 二、代碼實現 三、源碼獲取 ...
  • 做下對文件複製操作相關的筆記: /// <summary> /// 文件幫助類 /// </summary> public class FileHelper { /// <summary> /// 複製一個目錄下所有文件到一個新目錄下 /// </summary> /// <param name=" ...
  • 前言 有一個東西叫做鴨子類型,所謂鴨子類型就是,只要一個東西表現得像鴨子那麼就能推出這玩意就是鴨子。 C 裡面其實也暗藏了很多類似鴨子類型的東西,但是很多開發者並不知道,因此也就沒法好好利用這些東西,那麼今天我細數一下這些藏在編譯器中的細節。 不是只有 和 才能 在 C 中編寫非同步代碼的時候,我們經 ...
  • [toc] 1.應用背景 底端設備有大量網路報文(位元組數組):心跳報文,數據採集報文,告警報文上報。需要有對應的報文結構去解析這些位元組流數據。 2.結構體解析 由此,我第一點就想到了用結構體去解析。原因有以下兩點: 2.1.結構體存在棧中 類屬於引用類型,存在堆中;結構體屬於值類型,存在棧中,在一個 ...
  • 《深入淺出 C#》 (第3版) [作者] (美) Andrew Stellman (美) Jennifer Greene[譯者] (中) 徐陽 丁小峰 等譯[出版] 中國電力出版社[版次] 2016年08月 第1版[印次] 2018年04月 第4次 印刷[定價] 148.00元 【引子】 要學習編程 ...
  • 記錄使用對象初始值設定項初始化對象。 using System; using System.Collections.Generic; namespace ConsoleApp2 { class Program { static void Main(string[] args) { // 使用構造函數 ...
x