ASP.NET Core 2 學習筆記（十四）Filters

来源:https://www.cnblogs.com/snaildev/archive/2018/06/08/9154669.html
-Advertisement-
Play Games

Filter是延續ASP.NET MVC的產物，同樣保留了五種的Filter，分別是Authorization Filter、Resource Filter、Action Filter、Exception Filter及Result Filter。通過不同的Filter可以有效處理封包進出的加工，本 ...


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

Filter 介紹

Filter的作用是在Action 執行前或執行後做一些加工處理。
某種程度來看，會跟Middleware很像，但執行的順序略有不同，用對Filter不僅可以減少代碼，還可以提高執行效率。

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

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

Filter 運作方式

ASP.NET Core的每個Request都會先經過已註冊的Middleware接著才會執行Filter，除了會依照上述的順序外，同類型的Filter預設都會以先進後出的方式處里封包。
Response在某些Filter並不會做處理，會直接被pass。Request及Response的運作流程如下圖：

  • 黃色箭頭是正常情況流程
  • 灰色箭頭是異常處理流程

建立Filter

ASP.NET Core的Filter基本上跟ASP.NET MVC的差不多。
上述的五種Filter範例分別如下：

Authorization Filter

AuthorizationFilter.cs

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc.Filters;

namespace MyWebsite.Filters
{
    public class AuthorizationFilter : IAuthorizationFilter
    {
        public void OnAuthorization(AuthorizationFilterContext context)
        {
            context.HttpContext.Response.WriteAsync($"{GetType().Name} in. \r\n");
        }
    }
}

非同步的方式：

// ...
public class AuthorizationFilter : IAsyncAuthorizationFilter
{
    public async Task OnAuthorizationAsync(AuthorizationFilterContext context)
    {
        await context.HttpContext.Response.WriteAsync($"{GetType().Name} in. \r\n");
    }
}

Resource Filter

ResourceFilter.cs

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc.Filters;

namespace MyWebsite.Filters
{
    public class ResourceFilter : IResourceFilter
    {
        public void OnResourceExecuting(ResourceExecutingContext context)
        {
            context.HttpContext.Response.WriteAsync($"{GetType().Name} in. \r\n");
        }

        public void OnResourceExecuted(ResourceExecutedContext context)
        {
            context.HttpContext.Response.WriteAsync($"{GetType().Name} out. \r\n");
        }
    }
}

非同步的方式：

// ...
public class ResourceFilter : IAsyncResourceFilter
{
    public async Task OnResourceExecutionAsync(ResourceExecutingContext context, ResourceExecutionDelegate next)
    {
        await context.HttpContext.Response.WriteAsync($"{GetType().Name} in. \r\n");

        await next();

        await context.HttpContext.Response.WriteAsync($"{GetType().Name} out. \r\n");
    }
}

Action Filter

ActionFilter.cs

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc.Filters;

namespace MyWebsite.Filters
{
    public class ActionFilter : IActionFilter
    {
        public void OnActionExecuting(ActionExecutingContext context)
        {
            context.HttpContext.Response.WriteAsync($"{GetType().Name} in. \r\n");
        }

        public void OnActionExecuted(ActionExecutedContext context)
        {
            context.HttpContext.Response.WriteAsync($"{GetType().Name} out. \r\n");
        }
    }
}

非同步的方式：

// ...
public class ActionFilter : IAsyncActionFilter
{
    public async Task OnActionExecutionAsync(ActionExecutingContext context, ActionExecutionDelegate next)
    {
        await context.HttpContext.Response.WriteAsync($"{GetType().Name} in. \r\n");

        await next();

        await context.HttpContext.Response.WriteAsync($"{GetType().Name} out. \r\n");
    }
}

Result Filter

ResultFilter.cs

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc.Filters;

namespace MyWebsite.Filters
{
    public class ResultFilter : IResultFilter
    {
        public void OnResultExecuting(ResultExecutingContext context)
        {
            context.HttpContext.Response.WriteAsync($"{GetType().Name} in. \r\n");
        }

        public void OnResultExecuted(ResultExecutedContext context)
        {
            context.HttpContext.Response.WriteAsync($"{GetType().Name} out. \r\n");
        }
    }
}

非同步的方式：

