我們知道在MVC5和之前的版本，兩個框架的生命周期是不一樣的，在新版MVC6中，MVC Controller/Web API Controller已經(jīng)合二為一了，本章我們主要講解Controller和Action的定義與使用，以及在MVC框架中，如何根據(jù)路由查詢相應(yīng)的Controller和Action。
Controller&Action的定義和使用
在新版MVC6框架中，依然提供了一個Controller基類，在這里除了依然提供了Url、RouteData、HttpContext、Request、Response以外，還提供了一個IServiceProvider類型的Resovler屬性，該屬于是依賴注入的容器，用于獲取當(dāng)前請求作用域內(nèi)指定類型的實例對象。
其遵守如下規(guī)則：
繼承于Microsoft.AspNet.Mvc.Controller的類肯定都是控制器，不管有沒有Controller后綴。不繼承Microsoft.AspNet.Mvc.Controller的自定義XXXController要作為MVC Controller的話，，則必須要引用Microsoft.AspNet.Mvc相關(guān)的程序集。如果不想讓滿足上述條件的Controller類作為Controller，需要在該類上加上NonControllerAttribute特性。同理，如果不想讓某個Controller中的方法作為Action，則需要在該方法上加上NonActionAttribute特性。
另外還有如下幾個特性需要注意：
|
特性 |
描述 |
|---|---|
|
ActionNameAttribute |
定義Action的名稱（可以和Action方法名不同） |
|
AcceptVerbsAttribute |
定義支持的Http Method名稱，支持單個或多個Method。 |
|
ActivateAttribute |
依賴注入的標(biāo)記，可以放在具有set權(quán)限的屬性或字段上。 |
|
ResponseCacheAttribute |
針對某個Controller或Action設(shè)置客戶端緩存。 |
|
RequireHttpsAttribute |
限制必須是Https請求。 |
|
RemoteAttribute |
標(biāo)記為Ajax請求，服務(wù)器端不驗證form表單的驗證。 |
|
NonControllerAttribute |
標(biāo)記該類不是Controller。 |
|
NonActionAttribute |
標(biāo)記該方法不是Action。 |
Controller的查找機制
由上述章節(jié)，我們知道MVC6不僅支持正常的Controller（繼承于Controller基類的子類），也支持POCO的Controller，本節(jié)我們就來研究一下Controller的查找原理機制。
首先，要判斷一個類是否是Controller必須先確定有多少個程序集里定義了這樣的類。Microsoft.AspNet.Mvc命名空間下的IAssemblyProvider接口就是覆蓋查找所有可能定義Controller的程序集，該接口的默認(rèn)實現(xiàn)是DefaultAssemblyProvider類，在該類中，設(shè)置的必要條件是，定義了MVC的Controller必須要引用了如下程序集中的一個或多個程序集，列表如下：
|
1
2
3
4
5
6
7
8
|
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都會被認(rèn)為是MVC的Controller。換句話說，如果你定義的POCO Controller類沒有引用上述程序集中的任意一個程序集，那這些Controller類不會被認(rèn)為是MVC的Controller。
程序集的查找
目前有兩種方式可以自定義Controller的查找機制，第一種是繼承IAssemblyProvider實現(xiàn)CandidateAssemblies方法（或重載DefaultAssemblyProvider），來定義自己的邏輯。接口定義如下：
|
1
2
3
4
|
public interface IAssemblyProvider{ IEnumerable<Assembly> CandidateAssemblies { get; }} |
另外一種方式，可能相對來說更簡單一些，那就是使用IServicesCollection上定義的擴展方法來定義要查找的程序集：
|
1
2
3
4
5
|
services.AddMvc().WithControllersAsServices(new[]{ typeof(MyController).Assembly, typeof(ExternalPocoController).Assembly}); |
使用上述代碼后，系統(tǒng)將會把DefaultAssemblyProvider切換成FixedSetAssemblyProvider來實現(xiàn)上述判斷機制，即：在固定范圍內(nèi)的程序集里進行查找。
程序集的篩選
確定了程序集以后，另外一個問題就來了，如何判斷一個程序集是否引用了上述MVC必要條件中所列的程序集呢？答案是，Microsoft.Framework.Runtime中的ILibraryManager接口實例的GetReferencingLibraries方法，可以查找有多少個程序集引用了上述列表中的其中一個程序集。例如，可以根據(jù)Microsoft.AspNet.Mvc程序集，來查找有多少個程序集引用了該程序集，示例如下：
|
1
2
|
var col = this.Resolver.GetRequiredService<ILibraryManager>();var data = col.GetReferencingLibraries("Microsoft.AspNet.Mvc"); |
該功能在DefaultAssemblyProvider默認(rèn)實現(xiàn)類中的使用代碼如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
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的判斷
確定了符合必要條件的程序集之后，就可以遍歷該程序集內(nèi)所有的類型，并接著判斷該類型是否是Controller了。在新版的Controller判斷上，實現(xiàn)該功能的是一個IControllerTypeProvider接口，該接口提供了一個ControllerTypes只讀屬性用于獲取所有定義的Controller，接口定義如下：
|
1
2
3
4
|
public interface IControllerTypeProvider{ IEnumerable<TypeInfo> ControllerTypes { get; }} |
DefaultControllerTypeProvider是該接口的默認(rèn)實現(xiàn)，在查詢符合條件的Controller的時候，該默認(rèn)實現(xiàn)類定義了一個IsController方法，用于判斷一個類型是否是Controller，具體邏輯如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
|
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結(jié)尾，或繼承于Controller基類，或其父類也是Controller。 { return false; } if (typeInfo.IsDefined(typeof(NonControllerAttribute))) // 該類不能設(shè)置NonControllerAttribute特性 { return false; } return true;} |
你也可以自己實現(xiàn)IControllerTypeProvider接口來定義自己的Controller判斷邏輯，不過和固定某些程序集類型，MVC在IServicesCollection上也提供了一個擴展方法，用于限制一些Controller特定類型，示例如下：
|
1
2
3
4
5
|
services.AddMvc().WithControllersAsServices(new[] { typeof(MyController), typeof(ExternalPocoController) }); |
使用上述代碼后，系統(tǒng)將會把DefaultControllerTypeProvider切換成FixedSetControllerTypeProvider來實現(xiàn)上述判斷機制，即：限制某些特定的類作為Controller，其它類型都不能作為Controller。
Action的查找機制
Action的選擇則是通過IActionSelector接口的默認(rèn)實現(xiàn)類DefaultActionSelector來實現(xiàn)的，在實現(xiàn)的SelectAsync方法中，通過上下文和路由數(shù)據(jù)選擇最匹配的Action，示意代碼如下：
|
1
2
3
4
|
public Task<ActionDescriptor> SelectAsync([NotNull] RouteContext context){ // ...} |
還有一個地方會判斷一個方法是否是Action，那就是IActionModelBuilder接口，該接口的默認(rèn)實現(xiàn)為DefaultActionModelBuilder類，實現(xiàn)方法如下：
|
1
2
3
4
5
6
7
8
9
|
public IEnumerable<ActionModel> BuildActionModels([NotNull] TypeInfo typeInfo, [NotNull] MethodInfo methodInfo){ if (!IsAction(typeInfo, methodInfo)) { return Enumerable.Empty<ActionModel>(); } // ....省略其它代碼} |
該實現(xiàn)方法，通過一個內(nèi)部的IsAction方法來判斷該方法是否是一個真正的Action方法，具體代碼如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
|
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ì)原理步驟，請參考Microsoft.AspNet.Mvc.Core程序集下的所有源碼。
