ASP.NET Core MVC 过滤器(Filter)

一.过滤器如何工作

  不同的过滤器类型在管道中的不同阶段执行,因此具有各自的与其场景。根据需要执行的任务以及需要执行的请求管道中的位置,选择要创建的过滤器类型。过滤器在 MVC 操作调用管道中运行,有时也称为过滤管道,在 MVC 中选择要执行的操作后,执行操作上的过滤器,如图:

ASP.NET Core MVC 过滤器(Filter)

  不同的过滤器在管道内的不同位置执行。像授权过滤器这样的过滤器只在管道中靠前的位置执行。其他过滤器,如操作(Action)过滤器,可以在管道执行的其他部分之前和之后执行,如图:

ASP.NET Core MVC 过滤器(Filter)

1.选择过滤器

  授权过滤器用于确定当前请求用户是否被授权。

  资源过滤器是在授权之后第一个处理请求的过滤器,也是最后一个在请求离开过滤管道时接触请求的过滤器。在性能方面,对实现缓存或者对过滤管道进行短路 特别有用。

  操作过滤器包装对单个操作方法的调用,并且可以处理传递到操作的参数以及从操作返回的操作结果。

  异常过滤器用于对 MVC 应用程序中未处理的异常应用全局策略。

  结果过滤器包装单个操作结果的执行,并且尽在操作执行成功时运行。它们必须是围绕视图执行或格式化程序执行的逻辑的理想选择。 

2.实现过滤器

  所有过滤器均可通过不同的接口定义支持同步和异步的实现。根据需要执行的任务类型,选择同步或异步实现。从框架的角度看,它们是可以互换的。

  同步过滤器定义了 OnStageExecuting 和 OnStageExecuted 方法(也有例外)。OnStageExecuting 方法在事件管道阶段之前通过阶段名称来调用,而 OnStageExecuted 方法将在阶段名称命名的管道阶段之后调用。

public class SampleActionFilter:IActionFilter { public void OnActionExecuting(ActionExecutingContext context) { //操作执行前做的事情 } public void OnActionExecuted(ActionExecutedContext context) { //操作执行后做的事情 } }

  异步过滤器定义了一个单一的 OnActionExecutionAsync  方法,可以在具体管道阶段的前后运行。 OnActionExecutionAsync 方法提供了一个 ActionExecutionDelegate 委托,调用时该委托会执行具体管道阶段的工作,然后等待完成。

public class SampleAsyncActionFilter: IAsyncActionFilter { public async Task OnActionExecutionAsync(ActionExecutingContext context, ActionExecutionDelegate next) { //操作执行前做的事情 await next(); //操作执行后做的事情 } }

3.过滤器作用域

  过滤器有三种不同级别的作用域。你可以在特定的操作上用特性(Attribute)的方式使用特定的过滤器。也可以在控制器上用特性的方式使用过滤器,这样就可以将效果作用在控制器内的所有操作上。或者注册一个全局过滤器,它将作用于整个 MVC 应用程序的每一个操作。

  如果想要使用全局过滤器,可以在配置 MVC 时,在 Startup 的 ConfigureServices 方法中添加:

services.AddMvc(options => { options.Filters.Add(typeof(SampleActionFilter));//通过类型 options.Filters.Add(new SampleActionFilter());//注册实例 }).SetCompatibilityVersion(CompatibilityVersion.Version_2_1);

  过滤器既可以通过类型添加,也可以通过实例添加。如果通过实例添加,则该实例会被使用于每一个请求。如果通过类型添加,则在每次请求后都会创建一个实例,其所有构造函数依赖项都将通过 DI 来填充。

  把过滤器接口的实现当作特性使用也非常方便。过滤器特性可应用于控制器和操作方法。框架包含了内置的基于特性的过滤器,可以继承他们或者另外定制。例如,下面的过滤器继承了 ResultFilterAttribute,并重写 OnResultExecuting 方法(在响应中增加一个信息头): 

public class AddHeaderAttribute: ResultFilterAttribute { private readonly string _name; private readonly string _value; public AddHeaderAttribute(string name, string value) { _name = name; _value = value; } public override void OnResultExecuting(ResultExecutingContext context) { context.HttpContext.Response.Headers.Add( _name,new string[] { _value }); base.OnResultExecuting(context); } }

  特性允许过滤器接受参数,如下,可将此特性添加到控制器或操作中,并为其指定所需 HTTP 头的名称和值:

[AddHeader("Author", "Ruby Lu")] public class HomeController : Controller { }

以下几种过滤器接口可以自定义为相应特性的实现:

ActionFilterAttribute

ExceptionFilterAttribute

ResultFilterAttribute

FormatFilterAttribute

ServiceFilterAttribute

TypeFilterAttribute

 4.取消和短路

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/zwwpzj.html