ASP.NET Core 中的過濾器（Action過濾器，控制器過濾器，全局應用程序過濾器）

ASP.NET Core 中的過濾器（Action過濾器，控制器過濾器，全局應用程序過濾器）

十年河東，十年河西，莫欺少年窮

學無止境，精益求精

今兒是週六，蘇州的天空飄着毛毛細雨，氣溫也降低了很多，上午去了蘇州繁花中心，來到二樓，自學了會古箏，逛了逛商場，中午去了肯德基，給孩子買了雞翅，我和我老婆大人各喝了一杯咖啡。下午回到家，躺在牀上刷抖音，刷的時間長了，也就以爲特別無聊，索性看看博客園吧，嘿嘿，因而我買了一瓶100ML的牛欄山二鍋頭，邊吃花生米邊看，本打算看netcore的中間件，因而百度搜了一些內容，大多數寫的中間件都是參考微軟教程，看的也是索然無味，有的說中間件相似於AOP，有的說中間件是HTTP請求管道中的一個組件，用於攔截你的http請求並決定是否把你的請求傳遞給下一個中間件，總的來講，中間件就是一個橫向切面編程，也就是所謂的AOP，這裏我們不討論中間件，咱們今天討論的是和中間件功能相似的過濾器，何爲過濾器呢？過濾器和中間件有何細微的差異呢？哈哈，其實本篇博客是轉載的別人

首先感謝原文做者的貢獻，其次我之因此轉載這篇博客，一是由於做者寫的好，二是由於這些知識和以前的MVC過濾器很相似，再者，我以前也寫過過濾器的應用，好比MVC的登陸受權過濾器，對MVC的登陸受權過濾器有興趣的小虎斑可參考個人博客 

廢話說多了，下面我們進入正題，以下：

1、前言

在分享ASP.NET Core Filter 使用以前，先來談談AOP,什麼是AOP 呢？

AOP全稱Aspect Oriented Programming意爲面向切面編程，也叫作面向方法編程，是經過預編譯方式和運行期動態代理的方式實現不修改源代碼的狀況下給程序動態統一添加功能的技術。

AOP技術利用一種稱爲「橫切」的技術，剖解開封裝對象的內部，將影響多個類的公共行爲封裝到一個可重用的模塊中，並將其命名爲Aspect切面。所謂的切面，簡單來講就是與業務無關，卻爲業務模塊所共同調用的邏輯，將其封裝起來便於減小系統的重複代碼，下降模塊的耦合度，有利用將來的可操做性和可維護性。

利用AOP能夠對業務邏輯各個部分進行隔離，從而使業務邏輯各部分之間的耦合度下降，提升程序的可重用性，同時提升開發效率。

AOP的使用場景主要包括日誌記錄、性能統計、安全控制、事務處理、異常處理等。

2、Filter-過濾器

Filter是延續ASP.NET MVC的產物，一樣保留了五種的Filter，分別是Authorization Filter、Resource Filter、Action Filter、Exception Filter及Result Filter。
經過不一樣的Filter能夠有效處理封包進出的加工，本篇將介紹ASP.NET Core的五種Filter運做方式。

2.1 Filter 介紹

ASP.NET Core 有如下五種Filter 可使用：

• • Authorization Filter：
    Authorization是五種Filter中優先級最高的，一般用於驗證Request合不合法，不合法後面就直接跳過。
  • Resource Filter：Resource是第二優先，會在Authorization以後，Model Binding以前執行。一般會是須要對Model加工處理才用。
  • Exception Filter：異常處理的Filter。
  • Action Filter：最常使用的Filter，封包進出都會通過它，使用上沒什麼須要特別注意的。跟Resource Filter很相似，但並不會通過Model Binding。
  • Result Filter：當Action完成後，最終會通過的Filter。

3、五大Filter 的應用

這一篇章主要來說解Asp.Net Core 的五大過濾器的實現及用途.

3.1 Authonization Filter

