netcore - MVC的ActionFilter的使用 - wangrudong003－IT工程師數位筆記本

文章出處

經過一周的時間沒有分享文章了，主要是在使用.netcore做一個小的項目，項目面向大眾用戶的增刪改查都做的差不多了，打算本周在云服務器上部署試試，很期待，也希望上線后大家多多支持；以上純屬個人廢話，來一起看看今天的正篇環節：

.繼承IActionFilter來定義個驗證登錄的流程例子

.ActionFilter中怎么使用依賴注入

下面一步一個腳印的來分享：

.繼承IActionFilter來定義個驗證登錄的流程例子

首先，咋們定義一個名叫FilterTestController的Controller，返回一個JsonResult結果；為了例子查看的方便性，同時在此文件中定義一個名MoResponse的類，對應的代碼如下：

 1 public class FilterTestController : Controller
 2     {
 3         public JsonResult Index()
 4         {
 5             var response = new MoResponse();
 6             response.Status = 1;
 7 
 8             return Json(response);
 9         }
10     }
11 
12     public class MoResponse
13     {
14 
15         public int Status { get; set; }
16         public string Des { get; set; } = "Ok";
17     }

View Code

然后，執行一下運行命令dotnet run，瀏覽器中輸入默認端口好5000并訪問剛才定義的Action，地址如：http://localhost:5000/FilterTes，不出意外大家都能看到如下結果的圖樣：

這表示項目初建沒有問題；

接著，創建一個類，名稱為CheckLoginAttribute并且繼承和實現Attribute, IActionFilter，這里實現IActionFilter接口的OnActionExecuting，OnActionExecuted兩個方法，看方法名稱后綴大概就明白一個是Action執行之前，一個是Action方法執行之后調用的，這里簡單補充下以前的mvc版本大部分都是去繼承ActionFilterAttribute，其實這個也去繼承和實現了Attribute, IActionFilter，不過還有其他的擴展罷了，這里不詳細區分說明：

然后咋們分別在兩個OnActionExecut中增加一些輸入信息，并且在FilterTestController的Index方法上方增加[CheckLogin]標記，代碼如下：

public class CheckLoginAttribute : Attribute, IActionFilter
    {

        public void OnActionExecuted(ActionExecutedContext context)
        {

            Console.WriteLine(DateTime.Now + "end...");
        }

        public void OnActionExecuting(ActionExecutingContext context)
        {

            Console.WriteLine(DateTime.Now + "start...");

            //context.Result = new RedirectResult("http://www.cnblogs.com/");

        }
    }

View Code

再運行起來，訪問剛才的路由，可以在命令窗體看到如圖：

剛才說的CheckLoginAttribute中的OnActionExecuting對應的是調用Controller的Action方法之前執行的部分，上面代碼剛才注釋的部分context.Result = new RedirectResult("http://www.cnblogs.com/");是跳轉到該http://www.cnblogs.com/地址中去，如果放開注釋，看到的效果是訪問之前Controller路由后直接跳轉到了該地址，并且名利窗體中只有start...日志的部分，沒有了之前end...的部分，可以看出這里context.Result效果是直接終止了程序繼續往下執行；到這里就可以走一個簡單登錄的驗證了，我這里只說下流程，不做具體代碼，因為這不是重點哈哈：

1.在OnActionExecuting方法中使用context.HttpContext.Session獲取用戶登陸的session(當然其他session保存方式除外)

2.使用context.HttpContext.Request.Path獲取當前訪問的路由地址

3.如果session為空，使用context.Result = new RedirectResult("/Login?returnUrl=" + context.HttpContext.Request.Path);跳轉到路由Login中去，returnUrl參數使用來傳遞登陸有再跳轉到當前訪問地址中去

.ActionFilter中怎么使用依賴注入

這個是值得關注的地方，這個在我的項目最初寫的時候遇到的問題；下面是一些分析，可供大家參考:

1.netcore常用的注入方式是通過構造函數注入的

2.通過構造函數注入后，在需要使用Filter的Action中無法通過對應參數個數的構造函數調用；只能調用無參的Filter構造函數

3.注意在需要使用依賴注入的Filter中不用定義無參構造函數（這里實驗過了，如果定義TypeFilter將會以無參構造函數為優先創建實例，這樣將會是依賴注入失敗）

以上就是最開始無法直接使用結構器依賴注入的原因，后面無意中發現一個很有用的過濾器：TypeFilterAttribute，該過濾器可以通過構造函數傳遞進去的對象實例化，下面我們一起來看下：

首先，我們定義個MyActionFilterAttribute類并且繼承TypeFilterAttribute，默認繼承構造函數，然后在Controller的Index上方使用這個自定義屬性并且傳遞我們定義的CheckLoginAttribute類型為參數，如下代碼：

[MyActionFilter(typeof(CheckLoginAttribute))]
        public JsonResult Index()
        {
            var response = new MoResponse();
            response.Status = 1;

            return Json(response);
        }

View Code

MyActionFilterAttribute代碼如下：

public class MyActionFilterAttribute : TypeFilterAttribute
    {
        public MyActionFilterAttribute(Type type) : base(type)
        {

        }
    }

View Code

好了，咋們再自定義個簡單的服務，并且把定義的服務在Startup.cs文件中增加代碼services.AddTransient<LogService>();注入服務，服務要求是定義個方法，在命令框中輸出hello...，如下代碼：

 public class LogService
    {
      
        public async void _LogRequest()
        {

            await Task.Run(() =>
             {

                 for (int i = 0; i < 10; i++)
                 {
                     Console.WriteLine(DateTime.Now + "hello...");
                 }
             });
        }
    }

View Code

再來，CheckLoginAttribute中增加代碼如：

 1 public class CheckLoginAttribute : Attribute, IActionFilter
 2     {
 3         private readonly LogService _logService;
 4         public CheckLoginAttribute(LogService logService)
 5         {
 6 
 7             _logService = logService;
 8         }
 9 
10         public void OnActionExecuted(ActionExecutedContext context)
11         {
12 
13             Console.WriteLine(DateTime.Now + "end...");
14         }
15 
16         public void OnActionExecuting(ActionExecutingContext context)
17         {
18 
19             Console.WriteLine(DateTime.Now + "start...");
20 
21             var path = context.HttpContext.Request.Path;
22             //context.Result = new RedirectResult($"/Login?returnUrl={path}");
23 
24             _logService._LogRequest();
25         }
26     }