ASP.NET MVC5高级编程 ——（6）过滤器

一、过滤器简介

1.1、理解什么是过滤器

1、过滤器（Filters）就是向请求处理管道中注入额外的逻辑。提供了一个简单而优雅的方式来实现横切关注点。

2、所谓的过滤器（Filters），MVC框架里面的过滤器完全不同于ASP.NET平台里面的Request.Filters和Response.Filter对象，它们主要是实现请求和响应流的传输。通常我们所说的过滤器是指MVC框架里面的过滤器。

3、过滤器可以注入一些代码逻辑到请求处理管道中，是基于C#的Attribute的实现。当负责调用Action的类ControllerActionInvoker在调用执行Action的时候会检查Action上面的Attribute并查看这些Attribute是否实现了指定的接口，以便进行额外的代码注入处理

4、过滤器的作用：实现将附加逻辑注入到请求处理管道，从而用一种简单而雅致的方式实现了交叉关注。在 Action 方法执行前或执行后做一些加工处理。使用过滤器可以避免Action方法的重复代码。

1.2、理解为什么要使用过滤器

假设你做了一个小项目，其中某个功能是操作管理用户信息模块，有这样一个需求，对用户信息管理必须是已通过认证的用户才能操作，我们可以在每一个Action方法里面检查认证请求，如下所示：

通过上面的代码，可以发现使用这种方式检查请求认证代码有许多重复的地方，这也就是为什么要使用过滤器的原因，使用过滤器可以实现相同的效果。如下所示：

过滤器是.NET里面的特性（Attributes），它提供了添加到请求处理管道的额外方法。这里使用Authorize过滤器可以实现同样的效果，不过代码就显然比之前更加简洁优雅。

1.3、理解注解属性

• 是派生于System.Attribute的特殊.NET类
• 可以被附加到其他代码元素（类、方法、属性、字段等）上
• 使用注解属性的目的：把附加信息嵌入到类的编译代码中，以便之后在运行时读取
• 语法：注解属性用方括号“[ ]”进行标识，而且可以用已命名参数为其public属性赋值（例如 [MyAttribute(oneP=value)]）
• C#编译器命名约定：注解属性名以“Attribute”结尾的，可以忽略，例如：[AuthorizeAttribute]可以写成[Authorize]

开发基于Asp.Net MVC框架的Web项目，面向应用系统的软件开发人员只需要在这个HTTP框架流程管道中挂接自己的代码（如在Controller中定义自己的Action）。框架的设计者为了给开发人员更多的接口，更多选择，所以定义很多Attribute供开发人员选择使用，来指定不同的框架功能。如下例子：

代码解释：当框架实际执行时，会通过反射发现存在[CheckInLogin]这个特性，然后动态决定行为，去执行用户定义的代码。这样做的好处是：通过Attribute机制将业务代码与权限代码很好的分离开发，代码更简洁，可理解性更强。如果没有这个特性的话，判断用户登录的代码就必须放在Action中完成，这样造成了不相关的代码耦合的在一起，使代码更难维护和阅读。

二、过滤器的使用

过滤器实现的机制：在MVC框架调用一个Action之前，它会检查方法的定义中是否实现了特性（Attributes），如果实现的话，那么在请求处理管道适当的位置，该特性定义的方法会被调用。通过注解属性将附加的逻辑步骤添加到请求处理管道。过程如下图：

2.1、基本类型的过滤器

ActionFilterAttribute类既实现了IactionFilter接口，也实现IResultFilter接口。这是一个抽象类，它要求你必须提供一个实现。AuthorizeAttribute和HandleErrorAttribute类，则包含了一些有用的特性，并且可以不必创建派生类进行使用。

2.2、过滤器的应用、应用方式以及执行顺序

• 可用于动作方法（方法级）-- Action
• 可用于控制器（控制器级）-- Controller
• 多个Filter可同时用
• 不同级别可以混搭
• 运用于基类的过滤器，会影响该基类的所有派生类

应用： 过滤器可以被应用到控制器上也可以用到Action方法上（仅此Action方法），应用到控制（Controller）上时，表示所有的Action方法都有了这个过滤器，并且可以混合使用，或多次使用，如下所示：

应用方式：特性的方式，如上面代码所示。

执行顺序：相同类型过滤器，执行顺序靠近方法的先执行，不同类型的过滤器一般执行顺序为【authorize（授权最先运行）--->action（然后执行方法）--->actionResult（方法结果在最后）】至于异常过滤器不分先后，只要抛出异常时就会执行异常过滤器。如果要调整执行顺序，可以通过调整Order方法值大小来控制执行顺序，值越小，越先执行。下图是Action/Result过滤器应用的执行顺序图：