權限控制過濾器
經過 Authonization Filter 能夠實現複雜的權限角色認證、登錄受權等操做
實現事例代碼以下：

 public class AuthonizationFilter :Attribute,IAuthorizationFilter
    {
        public void OnAuthorization(AuthorizationFilterContext context)
        {
            //這裏能夠作複雜的權限控制操做
            if (context.HttpContext.User.Identity.Name != "1") //簡單的作一個示範
            {
                //未經過驗證則跳轉到無權限提示頁
                RedirectToActionResult content = new RedirectToActionResult("NoAuth", "Exception", null);
                context.Result = content;
            }
        }
    }

3.2 Resource Filter

資源過濾器
能夠經過Resource Filter 進行資源緩存、防盜鏈等操做。
使用Resource Filter 要求實現IResourceFilter 抽象接口

 public class ResourceFilter : Attribute,IResourceFilter
    {
        public void OnResourceExecuted(ResourceExecutedContext context)
        {
            // 執行完後的操做
        }

        public void OnResourceExecuting(ResourceExecutingContext context)
        {
            // 執行中的過濾器管道
        }
    }

3.3 Exception Filter

經過Execption Filter 過濾器能夠進行全局的異常日誌收集 等操做。

使用Execption Filter 要求實現IExceptionFilter 抽象接口
IExceptionFilter接口會要求實現OnException方法，當系統發生未捕獲異常時就會觸發這個方法。OnException方法有一個ExceptionContext異常上下文，其中包含了具體的異常信息，HttpContext及mvc路由信息。系統一旦出現未捕獲異常後，比較常見的作法就是使用日誌工具，將異常的詳細信息記錄下來，方便修正調試。下面是日誌記錄的實現。　　

 public class ExecptionFilter : Attribute, IExceptionFilter
  {
        private ILogger<ExecptionFilter> _logger;
        //構造注入日誌組件
        public ExecptionFilter(ILogger<ExecptionFilter> logger)
        {
            _logger = logger;
        }

        public void OnException(ExceptionContext context)
        {
            //日誌收集
            _logger.LogError(context.Exception, context?.Exception?.Message??"異常");
        }
    }

3.4 Action Filter

做用：能夠經過ActionFilter 攔截 每一個執行的方法進行一系列的操做，好比：執行操做日誌、參數驗證，權限控制 等一系列操做。

使用Action Filter 須要實現IActionFilter 抽象接口，IActionFilter 接口要求實現OnActionExecuted 和OnActionExecuting 方法

 public class ActionFilter : Attribute, IActionFilter
    {
        public void OnActionExecuted(ActionExecutedContext context)
        {
            //執行完成....
        }

        public void OnActionExecuting(ActionExecutingContext context)
        {
            //執行中...
        }
    }

3.5 Result Filter

結果過濾器，能夠對結果進行格式化、大小寫轉換等一系列操做。

使用Result Filter 須要實現IResultFilter 抽象接口，接口要求實現
OnResultExecuting 方法 和OnResultExecuted 方法

• OnResultExecuting ：Called before the action result executes. 在操做結果執行以前調用
• OnResultExecuted ：Called after the action result executes. 在操做結果執行以後調用

具體代碼實現代碼以下：

public class ResultFilter : Attribute, IResultFilter
 {
        public void OnResultExecuted(ResultExecutedContext context)
        { 
            // 在結果執行以後調用的操做...
        }

        public void OnResultExecuting(ResultExecutingContext context)
        {
            // 在結果執行以前調用的一系列操做
        }
    }

4、Asp.Net Core 過濾器的註冊方式

這一篇章主要來分析探討Asp.Net Core 中過濾器的三種註冊方式Action、Controller、全局 。

4.1 Action 註冊方式

Action 註冊方式是局部註冊方式，針對控制器中的某個方法上標註特性的方式進行註冊，代碼以下：

 [AuthonizationFilter()]
 public IActionResult Index()
 {
            return View();
 }

