詳解ASP.NET MVC的篩選器

在ActionInvoker對Action的執行過程中，除了通過利用ActionDescriptor對Action方法的執行，以及之前進行的Model綁定與驗證之外，還具有一個重要的工作，那就是對相關篩選器（Filter）的執行。ASP.NET MVC的篩選器是一種基於AOP（面向方面編程）的設計，我們將一些非業務的邏輯實現在相應的篩選器中，然後以一種橫切（Crosscutting）的方式應用到對應的Action方法。當Action方法執行前後，這些篩選器會自動執行。ASP.NET MVC提供了四種類型的篩選器（AuthorizationFilter、ActionFilter、ResultFilter和ExceptionFilter），它們對應著相應的篩選器介面（IAuthorizationFilter、IActionFilter、IResultFilter和IExceptionFilter）。[本文已經同步到《How ASP.NET MVC Works?》中]

目錄

一、Filter

二、FilterProvider

三、FilterAttribute與FilterAttributeFilterProvider

四、Controller與ControllerInstanceFilterProvider

五、GlobalFilterCollection

六、執行個體示範：驗證Filter的提供機制和執行順序

一、Filter

雖然ASP.NET MVC提供的四種類型的篩選器具有各自實現的介面，但是對於篩選器的提供體系來說所有的篩選器都通過具有如下定義的Filter類型表示。Filter的核心是Instance屬性，因為它代表真正實施篩選功能的對象，該對象實現了一個或者多個基於上述四種篩選器類型的介面。

public class Filter{   public const int DefaultOrder = -1;   public Filter(object instance, FilterScope scope, int? order);     public object Instance { get; protected set; }  public int Order { get; protected set; }  public FilterScope Scope { get; protected set; }}public enum FilterScope{  Action    = 30,  Controller  = 20,  First     = 0,  Global    = 10,  Last     = 100}

註：由於System.Web.Mvc.Filter和實現了IAuthorizationFilter、IActionFilter、IResultFilter和IExceptionFilter的類型均可以被稱為“篩選器”，為了不至於造成混淆，在沒有做明確說明的情況下，我們使用英文“Filter”和中文“篩選器”分別來表示它們。

Filter的Order和Scope屬性最終決定了篩選器的執行順序。Order屬性對應數值越小，執行的優先順序越高，該屬性的預設值為-1（對應著Filter中定義的常量DefaultOrder）。如果兩個Filter具有相同的Order屬性值，那麼Scope屬性最終決定哪個被優先執行。Filter的Scope屬性類型是一個類型為FilterScope的枚舉。該枚舉表示應用Filter的範圍，Action和Controller代表Action方法和Controller類層級；First和Last意味著希望被作為第一個和最後一個Filter來執行；Global代表一個全域的Filter。

通過上面的代碼片斷我們可以看到FilterScope的5個枚舉選項均被設定了一個值，這個值決定了Filter的執行順序，具有更小的枚舉值會被優先執行。從FilterScope的定義可以得到這樣的結論：對於具有相同Order屬性值的多個Filter，應用在Controller上的Filter比應用在Action方法上的Filter具有更高的執行優先順序，而一個全域的Filter的執行優先順序又高於基於Action的Filter。

二、FilterProvider

Filter的提供機制與之前我們介紹的基於ModelBinder和ModelValidator的提供機制比較類似，均是通過相應的Provider來提供的。提供篩選器的FilterProvider實現了介面IFilterProvider，如下面的代碼片斷所示，該介面定義了唯一的方法GetFilters根據指定的Controller上下文和用於描述目標Action的ActionDescriptor對象擷取一個Filter對象集合。

public interface IFilterProvider{   IEnumerable<Filter> GetFilters(ControllerContext controllerContext, ActionDescriptor actionDescriptor);}

我們可以通過靜態類型FilterProviders註冊或者擷取當前應用使用的FilterProvider。如下面的代碼片斷所示，FilterProviders具有一個類型為FilterProviderCollection的唯讀屬性Providers，表示基於整個Web應用範圍內被使用的FilterProvider列表。FilterProviderCollection是元素類型為IFilterProvider的集合，GetFilters方法用於或者該集合中所有FilterProvider對象提供的Filter對象。

