ASP.NET MVC的Action Filter

一年前写了一篇短文ASP.NET MVC Action Filters，整理了Action Filter方面的资源，本篇文章详细的描述Action Filter。Action Filter作为一个可以应用到Controller Action（或者是整个controller）上的属性（Attribute），改变Action执行的行为，当应用于整个Controller上时，Controller上的所有Action都应用了同样设置的Action。 使用Action Filter 可以处理缓存、 验证和错误处理您的操作使用声明性编程模型的行为。

ASP.NET MVC Framework支持四种不同类型的Filter：

1. Authorization filters – 实现IAuthorizationFilter接口的属性.
2. Action filters – 实现IActionFilter接口的属性.
3. Result filters – 实现IResultFilter接口的属性.
4. Exception filters – 实现IExceptionFilter接口的属性.

Filter的默认的执行顺序按上面的列表中顺序进行。如验证(authorization）Filter永远都是最开始执行的，异常（exception）Filter永远都是最后执行的，当然你也可以根据需要通过Order属性设定过滤器执行的顺序。

ASP.NET MVC Framework包括几种Action Filter：

验证（authorization）filter用于实现在controller action上的验证和授权，如Authorize filter就是一个验证filter的例子；

Action filter包含一些逻辑，用于该action执行之前或者之后。比如可以使用一个action filter来修改action返回的view data；

Result filter包含一些逻辑，用于该action的view result执行之前和之后。比如可以修改一个view result在view被呈现到浏览器之前；

异常（Exception）Action用于处理异常信息，同样可以使用异常filter记录错误日志。

你同时可以创建自己的Action filter，比如说要实现一个自定义的验证系统，那么可能需要创建一个自定义的action filter，或者说当你需要改变controller action返回的view data的时候，也可以通过创建自定义action filter实现。

为了让用户更简单的创建一个自定义Action filter，ASP.NET MVC Framework提供了一个基类ActionFilterAttribute，这个类实现了IActionFilter和IResultFilter接口，并且继承了FilterAttribute类。从广义上来说，在ASP.NET MVC Framework中，任何实现filter的类型都是action filter。

ActionFilterAttribute类有以下的方法可以重写：

• OnActionExecuting – 在controller action执行之前调用
• OnActionExecuted – 在controller action执行之后调用
• OnResultExecuting – 在controller action result执行之前调用
• OnResultExecuted – 在controller action result执行之后调用

执行的顺序如下图：

下面我们来介绍一个如何自定义一个Action Filter，这个示例的代码来自ASP.NET MVC 2示例Tailspin Travel，实现的功能是Action的执行时间，页面经常需要一个当前页面执行时间的功能，这是一个非功能性需求，ASP.NET MVC上就可以使用自定义的ActionFilter来实现，从上面的介绍，就知道我们需要重写OnActionExecuting和OnActionExecuted方法，代码如下：

namespace Microsoft.Samples.Tailspin.Web  {      using System.Configuration;      using System.Diagnostics;      using System.Globalization;      using System.Web.Mvc;

    public class ExecutionTimingAttribute : ActionFilterAttribute      {          private bool timingEnabled = bool.Parse(ConfigurationManager.AppSettings["TimingEnabled"]);          private Stopwatch timer;

        public override void OnActionExecuting(ActionExecutingContext filterContext)          {              base.OnActionExecuting(filterContext);              if (this.timingEnabled)              {                  this.timer = new Stopwatch();                  this.timer.Start();              }          }

        public override void OnActionExecuted(ActionExecutedContext filterContext)          {              base.OnActionExecuted(filterContext);              if (this.timingEnabled)              {                  this.timer.Stop();                  Trace.WriteLine(string.Format(CultureInfo.InvariantCulture, "Action execution time: {0}ms", this.timer.ElapsedMilliseconds));                  if (filterContext.Result is ViewResult)                  {                      ((ViewResult)filterContext.Result).ViewData["ExecutionTime"] = this.timer.ElapsedMilliseconds;                  }              }          }      }  }

通过一个配置项是否启用页面执行时间的控制，代码非常简单，使用Stopwatch来进行时间的计算，将执行的时间（毫秒为单位）存放到ViewData里ViewData["ExecutionTime"] 。  在MasterPage里头尾部加入：

<div id="footer">          <% if(ViewData.ContainsKey("ExecutionTime")) { %>              <p>Execution Time: <%:ViewData["ExecutionTime"]%> ms.</p>          <%} %>      </div>

參考

Creating Custom Action Filters

Understanding Action Filters

asp.MVC 权限设计