ASP.NET Core MVC 过滤器介绍

过滤器的作用是在 Action 方法执行前或执行后做一些加工处理。使用过滤器可以避免Action方法的重复代码,例如,您可以使用异常过滤器合并异常处理的代码。

过滤器如何工作?

过滤器在 MVC Action 调用管道中运行,有时称为过滤器管道。MVC选择要执行的Action方法后,才会执行过滤器管道:


实现

过滤器同时支持同步和异步两种不同的接口定义。您可以根据执行的任务类型,选择同步或异步实现。

同步过滤器定义OnStageExecuting和OnStageExecuted方法,会在管道特定阶段之前和之后运行代码的。例如IActionFilter过滤器,在调用Action方法之前调用OnActionExecuting,在Action方法之回之后调用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的委托,当调用该委托时会执行具体管道阶段的工作。例如,ActionExecutionDelegate用于调用Action方法,您可以在调用它之前和之后执行代码。

    public class SampleAsyncActionFilter : IAsyncActionFilter{        public async Task OnActionExecutionAsync(            ActionExecutingContext context,            ActionExecutionDelegate next)        {        
       // do something before the action executesawait next();            // do something after the action executes}}

您可以在单个类中实现多个过滤器接口。例如,ActionFilterAttribute抽象类实现了IActionFilterIResultFilter,以及与它们对应的异步接口。

提示
您不需要同时实现两种过滤器接口,要么是同步的,要么是异步的。框架首先检查过滤器是否实现了异步接口,如果是,直接执行异步方法。如果不是,它会执行同步接口的方法。如果在一个类上同时实现两种接口,则只会调用异步方法。当使用像ActionFilterAttribute这类抽象类时,您只需要覆盖过滤器的同步方法或异步方法。

过滤器类型

ASP.NET Core 有以下五种类型的过滤器,每个过滤器类型在过滤器管道中的不同阶段执行:

  1. Authorization Filter
    授权过滤器 在过滤器管道中第一个执行,通常用于验证当前请求的合法性,不合法后面的管道会直接跳过。它们只有一个Before方法,不像其它大多数过滤器支持前置阶段方法和后置阶段方法。注意,您不要在授权过滤器中抛出异常,因为没有任何代码来处理异常(异常过滤器不处理它们)。

  2. Resource Filter
    资源过滤器是第二个运行,在 Authorization Filter 之后,Model Binding 之前执行。在性能方面,资源过滤器在实现缓存或截断过滤器管道尤为重要。

  3. Action Filter
    使用率最高的过滤器,在调用 Acioin 方法之前和之后执行代码。跟 Resource Filter 很类似,但 Model Binding 在之后执行。

  4. Exception Filter
    用于为应用程序执行异常处理策略。

  5. Result Filter
    当 Action 执行完成后,最后会执行过滤器。用于处理ActionResult结果输出策略。


过滤器运行顺序

ASP.NET Core 的每个请求都会先经过已注册的Middleware,接着才会执行过滤器:同类型的过滤器都会以先进后出的方式执行。

图片来自 John Wu 的博客

黃色箭头是正常情況流程
灰色箭头是异常处理流程

过滤器的作用域与执行顺序

过滤器具有三种不同级别的作用域。您可以通过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 instanceoptions.Filters.Add(typeof(SampleActionFilter)); // by typeoptions.Filters.Add(new SampleGlobalActionFilter()); // an instance});services.AddScoped<AddHeaderFilterWithDi>();}}

示例来自于ASP.NET Core MVC 英语文档

默认执行顺序

当管道的某个阶段存在多个过滤器时,过滤器执行的默认顺序由作用域确定:全局过滤器优先于控制器过滤器,控制器过滤器优先于Action方法过滤器。
以下示例是同步 Action 过滤器调用的顺序:

序号过滤器作用域过滤器方法
1GlobalOnActionExecuting
2ControllerOnActionExecuting
3MethodOnActionExecuting
4MethodOnActionExecuted
5ControllerOnActionExecuted
6GlobalOnActionExecuted

提示
每个控制器的基类Controller包含OnActionExecutingOnActionExecuted方法。其中OnActionExecuting在所有过滤器之前调用,OnActionExecuted在所有过滤器之后调用。

覆盖默认执行顺序

您可以通过实现IOrderedFilter接口来覆盖默认的执行顺序。此接口公开了Order属性表示优先级,以确定执行顺序;具有较低Order值的过滤器将在具有较高Order值的过滤器之前执行前置方法;具有较低Order值的过滤器将在具有较高Order值的过滤器之后执行后置方法。
您可以使用构造函数参数设置Order属性:

[MyFilter(Name = "Controller Level Attribute", Order=1)]

如果您将上述示例中 Action 过滤器的Order设置为1,将控制器和全局过滤器的Order属性分别设置为2和3,则执行顺序将与默认相反。

序号过滤器作用域Order 属性过滤器方法
1Method1OnActionExecuting
2Controller2OnActionExecuting
3Global3OnActionExecuting
4Global3OnActionExecuted
5Controller2OnActionExecuted
6Method1OnActionExecuted

过滤器执行时,Order属性的优先级高于作用域。过滤器首先按Order属性排序,然后再按作用域排序。所有内置过滤器实现IOrderedFilter接口并将Order值默认设置为0;因此,除非设置Order属性为非零值,否则按作用域的优先级执行。

总结

今天我们已经了解了关于过滤器基本知识,在下一篇博客中,我们将介绍内置过滤器、过滤的使用、依赖注入、取消与截断等知识,谢谢!

参考资料

  • https://blog.johnwu.cc/article/asp-net-core-filters.html

  • https://docs.microsoft.com/en-us/aspnet/core/mvc/controllers/filters

原文地址:http://www.cnblogs.com/tdfblog/p/filters-in-aspnet-core-mvc.html


.NET社区新闻,深度好文,微信中搜索dotNET跨平台或扫描二维码关注

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/324540.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

dubbo小项目

完整Dubbo项目演示 1 原型 1.1 部门显示&#xff0c;显示全部部门信息 1.2 员工新增 1.3 查看部门员工 2 按照分布式架构进行设计项目 设定员工管理和部门管理不在同一个模块中&#xff0c;需要有一个员工管理项目和一个部门管理项目。 为了方便&#xff0c;不去每个项…

如何构建一套高可用的 APP 消息推送平台

转载自 如何构建一套高可用的 APP 消息推送平台 消息推送作为移动 APP 运营中的一项关键技术&#xff0c;已经被越来越广泛的运用。本文追溯了推送技术的发展历史&#xff0c;剖析了其核心原理&#xff0c;并对推送服务的关键技术进行深入剖析&#xff0c;围绕消息推送时产生…

为什么要有周考?周考是用来干什么的?

周考已经实行一年多的时间了&#xff0c;目前唯一用来检测学生们水平的可能就是周考的成绩了&#xff0c;不过&#xff0c;周考成绩也很能说明一切&#xff0c;每周周考的题目和范围都是本周所学知识&#xff0c;如果周考的成绩很差&#xff0c;那么可以很肯定的说&#xff0c;…

POJ2186-Popular Cows(流行的奶牛)【tarjan,强连通分量,图论】

正题 题目链接 大意 有n头奶牛&#xff0c;奶牛们会认为有些奶牛很受欢迎&#xff0c;受欢迎会互相传递&#xff0c;如:如果A认为B很受欢迎&#xff0c;而B认为C受欢迎&#xff0c;那么A也会认为C是受欢迎的。然后求每一个奶牛都认为受欢迎的奶牛数量。 解题思路 先用tarjan…

.NET Core快速入门教程 4、使用VS Code开发.NET Core控制台应用程序

一、前言 为什么选择VS Code&#xff1f;VS Code 是一款跨平台的代码编辑器&#xff0c;想想他的哥哥VS&#xff0c;并是微软出品的宇宙第一IDE&#xff0c;那作为VS的弟弟&#xff0c;VS Code 也不会差&#xff0c;毕竟微软出品。反正ken是这么认为的本篇开发环境&#xff1f…

zookeeper not connected

问题&#xff1a; 异常信息&#xff1a; zookeeper not connected 异常场景&#xff1a; spring boot dubbo 启动时&#xff0c;连接zk出现问题 解决方案&#xff1a; 1、 检查zk所在机的防火墙。 systemctl stop firewalld | service firewalld stop 2、 检查zk所在机的ip和y…

Redis 5.0 正式版发布了,19 个新特性

转载自 Redis 5.0 正式版发布了&#xff0c;19 个新特性 Redis 5.0 GA 正式版发布了&#xff01; 下载地址&#xff1a; download.redis.io/releases/redis-5.0.0.tar.gz 源码下载&#xff1a; github.com/antirez/redis/releases/tag/5.0.0 先看一下 Redis 5 带来的更新内容…

晨读,难道只是为了完成任务而读的吗?

前两天&#xff0c;看到一篇“湖北恩施的一名学生早读课上大汗淋漓”的文章&#xff0c;不禁想起了我们班的早读。01早读情况除周一升旗以外&#xff0c;其余的学习日都是有早读的&#xff0c;但是早读的利用率有多少就不得而知了。一般在前一天布置作业的时候&#xff0c;作业…

P1197-星球大战【并查集,图论】

正题 题目链接 大意 有n个星球&#xff0c;有一些双向通道连接星球&#xff0c;将一些星球实施打击。求开始和每一次打击后的联通块数量。 解题思路 可以尝试一下逆向思维&#xff0c;把摧毁改为连接&#xff0c;然后倒着输出。 代码 #include<cstdio> #include<i…

代码调用NullPointerException(NPE)

异常信息&#xff1a; 空指针异常 场景&#xff1a; 控制调用服务代码发生异常 服务代码调用mapper发生异常 解决方案&#xff1a; 找到异常发生的行&#xff0c;找方法调用过程"."&#xff0c; 如&#xff1a;xxxService.xxx()。通常都是这个xxxService为null&#…

AOP in dotnet :AspectCore的参数拦截支持

距离上一篇AspectCore的介绍发布已经很长一段时间了&#xff0c;这篇文章也早该和大家见面&#xff0c;最近一直忙于适应新工作&#xff0c;并在业余时间有幸向何镇汐&#xff0c;Savorboard&#xff0c;农夫&#xff0c;AlexLEWIS等几位大牛请教学习&#xff0c;收获颇多。另一…

GitHub 发布了一款重量级产品,可直接运行代码

转载自 GitHub 发布了一款重量级产品&#xff0c;可直接运行代码 【导读】10月16日&#xff0c;GitHub Universe开发者大会如期举行&#xff0c;并重磅推出GitHub Actions&#xff0c;平台主管Sam Lambert称&#xff0c;这将是GitHub历史上最大的改变。此外&#xff0c;GitHu…

“老师,请您多关注一下我吧!!!”

一个班&#xff0c;有学习好的&#xff0c;有学习差的&#xff1b;有喜欢表现的&#xff0c;也有不喜欢表现的。01爱表现的类型&#xff1a;第一种&#xff0c;喜欢表现的学生平时总是让时不时的让老师关注到他&#xff0c;比如上课和老师积极互动的&#xff0c;老师问一个问题…

【2018.3.31】模拟赛之一-ssl2406 约数【水题】

前言 其实水题我是真的不想写的&#xff0c;但是没有办法 正题 大意 一个数&#xff0c;输出他的所有除数和 代码 #include<cstdio> #include<cmath> using namespace std; int n,s; int main() { // freopen("bri.in","r",stdin); // fr…

.NET Core 事件总线,分布式事务解决方案:CAP

背景 相信前面几篇关于微服务的文章也介绍了那么多了&#xff0c;在构建微服务的过程中确实需要这么一个东西&#xff0c;即便不是在构建微服务&#xff0c;那么在构建分布式应用的过程中也会遇到分布式事务的问题&#xff0c;那么 CAP 就是在这样的背景下诞生的。 最初打算做…

dubbo小项目2

1、项目结构搭建 父项目pom.xml <?xml version"1.0" encoding"UTF-8"?>-<project xsi:schemaLocation"http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns:xsi"http://www.w3.org/2001/XM…

Java中的TreeSet集合会自动将元素升序排序

我们都知道&#xff0c;java中的集合可以分为这么两大类&#xff1a;Collection和Map &#xff0c;其中Collection 接口中又可以派生出来两个接口&#xff0c;分别为&#xff1a;List和Set接口。其中&#xff0c;Set下有HashSet&#xff0c;LinkedHashSet&#xff0c;TreeSet&a…

面试时如何介绍自己的项目经验

转载自 面试时如何介绍自己的项目经验 在面试时&#xff0c;经过寒暄后&#xff0c;一般面试官会让介绍项目经验 。常见的问法是&#xff0c;说下你最近的&#xff08;或最拿得出手的&#xff09;一个项目。 根据我们的面试经验&#xff0c;发现有不少候选人对此没准备&…

【2018.3.31】模拟赛之二-ssl2407 负进制【贪心】

正题 大意 将二进制从右到左的权值改为&#xff1a; 1,-2,4,-8,16,-32,64… 然后给出一个数用二进制表达出来&#xff0c;如&#xff1a; −131101111(−32)116141(−2)11−131101111(−32)116141(−2)11解题思路 注意&#xff1a;这不是最优解。 比赛的时候就一直在想用贪…

jsp中使用cookie时报错……

今天在看jsp中的cookie时&#xff0c;遇到一个比较麻烦的问题。关键代码如下&#xff1a;登录页面&#xff1a;login.jsp<form action"doLogin.jsp" method"post">用户名&#xff1a;<input type"text" name"sname" /><…