ASP.NET MVC同步和異步的使用總結
Action方法的執行具有兩種基本的形式，即同步執行和異步執行，而在ASP.NETMVC的整個體系中涉及到很多同步/異步的執行方式，雖然在前面相應的文章中已經對此作了相應的介紹，為了讓讀者對此有一個整體的了解，我們來做一個總結性的論述。
一、MvcHandler的同步與異步
對于ASP.NET MVC應用來說，MvcHandler是最終用于處理請求的HttpHandler，它是通過UrlRoutingModule這個實現了URL路由的 HttpModule被動態映射到相應的請求的。MvcHandler借助于ControllerFactory激活并執行目標Controller，并 在執行結束后負責對激活的Controller進行釋放，相關的內容請參與本書的第3章“Controller的激活”。如下面的代碼片斷所 示，MvcHandler同時實現了IHttpHandler和IHttpAsyncHandler接口，所以它總是調用 BeginProcessRequest/EndProcessRequest方法以異步的方式來處理請求。
public class MvcHandler : IHttpAsyncHandler, IHttpHandler, ...
{
//其他成員
IAsyncResult IHttpAsyncHandler.BeginProcessRequest(HttpContext context, AsyncCallback cb, object extraData);
void IHttpAsyncHandler.EndProcessRequest(IAsyncResult result);
void IHttpHandler.ProcessRequest(HttpContext httpContext);
} 二、Controller的同步與異步
Controller也具有同步與異步兩個版本，它們分別實現了具有如下定義的兩個接口IController和 IAsyncController。當激活的Controller對象在MvcHandler的BeginProcessRequest方法中是按照這樣 的方式執行的：如果Controller的類型實現了IAsyncController接口，則調用BeginExecute/EndExecute方法 以異步的方式執行Controller；否則Controller的執行通過調用Execute方法以同步方式執行。
public interface IController
{
void Execute(RequestContext requestContext);
}
public interface IAsyncController : IController
{
IAsyncResult BeginExecute(RequestContext requestContext, AsyncCallback callback, object state);
void EndExecute(IAsyncResult asyncResult);
} 默認情況下通過Visual Studio的向導創建的Controller類型是抽象類型Controller的子類。如下面的代碼片斷所示，Controller同時實現了 IController和IAsyncController這兩個接口，所以當MvcHandler進行請求處理時總是以異步的方式來執行 Controller。
public abstract class Controller : ControllerBase, IController, IAsyncController, ...
{
//其他成員
protected virtual bool DisableAsyncSupport
{
get{return false;}
}
} 但是Controller類型具有一個受保護的只讀屬性DisableAsyncSupport用于表示是否禁用對異步執行的支持。在默認情況下， 該屬性值為False，所以默認情況下是支持Controller的異步執行的。如果我們通過重寫該屬性將值設置為True，那么Controller將 只能以同步的方式執行。具體的實現邏輯體現在如下的代碼片斷中：BeginExecute方法在DisableAsyncSupport屬性為True的 情況下通過調用Execute方法（該方法會調用一個受保護的虛方法ExecuteCore最終對Controller進行同步執行）；否則通過調用 BeginExecuteCore/EndExecuteCore以異步方式執行Controller。
public abstract class Controller: ...
{
//其他成員
protected virtual IAsyncResult BeginExecute(RequestContext requestContext,
AsyncCallback callback, object state)
{
if (this.DisableAsyncSupport)
{
//通過調用Execute方法同步執行Controller
}
else
{
//通過調用BeginExecuteCore/EndExecuteCore方法異步執行Controller
}
}
protected override void ExecuteCore();
protected virtual IAsyncResult BeginExecuteCore(AsyncCallback callback, object state);
protected virtual void EndExecuteCore(IAsyncResult asyncResult);
} 三、 ActionInvoker的同步與異步
包括Model綁定與驗證的整個Action的執行通過一個名為ActionInvoker的組件來完成，而它同樣具有同步和異步兩個版本，分別實 現了接口IActionInvoker和IAsyncActionInvoker。如下面的代碼片斷所示，這兩個接口分別通過InvokeAction和 BeginInvokeAction/EndInvokeAction方法以同步和異步的方式執行Action。抽象類Controller中具有一個 ActionInvoker屬性用于設置和返回用于執行自身Action的ActionInvoker對象，而該對象最終是通過受保護需方法 CreateActionInvoker創建的。
public interface IActionInvoker
{
bool InvokeAction(ControllerContext controllerContext, string actionName);
}
public interface IAsyncActionInvoker : IActionInvoker
{
IAsyncResult BeginInvokeAction(ControllerContext controllerContext, string actionName, AsyncCallback callback, object state);
bool EndInvokeAction(IAsyncResult asyncResult);
}
public abstract class Controller
{
//其它成員
public IActionInvoker ActionInvoker { get; set; }
protected virtual IActionInvoker CreateActionInvoker()
} ASP.NET MVC真正用于Action方法同步和異步執行的ActionInvoker分別是ControllerActionInvoker和 AsyncControllerActionInvoker。如下面的代碼片斷所示，ControllerActionInvoker定義了一個受保護的 方法GetControllerDescriptor用于根據指定的Controller上下文獲取相應的ControllerDescriptor，它 的子類AsyncControllerActionInvoker對這個方法進行了重寫。
public class ControllerActionInvoker : IActionInvoker
{
//其它成員
protected virtual ControllerDescriptor GetControllerDescriptor(ControllerContext controllerContext);
}
public class AsyncControllerActionInvoker : ControllerActionInvoker,IAsyncActionInvoker, IActionInvoker
{
//其它成員
protected override ControllerDescriptor GetControllerDescriptor(ControllerContext controllerContext); 我們所有要了解的是在默認情況下（沒有對Controller類型的ActionInvoker屬性進行顯式設置）采用的ActionInvoker類型是哪個。ASP.NET MVC對Conroller采用的ActionInvoker類型的選擇機制是這樣的：
通過當前的DependencyResolver以IAsyncActionInvoker接口去獲取注冊的ActionInvoker，如果返回對象不為Null，則將其作為默認的ActionInvoker。
通過當前的DependencyResolver以IActionInvoker接口去獲取注冊的ActionInvoker，如果返回對象不為Null，則將其作為默認的ActionInvoker。
創建AsyncControllerActionInvoker對象作為默認的ActionInvoker。
在默認的情況下，當前的DependencyResolver直接通過對指定的類型進行反射來提供對應的實例對象，所以對于前面兩個步驟返回的對象 均為Null，所以默認創建出來的ActionInvoker類型為AsyncControllerActionInvoker。我們可以通過如下一個簡 單的實例來驗證這一點。在通過Visual Studio的ASP.NET MVC項目模板創建的空Web應用中，我們創建了如下一個默認的HomeController，在Action方法Index中直接通過 ContentResult將ActionInvoker屬性的類型名稱呈現出來。
public class HomeController : Controller
{
public ActionResult Index()
{
return Content("默認ActionInvoker類型:" + this.ActionInvoker.GetType().FullName);
}
} 當運行該Web應用時，會在瀏覽器上產生如下的輸出結果，我們可以清楚地看到默認采用的ActionInvoker類型正是AsyncControllerActionInvoker。
默認ActionInvoker類型:System.Web.Mvc.Async.AsyncControllerActionInvoker
為了進一步驗證基于DependencyResolver對ActionInvoker的提供機制，我們將《ASP.NET MVC Controller激活系統詳解：IoC的應用》創建的基于Ninject的自定義NinjectDependencyResolver應用在這里。如 下面的代碼片斷所示，在初始化NinjectDependencyResolver的時候，我們將IActionInvoker和 IAsyncActionInvoker影射到兩個自定義ActionInvoker類型，即FooActionInvoker和 FooAsyncActionInvoker，它們分別繼承自ControllerActionInvoker和 AsyncControllerActionInvoker。
public class NinjectDependencyResolver : IDependencyResolver
{
public IKernel Kernel { get; private set; }
public NinjectDependencyResolver()
{
this.Kernel = new StandardKernel();
AddBindings();
}
private void AddBindings()
{
this.Kernel.Bind<IActionInvoker>().To<FooActionInvoker>();
this.Kernel.Bind<IAsyncActionInvoker>().To<FooAsyncActionInvoker>();
}
public object GetService(Type serviceType)
{
return this.Kernel.TryGet(serviceType);
}
public IEnumerable<object> GetServices(Type serviceType)
{
return this.Kernel.GetAll(serviceType);
}
}
public class FooActionInvoker : ControllerActionInvoker
{}
public class FooAsyncActionInvoker : AsyncControllerActionInvoker
{} 在Global.asax中對NinjectDependencyResolver進行注冊后運行我們的程序，會在瀏覽器中得到如下的輸出結果。 IAsyncActionInvoker和FooAsyncActionInvoker進行了影射，NinjectDependencyResolver 可以通過IAsyncActionInvoker提供一個FooAsyncActionInvoker實例。
默認ActionInvoker類型:Artech.Mvc.FooAsyncActionInvoker
現在我們對NinjectDependencyResolver的定義稍加修改，將針對IAsyncActionInvoker接口的類型影射刪除，只保留針對IActionInvoker的映射。
public class NinjectDependencyResolver : IDependencyResolver
{
//其它成員
private void AddBindings()
{
this.Kernel.Bind<IActionInvoker>().To<FooActionInvoker>();
//this.Kernel.Bind<IAsyncActionInvoker>().To<FooAsyncActionInvoker>();
}
} 再次運行我們的程序則會得到如下的輸出結果。由于NinjectDependencyResolver只能通過IActionInvoker接口提 供具體的ActionInvoker，所以最終被創建的是一個FooActionInvoker對象。這個實例演示告訴我們：當我們需要使用到自定義的 ActionInvoker的時候，可以通過自定義DependencyResolver以IoC的方式提供具體的ActionInvoker實例。
默認ActionInvoker類型:Artech.Mvc.FooActionInvoker
四、ControllerDescriptor的同步與異步
如果采用ControllerActionInvoker，Action總是以同步的方式來直接，但是當 AsyncControllerActionInvoker作為Controller的ActionInvoker時，并不意味著總是以異步的方式來執行 所有的Action。至于這兩種類型的ActionInvoker具體采用對Action的怎樣的執行方式，又涉及到兩個描述對象，即用于描述 Controller和Action的ControllerDescriptor和ActionDescriptor。
通過前面“Model的綁定”中對這兩個對象進行過相應的介紹，我們知道在ASP.NET MVC應用編程接口中具有兩個具體的ControllerDescriptor，即ReflectedControllerDescriptor和 ReflectedAsyncControllerDescriptor，它們分別代表同步和異步版本的ControllerDescriptor。
public class ReflectedControllerDescriptor : ControllerDescriptor
{
//省略成員
}
public class ReflectedAsyncControllerDescriptor : ControllerDescriptor
{
//省略成員
} ReflectedControllerDescriptor和ReflectedAsyncControllerDescriptor并非對分別 實現了IController和IAyncController接口的Controller的描述，而是對直接繼承自抽象類Controller和 AsyncController的Controller的描述。它們之間的區別在于創建者的不同，在默認情況下 ReflectedControllerDescriptor和ReflectedAsyncControllerDescriptor分別是通過 ControllerActionInvoker和AsyncControllerActionInvoker來創建的。ActionInvoker和 ControllerDescriptor之間的關系可以通過如下圖所示的UML來表示。
ActionInvoker與ControllerDescriptor之間的關系可以通過一個簡單的實例來驗證。在通過Visual Studio的ASP.NET MVC項目模板創建的空Web應用中，我們自定義了如下兩個分別繼承自ControllerActionInvoker和 AsyncControllerActionInvoker的ActionInvoker類型。在這兩個自定義ActionInvoker中，定義了公有 的GetControllerDescriptor方法覆蓋了基類的同名方法（受保護的虛方法），并直接直接調用基類的同名方法根據提供的 Controller上下文的到相應的ControllerDescriptor對象。
public class FooActionInvoker : ControllerActionInvoker
{
public new ControllerDescriptor GetControllerDescriptor(ControllerContext controllerContext)
{
return base.GetControllerDescriptor(controllerContext);
}
}
public class BarActionInvoker : AsyncControllerActionInvoker
{
public new ControllerDescriptor GetControllerDescriptor(ControllerContext controllerContext)
{
return base.GetControllerDescriptor(controllerContext);
}
} 然后我們定義了兩個Controller類型，它們均是抽象類型Controller的直接繼承者。如下面的代碼片斷所示，這兩 Controller類（FooController和BarController）都重寫了虛方法CreateActionInvoker，而返回的 ActionInvoker類型分別是上面我們定義的FooActionInvoker和BarActionInvoker。在默認的Action方法 Index中，我們利用當前的ActionInvoker得到用于描述本Controller的ControllerDescriptor對象，并將其類 型呈現出來。
public class FooController : Controller
{
protected override IActionInvoker CreateActionInvoker()
{
return new FooActionInvoker();
}
public void Index()
{
ControllerDescriptor controllerDescriptor = ((FooActionInvoker)this.ActionInvoker).GetControllerDescriptor(ControllerContext);
Response.Write(controllerDescriptor.GetType().FullName);
}
}
public class BarController : Controller
{
protected override IActionInvoker CreateActionInvoker()
{
return new BarActionInvoker();
}
public void Index()
{
ControllerDescriptor controllerDescriptor = ((BarActionInvoker)this.ActionInvoker).GetControllerDescriptor(ControllerContext);
Response.Write(controllerDescriptor.GetType().FullName);
}
} 現在我們運行我們的程序，并在瀏覽器中輸入相應的地址對定義在FooController和BarController的默認Action方法Index發起訪問，相應的ControllerDescriptor類型名稱會以下圖所示的形式呈現出來，它們的類型分別是ReflectedControllerDescriptor和ReflectedAsyncControllerDescriptor。
五、ActionDescriptor的執行
Controller包含一組用于描述Action方法的ActionDescriptor對象。由于Action方法可以采用同步和異步執行方 法，異步Action對應的ActionDescriptor直接或者間接繼承自抽象類AsyncActionDescriptor，后者是抽象類 ActionDescriptor的子類。如下面的代碼片斷所示，同步和異步Action的執行分別通過調用Execute和BeginExecute/EndExecute方法來完成。值得一提的是，AsyncActionDescriptor重寫了Execute方法并直接在此方法中拋出一個InvalidOperationException異常，也就是說AsyncActionDescriptor對象只能采用 異步執行方式。
public abstract class ActionDescriptor : ICustomAttributeProvider
{
//其他成員
public abstract object Execute(ControllerContext controllerContext, IDictionary<string, object> parameters);
}
public abstract class AsyncActionDescriptor : ActionDescriptor
{
//其他成員
public abstract IAsyncResult BeginExecute(ControllerContext controllerContext, IDictionary<string, object> parameters, AsyncCallback callback, object state);
public abstract object EndExecute(IAsyncResult asyncResult);
} 通過前面“Model的綁定”我們知道，在ASP.NET MVC應用編程接口中采用ReflectedControllerDescriptor來描述同步Action。異步Action方法具有兩種不同的定義 方式：其一，通過兩個匹配的方法XxxAsync/XxxCompleted定義；其二，通過返回類型為Task的方法來定義。這兩種異步Action方 法對應的AsyncActionDescriptor類型分別是ReflectedAsyncActionDescriptor和TaskAsyncActionDescriptor。
對于ReflectedControllerDescriptor來說，包含其中的ActionDescriptor類型均為 ReflectedActionDescriptor。而ReflectedAsyncControllerDescriptor描述的 Controller可以同時包含同步和異步的Action方法，ActionDescriptor的類型取決于Action方法定義的方式。 ControllerDescriptor與ActionDescriptor之間的關系如下圖所示的UML來表示。
實例演示：AsyncActionInvoker對ControllerDescriptor的創建
為了讓讀者對ActionInvoker對ControllerDescriptor的解析機制具有一個深刻的理解，同時也作為對該機制的驗證，我 們做一個簡單的實例演示。通過前面的介紹我們知道在默認的情況下Controller采用AsyncControllerActionInvoker進行 Action方法的執行，這個例子就來演示一下它生成的ControllerDescriptor是個怎樣的對象。我們通過Visual Studio的ASP.NET MVC項目模板創建一個空Web應用，并創建一個默認的HomeController，然后對其進行如下的修改。
public class HomeController : AsyncController
{
public void Index()
{
MethodInfo method = typeof(AsyncControllerActionInvoker).GetMethod("GetControllerDescriptor", BindingFlags.Instance | BindingFlags.NonPublic);
ControllerDescriptor controllerDescriptor = (ControllerDescriptor)method.Invoke(this.ActionInvoker, new object[] { this.ControllerContext });
Response.Write(controllerDescriptor.GetType().FullName + "<br/>");
CheckAction(controllerDescriptor, "Foo");
CheckAction(controllerDescriptor, "Bar");
CheckAction(controllerDescriptor, "Baz");
}
private void CheckAction(ControllerDescriptor controllerDescriptor,string actionName)
{
ActionDescriptor actionDescriptor = controllerDescriptor.FindAction(this.ControllerContext, actionName);
Response.Write(string.Format("{0}: {1}<br/>",actionName,actionDescriptor.GetType().FullName));
}
public void Foo() { }
public void BarAsync() { }
public void BarCompleted() { }
public Task<ActionResult> Baz()
{
throw new NotImplementedException();
} 我們首先將HomeController的基類從Controller改為AsyncController，并定義了Foo、 BarAsync/BarCompleted和Baz四個方法，我們知道它們對應著Foo、Bar和Baz三個Action，其中Foo是同步 Action，Bar和Baz分別是兩種不同定義形式（XxxAsync/XxxCompleted和Task）的異步Action。
CheckAction用于根據指定的Action名稱從ControllerDescriptor對象中獲取用于表示對應Action的 ActionDescriptor對象，最終將類型名稱呈現出來。在Index方法中，我們通過反射的方式調用當前ActionInvoker（一個 AsyncControllerActionInvoker對象）的受保護方法GetControllerDescriptor或者用于描述當前 Controller（HomeController）的ControllerDescriptor的對象，并將類型名稱呈現出來。最后通過調用 CheckAction方法將包含在創建的ControllerDescriptor對象的三個ActionDescriptor類型呈現出來。
當我們運行該程序的時候，在瀏覽器中會產生如下的輸出結果，從中可以看出ControllerDescriptor類型為 ReflectedAsyncControllerDescriptor。同步方法Foo對象的ActionDescriptor是一個 ReflectedActionDescriptor對象；以XxxAsync/XxxCompleted形式定義的異步方法Bar對應的 ActionDescriptor是一個ReflectedAsyncActionDescriptor對象；而返回類型為Task的方法Baz對應的 ActionDescriptor類型則是TaskAsyncActionDescriptor。
AsyncController、AsyncControllerActionInvoker與AsyncActionDescriptor
不論我們采用哪種形式的定義方式，異步Action方法都只能定義在繼承自AsyncController的Controller類型中，否則將被認為是同步方法。此外，由于通過ControllerActionInvoker只能創建包含ReflectedActionDescriptor的ReflectedControllerDescriptor，如果我們在AsyncController中采用ControllerActionInvoker對象作為ActionInvoker，所有的Action方法也將被認為是同步的。
我們同樣可以采用一個簡單的實例演示來證實這一點。在通過Visual Studio的ASP.NET MVC項目模板創建的空Web應用中我們定義如下三個Controller（FooController、BarController和 BazController）。我們重寫了它們的CreateActionInvoker方法，返回的ActionInvoker類型 （FooActionInvoker和BarActionInvoker）定義在上面，在這里我們將FooActionInvoker和 BarActionInvoker看成是ControllerActionInvoker和 AsyncControllerActionInvoker（默認使用的ActionInvoker）。
public class FooController : AsyncController
{
protected override IActionInvoker CreateActionInvoker()
{
return new BarActionInvoker();
}
public void Index()
{
BarActionInvoker actionInvoker = (BarActionInvoker)this.ActionInvoker;
Utility.DisplayActions(controllerContext=>actionInvoker.GetControllerDescriptor(ControllerContext),ControllerContext);
}
public void DoSomethingAsync()
{ }
public void DoSomethingCompleted()
{ }
}
public class BarController : Controller
{
protected override IActionInvoker CreateActionInvoker()
{
return new BarActionInvoker();
}
public void Index()
{
BarActionInvoker actionInvoker = (BarActionInvoker)this.ActionInvoker;
Utility.DisplayActions(controllerContext => actionInvoker.GetControllerDescriptor(ControllerContext), ControllerContext);
}
public void DoSomethingAsync()
{ }
public void DoSomethingCompleted()
{ }
}
public class BazController : Controller
{
protected override IActionInvoker CreateActionInvoker()
{
return new FooActionInvoker();
}
public void Index()
{
FooActionInvoker actionInvoker = (FooActionInvoker)this.ActionInvoker;
Utility.DisplayActions(controllerContext => actionInvoker.GetControllerDescriptor(ControllerContext), ControllerContext);
}
public void DoSomethingAsync()
{ }
public void DoSomethingCompleted()
{ }
}
public static class Utility
{
public static void DisplayActions(Func<ControllerContext, ControllerDescriptor> controllerDescriptorAccessor, ControllerContext controllerContext)
{
ControllerDescriptor controllerDescriptor = controllerDescriptorAccessor(controllerContext);
string[] actionNames = { "DoSomething", "DoSomethingAsync", "DoSomethingCompleted" };
Array.ForEach(actionNames, actionName =>
{
ActionDescriptor actionDescriptor = controllerDescriptor.FindAction(controllerContext,actionName);
if (null != actionDescriptor)
{
HttpContext.Current.Response.Write(string.Format("{0}: {1}<br/>", actionDescriptor.ActionName, actionDescriptor.GetType().Name));
}
});
}
} 我們在三個Controller中以異步Action的形式定義了兩個方法DoSomethingAsync和 DoSomethingCompleted。FooController繼承自AsyncController，使用 AsyncControllerActionInvoker作為其ActionInvoker，這是正常的定義；BarController雖然采用 AsyncControllerActionInvoker，但是將抽象類Controller作為其基類；而BazController雖然繼承自 ActionInvoker，但ActionInvoker類型為ControllerActionInvoker。在默認的Action方法Index 中，我們將通過DoSomethingAsync和DoSomethingCompleted方法定義的Action的名稱和對應的 ActionDescriptor類型輸出來。
如果我們運行該程序，并在瀏覽器中輸入相應的地址對定義在三個Controller的默認Action方法Index發起訪問，會呈現出如下圖所示 的結果。我們可以清楚地看到，對于以XxxAsync/XxxCompleted形式定義的“異步”Action方法定義，只有針對 AsyncController并且采用AsyncControllerActionInvoker的情況下才會被解析為一個異步Action。如果不滿 足這兩個條件，它們會被視為兩個普通的同步Action。
Action方法的執行
目標Action方法的最終執行由被激活的Controller的ActionInvoker決定，ActionInvoker最終通過調用對應的 ActionDescriptor來執行被它描述的Action方法。如果采用ControllerActionInvoker，被它創建的 ControllerDescriptor（ReflectedControllerDescriptor）只包含同步的 ActionDescriptor（ReflectedActionDescriptor），所以Action方法總是以同步的方式被執行。
如果目標Controller是抽象類Controller的直接繼承者，這也是通過Visual Studio的Controller創建向導的默認定義方 式，ActionInvoker（ControllerActionInvoker/AsyncControllerActionInvoker）的選擇 只決定了創建的ControllerDescriptor的類型 （ReflectedControllerDescriptor/ReflectedAsyncControllerDescriptor），ControllerDescriptor 包含的所有ActionDescriptor依然是同步的（ReflectedActionDescriptor），所以Action方法也總是以同步的 方式被執行。
以異步方式定義的Action方法（XxxAsync/XxxCompleted或采用Task返回類型）只有定義在繼承自AsyncController的Controller類型中，并且采用AsyncControllerActionInvoker作為其ActionInvoker，最終才會創建AsyncActionDescriptor來描述該Action。也只有同時滿足這兩個條件，Action方法才能以異步的方式執行。