特性 | 描述 |
---|---|
ActionNameAttribute | 定義Action的名稱(可以和Action方法名不同) |
AcceptVerbsAttribute | 定義支持的Http Method名稱,支持單個(gè)或多個(gè)Method。 |
ActivateAttribute | 依賴注入的標(biāo)記,可以放在具有set權(quán)限的屬性或字段上。 |
ResponseCacheAttribute | 針對(duì)某個(gè)Controller或Action設(shè)置客戶端緩存。 |
RequireHttpsAttribute | 限制必須是Https請(qǐng)求。 |
RemoteAttribute | 標(biāo)記為Ajax請(qǐng)求,服務(wù)器端不驗(yàn)證form表單的驗(yàn)證。 |
NonControllerAttribute | 標(biāo)記該類不是Controller。 |
NonActionAttribute | 標(biāo)記該方法不是Action。 |
Controller的查找機(jī)制
由上述章節(jié),我們知道MVC6不僅支持正常的Controller(繼承于Controller基類的子類),也支持POCO的Controller,本節(jié)我們就來研究一下Controller的查找原理機(jī)制。
首先,要判斷一個(gè)類是否是Controller必須先確定有多少個(gè)程序集里定義了這樣的類。Microsoft.AspNet.Mvc
命名空間下的IAssemblyProvider
接口就是覆蓋查找所有可能定義Controller的程序集,該接口的默認(rèn)實(shí)現(xiàn)是DefaultAssemblyProvider
類,在該類中,設(shè)置的必要條件是,定義了MVC的Controller必須要引用了如下程序集中的一個(gè)或多個(gè)程序集,列表如下:
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
也就是說,如果你定義了一個(gè)引用了Microsoft.AspNet.Mvc
的DLL類庫(kù)的話,其里面的POCO Controller都會(huì)被認(rèn)為是MVC的Controller。換句話說,如果你定義的POCO Controller類沒有引用上述程序集中的任意一個(gè)程序集,那這些Controller類不會(huì)被認(rèn)為是MVC的Controller。
程序集的查找
目前有兩種方式可以自定義Controller的查找機(jī)制,第一種是繼承IAssemblyProvider
實(shí)現(xiàn)CandidateAssemblies
方法(或重載DefaultAssemblyProvider
),來定義自己的邏輯。接口定義如下:
public interface IAssemblyProvider { IEnumerableAssembly> CandidateAssemblies { get; } }
另外一種方式,可能相對(duì)來說更簡(jiǎn)單一些,那就是使用IServicesCollection
上定義的擴(kuò)展方法來定義要查找的程序集:
services.AddMvc().WithControllersAsServices(new[] { typeof(MyController).Assembly, typeof(ExternalPocoController).Assembly });
使用上述代碼后,系統(tǒng)將會(huì)把DefaultAssemblyProvider
切換成FixedSetAssemblyProvider
來實(shí)現(xiàn)上述判斷機(jī)制,即:在固定范圍內(nèi)的程序集里進(jìn)行查找。
程序集的篩選
確定了程序集以后,另外一個(gè)問題就來了,如何判斷一個(gè)程序集是否引用了上述MVC必要條件中所列的程序集呢?答案是,Microsoft.Framework.Runtime
中的ILibraryManager
接口實(shí)例的GetReferencingLibraries
方法,可以查找有多少個(gè)程序集引用了上述列表中的其中一個(gè)程序集。例如,可以根據(jù)Microsoft.AspNet.Mvc
程序集,來查找有多少個(gè)程序集引用了該程序集,示例如下:
var col = this.Resolver.GetRequiredServiceILibraryManager>(); var data = col.GetReferencingLibraries("Microsoft.AspNet.Mvc");
該功能在DefaultAssemblyProvider默認(rèn)實(shí)現(xiàn)類中的使用代碼如下:
protected virtual IEnumerableILibraryInformation> GetCandidateLibraries() { if (ReferenceAssemblies == null) { return Enumerable.EmptyILibraryInformation>(); } // GetReferencingLibraries returns the transitive closure of referencing assemblies // for a given assembly. return ReferenceAssemblies.SelectMany(_libraryManager.GetReferencingLibraries) .Distinct() .Where(IsCandidateLibrary); }
Controller的判斷
確定了符合必要條件的程序集之后,就可以遍歷該程序集內(nèi)所有的類型,并接著判斷該類型是否是Controller了。在新版的Controller判斷上,實(shí)現(xiàn)該功能的是一個(gè)IControllerTypeProvider
接口,該接口提供了一個(gè)ControllerTypes
只讀屬性用于獲取所有定義的Controller,接口定義如下:
public interface IControllerTypeProvider { IEnumerableTypeInfo> ControllerTypes { get; } }
DefaultControllerTypeProvider
是該接口的默認(rèn)實(shí)現(xiàn),在查詢符合條件的Controller的時(shí)候,該默認(rèn)實(shí)現(xiàn)類定義了一個(gè)IsController
方法,用于判斷一個(gè)類型是否是Controller,具體邏輯如下:
protected internal virtual bool IsController([NotNull] TypeInfo typeInfo, [NotNull] ISetAssembly> candidateAssemblies) { if (!typeInfo.IsClass) // 該類型必須是一個(gè)類 { 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) // 該類必須是一個(gè)Public類(并且不嵌套),嵌套類不能作為Controller { return false; } if (typeInfo.ContainsGenericParameters) // 該類不能是泛型類 { return false; } if (!typeInfo.Name.EndsWith(ControllerTypeName, StringComparison.OrdinalIgnoreCase) !DerivesFromController(typeInfo, candidateAssemblies)) // 該類以Controller結(jié)尾,或繼承于Controller基類,或其父類也是Controller。 { return false; } if (typeInfo.IsDefined(typeof(NonControllerAttribute))) // 該類不能設(shè)置NonControllerAttribute特性 { return false; } return true; }
你也可以自己實(shí)現(xiàn)IControllerTypeProvider
接口來定義自己的Controller判斷邏輯,不過和固定某些程序集類型,MVC在IServicesCollection
上也提供了一個(gè)擴(kuò)展方法,用于限制一些Controller特定類型,示例如下:
services.AddMvc().WithControllersAsServices(new[] { typeof(MyController), typeof(ExternalPocoController) });
使用上述代碼后,系統(tǒng)將會(huì)把DefaultControllerTypeProvider
切換成FixedSetControllerTypeProvider
來實(shí)現(xiàn)上述判斷機(jī)制,即:限制某些特定的類作為Controller,其它類型都不能作為Controller。
Action的查找機(jī)制
Action的選擇則是通過IActionSelector
接口的默認(rèn)實(shí)現(xiàn)類DefaultActionSelector
來實(shí)現(xiàn)的,在實(shí)現(xiàn)的SelectAsync
方法中,通過上下文和路由數(shù)據(jù)選擇最匹配的Action,示意代碼如下:
public TaskActionDescriptor> SelectAsync([NotNull] RouteContext context) { // ... }
還有一個(gè)地方會(huì)判斷一個(gè)方法是否是Action,那就是IActionModelBuilder
接口,該接口的默認(rèn)實(shí)現(xiàn)為DefaultActionModelBuilder
類,實(shí)現(xiàn)方法如下:
public IEnumerableActionModel> BuildActionModels([NotNull] TypeInfo typeInfo, [NotNull] MethodInfo methodInfo) { if (!IsAction(typeInfo, methodInfo)) { return Enumerable.EmptyActionModel>(); } // ....省略其它代碼 }
該實(shí)現(xiàn)方法,通過一個(gè)內(nèi)部的IsAction
方法來判斷該方法是否是一個(gè)真正的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) // 不能是特殊名稱(如重載的操作符或?qū)傩栽L問器) { 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) // 不能是靜態(tài)方法 { return false; } if (methodInfo.IsAbstract) // 不能是抽象方法 { return false; } if (methodInfo.IsConstructor) // 不能是構(gòu)造函數(shù) { return false; } if (methodInfo.IsGenericMethod) // 不能是泛型方法 { return false; } return methodInfo.IsPublic; // 必須是Public方法 }
以上內(nèi)容就是關(guān)于Controller和Action查找相關(guān)的重要代碼,詳細(xì)原理步驟,請(qǐng)參考Microsoft.AspNet.Mvc.Core
程序集下的所有源碼。
標(biāo)簽:中衛(wèi) 聊城 海西 慶陽(yáng) 甘肅 清遠(yuǎn) 臨夏
巨人網(wǎng)絡(luò)通訊聲明:本文標(biāo)題《解讀ASP.NET 5 & MVC6系列教程(10):Controller與Action》,本文關(guān)鍵詞 解讀,ASP.NET,amp,MVC6,系列,;如發(fā)現(xiàn)本文內(nèi)容存在版權(quán)問題,煩請(qǐng)?zhí)峁┫嚓P(guān)信息告之我們,我們將及時(shí)溝通與處理。本站內(nèi)容系統(tǒng)采集于網(wǎng)絡(luò),涉及言論、版權(quán)與本站無(wú)關(guān)。