// ...
public class ResultFilter : IAsyncResultFilter
{
    public async Task OnResultExecutionAsync(ResultExecutingContext context, ResultExecutionDelegate next)
    {
        await context.HttpContext.Response.WriteAsync($"{GetType().Name} in. \r\n");

        await next();

        await context.HttpContext.Response.WriteAsync($"{GetType().Name} out. \r\n");
    }
}

Exception Filter

ExceptionFilter.cs

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc.Filters;

namespace MyWebsite.Filters
{
    public class ExceptionFilter : IExceptionFilter
    {
        public void OnException(ExceptionContext context)
        {
            context.ExceptionHandled = true; // 表明異常已處理，客戶端可得到正常返回
            context.HttpContext.Response.WriteAsync($"{GetType().Name} in. \r\n");
        }
    }
}

非同步的方式：

// ...
public class ExceptionFilter : IAsyncExceptionFilter
{
        public Task OnExceptionAsync(ExceptionContext context)
        {
            context.ExceptionHandled = true;// 表明異常已處理，客戶端可得到正常返回
            context.HttpContext.Response.WriteAsync($"{GetType().Name} in. \r\n");
            return Task.CompletedTask;
        }
}

註冊Filter

Filter有兩種註冊方式，一種是全局註冊，另一種是用[Attribute]局部註冊的方式，只套用在特定的Controller或Action。

全局註冊

在Startup.ConfigureServices的MVC服務中註冊Filter，這樣就可以套用到所有的Request。如下：

// ...
public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddMvc(config =>
        {
            config.Filters.Add(new ResultFilter());
            config.Filters.Add(new ExceptionFilter());
            config.Filters.Add(new ResourceFilter());
        });
    }
}

局部註冊

ASP.NET Core在局部註冊Filter的方式跟ASP.NET MVC有一點不一樣，要通過[TypeFilter(type)]。
在Controller或Action上面加上[TypeFilter(type)]就可以局部註冊Filter。如下：

// ...
namespace MyWebsite.Controllers
{
    [TypeFilter(typeof(AuthorizationFilter))]
    public class HomeController : Controller
    {
        [TypeFilter(typeof(ActionFilter))]
        public void Index()
        {
            Response.WriteAsync("Hello World! \r\n");
        }
        
        [TypeFilter(typeof(ActionFilter))]
        public void Error()
        {
            throw new System.Exception("Error");
        }
    }
}

[TypeFilter(type)]用起來有點冗長，想要像過去ASP.NET MVC用[Attribute]註冊Filter的話，只要將Filter繼承Attribute即可。如下：

public class AuthorizationFilter : Attribute, IAuthorizationFilter
{
    // ...
}
public class ActionFilter : Attribute, IActionFilter
{
    // ...
}

[Attribute] 註冊就可以改成如下方式：

// ...
namespace MyWebsite.Controllers
{
    [AuthorizationFilter]
    public class HomeController : Controller
    {
        [ActionFilter]
        public void Index()
        {
            Response.WriteAsync("Hello World! \r\n");
        }
        
        [ActionFilter]
        public void Error()
        {
            throw new System.Exception("Error");
        }
    }
}

執行結果

http://localhost:5000/Home/Index 輸出結果如下：

AuthorizationFilter in.
ResourceFilter in.
ActionFilter in.
Hello World!
ActionFilter out.
ResultFilter in.
ResultFilter out.
ResourceFilter out.

http://localhost:5000/Home/Error 輸出結果如下：

AuthorizationFilter in.
ResourceFilter in.
ActionFilter in.
ActionFilter out.
ExceptionFilter in.
ResourceFilter out.

執行順序

預設註冊同類型的Filter 是以先進後出的方式處里封包，註冊層級也會影響執行順序。

但也可以通過實現 IOrderedFilter 更改執行順序。例如：

public class ActionFilter : Attribute, IActionFilter, IOrderedFilter
{
    public string Name { get; set; }

    public int Order { get; set; } = 0;

    public void OnActionExecuting(ActionExecutingContext context)
    {
        context.HttpContext.Response.WriteAsync($"{GetType().Name}({Name}) in. \r\n");
    }
    public void OnActionExecuted(ActionExecutedContext context)
    {
        context.HttpContext.Response.WriteAsync($"{GetType().Name}({Name}) out. \r\n");
    }
}

