解讀ASP.NET 5 & MVC6系列教程（10）：Controller與Action_自學過程

我們知道在MVC5和之前的版本，兩個架構的生命週期是不一樣的，在新版MVC6中，MVC Controller/Web API Controller已經合二為一了，本章我們主要講解Controller和Action的定義與使用，以及在MVC架構中，如何根據路由查詢相應的Controller和Action。

Controller&Action的定義和使用

在新版MVC6架構中，依然提供了一個Controller基類，在這裡除了依然提供了Url、RouteData、HttpContext、Request、Response以外，還提供了一個IServiceProvider類型的Resovler屬性，該屬於是依賴注入的容器，用於擷取當前請求範圍內指定類型的執行個體對象。

其遵守如下規則：

繼承於Microsoft.AspNet.Mvc.Controller的類肯定都是控制器，不管有沒有Controller尾碼。不繼承Microsoft.AspNet.Mvc.Controller的自訂XXXController要作為MVC Controller的話，，則必須要引用Microsoft.AspNet.Mvc相關的程式集。如果不想讓滿足上述條件的Controller類作為Controller，需要在該類上加上NonControllerAttribute特性。同理，如果不想讓某個Controller中的方法作為Action，則需要在該方法上加上NonActionAttribute特性。

另外還有如下幾個特性需要注意：

特性	描述
ActionNameAttribute	定義Action的名稱（可以和Action方法名不同）
AcceptVerbsAttribute	定義支援的Http Method名稱，支援單個或多個Method。
ActivateAttribute	依賴注入的標記，可以放在具有set許可權的屬性或欄位上。
ResponseCacheAttribute	針對某個Controller或Action設定用戶端緩衝。
RequireHttpsAttribute	限制必須是Https請求。
RemoteAttribute	標記為Ajax請求，伺服器端不驗證form表單的驗證。
NonControllerAttribute	標記該類不是Controller。
NonActionAttribute	標記該方法不是Action。

Controller的尋找機制

由上述章節，我們知道MVC6不僅支援正常的Controller（繼承於Controller基類的子類），也支援POCO的Controller，本節我們就來研究一下Controller的尋找原理機制。

首先，要判斷一個類是否是Controller必須先確定有多少個程式集裡定義了這樣的類。Microsoft.AspNet.Mvc命名空間下的IAssemblyProvider介面就是覆蓋尋找所有可能定義Controller的程式集，該介面的預設實現是DefaultAssemblyProvider類，在該類中，設定的必要條件是，定義了MVC的Controller必須要引用了如下程式集中的一個或多個程式集，列表如下：

Microsoft.AspNet.MvcMicrosoft.AspNet.Mvc.CoreMicrosoft.AspNet.Mvc.ModelBindingMicrosoft.AspNet.Mvc.RazorMicrosoft.AspNet.Mvc.Razor.HostMicrosoft.AspNet.Mvc.TagHelpersMicrosoft.AspNet.Mvc.XmlMicrosoft.AspNet.PageExecutionInstrumentation.Interfaces

也就是說，如果你定義了一個引用了Microsoft.AspNet.Mvc的DLL類庫的話，其裡面的POCO Controller都會被認為是MVC的Controller。換句話說，如果你定義的POCO Controller類沒有引用上述程式集中的任意一個程式集，那這些Controller類不會被認為是MVC的Controller。

程式集的尋找

目前有兩種方式可以自訂Controller的尋找機制，第一種是繼承IAssemblyProvider實現CandidateAssemblies方法（或重載DefaultAssemblyProvider），來定義自己的邏輯。介面定義如下：

public interface IAssemblyProvider{ IEnumerable<Assembly> CandidateAssemblies { get; }}

另外一種方式，可能相對來說更簡單一些，那就是使用IServicesCollection上定義的擴充方法來定義要尋找的程式集：

services.AddMvc().WithControllersAsServices(new[]{ typeof(MyController).Assembly, typeof(ExternalPocoController).Assembly});

使用上述代碼後，系統將會把DefaultAssemblyProvider切換成FixedSetAssemblyProvider來實現上述判斷機制，即：在固定範圍內的程式集裡進行尋找。

程式集的篩選

確定了程式集以後，另外一個問題就來了，如何判斷一個程式集是否引用了上述MVC必要條件中所列的程式集呢？答案是，Microsoft.Framework.Runtime中的ILibraryManager介面執行個體的GetReferencingLibraries方法，可以尋找有多少個程式集引用了上述列表中的其中一個程式集。例如，可以根據Microsoft.AspNet.Mvc程式集，來尋找有多少個程式集引用了該程式集，樣本如下：

var col = this.Resolver.GetRequiredService<ILibraryManager>();var data = col.GetReferencingLibraries("Microsoft.AspNet.Mvc");

該功能在DefaultAssemblyProvider預設實作類別中的使用代碼如下：

