解讀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屬性，該屬因而依賴注入的容器，用於獲取當前請求做用域內指定類型的實例對象。

其遵照以下規則：

1. 繼承於Microsoft.AspNet.Mvc.Controller的類確定都是控制器，無論有沒有Controller後綴。
2. 不繼承Microsoft.AspNet.Mvc.Controller的自定義XXXController要做爲MVC Controller的話，，則必需要引用Microsoft.AspNet.Mvc相關的程序集。
3. 若是不想讓知足上述條件的Controller類做爲Controller，須要在該類上加上NonControllerAttribute特性。
4. 同理，若是不想讓某個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.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程序集下的全部源碼。

同步與推薦

本文已同步至目錄索引：解讀ASP.NET 5 & MVC6系列