MVC中的自定义过滤器

过滤器的类型

ASP.NET MVC 框架支持以下几种过滤器:
    1、Authorization 过滤器– 实现了 IAuthorizationFilter 接口。这一类的过滤器用来实现用户验证和对Action的访问授权。比如Authorize 就属于Authorization 过滤器。
    2、Action 过滤器– 实现了 IActionFilter 接口。它可以包含一些Action执行前或者执行后的逻辑,比如有一些过滤器专门用来修改Action返回的数据。
    3、Result 过滤器– 实现了 IResultFilter 接口。它可以包含一些view result生成前或者生成后的逻辑,比如有一些过滤器专门用来修改视图向浏览器展现前的结果。
    4、Exception 过滤器– 实现了IExceptionFilter 接口。它用以用来处理Action或者Result的错误,也可以记录错误。
    过滤器的默认执行顺序也和上面的列表相同,比如Authorization 过滤器会先于Action 过滤器执行,而Exception 过滤器总会在最后执行。当然你也可以根据需要通过Order属性设定过滤器执行的顺序。

自定义过滤器
    自定义过滤器必须继承System.Web.Mvc.FilterAttribute ,并且实现上述几个接口中的一个或者多个。MVC框架为了方便开发人员,预定义了一个ActionFilterAttribute 类,它已实现了IActionFilter 和IResultFilter 接口。你可以重载   ActionFilterAttribute 类中以下几个方法:
  OnActionExecuting – 在Action执行之前调用。 
  OnActionExecuted – 在Action执行之后调用。 
  OnResultExecuting – 在Result产生之前调用。 
  OnResultExecuted – 在Result产生之前调用。 



要实现一个Filter,我们需要继承自FilterAttribute类同时实现上面的一个或几个接口:

public class MyFilter : FilterAttribute, IActionFilter, IResultFilter
{
}

这几个接口提供的方法如下:


上图的方法和Filter接口对应的方法按名称对号入座就可以。

IActionFilter接口有两个方法:


其中OnActionExecuting在执行Action方法之前会被调用,OnActionExecuted会在Action方法执行后调用。注意他们的参数分别是ActionExecutingContext和ActionExecutedContext。

ActionExecutedContext类包含一个 Canceled的属性,允许你取消当前的Action(怎么原来在P3中是在ActionExecutingContext的Canceled属性在P5中没有了呢?神奇.那么在OnActionExecuting的时候怎么取消一个Action呢?)。

FilterExcutedContext 类包含一个Exception属性和一个ExceptionHandled属性。如果Exception属性为null,则没有异常在action stack中,表明Action方法运行并没有发生错误。反之则为出现异常。如果将ExceptionHandled属性设置为true则表明在这个Filter中已经处理了异常。

IResultFilter接口也提供了两个方法:


他们分别在Action返回结果(例如return View();)之前和之后执行。和IActionFilter差不多就不多说了。

IAuthorizationFilter是一个用于身份验证的Filter。只提供了一个void OnAuthorization(AuthorizationContext filterContext)方法。

IExceptionFilter会在出现异常的时候调用,也是只 提供一个void OnException(ExceptionContext filterContext)的方法;


  • 同时FilterAttribute还提供了一个Order的属性,用于指定Filter的执行顺序

  • 每一个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.



    关于异常:

    如果在执行IActionFilterIResultFilter的代码时异常了怎么办?拿IActionFilter作说明,书中有这样一张图:

    image

     

    这张图给了我们这样的信息,一个Action上面加了3层IActionFilter,当第三层的OnActionExecuting抛出异常后,被第二层的OnActionExecuted捕获了,而且继续执行第一层的OnActionExecuted。其中跳过了ActionMethod和第三层的OnActionExecuted。

    IResultFilter实际上跟IActionFilter的行为完全相同。

    另外,Response.Redirect()方法将抛出ThreadAbortException异常,MVC自行捕获了这种特殊的异常,使得这种异常实际上不会影响我们,我们大可假装对此完全不知。下面的代码和注释是从InvokeActionMethodFilter方法中截取的,说明了MVC框架在这里的“用心良苦”。



    示例代码

     public class FilterTest : ActionFilterAttribute
        {
            public string OPName = string.Empty;
            public string Memo = string.Empty;

            public override void OnActionExecuting(ActionExecutingContext filterContext)
            {
                string a = filterContext.ActionDescriptor.ActionName;
                string b = filterContext.ActionDescriptor.ControllerDescriptor.ControllerName;
                var temp = filterContext.ActionParameters;

            }
             
        }




    [IOF.AppMobile.Mobile.FilterTest(OPName = "testName",Memo = "wj memo")]
            public ActionResult Test(string name, int age, [ModelBinder(typeof(JSONModelBinder<IOF.Common.InnerService.AppMobileService.Phone>))]IOF.Common.InnerService.AppMobileService.Phone phone)
            {
                string a = name + "ccc";
                return Json(new { Data = 0, isSuccess = true }, "text/json", JsonRequestBehavior.AllowGet);
            }


  • 0
    点赞
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值