網(wǎng)站首頁 編程語言 正文
過濾器的作用是在 Action 方法執(zhí)行前或執(zhí)行后做一些加工處理。使用過濾器可以避免Action方法的重復(fù)代碼,例如,您可以使用異常過濾器合并異常處理的代碼。
過濾器如何工作?
過濾器在?MVC Action 調(diào)用管道中運行,有時稱為過濾器管道。MVC選擇要執(zhí)行的Action方法后,才會執(zhí)行過濾器管道:
實現(xiàn)
過濾器同時支持同步和異步兩種不同的接口定義。您可以根據(jù)執(zhí)行的任務(wù)類型,選擇同步或異步實現(xiàn)。
同步過濾器定義OnStageExecuting和OnStageExecuted方法,會在管道特定階段之前和之后運行代碼的。例如IActionFilter
過濾器,在調(diào)用Action方法之前調(diào)用OnActionExecuting
,在Action方法之回之后調(diào)用OnActionExecuted
:
public class SampleActionFilter : IActionFilter { public void OnActionExecuting(ActionExecutingContext context) { // do something before the action executes } public void OnActionExecuted(ActionExecutedContext context) { // do something after the action executes } }
異步過濾器定義了一個OnStageExecutionAsync方法。該方法提供了FilterTypeExecutionDelegate的委托,當(dāng)調(diào)用該委托時會執(zhí)行具體管道階段的工作。例如,ActionExecutionDelegate
用于調(diào)用Action方法,您可以在調(diào)用它之前和之后執(zhí)行代碼。
public class SampleAsyncActionFilter : IAsyncActionFilter { public async Task OnActionExecutionAsync( ActionExecutingContext context, ActionExecutionDelegate next) { // do something before the action executes await next(); // do something after the action executes } }
您可以在單個類中實現(xiàn)多個過濾器接口。例如,ActionFilterAttribute抽象類實現(xiàn)了IActionFilter
和IResultFilter
,以及與它們對應(yīng)的異步接口。
提示您不需要同時實現(xiàn)兩種過濾器接口,要么是同步的,要么是異步的。框架首先檢查過濾器是否實現(xiàn)了異步接口,如果是,直接執(zhí)行異步方法。如果不是,它會執(zhí)行同步接口的方法。如果在一個類上同時實現(xiàn)兩種接口,則只會調(diào)用異步方法。當(dāng)使用像
ActionFilterAttribute
這類抽象類時,您只需要覆蓋過濾器的同步方法或異步方法。
過濾器類型
ASP.NET Core 有以下五種類型的過濾器,每個過濾器類型在過濾器管道中的不同階段執(zhí)行:
- Authorization Filter
授權(quán)過濾器?在過濾器管道中第一個執(zhí)行,通常用于驗證當(dāng)前請求的合法性,不合法后面的管道會直接跳過。它們只有一個Before
方法,不像其它大多數(shù)過濾器支持前置階段方法和后置階段方法。注意,您不要在授權(quán)過濾器中拋出異常,因為沒有任何代碼來處理異常(異常過濾器不處理它們)。 - Resource Filter
資源過濾器是第二個運行,在 Authorization Filter 之后,Model Binding 之前執(zhí)行。在性能方面,資源過濾器在實現(xiàn)緩存或截斷過濾器管道尤為重要。 - Action Filter
使用率最高的過濾器,在調(diào)用 Acioin 方法之前和之后執(zhí)行代碼。跟 Resource Filter 很類似,但 Model Binding 在之后執(zhí)行。 - Exception Filter
用于為應(yīng)用程序執(zhí)行異常處理策略。 - Result Filter
當(dāng) Action 執(zhí)行完成后,最后會執(zhí)行過濾器。用于處理ActionResult結(jié)果輸出策略。
過濾器運行順序
ASP.NET Core 的每個請求都會先經(jīng)過已注冊的`Middleware`,接著才會執(zhí)行過濾器:同類型的過濾器都會以先進后出的方式執(zhí)行。
黃色箭頭是正常情況流程
灰色箭頭是異常處理流程
過濾器的作用域與執(zhí)行順序
過濾器具有三種不同級別的作用域。您可以通過Attribute
將過濾器注冊到指定控制器或 Action 方法;您也可以在Startup
類的ConfigureServices
方法中將過濾器注冊到MvcOptions.Filters
的集合中作為全局過濾器(對所有的控制器和Action方法均有效):
public class Startup { public void ConfigureServices(IServiceCollection services) { services.AddMvc(options => { options.Filters.Add(new AddHeaderAttribute("GlobalAddHeader", "Result filter added to MvcOptions.Filters")); // an instance options.Filters.Add(typeof(SampleActionFilter)); // by type options.Filters.Add(new SampleGlobalActionFilter()); // an instance }); services.AddScoped<AddHeaderFilterWithDi>(); } }
示例來自于ASP.NET Core MVC 英語文檔
默認執(zhí)行順序
當(dāng)管道的某個階段存在多個過濾器時,過濾器執(zhí)行的默認順序由作用域確定:全局過濾器優(yōu)先于控制器過濾器,控制器過濾器優(yōu)先于Action方法過濾器。
以下示例是同步 Action 過濾器調(diào)用的順序:
序號 | 過濾器作用域 | 過濾器方法 |
---|---|---|
1 | Global | OnActionExecuting |
2 | Controller | OnActionExecuting |
3 | Method | OnActionExecuting |
4 | Method | OnActionExecuted |
5 | Controller | OnActionExecuted |
6 | Global | OnActionExecuted |
提示每個控制器的基類
Controller
包含OnActionExecuting
和OnActionExecuted
方法。其中OnActionExecuting
在所有過濾器之前調(diào)用,OnActionExecuted
在所有過濾器之后調(diào)用。
覆蓋默認執(zhí)行順序
您可以通過實現(xiàn)IOrderedFilter
接口來覆蓋默認的執(zhí)行順序。此接口公開了Order
屬性表示優(yōu)先級,以確定執(zhí)行順序;具有較低Order
值的過濾器將在具有較高Order
值的過濾器之前執(zhí)行前置方法;具有較低Order
值的過濾器將在具有較高Order
值的過濾器之后執(zhí)行后置方法。
您可以使用構(gòu)造函數(shù)參數(shù)設(shè)置Order
屬性:
[MyFilter(Name = "Controller Level Attribute", Order=1)]
如果您將上述示例中 Action 過濾器的Order
設(shè)置為1,將控制器和全局過濾器的Order
屬性分別設(shè)置為2和3,則執(zhí)行順序?qū)⑴c默認相反。
序號 | 過濾器作用域 |
Order ?屬性 |
過濾器方法 |
---|---|---|---|
1 | Method | 1 | OnActionExecuting |
2 | Controller | 2 | OnActionExecuting |
3 | Global | 3 | OnActionExecuting |
4 | Global | 3 | OnActionExecuted |
5 | Controller | 2 | OnActionExecuted |
6 | Method | 1 | OnActionExecuted |
過濾器執(zhí)行時,Order
屬性的優(yōu)先級高于作用域。過濾器首先按Order
屬性排序,然后再按作用域排序。所有內(nèi)置過濾器實現(xiàn)IOrderedFilter
接口并將Order
值默認設(shè)置為0;因此,除非設(shè)置Order
屬性為非零值,否則按作用域的優(yōu)先級執(zhí)行。
原文鏈接:https://www.cnblogs.com/tdfblog/p/filters-in-aspnet-core-mvc.html
相關(guān)推薦
- 2022-07-03 C#中的預(yù)定義類型與引用類型_C#教程
- 2022-03-08 android?studio組件通信:Intend啟動Activity接收返回結(jié)果_Android
- 2022-11-12 Android手冊之Toolbar搜索聯(lián)動及監(jiān)聽小技巧_Android
- 2022-05-20 Spring-實現(xiàn)AOP的三種方式演示
- 2021-12-12 Redis實現(xiàn)分布式鎖的實例講解_Redis
- 2023-02-05 Redis處理高并發(fā)之布隆過濾器詳解_Redis
- 2022-07-03 C#并行編程之PLINQ(并行LINQ)_C#教程
- 2022-04-26 Python中的3D繪圖命令總結(jié)_python
- 最近更新
-
- window11 系統(tǒng)安裝 yarn
- 超詳細win安裝深度學(xué)習(xí)環(huán)境2025年最新版(
- Linux 中運行的top命令 怎么退出?
- MySQL 中decimal 的用法? 存儲小
- get 、set 、toString 方法的使
- @Resource和 @Autowired注解
- Java基礎(chǔ)操作-- 運算符,流程控制 Flo
- 1. Int 和Integer 的區(qū)別,Jav
- spring @retryable不生效的一種
- Spring Security之認證信息的處理
- Spring Security之認證過濾器
- Spring Security概述快速入門
- Spring Security之配置體系
- 【SpringBoot】SpringCache
- Spring Security之基于方法配置權(quán)
- redisson分布式鎖中waittime的設(shè)
- maven:解決release錯誤:Artif
- restTemplate使用總結(jié)
- Spring Security之安全異常處理
- MybatisPlus優(yōu)雅實現(xiàn)加密?
- Spring ioc容器與Bean的生命周期。
- 【探索SpringCloud】服務(wù)發(fā)現(xiàn)-Nac
- Spring Security之基于HttpR
- Redis 底層數(shù)據(jù)結(jié)構(gòu)-簡單動態(tài)字符串(SD
- arthas操作spring被代理目標(biāo)對象命令
- Spring中的單例模式應(yīng)用詳解
- 聊聊消息隊列,發(fā)送消息的4種方式
- bootspring第三方資源配置管理
- GIT同步修改后的遠程分支