学步园

概述

在 ASP.NET MVC 中，控制器将定义一些操作方法，这些操作方法与可能的用户交互（如单击链接或提交窗体）之间通常具有一一对应关系。 例如，当用户单击链接时，会将请求路由到指定的控制器，然后调用对应的操作方法。 例如操作完成后你要产生日志、语言筛选、等其他动态操作。

筛选器的由来及用途

有时，您需要在调用操作方法之前或运行操作方法之后执行逻辑。

为了对此提供支持，ASP.NET MVC 提供了筛选器。 筛选器是自定义类，可提供用于向控制器操作方法添加操作前行为和操作后行为的声明性和编程性手段。

ASP.NET MVC 筛选器的类型

ASP.NET MVC 支持以下类型的操作筛选器：

• 授权筛选器。 这些筛选器用于实现 IAuthorizationFilter 和做出关于是否执行操作方法（如执行身份验证或验证请求的属性）的安全决策。 AuthorizeAttribute 类和 RequireHttpsAttribute 类是授权筛选器的示例。 授权筛选器在任何其他筛选器之前运行。

• 操作筛选器。 这些筛选器用于实现 IActionFilter 以及包装操作方法执行。 IActionFilter 接口声明两个方法：OnActionExecuting 和 OnActionExecuted。 OnActionExecuting 在操作方法之前运行。 OnActionExecuted 在操作方法之后运行，可以执行其他处理，如向操作方法提供额外数据、检查返回值或取消执行操作方法。

• 结果筛选器。 这些筛选器用于实现 IResultFilter 以及包装 ActionResult 对象的执行。 IResultFilter 声明两个方法：OnResultExecuting 和 OnResultExecuted。 OnResultExecuting 在执行 ActionResult 对象之前运行。 OnResultExecuted 在结果之后运行，可以对结果执行其他处理，如修改
  HTTP 响应。 OutputCacheAttribute 类是结果筛选器的一个示例。

• 异常筛选器。 这些筛选器用于实现 IExceptionFilter，并在
  ASP.NET MVC 管道执行期间引发了未处理的异常时执行。 异常筛选器可用于执行诸如日志记录或显示错误页之类的任务。HandleErrorAttribute 类是异常筛选器的一个示例。

ASP.NET MVC提供的筛选器

筛选器运行顺序

筛选器按下列顺序运行：

1. 授权筛选器

2. 操作筛选器

3. 响应筛选器

4. 异常筛选器

例如，授权筛选器最先运行，异常筛选器最后运行。 在每个筛选器类型中，Order 值将指定运行顺序。 在每个筛选器类型和顺序中，Scope 模拟值将指定筛选器的顺序。 此枚举将定义以下筛选器范围值（按它们运行的顺序）：

1. First

2. Global

3. Controller

4. Action

5. Last

例如，其 Order 属性设置为
0 且筛选器范围设置为 First 的操作筛选器将在其 Order 属性设置为
0 且筛选器范围设置为 Action 的操作筛选器之前运行。

未定义具有相同类型、顺序和范围的筛选器的执行顺序。

取消筛选器的执行

我们可以将 Result 属性设置为非 null 值，程序运行在 OnActionExecuting 和 OnResultExecuting 方法中会取消筛选器执行。 任何挂起的 OnActionExecuted 和 OnActionExecuting筛选器都不会调用，且调用程序不会为取消的筛选器和挂起的筛选器调用 OnActionExecuted 方法。 上次运行的筛选器的 OnActionExecuted 筛选器将会运行。 所有 OnResultExecuting和 OnResultExecuted 筛选器都会运行。

实例：创建自定义操作筛选器 

回顾一下ASP.NET MVC 操作筛选器的执行顺序，框架将先调用操作筛选器的 OnActionExecuting 方法，然后再调用以操作筛选器特性标记的任意操作方法。 同样，该框架将在操作方法完成后调用 OnActionExecuted 方法。

调用 OnResultExecuting 方法后，要立即调用您的操作返回的 ActionResult 实例。 执行结果后，紧接着就要调用 OnResultExecuted 方法。 这些方法对于执行日志记录、缓存输出结果之类的操作非常有用。

创建一个名为LoggingFilterAttribute的类

跟上面所说一样该类继承了ActionFilterAttribute表示操作特性的基类。

代码

    public class LoggingFilterAttribute : ActionFilterAttribute
    {
        public override void OnActionExecuting(ActionExecutingContext filterContext)
        {
            //可以自行添加一些控制代码
            filterContext.Controller.ViewData["mess1"] = "正要加载" + filterContext.ActionDescriptor.ActionName + "方法";

            base.OnActionExecuting(filterContext);
        }

        public override void OnActionExecuted(ActionExecutedContext filterContext)
        {
            //可以自行添加一些控制代码
            filterContext.Controller.ViewData["mess2"] = filterContext.ActionDescriptor.ActionName + "方法加载完毕";

            base.OnActionExecuted(filterContext);
        }
    }

此处我们只是设置了两个值，放在页面上做对照，完全可以换成日志功能。

调用操作筛选器 

在Controller中新建Index方法在上面加上刚刚定义的筛选标志[LoggingFilter]

        //
        // GET: /Person/
        [LoggingFilter]
        public ActionResult Index()
         {
             ViewData["mess1"] = "mess1";
             ViewData["mess2"] = "mess2";
            return View(GetData());
        }

View代码

        <h2>@ViewData["mess1"]</h2>
        <h2>@ViewData["mess2"]</h2>

运行效果

这一结果完全验证了，筛选器的工作顺序。OnActionExecuting-->Action-->OnActionExecuted

如果有多个筛选的话我们可以用Order来将他们一一列出顺序。默认Order为-1.

        //
        // GET: /Person/
        [LoggingFilter(Order = 1)]
        [LoggingFilter1(Order = 0)]
        public ActionResult Index()
         {
             ViewData["mess1"] = "mess1";
             ViewData["mess2"] = "mess2";
            return View(GetData());
        }

这样就会先执行LoggingFilter1后执行LoggingFilter。

对指定的控制器采用不同的筛选

在ASP.NET MVC Controller 类中我们可以重写的 OnActionExecuting 和 OnActionExecuted 方法。

这样重写这些方法中的一个或全部时，我们的逻辑将在该控制器的所有操作方法之前或之后执行。 此功能类似于操作筛选器，但方法局限于控制器范围。

此时我们就不需要单独去在Action上面去调用他了，因为该Controller 中的筛选已经被重写。并且仅属于该Controller 。

代码

        [NonAction]
        protected override void OnActionExecuting(ActionExecutingContext filterContext)
        {
            //可以自行添加一些控制代码
            filterContext.Controller.ViewData["mess1"] = "正要加载" + filterContext.ActionDescriptor.ActionName + "方法";
            base.OnActionExecuting(filterContext);
        }

        [NonAction]
        protected override void OnActionExecuted(ActionExecutedContext filterContext)
        {
            //可以自行添加一些控制代码
            filterContext.Controller.ViewData["mess2"] = filterContext.ActionDescriptor.ActionName + "方法加载完毕";
            base.OnActionExecuted(filterContext);
        }

运行效果与上面的一样

总结

有了筛选器我们的程序变的完美了，权限、操作、响应、异常这一系列的问题都完全被我们自己掌控，成为我们自己的规则，程序可控性更高。