我們知道在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
特性。
另外還有如下幾個特性需要注意:
Controller的查找機制
由上述章節,我們知道MVC6不僅支持正常的Controller(繼承於Controller基類的子類),也支持POCO的Controller,本節我們就來研究一下Controller的查找原理機制。
首先,要判斷一個類是否是Controller必須先確定有多少個程序集裡定義了這樣的類。Microsoft.AspNet.Mvc
命名空間下的IAssemblyProvider
接口就是覆蓋查找所有可能定義Controller的程序集,該接口的默認實現是DefaultAssemblyProvider
類,在該類中,設置的必要條件是,定義了MVC的Controller必須要引用了如下程序集中的一個或多個程序集,列表如下:
Microsoft.AspNet.Mvc Microsoft.AspNet.Mvc.Core Microsoft.AspNet.Mvc.ModelBinding Microsoft.AspNet.Mvc.Razor Microsoft.AspNet.Mvc.Razor.Host Microsoft.AspNet.Mvc.TagHelpers Microsoft.AspNet.Mvc.Xml Microsoft.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
程序集下的所有源碼。