4.2 Controller 註冊方式

瞭解過Action 特性註冊方式的同窗，必定發現了它的很差之處就是我一個控制器裏面須要使用同一套Filter 的時候，須要一個一個Action 標註特性註冊，是否是很繁瑣呢？有沒有其餘方式進行代替這些繁瑣的操做呢？微軟給咱們提供了簡便的控制器標註註冊方式，代碼以下：

[AuthonizationFilter()]
 public class FirstController : Controller
  {
        private ILogger<FirstController> _logger;

        public FirstController(ILogger<FirstController> logger)
        {
            _logger = logger;
        }

        public IActionResult Index()
        {
            return View();
        }
 }

4.3 全局註冊方式

如今有些同窗考慮了一些全局的狀況，好比我要全局處理系統中的異常，或者收集操做日誌等，須要全局註冊一個ExceptionFilter 來實現，就不須要每個Controller 中進行代碼註冊，方便快捷。代碼以下：

 public void ConfigureServices(IServiceCollection services)
  {
            //全局註冊異常過濾器
            services.AddControllersWithViews(option=> {
                option.Filters.Add<ExecptionFilter>();
            });

            services.AddSingleton<ISingletonService, SingletonService>();
}

4.4 TypeFilter 和 ServiceFilter 註冊方式

上面的五大過濾器中事例代碼中其中有一個過濾器的代碼比較特別，再來回顧ExceptionFilter過濾器的實現代碼：

public class ExecptionFilter : Attribute, IExceptionFilter
    {
        private ILogger<ExecptionFilter> _logger;
        //構造注入日誌組件
        public ExecptionFilter(ILogger<ExecptionFilter> logger)
        {
            _logger = logger;
        }

        public void OnException(ExceptionContext context)
        {
            //日誌收集
            _logger.LogError(context.Exception, context?.Exception?.Message??"異常");
        }
    }

從上面的代碼中能夠發現 ExceptionFilter 過濾器實現中存在日誌服務的構造函數的注入，也就是說該過濾器依賴於其餘的日誌服務，可是日誌服務都是經過DI 注入進來的；再來回顧下上面Action 註冊方式或者Controller 註冊方式 也即Attribute 特性標註註冊方式，自己基礎的特性是不支持構造函數的，是在運行時註冊進來的，那要解決這種自己須要對服務依賴的過濾器須要使用 TypeFilter 或者ServiceFilter 方式進行過濾器的標註註冊。

TypeFilter 和ServiceFilter 的區別。

• ServiceFilter和TypeFilter都實現了IFilterFactory
• ServiceFilter須要對自定義的Filter進行註冊，TypeFilter不須要
• ServiceFilter的Filter生命週期源自於您如何註冊，而TypeFilter每次都會建立一個新的實例

TypeFilter 使用方式

代碼以下：

[TypeFilter(typeof(ExecptionFilter))]
public IActionFilter Index2()
{
      return View();
}

經過上面的代碼能夠發現AuthonizationFilter 是默認的構造器，可是若是過濾器中構造函數中存在參數，須要注入服務那該怎麼辦呢?，好比上面的ExceptionFilter 代碼，就不能使用這種方式進行註冊，須要使用服務特性的方式，咱們能夠選擇使用 代碼以下：

[TypeFilter(typeof(ExecptionFilter))]
public IActionFilter Index2()
{
           return View();
}

ServiceFilter 使用方式

控制器中的代碼以下：

[ServiceFilter(typeof(ExecptionFilter))]
public IActionFilter Index2()
{
           return View();
}

註冊服務的代碼以下：

// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
       Console.WriteLine("ConfigureServices");
       services.AddControllersWithViews();

       //services.AddControllersWithViews(option=> {
       //    option.Filters.Add<ExecptionFilter>();
       //});
        
        //註冊過濾器服務，使用ServiceFilter 方式必需要註冊 不然會報沒有註冊該服務的相關異常
        services.AddSingleton<ExecptionFilter>();
}