过滤器执行顺序实例：

(1)、相同类型过滤器应用示例：两个自定义Action过滤器MyFirstFilter，MyThreeFilter应用到同一个Action方法Index上。-- 结果：相同类型过滤器，靠近方法的先执行！

Three控制器代码如下：

MyFirstFilter 代码如下：

MyThreeFilter代码如下：

运行结果如下：

(2)、不同类型过滤器应用示例：有一个自定义Action过滤器MyFirstFilter，有一个自定义Result过滤器MySecondFilter，应用到同一个Action方法Index上。

【authorize--->action--->actionResult】

Three控制器代码如下：

MyFirstFilter 代码如下：

MySecondFilter代码如下：

运行结果如下：

看完上面的解释，可能你现在对这些过滤器的执行顺序，以及如何自定义过滤器还不明白，不要紧，下面我们会逐一介绍这几个基本的过滤器的使用，以及如何自定义过滤器。

2.3、使用授权过滤器

所有实现了IAuthorizationFilter接口的都可以称之为授权过滤器:其定义如下：

Authorization过滤器是最先运行的过滤器，它运行在所有其他过滤器或者动作方法之前。

Authorization过滤器执行的是授权策略。

注意：验证与授权是两回事，验证发生在授权之前。

默认的授权过滤器已经有了验证的功能，其验证的机理是利用Asp.net平台自带的验证机制，如表单验证和Windows验证。除了验证功能，它本身还有授权的功能。授权过滤器是所有过滤器中最早运行的。

经过Route到达了控制器的时候，在调用Action之前，MVC框架会检测在相关的Action上是否有授权过滤器，如果有会调用OnAuthorization方法，如果此方法批准了请求，才会调用相应的Action。流程如图：

使用授权过滤器几种情况如下：

1.直接在Action上或者控制器上加Authorize，表示启用了验证，但不牵涉到授权。

2.添加Authorize(Users=“a,b”)]，表示启用了验证，并且也启用了授权，只有a或者b用户能访问此控制器。

3.当添加Authorize（Roles=“admin,Member”)]时的步骤如下：

---利用asp.net自带的角色提供者，或者实现自己的角色提供者，实现自己的角色提供者时，只需要集成RoleProvider类型，并实现其中的所有方法或部分方法，最好实现所有方法。

---在Web程序的根目录的Web.config文件中配置角色管理者。

---在适当的Action中利用Roles类型来访问自己创建的RoleProvider中的相关方法。

使用内置的授权过滤器

MVC框架内置的授权过滤器AuthorizeAttribute，它允许我们使用这个类的两个公共属性来指定授权策略，如下所示：

Users和Roles两者是并且的关系，例如Users=“a,b,c”,Roles=“admin”,表示用户是a，b,c 其中一个并且是Admin角色才能访问。

例子二：

只有同时满足用户名是“adam”、“ steve”或“ bob”并且具有 admin 角色的人才被授权访问该 方法。

对于大多数应用程序而言，AuthorizeAttribute提供的授权策略已经足够，但如果要想实现一些特殊的处理，可通过该类进行派生。

AuthorizeAttribute提供的两个定制点：

AuthorizeCore( )方法,实现授权检查。

HandleUnauthorizedRequest( )方法，在授权失败时调用。

创建自定义的授权过滤器

自定义的方法有两种：

• 创建 AuthorizeAttribute 类的子类
• 实现 IAuthorizationFilter 接口

创建授权过滤器最简单的办法是创建AuthorizeAttribute类的子类，AuthorizeAttribute类是系统内建的，通过创建AuthorizeAttribute类的子类实现定义授权过滤器，就是需要重写该类的AuthorizeCore()方法，签名为： bool AuthorizeCore(HttpContextBase httpContext)，代码如下所示：

自定义授权过滤器的使用：

2.4、使用动作过滤器

动作过滤器是可以以用于任何目的的多用途过滤器，创建自定义动作过滤器需要实现IActionFilter接口，该接口代码如下所示：

该接口定义了两个方法，MVC框架在调用动作方法之前，会调用OnActionExecting方法。在调用动作方法之后，则会调用OnActionExecuted方法。

实现OnActionExecting方法

参数ActionExecutingContext对象继承于ControllerContext，其中的2个属性：

