ASP.NET中Controller與Action怎么使用

這篇文章將為大家詳細(xì)講解有關(guān)ASP.NET中Controller與Action怎么使用，文章內(nèi)容質(zhì)量較高，因此小編分享給大家做個(gè)參考，希望大家閱讀完這篇文章后對(duì)相關(guān)知識(shí)有一定的了解。

Controller&Action的定義和使用

在新版MVC6框架中，依然提供了一個(gè)Controller基類(lèi)，在這里除了依然提供了Url、RouteData、HttpContext、Request、Response以外，還提供了一個(gè)IServiceProvider類(lèi)型的Resovler屬性，該屬于是依賴(lài)注入的容器，用于獲取當(dāng)前請(qǐng)求作用域內(nèi)指定類(lèi)型的實(shí)例對(duì)象。

其遵守如下規(guī)則：

繼承于Microsoft.AspNet.Mvc.Controller的類(lèi)肯定都是控制器，不管有沒(méi)有Controller后綴。不繼承Microsoft.AspNet.Mvc.Controller的自定義XXXController要作為MVC Controller的話(huà)，，則必須要引用Microsoft.AspNet.Mvc相關(guān)的程序集。如果不想讓滿(mǎn)足上述條件的Controller類(lèi)作為Controller，需要在該類(lèi)上加上NonControllerAttribute特性。同理，如果不想讓某個(gè)Controller中的方法作為Action，則需要在該方法上加上NonActionAttribute特性。

另外還有如下幾個(gè)特性需要注意：

Controller的查找機(jī)制

由上述章節(jié)，我們知道MVC6不僅支持正常的Controller（繼承于Controller基類(lèi)的子類(lèi)），也支持POCO的Controller，本節(jié)我們就來(lái)研究一下Controller的查找原理機(jī)制。

首先，要判斷一個(gè)類(lèi)是否是Controller必須先確定有多少個(gè)程序集里定義了這樣的類(lèi)。Microsoft.AspNet.Mvc命名空間下的IAssemblyProvider接口就是覆蓋查找所有可能定義Controller的程序集，該接口的默認(rèn)實(shí)現(xiàn)是DefaultAssemblyProvider類(lèi)，在該類(lèi)中，設(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

也就是說(shuō)，如果你定義了一個(gè)引用了Microsoft.AspNet.Mvc的DLL類(lèi)庫(kù)的話(huà)，其里面的POCO Controller都會(huì)被認(rèn)為是MVC的Controller。換句話(huà)說(shuō)，如果你定義的POCO Controller類(lèi)沒(méi)有引用上述程序集中的任意一個(gè)程序集，那這些Controller類(lèi)不會(huì)被認(rèn)為是MVC的Controller。

程序集的查找

目前有兩種方式可以自定義Controller的查找機(jī)制，第一種是繼承IAssemblyProvider實(shí)現(xiàn)CandidateAssemblies方法（或重載DefaultAssemblyProvider），來(lái)定義自己的邏輯。接口定義如下：

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

另外一種方式，可能相對(duì)來(lái)說(shuō)更簡(jiǎn)單一些，那就是使用IServicesCollection上定義的擴(kuò)展方法來(lái)定義要查找的程序集：

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

使用上述代碼后，系統(tǒng)將會(huì)把DefaultAssemblyProvider切換成FixedSetAssemblyProvider來(lái)實(shí)現(xiàn)上述判斷機(jī)制，即：在固定范圍內(nèi)的程序集里進(jìn)行查找。

程序集的篩選

確定了程序集以后，另外一個(gè)問(wèn)題就來(lái)了，如何判斷一個(gè)程序集是否引用了上述MVC必要條件中所列的程序集呢？答案是，Microsoft.Framework.Runtime中的ILibraryManager接口實(shí)例的GetReferencingLibraries方法，可以查找有多少個(gè)程序集引用了上述列表中的其中一個(gè)程序集。例如，可以根據(jù)Microsoft.AspNet.Mvc程序集，來(lái)查找有多少個(gè)程序集引用了該程序集，示例如下：

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

該功能在DefaultAssemblyProvider默認(rèn)實(shí)現(xiàn)類(lèi)中的使用代碼如下：

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)所有的類(lèi)型，并接著判斷該類(lèi)型是否是Controller了。在新版的Controller判斷上，實(shí)現(xiàn)該功能的是一個(gè)IControllerTypeProvider接口，該接口提供了一個(gè)ControllerTypes只讀屬性用于獲取所有定義的Controller，接口定義如下：

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

DefaultControllerTypeProvider是該接口的默認(rèn)實(shí)現(xiàn)，在查詢(xún)符合條件的Controller的時(shí)候，該默認(rèn)實(shí)現(xiàn)類(lèi)定義了一個(gè)IsController方法，用于判斷一個(gè)類(lèi)型是否是Controller，具體邏輯如下：

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

 return true;
}

你也可以自己實(shí)現(xiàn)IControllerTypeProvider接口來(lái)定義自己的Controller判斷邏輯，不過(guò)和固定某些程序集類(lèi)型，MVC在IServicesCollection上也提供了一個(gè)擴(kuò)展方法，用于限制一些Controller特定類(lèi)型，示例如下：

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

使用上述代碼后，系統(tǒng)將會(huì)把DefaultControllerTypeProvider切換成FixedSetControllerTypeProvider來(lái)實(shí)現(xiàn)上述判斷機(jī)制，即：限制某些特定的類(lèi)作為Controller，其它類(lèi)型都不能作為Controller。

Action的查找機(jī)制

Action的選擇則是通過(guò)IActionSelector接口的默認(rèn)實(shí)現(xiàn)類(lèi)DefaultActionSelector來(lái)實(shí)現(xiàn)的，在實(shí)現(xiàn)的SelectAsync方法中，通過(guò)上下文和路由數(shù)據(jù)選擇最匹配的Action，示意代碼如下：

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

還有一個(gè)地方會(huì)判斷一個(gè)方法是否是Action，那就是IActionModelBuilder接口，該接口的默認(rèn)實(shí)現(xiàn)為DefaultActionModelBuilder類(lèi)，實(shí)現(xiàn)方法如下：

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

該實(shí)現(xiàn)方法，通過(guò)一個(gè)內(nèi)部的IsAction方法來(lái)判斷該方法是否是一個(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) // 不能是特殊名稱(chēng)（如重載的操作符或?qū)傩栽L(fǎng)問(wèn)器）
 {
  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方法
}

關(guān)于ASP.NET中Controller與Action怎么使用就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，可以學(xué)到更多知識(shí)。如果覺(jué)得文章不錯(cuò)，可以把它分享出去讓更多的人看到。