MVC四大筛选器—ActionFilter&ResultedFilter

AuthorizeFilter筛选器

在Action的执行中包括两个重要的部分,一个是Action方法本身逻辑代码的执行,第二个就是Action方法的筛选器的执行。

MVC4中筛选器都是以AOP(面向方面编程)的方式来设计的,通过对Action方法上标注相应的Attribute标签来实现。MVC4提供了四种筛选器,分别为:AuthorizationFilter、ActionFilter、ExceptionFilter和ResultFilter,他们分别对应了四个筛选器接口IAuthorizationFilter、IActionFilter、IExceptionFilter和IResultFilter。

这四种筛选器都有派生于一个公共的类FilterAttribute,该类指定了筛选器的执行顺序Order和是否允许多个应用AllowedMultiple。这四种筛选器默认的执行顺序为最先进行授权筛选,最后进行异常处理,中间则是ActionFilter和ResultedFilter。

下面是抽象类FilterAttribute的类图

 

下面我们来具体列举一下各个筛选器的作用和实现

从字面上我们就能看出这是对Controller或Action方法授权的筛选器,即在Controller或Action方法执行前,首先会先执行该筛选器,若通过,才会继续执行。下面是此筛选器的简单类图

 

AuthorizeAttribute为最终授权筛选器的实现者,它实现了IAuthorizationFilter接口和FilterAttribute抽象类,接口中的OnAuthorizationAuthorizationContext filterContext)方法是最终验证授权的逻辑(其中AuthorizationContext是继承了ControllerContext类)

[csharp] view plain copy
 

protected virtual bool AuthorizeCoreHttpContextBase httpContext)  
        {  
            if httpContext == null)  
            {  
                throw new ArgumentNullException“httpContext”);  
            }  
  
            IPrincipal user = httpContext.User;  
            if !user.Identity.IsAuthenticated)  
            {  
                return false;  
            }  
  
            if _usersSplit.Length > 0 && !_usersSplit.Containsuser.Identity.Name, StringComparer.OrdinalIgnoreCase))  
            {  
                return false;  
            }  
  
            if _rolesSplit.Length > 0 && !_rolesSplit.Anyuser.IsInRole))  
            {  
                return false;  
            }  
  
            return true;  
        }  

AuthorizeCore方法是最终OnAuthorization)方法调用的最终逻辑,从代码可以看出,当同时指定了users和roles时,两者只有同时满足条件时才可以验证授权通过。如

[csharp] view plain copy
 

[AuthorizeUsers=“zhangsan”, Roles=“Admin”)]  
       public ActionResult ActionMethod)  
       {  
       }  

则只有用户zhangsan,且用户属于Admin角色时才能验证授权通过。

若验证不通过时,OnAuthorization方法内部会调用HandleUnauthorizedRequest

虚方法进行处理,代码如下:

[csharp] view plain copy
 

protected virtual void HandleUnauthorizedRequestAuthorizationContext filterContext)  
        {  
            // Returns HTTP 401 – see comment in HttpUnauthorizedResult.cs.  
            filterContext.Result = new HttpUnauthorizedResult);  
        }  

该方法设置了参数上下文中ActionResult的值,用于供View展示。

我们可以自定义Authorize筛选器,由于OnAthurization)、AuthorizeCore)和HandleUnauthorizedRequest)方法都是虚方法,我们自定义的Authorize筛选器只需要继承AuthorizeAttribute类,重写以上三种方法,这样就可以自定义自己的验证规则和验证失败时的处理逻辑了。

IAuthorizationFilter还有其他类型的实现类,如RequireHttpsAttribute、ValidateInputAttribute都是实现了OnAuthorization)方法,来完成各自筛选器处理的。

ExceptionFilter过滤器

该筛选器是在系统出现异常时触发,可以对抛出的异常进行处理。所有的ExceptionFilter筛选器都是实现自IExceptionFilter接口  

[csharp] view plain copy
 

public interface IExceptionFilter  
    {  
        void OnExceptionExceptionContext filterContext);  
    }  

实现OnException方法来实现对异常的自定义处理

MVC4中实现了默认的异常处理机制,源码如下 

[csharp] view plain copy
 

