MVC Action Filter

Action过滤器的执行顺序

每一个Action过滤器都有一个 Order 属性，用来决定Action过滤器在该范围内的执行顺序。Order属性必需是0(默认值)或者更大的整数值。省略Order属性则会给该过滤器的Order值为 -1, 表明为指明顺序。任何一个在同一范围的Action过滤器Order设为 -1 的都将按不确定的顺序执行，单在此之前过滤器有一个特定的顺序(注：下面会说到).

当设置Order属性的值的时候，必需指定一个唯一的值。如果两个或者更多的Action过滤器具有相同的Order属性值，将会抛出一个异常。

来看一个示例：

[Filter1(Order = 2)]
[Filter2(Order = 3)]
[Filter3(Order = 1)]
public void Index()
{
    RenderView("Index");
}

Filter的执行顺序为：Filter3 => Filter1 => Filter2.

内置过滤器简介

1OutputCacheAttribute

[OutputCache(Duration=10,VaryByParam="none")]
        public ActionResult TestCache() {
            ViewBag.Time = DateTime.Now.ToString();
            return View();
        }

上述代码在动作方法上设置了OutputCache特性，使得页面具有缓存功能，缓存10秒。Cache的属性也可在web.config中设置

<caching>
          <outputCacheSettings>
              <outputCacheProfiles>
                  <add name="outPutCache" duration="10" varyByParam="none"/>
              </outputCacheProfiles>
          </outputCacheSettings>
      </caching>

相应的动作方法上

[OutputCache(CacheProfile="outPutCache")]
        public ActionResult TestCache() {
            ViewBag.Time = DateTime.Now.ToString();
            return View();
        }

2 AuthorizeAttribute

该类主要实现页面的成员和角色管理，AuthorizeAttribute类中设置了两个属性，分别是Users和Roles，分别表示成员和角色

[Authorize]
        public ActionResult TestAuthorize()
        { 
            return View();
        }

上述动作方法上设置了Authorize特性，指明该动作方法只能是注册并通过认证的用户才能访问

[Authorize(Users="test1,test2")]
        public ActionResult TestAuthorize()
        { 
            return View();
        }

上述动作方法指明只有用户test1，test2能够访问，如果用户过多，可以将这些用户设置为一类角色，通过设置角色参数来设定

  [Authorize(Roles="Admin")]
        public ActionResult TestAuthorize()
        { 
            return View();
        }

上述动作方法指明只有角色为Admin的用户才能访问。

------------------------------------------------------------------------------------------------------------------------------------

一、自定义Filter

因此自定义过滤器可以选择适当的方法来重写方可。下面来举个简单的例子：检查登录状态的过滤器，没有登录则跳转到登录页

　　控制器代码：

        [CheckLogin]　　//此处为自定义属性，要引用相应的命名空间
        public ActionResult Index()
        {
            return View();
        }

        public ActionResult Login()　　　//此Action自动往cookie里写入登录信息
        {
            HttpCookie hcUserName = new HttpCookie("username","admin");
            HttpCookie hcPassWord = new HttpCookie("password","123456");
            System.Web.HttpContext.Current.Response.SetCookie(hcUserName);
            System.Web.HttpContext.Current.Response.SetCookie(hcPassWord);
            return View();
        }

　　过滤器代码

    public class CheckLogin : ActionFilterAttribute
    {
        //在Action执行之前　乱了点，其实只是判断Cookie用户名密码正不正确而已而已。
        public override void OnActionExecuting(ActionExecutingContext filterContext)
        {
            HttpCookieCollection CookieCollect = System.Web.HttpContext.Current.Request.Cookies;if (CookieCollect["username"] == null || CookieCollect["password"] == null)
            {
                filterContext.Result = new RedirectResult("/Home/Login");
            }
            else
            {
                if (CookieCollect["username"].Value != "admin" && CookieCollect["password"].Value != "123456")
                {
                    filterContext.Result = new RedirectResult("/Home/Login");
                }
            }
        }
    }//本示例贪图方便，将要跳转到的Action放在同一个Controller下了，如果将过滤器放到Controller类顶部，则永远也跳不到这个LoginAction。

　　此过滤器实现的效果是，当用户Cookie中用户名和密码不正确则跳转到登录页，注意过滤器也可以放在整个Controller类的顶部，表示该Controller下的所有Action都执行该项检查。这样一来，控制器里的代码非常漂亮，再也不用所有的Action里都充斥着判断登录的代码了。

二、带参数的自定义Filter

首先，还是按照之前添加自定义过滤器的方法，添加一个自定义过滤器，只是里面多了一个属性，代码如下：

    public class FilterAttribute : ActionFilterAttribute
    {
        public string Message { get; set; }

        public override void OnActionExecuting(ActionExecutingContext filterContext)
        {
            base.OnActionExecuting(filterContext);
            filterContext.HttpContext.Response.Write("Action执行之前" + Message + "<br />");
        }

        public override void OnActionExecuted(ActionExecutedContext filterContext)
        {
            base.OnActionExecuted(filterContext);
            filterContext.HttpContext.Response.Write("Action执行之后" + Message + "<br />");
        }

        public override void OnResultExecuting(ResultExecutingContext filterContext)
        {
            base.OnResultExecuting(filterContext);
            filterContext.HttpContext.Response.Write("返回Result之前" + Message + "<br />");
        }

        public override void OnResultExecuted(ResultExecutedContext filterContext)
        {
            base.OnResultExecuted(filterContext);
            filterContext.HttpContext.Response.Write("返回Result之后" + Message + "<br />");
        }
    }

　　然后在调用过滤器的时候，添加上该参数，Controller代码如下：

        [Filter(Message="刘备")]　　//参数给上
        public ActionResult Index()
        {
            return View();
        }

　　输出结果如下：

　　

 　　如果标签打到Controller上的话，TestFilterAttributeFilter将作用到Controller下的所有的Action。

　　默认情况下Action上打了某个自定义标签后，虽然在Controller上也打上了此标签，但它只有Action上的标签起作用了。
　　补充：如果Action没有打上该标签，那么Controller上的标签便会被执行。

 　　如果想让Action上的标签执行一次，然后Controller上的标签也执行一次，那么应该如何操作呢？

　　 我们只需在FilterAttribute类的定义上打上标记[AttributeUsage(AttributeTargets.All, AllowMultiple = true)]即可【下面类的最上面红色字体部分】，也就是让其成为可以多次执行的Action。代码如下：

    [AttributeUsage(AttributeTargets.All,AllowMultiple = true)]
    public class FilterAttribute : ActionFilterAttribute
    {
        public string Message { get; set; }
        ......

三、全局过滤器　　

　　有时我们想有些公共的方法需要每个Action都执行，但是又不想再每一个Controller上都打上Action标签，怎么办？幸好Asp。Net MVC3带来了一个美好的东西，全局Filter。而怎么注册全局Filter呢？答案就在Global.asax中。让我们看以下代码，我是如何将上面我们定义的TestFilterAttribute 注册到全局Filter中。

 　　　　public static void RegisterGlobalFilters(GlobalFilterCollection filters)
        {
            filters.Add(new HandleErrorAttribute());
            //注册全局过滤器
            filters.Add(new TestFilterAttribute() { Message="全局"});
        }

　　这样就每个Action都会执行此过滤器，而不必每个Controller顶部都加上标签。