在註冊Filter 時帶上Order，數值越小優先權越高。

// ...
public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddMvc(config =>
        {
            config.Filters.Add(new ActionFilter() { Name = "Global", Order = 3 });
        });
    }
}

// ...
namespace MyWebsite.Controllers
{
    [ActionFilter(Name = "Controller", Order = 2)]
    public class HomeController : Controller
    {
        [ActionFilter(Name = "Action", Order = 1)]
        public void Index()
        {
            Response.WriteAsync("Hello World! \r\n");
        }
    }
}

變更執行順序後的輸出內容：

ActionFilter(Action) in. 
ActionFilter(Controller) in. 
ActionFilter(Global) in. 
Hello World! 
ActionFilter(Global) out. 
ActionFilter(Controller) out. 
ActionFilter(Action) out.

參考

ASP.NET Core Filters

 

老司機發車啦：https://github.com/SnailDev/SnailDev.NETCore2Learning  


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

-Advertisement-
Play Games
更多相關文章
  • VisualStudio，用C#寫的一個開源移動APP，資產管理類項目SmoSec
    一款用C#開發的APP開源項目。這款開源項目名為SmoSec，目前包含資產管理、耗材管理兩大類。並且，未來會不斷迭代，持續增加盤點、標簽列印和倉庫管理等功能。 ...
  • C# 連蒙帶騙不知所以然的搞定USB下位機讀寫
    公司用了一臺發卡機，usb介面，半雙工，給了個dll，不支持線程操作，使得UI線程老卡。 懊惱了，想自己直接通過usb讀寫，各種百度，然後是無數的坑，最終搞定。 現將各種坑和我自己的某些猜想記錄一下，也供各位參考。 一、常量定義 主要用於CreateFile時用。 二、結構、枚舉、類定義 都是從各種 ...
  • 使用.Net Core 2.1開發Captcha圖片驗證碼服務
    使用.Net Core 2.1開發Captcha驗證碼服務 開發工具：Visual Studio 2017 15.7.3 開發平臺：64位 Windows 10 目標框架：.NET Core 2.1 完成度：已實現 Github地址： "https://github.com/PuzzledAlien ...
  • Revit二次開發： 文件損壞
    哪些因素可能會導致損壞？ 損壞的原因也各不相同，包括但不限於 無法讀取/寫入存儲介質 程式發生崩潰（特別是在數據寫入 RVT 模型時） 附加模塊以通過正常 UI 無法或意外的方式修改圖元 未經測試的多項操作或一系列操作（例如，取消同步或在同步後使用“撤消”命令） 解決方案： 要最大程度地減少數據損壞 ...
  • Ocelot 新手上路
    新手上路，老司機請多多包含！Ocelot 在博園裡文章特別多，但是按照其中一篇文章教程，如果經驗很少或者小白，是沒法將程式跑向博主的結果. 因此總結下 參考多篇文章，終於達到預期效果。 Ocelot 目標是使用.NET運行微服務/面向服務架構，我們需要一個統一的入口進入我們的服務，提供監控、鑒權、負 ...
  • Python3 與 C# 基礎語法對比（List、Tuple、Dict專欄）
    Python3 與 C# 基礎語法對比（基礎知識場）：https://www.cnblogs.com/dunitian/p/9103673.html Python3 與 C# 基礎語法對比（String專欄）：https://www.cnblogs.com/dunitian/p/9119986.ht ...
  • 下拉式選單連動設定
    需求：當選擇工序時，帶出對應的作業內容 步驟一：使用SqlDataSource設定從資料庫撈取要填入下拉式選單的值 步驟二：設定下拉式選單的項目 步驟三：再拉一個SqlDatasource 步驟四：設定第二個SqlDataSource變數 步驟五：再拉一個下拉式選單設定數據源 , 但不打勾AutoP ...
  • 嘗試載入 Oracle 客戶端庫時引發 BadImageFormatException。如果在安裝 32 位 Oracle 客戶端組件的情況下以 64 位模式運行，將出現此問題。
    問題描述： “System.InvalidOperationException”類型的異常在 System.Data.OracleClient.dll 中發生，但未在用戶代碼中進行處理 其他信息: 嘗試載入 Oracle 客戶端庫時引發 BadImageFormatException。如果在安裝 3 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類