public virtual void OnExceptionExceptionContext filterContext)  
        {  
            if filterContext == null)  
            {  
                throw new ArgumentNullException“filterContext”);  
            }  
            if filterContext.IsChildAction)  
            {  
                return;  
            }  
  
            // If custom errors are disabled, we need to let the normal ASP.NET exception handler  
            // execute so that the user can see useful debugging information.  
            if filterContext.ExceptionHandled || !filterContext.HttpContext.IsCustomErrorEnabled)  
            {  
                return;  
            }  
  
            Exception exception = filterContext.Exception;  
  
            // If this is not an HTTP 500 for example, if somebody throws an HTTP 404 from an action method),  
            // ignore it.  
            if new HttpExceptionnull, exception).GetHttpCode) != 500)  
            {  
                return;  
            }  
  
            if !ExceptionType.IsInstanceOfTypeexception))  
            {  
                return;  
            }  
  
            string controllerName = string)filterContext.RouteData.Values[“controller”];  
            string actionName = string)filterContext.RouteData.Values[“action”];  
            HandleErrorInfo model = new HandleErrorInfofilterContext.Exception, controllerName, actionName);  
            filterContext.Result = new ViewResult  
            {  
                ViewName = View,  
                MasterName = Master,  
                ViewData = new ViewDataDictionary<HandleErrorInfo>model),  
                TempData = filterContext.Controller.TempData  
            };  
            filterContext.ExceptionHandled = true;  
            filterContext.HttpContext.Response.Clear);  
            filterContext.HttpContext.Response.StatusCode = 500;  
  
            // Certain versions of IIS will sometimes use their own error page when  
            // they detect a server error. Setting this property indicates that we  
            // want it to try to render ASP.NET MVC’s error page instead.  
            filterContext.HttpContext.Response.TrySkipIisCustomErrors = true;  
        }  

Application_Start中将HandleErrorAttribute添加到全局筛选器GlobalFilterCollection中,系统即会对异常进行对应的处理。
我们现在实现一个自定义的异常处理筛选器,在处理完后记录异常信息至日志文件中  

[csharp] view plain copy
 

public class MyExceptionHandleAttribute : HandleErrorAttribute  
    {  
        public MyExceptionHandleAttribute)  
            : base)  
        {  
        }  
  
        public void OnExceptionExceptionContext filterContext)  
        {  
            base.OnExceptionfilterContext);  
            //记录日志  
            log.InfofilterContext.Exception);  
        }  
    }  

在GlobalFilterCollection添加MyExceptionHandleAttribute 即可使用自定义的异常筛选器来处理

ActionFilter筛选器

ActionFilter筛选器是在Action方法执行前后会触发,主要用于在Action执行前后处理一些相应的逻辑。ActionFilter的筛选器都继承于ActionFilterAttribute抽象类,而它实现了IActionFilter、IResultFilter和FilterAttribute类,结构如下

 

因此自定义ActionFilter筛选器只要继承ActionFilterAttribute,实现其中的方法即可。

我们来举一个简单的例子,获取Action方法的执行时长,代码如下

[csharp] view plain copy
 

public class DefaultController : Controller  
    {  
        [ActionExecTimeSpan]  
        public ActionResult DoWork)  
        {  
            return View);  
        }  
    }  
  
public class ActionExecTimeSpanAttribute : ActionFilterAttribute  
    {  
        private const string executeActionTimeKey = “ActionExecBegin”;  
  
        public override void OnActionExecutingActionExecutingContext filterContext)  
        {  
            base.OnActionExecutingfilterContext);  
            //记录开始执行时间  
            filterContext.HttpContext.Items[executeActionTimeKey] = DateTime.Now;  
        }  
  
        public override void OnActionExecutedActionExecutedContext filterContext)  
        {  
            //计算执行时间,并记录日志  
            if filterContext.HttpContext.Items.ContainsexecuteActionTimeKey))  
            {  
                DateTime endTime = DateTime.Now;  
                DateTime beginTime = Convert.ToDateTimefilterContext.HttpContext.Items[executeActionTimeKey]);  
                TimeSpan span = endTime – beginTime;  
                double execTimeSpan = span.TotalMilliseconds;  
                log.InfoexecTimeSpan + “毫秒”);  
            }  
            //  
            base.OnActionExecutedfilterContext);  
        }  
    }  

ResultFilter筛选器

ResultFilter筛选器是对Action方法返回的Result结果进行执行时触发的。它也分执行前和执行后两个段执行

所有的ResultFilter都实现了IResultFilter接口和FilterAttribute类,看一下接口定义

[csharp] view plain copy
 

public interface IResultFilter  
   {  
       void OnResultExecutingResultExecutingContext filterContext);  
  
       void OnResultExecutedResultExecutedContext filterContext);  
   }  

其中OnResultExecuting和OnResultExecuted方法分别是在Result执行前、后(页面展示内容生成前、后)触发。
使用ResultFilter筛选器最典型的应用就是页面静态化,我们以后在其他文章中在对此进行详细讲解

学习什么时候都不晚,从现在起我们一起

Published by

风君子

独自遨游何稽首 揭天掀地慰生平