1. 程式人生 > >ASP.NET MVC 入門9、Action Filter 與 內建的Filter實現(介紹)

ASP.NET MVC 入門9、Action Filter 與 內建的Filter實現(介紹)

本系列文章基於ASP.NET MVC Preview5.

有時候你想在呼叫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類同時實現上面的一個或幾個介面:

    publicclass MyFilter : FilterAttribute, IActionFilter, IResultFilter
    {

    這幾個介面提供的方法如下:

    image

    上圖的方法和Filter介面對應的方法按名稱對號入座就可以。

    IActionFilter

    介面有兩個方法:

    image

    其中OnActionExecuting在執行Action方法之前會被呼叫,OnActionExecuted會在Action方法執行後呼叫。注意他們的引數分別是ActionExecutingContext和ActionExecutedContext。

    ActionExecutedContext類包含一個 Canceled的屬性,允許你取消當前的Action(怎麼原來在P3中是在ActionExecutingContext的Canceled屬性在P5中沒有了呢?神奇.那麼在OnActionExecuting的時候怎麼取消一個Action呢?)。

    FilterExcuted

    Context 類包含一個Exception屬性和一個ExceptionHandled屬性。如果Exception屬性為null,則沒有異常在action stack中,表明Action方法執行並沒有發生錯誤。反之則為出現異常。如果將ExceptionHandled屬性設定為true則表明在這個Filter中已經處理了異常。

    IResultFilter介面也提供了兩個方法:

    image

    他們分別在Action返回結果(例如return View();)之前和之後執行。和IActionFilter差不多就不多說了。

    IAuthorizationFilter是一個用於身份驗證的Filter。只提供了一個void OnAuthorization(AuthorizationContext filterContext)方法。

    IExceptionFilter會在出現異常的時候呼叫,也是隻 提供一個void OnException(ExceptionContext filterContext)的方法;

    這些Filter可以被應用在類或者方法上,下面我們來看一下他們的執行順序。首先我們寫一個BaseController並加上兩個Filter:

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

    應為Controller類是實現這幾個Filter介面的,所以我們在HomeController中重寫Controller基類中的所有Filter介面的方法,並在HomeController類和裡面的Filter方法加上我們自定義的MyFilter:

    HomeController

    然後我們執行一下看看結果如何:

    image

    從執行結果我們可以看到,在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)]
    publicvoid Index()
    {
        RenderView(
    "Index");

    Filter的執行順序為:Filter3 => Filter1 => Filter2.

    暫時就寫這麼多吧,這一部分主要介紹概念。Enjoy!Post by Q.Lee.lulu

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