protected virtual IEnumerable<ILibraryInformation> GetCandidateLibraries(){ if (ReferenceAssemblies == null) {  return Enumerable.Empty<ILibraryInformation>(); } // GetReferencingLibraries returns the transitive closure of referencing assemblies // for a given assembly. return ReferenceAssemblies.SelectMany(_libraryManager.GetReferencingLibraries)        .Distinct()        .Where(IsCandidateLibrary);}

Controller的判斷

確定了符合必要條件的程式集之後，就可以遍曆該程式集內所有的類型，並接著判斷該類型是否是Controller了。在新版的Controller判斷上，實現該功能的是一個IControllerTypeProvider介面，該介面提供了一個ControllerTypes唯讀屬性用於擷取所有定義的Controller，介面定義如下：

public interface IControllerTypeProvider{ IEnumerable<TypeInfo> ControllerTypes { get; }}

DefaultControllerTypeProvider是該介面的預設實現，在查詢合格Controller的時候，該預設實作類別定義了一個IsController方法，用於判斷一個類型是否是Controller，具體邏輯如下：

protected internal virtual bool IsController([NotNull] TypeInfo typeInfo,            [NotNull] ISet<Assembly> candidateAssemblies){ if (!typeInfo.IsClass) // 該類型必須是一個類 {  return false; } if (typeInfo.IsAbstract) // 該類必須不是抽象類別 {  return false; } // We only consider public top-level classes as controllers. IsPublic returns false for nested // classes, regardless of visibility modifiers if (!typeInfo.IsPublic) // 該類必須是一個Public類（並且不嵌套），嵌套類不能作為Controller {  return false; } if (typeInfo.ContainsGenericParameters) // 該類不能是泛型類 {  return false; } if (!typeInfo.Name.EndsWith(ControllerTypeName, StringComparison.OrdinalIgnoreCase) &&  !DerivesFromController(typeInfo, candidateAssemblies)) // 該類以Controller結尾，或繼承於Controller基類，或其父類也是Controller。 {  return false; } if (typeInfo.IsDefined(typeof(NonControllerAttribute))) // 該類不能設定NonControllerAttribute特性 {  return false; } return true;}

你也可以自己實現IControllerTypeProvider介面來定義自己的Controller判斷邏輯，不過和固定某些程式集類型，MVC在IServicesCollection上也提供了一個擴充方法，用於限制一些Controller特定類型，樣本如下：

services.AddMvc().WithControllersAsServices(new[] {  typeof(MyController),  typeof(ExternalPocoController) });

使用上述代碼後，系統將會把DefaultControllerTypeProvider切換成FixedSetControllerTypeProvider來實現上述判斷機制，即：限制某些特定的類作為Controller，其它類型都不能作為Controller。

Action的尋找機制

Action的選擇則是通過IActionSelector介面的預設實作類別DefaultActionSelector來實現的，在實現的SelectAsync方法中，通過上下文和路由資料選擇最匹配的Action，示意代碼如下：

public Task<ActionDescriptor> SelectAsync([NotNull] RouteContext context){ // ...}

還有一個地方會判斷一個方法是否是Action，那就是IActionModelBuilder介面，該介面的預設實現為DefaultActionModelBuilder類，實現方法如下：

public IEnumerable<ActionModel> BuildActionModels([NotNull] TypeInfo typeInfo,             [NotNull] MethodInfo methodInfo){ if (!IsAction(typeInfo, methodInfo)) {  return Enumerable.Empty<ActionModel>(); } // ....省略其它代碼}

該實現方法，通過一個內部的IsAction方法來判斷該方法是否是一個真正的Action方法，具體代碼如下：

protected virtual bool IsAction([NotNull] TypeInfo typeInfo, [NotNull] MethodInfo methodInfo){ // The SpecialName bit is set to flag members that are treated in a special way by some compilers // (such as property accessors and operator overloading methods). if (methodInfo.IsSpecialName) // 不能是特殊名稱（如重載的操作符或屬性訪問器） {  return false; } if (methodInfo.IsDefined(typeof(NonActionAttribute))) // 不能聲明NonActionAttribute特性 {  return false; } // Overriden methods from Object class, e.g. Equals(Object), GetHashCode(), etc., are not valid. if (methodInfo.GetBaseDefinition().DeclaringType == typeof(object)) //不能是重載的方法，比如Equals和GetHashCode {  return false; } // Dispose method implemented from IDisposable is not valid if (IsIDisposableMethod(methodInfo, typeInfo)) // 不能是Dispose方法 {  return false; } if (methodInfo.IsStatic) // 不能是靜態方法 {  return false; } if (methodInfo.IsAbstract) // 不能是抽象方法 {  return false; } if (methodInfo.IsConstructor) // 不能是建構函式 {  return false; } if (methodInfo.IsGenericMethod) // 不能是泛型方法 {  return false; } return  methodInfo.IsPublic; // 必須是Public方法}

以上內容就是關於Controller和Action尋找相關的重要代碼，詳細原理步驟，請參考Microsoft.AspNet.Mvc.Core程式集下的所有源碼。