ActionDescriptor：提供了关于Action方法的相关信息

Result：类型为ActionResult，通过给这个属性设置一个非null的值就可以取消这个请求。

我们可以用过滤器来取消一个请求，通过设置Result属性即可。代码如下所示：

这个例子通过用OnActionExecuting方法检查请求是否来自本地机器，如果是，编队用户返回一个“404”未找到的响应。运行结果如下图：

实现OnActionExecuted方法

我们也可以通过OnActionExecuted方法来执行一些跨越动作方法的任务，下面这个例子是计算动作方法运行的时间，代码如下：

我们将自定义的动作过滤器MyActionFilter应用到HomeController的Index方法上，运行结果如下：

2.5、使用结果过滤器

结果过滤器是多用途的过滤器，他会对动作方法所产生结果进行操作，结果过滤器实现IResultFilter接口，创建自定义结果过滤器需要现IResultFilter接口，该接口代码如下所示：

当结果过滤器运用于一个动作方法时，会在动作方法返回动作结果之前，调用OnResultExecuting方法，在返回动作结果之后，会调用OnResultExecuted方法。下面这个例子是计算动作方法返回结果运行的时间，代码如下：

我们将自定义的结果过滤器MyResultFilter应用到HomeController的Index方法上，运行结果如下：

需要注意的是：动作过滤器是运行在页面输出之前，结果过滤器是运行在页面输出之后。

2.6、使用异常过滤器

异常过滤器只有在调用一个动作方法而抛出未处理的异常才会运行，这种异常来自以下位置：

A、另一种过滤器（授权、动作、或结果过滤器）。

B、动作方法本身。

C、当动作结果被执行时。

使用内置的异常过滤器

HandleErrorAttribute(处理程序错误特性)，它是MVC内嵌的异常过滤器，有以下3个重要的属性：

1.ExceptionType：类型为Type，表示希望被此过滤器处理的异常类型，包括其子类型，默认值为System.Exception

2.View:类型为string，表示此过滤器呈递的视图页面，默认值为Error

3.Master：呈递的视图页的母板页，如果不指定，视图会用其默认的母版页

内嵌的HandleErrorException只有在配置文件Web.config中配置的CustomError 的mode设置为on的时候才生效（其默认模式为RemoteOnly）,如下图所示：

此过滤器还会给视图传递一个HandleErrorInfo类型的对象给视图，以便视图可以显示一些额外的关于错误的信息。下面是使用异常过滤器的示例。

应用到Index动作方法上：

在Views/Shared文件夹下添加一个显示异常信息的视图页SpecialError.cshtml,页面代码如下：

运行结果如下：

创建自定义的异常过滤器

如果我们对异常过滤器有特殊的需求，可以通过自定义的异常过滤器来完成，创建自定义异常过滤器必须实现IExceptionFilter接口，该接口代码如下：

当一个未知处理异常发生时，OnException方法会被调用。该方法的传递一个ExceptionContext对象，派生于ControllerContext类，定义了一些额外的过滤器专有属性如下表所示：

抛出的异常通过Exception属性是可以访问的。通过把ExceptionHandled属性设置为true,一个异常过滤器可以报告它已经处理了该异常，应用于一个动作的所有异常过滤器都会被调用。

需要注意的是：如果一个动作方法的所有异常过滤器均为把ExceptionHandled属性设置为true，MVC框架将使用默认的ASP.NET异常处理程序。

Result属性有异常过滤器使用，以告诉MVC框架要做什么，异常过滤器的两个主要应用是记录该异常到日志，并把适当的消息显示给用户。下面的代码将演示通过创建一个自定义的异常过滤器，当一个特定的钟类的未处理异常出现时，把该用户重定向到一个指定的错误页面。

然后在项目根目录添加一个名为Content的文件夹，在该文件夹下创建SpeciErrorPage.html文件，当异常被处理时，将以这个错误页面显示个用户。该页面代码如下：

在控制器中应用MyExection异常过滤器，并主动让其抛出一个空引用异常，以便测试。

运行结果如下：

总结：本文章简单总结了对过滤器的理解以及如何使用MVC框架内置基本的过滤器和如何自定义过滤器及应用。

以上就是本文的全部内容，希望对大家的学习有所帮助，如果有什么问题，可以在微信公众号后台留言，看到会及时回复！

参考文章：

https://www.jb51.net/article/107613.htm

本系列文章所有实例代码GitEE地址：

https://gitee.com/jahero/mvc