MVC过滤器详解和示例

MVC过滤器一共分为四个：ActionFilter（方法过滤器），ResultFilter（结果过滤器，感觉不是很好听，就这样叫吧），AuthorizationFilter（授权过滤器），ExceptionFilter（异常处理过滤器）

过滤器类型	接口	默认实现	描述
Action	IActionFilter	ActionFilterAttribute	在动作方法之前及之后运行
Result	IResultFilter	ActionFilterAttribute	在动作结果被执行之前和之后运行
AuthorizationFilter	IAuthorizationFilter	AuthorizeAttribute	首先运行，在任何其它过滤器动作方法之前运行
Exception	IExceptionFilter	HandleErrorAttribute	只在另外一个过滤器，动作方法，动作结果弹出异常时运行

示例：Action方法过滤器

/// <summary>
    /// Action方法 过滤器 类
    /// </summary>
    public class MyActionFilterAttribute : ActionFilterAttribute
    {
        /// <summary>
        /// 在  Action方法之前 调用
        /// </summary>
        /// <param name="filterContext"></param>
        public override void OnActionExecuting(ActionExecutingContext filterContext)
        {
            //1. RouteData 中 保存了 当前请求 匹配的 路由信息和路由对象
            //             如果本次请求 是请求了某个 区域 里的 控制器方法，还可以通过filterContext.RouteData.DataTokens["area"]获取区域名

            //string strArea = filterContext.RouteData.DataTokens["area"].ToString();
            string strController = filterContext.RouteData.Values["controller"].ToString();
            string strAction = filterContext.RouteData.Values["action"].ToString();
            //filterContext.RouteData.GetRequiredString

            //2.另一种方式 获取 请求的 类名和方法名
            string strAction2 = filterContext.ActionDescriptor.ActionName;
            string strController2 = filterContext.ActionDescriptor.ControllerDescriptor.ControllerName;

            //2.1检查 被请求方法 是否 加了 MoneyAttribute 特性
            if (filterContext.ActionDescriptor.IsDefined(typeof(Filters.MoneyAttribute), false))
            {
                //直接为 请求 设置 返回结果，而不执行 对应的 Action 方法，也不执行 OnActionExcuted，但是，会执行 Result过滤器和 生成视图
                filterContext.Result = new ContentResult() { Content = "<br/>哈哈哈，直接被跳过了吧~~~！<br/>" };
            }   

            filterContext.HttpContext.Response.Write("哇哈哈哈~！OnActionExecuting<br/>");
            base.OnActionExecuting(filterContext);
        }

        /// <summary>
        /// 在  Action方法之后 调用
        /// </summary>
        /// <param name="filterContext"></param>
        public override void OnActionExecuted(ActionExecutedContext filterContext)
        {
            filterContext.HttpContext.Response.Write("哇哈哈哈~！OnActionExecuted<br/>");
            base.OnActionExecuted(filterContext);
        }

使用方法1：将过滤器加到方法上

 [Filters.MyActionFilter]//1.将 过滤器 加到方法上
        [Filters.Money]
        [Filters.MyResultFilter]
        [Filters.MyAuthorize]
        public ActionResult Index()
        {
            Response.Write("Index 方法<br/>");
            ViewBag.name = "时间：" + DateTime.Now;
            return View();
        }

使用方法2：将过滤器加到方类上

[Filters.MyActionFilter]
    public class HomeController : Controller
    {
    }

使用方法3：添加全局过滤器，即添加到FilterConfig.cs中

 public class FilterConfig
    {
        public static void RegisterGlobalFilters(GlobalFilterCollection filters)
        {
            //filters.Add(new HandleErrorAttribute());

            //3. 添加全局过滤器
            filters.Add(new Filters.MyActionFilterAttribute());

            filters.Add(new Filters.MyHandleErrorAttribute());
        }
    }

示例：Result过滤器

 /// <summary>
    /// Result 过滤器 类 - 如果请求的是 要加载视图的 Action 方法的话
    ///                   在 视图加载 前 后 调用方法
    /// </summary>
    public class MyResultFilterAttribute:System.Web.Mvc.ActionFilterAttribute
    {
        /// <summary>
        /// 加载 "视图" 前执行
        /// </summary>
        /// <param name="filterContext"></param>
        public override void OnResultExecuting(System.Web.Mvc.ResultExecutingContext filterContext)
        {
            filterContext.HttpContext.Response.Write("加载 视图 前执行 OnResultExecuting <br/>");
            base.OnResultExecuting(filterContext);
        }

        /// <summary>
        /// 加载"视图" 后执行
        /// </summary>
        /// <param name="filterContext"></param>
        public override void OnResultExecuted(System.Web.Mvc.ResultExecutedContext filterContext)
        {
            filterContext.HttpContext.Response.Write("加载 视图 后执行 OnResultExecuted <br/>");
            base.OnResultExecuted(filterContext);
        }
    }

示例：授权过滤器 - 在 Action过滤器前 执行

/// <summary>
    /// 授权过滤器 - 在 Action过滤器前 执行
    /// </summary>
    public class MyAuthorizeAttribute:AuthorizeAttribute
    {
        public override void OnAuthorization(AuthorizationContext filterContext)
        {
            filterContext.HttpContext.Response.Write("<br/>OnAuthorization<br/>");
            //注释掉 父类方法，因为 父类里的 OnAuthorization 方法会 调用 asp.net的授权验证机制！
            //base.OnAuthorization(filterContext);
        }
    }

示例：Exception过滤器

/// <summary>
    /// 异常处理 过滤器
    /// </summary>
    public class MyHandleErrorAttribute : HandleErrorAttribute
    {
        public override void OnException(ExceptionContext filterContext)
        {
            //1.获取异常对象
            Exception ex = filterContext.Exception;
            //2.记录异常日志
            //3.重定向友好页面
            filterContext.Result = new RedirectResult("~/error.html");
            //4.标记异常已经处理完毕
            filterContext.ExceptionHandled = true;

            base.OnException(filterContext);
        }
    }