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方法才能以非同步的方式執行。