首页 > 代码库 > ASP.NET MVC 入门9、Action Filter 与 内置的Filter实现(介绍)

ASP.NET MVC 入门9、Action Filter 与 内置的Filter实现(介绍)

原帖地址:http://www.cnblogs.com/QLeelulu/archive/2008/10/09/1307660.html

有时候你想在调用action方法之前或者action方法之后处理一些逻辑。为了支持这个。ASP.NET MVC同意你创建action过滤器。Action过滤器是自己定义的Attributes。用来标记加入Action方法之前或者Action方法之后的行为到控制器类中的Action方法中。

一些可能用到Action过滤器的地方有:

  • 日志,异常处理
  • 身份验证和授权 - 限制用户的訪问
  • 输出缓存 - 保存一个Action的结果
  • 网络爬虫的过滤
  • 本地化
  • 动态Action - 将一个Action注入到控制器中

ASP.NET MVC为我们提供了以下的几个Filter接口:

  • IActionFilter
  • IAuthorizationFilter
  • IExceptionFilter
  • IResultFilter

    要实现一个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)的方法;

    这些Filter能够被应用在类或者方法上。以下我们来看一下他们的运行顺序。

    首先我们写一个BaseController并加上两个Filter:

    [MyFilter2(Target = "BaseController")]
    [MyFilter1(Target
    ="BaseController")]
    public class BaseController : Controller

     

    应为Controller类是实现这几个Filter接口的,所以我们在HomeController中重写Controller基类中的全部Filter接口的方法,并在HomeController类和里面的Filter方法加上我们自己定义的MyFilter:

    技术分享HomeController

    然后我们执行一下看看结果怎样:

    技术分享

    从执行结果我们能够看到。在Controller中重写的Filter会最先执行,然后到应用在类上的Filter。然后再到应用在类方法上的Filter。

    而4个接口的方法运行顺序例如以下:IAuthorizationFilter -> IActionFilter -> IResultFilter -> IExceptionFilter .

    而对于同一个Filter。比如IAuthorizationFilter在MyFilter1和MyFilter2里里面的实现,又依据他们的载入顺序不同而不同。

    在BaseController中应用的Filter会被子类继承。假设子类又应用了和基类相同的Filter。则会不运行基类的Filter。比如上面的HomeController应用了MyFilter2,所以调用HomeController的MyFilter2。而不是BaseController的MyFilter2。

    这个运行顺序还得大家好好研究才干了解的。

    同一时候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.


  • ASP.NET MVC 入门9、Action Filter 与 内置的Filter实现(介绍)