public static class FilterProviders{   public static FilterProviderCollection Providers { get; }}public class FilterProviderCollection : Collection<IFilterProvider>{    //其他成員  public IEnumerable<Filter> GetFilters(ControllerContext controllerContext, ActionDescriptor actionDescriptor); }

ASP.NET MVC提供了三種原生的FilterProvider，分別是FilterAttributeFilterProvider、ControllerInstanceFilterProvider和GlobalFilterCollection，接下來我們對它們進行單獨介紹。

三、FilterAttribute與FilterAttributeFilterProvider

我們通常將篩選器定義成特性以聲明的方式應用到Controller類型或者Action方法上，而抽象類別型FilterAttribute是所有篩選器的基類。如下面的代碼片斷所示，FilterAttribute特性實現了IMvcFilter介面，該介面定義了Order和AllowMultiple兩個唯讀屬性，分別用於控制篩選器的執行順序以及多個同類的篩選器能夠同時應用到同一個目標元素（類或者方法）。

[AttributeUsage(AttributeTargets.Method | AttributeTargets.Class, Inherited=true, AllowMultiple=false)]public abstract class FilterAttribute : Attribute, IMvcFilter{   protected FilterAttribute();     public bool AllowMultiple { get; }  public int Order { get; set; }}public interface IMvcFilter{   bool AllowMultiple { get; }  int Order { get; }}

從應用在FilterAttribute上的AttributeUsageAttribute的定義可以看出該特性可以應用在類型和方法上，這意味著篩選器一般都可以應用在Controller類型和Action方法上。唯讀屬性AllowMultiple實際上返回的是AttributeUsageAttribute的同名屬性，通過上面的定義我們可以看到預設情況下該屬性值為False。

用於描述Controller和Action的ControllerDescriptor和ActionDescriptor均實現了ICustomAttributeProvider介面，我們可以直接利用它們擷取應用在對應的Controller類型或者Action方法上包括FilterAttribute在內的所有特性。實際上，這兩個描述類型提供了單獨的方法GetFilterAttributes專門用於擷取FilterAttribute特性列表。如下面的代碼片斷所示，該方法具有一個布爾類型的參數useCache，表示是否需要對解析出來的FilterAttribute特性進行緩衝以緩解頻繁的反射操作對效能造成的影響。

public abstract class ControllerDescriptor : ICustomAttributeProvider, IUniquelyIdentifiable{  //其他成員  public virtual IEnumerable<FilterAttribute> GetFilterAttributes(bool useCache);}public abstract class ActionDescriptor : ICustomAttributeProvider, IUniquelyIdentifiable{   //其他成員  public virtual IEnumerable<FilterAttribute> GetFilterAttributes(bool useCache); }

針對FilterAttribute特性的Filter通過FilterAttributeFilterProvider對象來提供。FilterAttributeFilterProvider直接調用當前ControllerDescriptor和ActionDescriptor的GetFilterAttributes方法擷取所有應用在Controller類型和當前Action方法的FilterAttribute特性，並藉此建立相應的Filter對象。FilterAttributeFilterProvider建構函式的參數cacheAttributeInstances表示是否啟用針對FilterAttribute的緩衝，它將作為調用GetFilterAttributes方法的參數。在預設的情況下（通過調用預設無參的建構函式建立的FilterAttributeFilterProvider）會採用針對FilterAttribute的緩衝。

public class FilterAttributeFilterProvider : IFilterProvider{  public FilterAttributeFilterProvider();  public FilterAttributeFilterProvider(bool cacheAttributeInstances);  protected virtual IEnumerable<FilterAttribute> GetActionAttributes(ControllerContext controllerContext, ActionDescriptor actionDescriptor);  protected virtual IEnumerable<FilterAttribute> GetControllerAttributes(ControllerContext controllerContext, ActionDescriptor actionDescriptor);  public virtual IEnumerable<Filter> GetFilters(ControllerContext controllerContext, ActionDescriptor actionDescriptor);}

對於通過調用GetFilters得到的Filter，對應的FilterAttribute特性作為其Instance屬性。Order屬性來源於FilterAttribute的同名屬性，而Scope屬性則取決於FilterAttribute特性是應用在Controller類型上（Scope屬性值為Controller）還是當前的Action方法上（Scope屬性值為Action）。

四、Controller與ControllerInstanceFilterProvider

提到ASP.NET MVC的篩選器，大部分的都只會想到通過FilterAttribute特性，實際上Controller本身（繼承自抽象類別Controller）就是一個篩選器。如下面的代碼片斷所示，抽象類別Controller實現了IActionFilter、IAuthorizationFilter、IExceptionFilter和IResultFilter這四個對應著不同篩選器類型的介面。

public abstract class Controller : ControllerBase,  IActionFilter,  IAuthorizationFilter,  IExceptionFilter,  IResultFilter,   ...{  //省略成員}

針對Controller對象這種獨特篩選器的FilterProvider類型為具有如下定義的ControllerInstanceFilterProvider。在實現的GetFilters方法中，它會根據指定的Controller上下文擷取對應的Controller對象，並以此建立一個Filter（Controller對象作為Filter對象的Instance屬性值）。該Filter的Scope不是Controller，而是First，而Order的值為-2147483648（Int32.MinValue），毫無疑問這樣的Filter肯定第一個被執行。

public class ControllerInstanceFilterProvider : IFilterProvider{   public IEnumerable<Filter> GetFilters(ControllerContext controllerContext, ActionDescriptor actionDescriptor); }

五、GlobalFilterCollection

通過FilterAttribute的形式定義的篩選器需要顯式地標註到目標Controller類型或者Action方法上，而在有些情況下需要一種全域的Filter。所謂全域篩選器，就是不需要顯式與某個Controller或者Action進行匹配，而是預設使用到所有的Action執行過程中。用於提供這種全域Filter的FilterProvider對應的類型為具有如下定義的GlobalFilterCollection。

public sealed class GlobalFilterCollection : IEnumerable<Filter>, IEnumerable, IFilterProvider{  public GlobalFilterCollection();  public void Add(object filter);  public void Add(object filter, int order);  private void AddInternal(object filter, int? order);  public void Clear();  public bool Contains(object filter);  public IEnumerator<Filter> GetEnumerator();  public void Remove(object filter);  IEnumerator IEnumerable.GetEnumerator();  IEnumerable<Filter> IFilterProvider.GetFilters(ControllerContext controllerContext, ActionDescriptor actionDescriptor);  public int Count { get; }}

通過命名以及上面給出的定義可以看出GlobalFilterCollection就是一個Filter的列表而已，實現的GetFilters方法返回的就是它自己。通過GlobalFilterCollection提供的方法我們可以實現對全域Filter的添加、刪除和清除操作。用於添加Filter的Add方法的參數filter不是一個Filter對象，而是一個具體篩選器（實現了相應的篩選器介面），添加的Filter對象根據該篩選器對象建立，其Scope屬性被設定成Global。我們通過在Add方法指定添加Filter對象的Order屬性，如果沒有顯示指定Order並且指定的篩選器是一個FilterAttribute特性，那麼該特性的Order將會作為Filter對象的Order；否則使用-1作為Order屬性值。

針對整個Web應用的全域Filter（或者說全域FilterProvider）的註冊和擷取可以通過靜態類型GlobalFilters來實現。如下面的代碼片斷所示，GlobalFilters具有一個靜態唯讀屬性Filters返回一個GlobalFilterCollection對象。

public static class GlobalFilters{   public static GlobalFilterCollection Filters { get; }}

到目前為止，我們已經介紹了ASP.NET MVC預設提供的三種FilterProvider，以及各自採用得Filter提供機制。當用於註冊FilterProvider的靜態類型在載入的時候，會預設建立這三種類型的對象並將其作為表示全域FilterProvider集合的Providers屬性值，具體的邏輯體現在如下的代碼片斷中。也就是說，在預設的情況下ASP.NET MVC會採用這三種FilterProvider來提供所有的Filter對象。

public static class FilterProviders{  static FilterProviders()  {    Providers = new FilterProviderCollection();    Providers.Add(GlobalFilters.Filters);    Providers.Add(new FilterAttributeFilterProvider());    Providers.Add(new ControllerInstanceFilterProvider());  }  public static FilterProviderCollection Providers{get;private set;}}

六、執行個體示範：驗證Filter的提供機制和執行順序

為了讓讀者對上面介紹的Filter提供機制具有一個更加深刻的映像，我們來做一個簡單的執行個體示範。在一個通過Visual Studio的ASP.NET MVC項目模板建立的空Web項目中，我們定義了如下一個幾個FilterAttribute。FilterBaseAttribute是一個實現了IActionFilter介面的抽象類別型，三個具體的FilterAttribute（FooAttribute、BarAttribute和BazAttribute）是它的繼承者。

public abstract class FilterBaseAttribute:FilterAttribute, IActionFilter{  public void OnActionExecuted(ActionExecutedContext filterContext)  {}  public void OnActionExecuting(ActionExecutingContext filterContext)  {}}public class FooAttribute : FilterBaseAttribute{}public class BarAttribute : FilterBaseAttribute{}public class BazAttribute : FilterBaseAttribute{}

我們首先在Global.asax中通過如下的方式將BazAttribute註冊為一個全域篩選器。需要注意的是定義在預設建立的Global.asax中的Application_Start方法會調用RegisterGlobalFilters方法註冊一個類型為HandleErrorAttribute的ExceptionFilter，我們需要將這行代碼注釋。

public class MvcApplication : System.Web.HttpApplication{  //其他成員  protected void Application_Start()  {       //其他動作    //RegisterGlobalFilters(GlobalFilters.Filters);       GlobalFilters.Filters.Add(new BazAttribute());  }}

最後我們建立如下一個預設的HomeController，一個空的Action方法Data上應用了我們定義的BarAttribute特性，而HomeController類上則應用了FooAttribute特性。在預設的Action方法Index中，我們通過FilterProviders的靜態屬性Providers表示的全域FilterProvider列表得到針對於Action方法Data的所有Filter對象，並將它們的基本資料（類型、Order和Scope屬性）呈現出來。

[Foo]public class HomeController : Controller{  public void Index()  {    ReflectedControllerDescriptor controllerDescriptor = new ReflectedControllerDescriptor(typeof(HomeController));    ActionDescriptor actionDescriptor = controllerDescriptor.FindAction(ControllerContext, "Data");    foreach (var filter in FilterProviders.Providers.GetFilters(ControllerContext, actionDescriptor))    {      Response.Write(string.Format("{0}<br/>",filter.Instance));      Response.Write(string.Format("    {0}: {1}<br/>", "Order",filter.Order));      Response.Write(string.Format("    {0}: {1}<br/><br/>", "Scope",filter.Scope));    }  }  [Bar]  public void Data()  { }}

運行我們的程式之後會在瀏覽器中呈現7-5所示的結果。我們可以清楚地看到，不僅僅應用在自身Action方法的FilterAttribute會應用到目標Action上，應用在Controller類的FilterAttribute、全域註冊的Filter以及Controller對象本身體現的Filter都回最終應用在所有的Action上面。

將應用於Action方法Data的4個Filter的Order和Scope屬性顯示出來。我們在前面提到這兩個屬性決定了同類篩選器執行的順序，我們現在利用這個程式要證實這一點。為此我們需要對FilterBaseAttribute作如下的修改，在OnActionExecuting中我們將當前執行的FilterAttribute的類型的方法名呈現出來。

public abstract class FilterBaseAttribute:FilterAttribute, IActionFilter{  public void OnActionExecuted(ActionExecutedContext filterContext)  {}  public void OnActionExecuting(ActionExecutingContext filterContext)  {    filterContext.HttpContext.Response.Write(string.Format("{0}.OnActionExecuting()<br/>", this.GetType()));  }}

然後我們按照相同的方式重寫了HomeController的OnActionExecuting方法，將HomeController自身的類型的當前方法名稱呈現出來。

[Foo]public class HomeController : Controller{  //其他成員  protected override void OnActionExecuting(ActionExecutingContext filterContext)  {    Response.Write("HomeController.OnActionExecuting()<br/>");  }  [Bar]  public void Data()  { }}

我們再次運行我們的程式，並在瀏覽器上指定正確的地址訪問定義在HomeController的Action方法Data，會在瀏覽器中呈現如所示的結果。輸出的結果體現了應用到Action方法Data上的四個ActionFilter執行的順序，而這是和Filter對應的Order和Scope屬性值是一致的。

關於Filter的提供還另一個值得深究的問題：我們在定義FilterAttribute的時候可以將應用在該類型上的AttributeUsageAttribute的AllowMultiple屬性設定為False使它只能在同一個目標元素上應用一次。但是，我們依然可以在Action方法和所在的Controller類型上應用它們，甚至可以將它們註冊為全域Filter，那麼這些FilterAttribute都將有效嗎？

我們現在就來通過執行個體來驗證這一點。現在我們刪除所有的FilterAttribute，定義如下一個類型為FooAttribute的ActionFilter，我們將應用在它上面的AttributeUsageAttribute特性的AllowMultiple屬性設定為False。

[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false)]public class FooAttribute : FilterAttribute, IActionFilter{  public void OnActionExecuted(ActionExecutedContext filterContext)  { }  public void OnActionExecuting(ActionExecutingContext filterContext)  { }}

現在我們將該FooAttribute特性同時應用在HomeController類型和Action方法Data上，然後在Global.asax中註冊一個針對FooAttribute特性的全域Filter。

[Foo]public class HomeController : Controller{  //其他成員  [Foo]  public void Data()  { }}public class MvcApplication : System.Web.HttpApplication{  //其他成員  protected void Application_Start()  {    //其他動作    //RegisterGlobalFilters(GlobalFilters.Filters);    GlobalFilters.Filters.Add(new FooAttribute());  }}

現在我們直接運行我們的程式，開啟的瀏覽器中會呈現出7-7所示的結果。可以清楚地看到雖然我們 在三個地方註冊了FooAttribute，但是由於該特性的AllowMultiple屬性為False，所以只有其中一個FooAttribute最終是有效。

對於AllowMultiple屬性為False的FilterAttribute來說，如果我們以不同的Scope註冊了多個，最終有效是哪個呢？從可以看出，應用在Action方法（Scope為Action）上的FooAttribute是有效。其實具體的邏輯是這樣的：所有被建立的Filter按照Order+Scope進行排序（即Filter執行的順序），取排在最後一個。對於我們的例子來說，提供的三個Filter具有相同的Order屬性值（-1），所有最終會按照Scope（Scope、Controller和Action）進行排序，排在最後一個的自然是Scope為Action的Filter。

以上就是本文的全部內容，希望本文的內容對大家的學習或者工作能帶來一定的協助，如果有疑問大家可以留言交流，同時也希望多多支援topic.alibabacloud.com！