ASP.NET MVC涉及到的5個同步與異步，你是否傻傻分不清楚？[下篇]

關于ASP.NET MVC對請求的處理方式（同步或者異步）涉及到的五個組件，在《上篇》中我們談了三個（MvcHandler、Controller和ActionInvoker），現在我們來談余下的兩個，即ControllerDescriptor和ActionDescriptor，這五個組件的執行并非孤立的，而是具有議定的關系。相信讀者認真閱讀了這兩篇文章后，會對整個請求的處理方式有一個深刻的理解。[

目錄
一、MvcHandler的同步于異步
二、Controller的同步與異步
三、ActionInvoker的同步與異步
四、ControllerDescriptor的同步與異步
五、ActionDescriptor的同步與異步
    1、實例演示：AsyncActionInvoker對ControllerDescriptor的創建
    2、AsyncController、AsyncControllerActionInvoker與AsyncActionDescriptor
    3、Action方法的執行

四、ControllerDescriptor的同步與異步

如果采用ControllerActionInvoker，Action總是以同步的方式來直接，但是當AsyncControllerActionInvoker作為Controller的ActionInvoker時，并不意味著總是以異步的方式來執行所有的Action。至于這兩種類型的ActionInvoker具體采用對Action的怎樣的執行方式，又涉及到兩個描述對象，即用于描述Controller和Action的ControllerDescriptor和ActionDescriptor。

通過前面“Model的綁定”中對這兩個對象進行過相應的介紹，我們知道在ASP.NET MVC應用編程接口中具有兩個具體的ControllerDescriptor，即ReflectedControllerDescriptor和ReflectedAsyncControllerDescriptor，它們分別代表同步和異步版本的ControllerDescriptor。

   1: public class ReflectedControllerDescriptor : ControllerDescriptor

   2: {

   3:     //省略成員

   4: }

5:

   6: public class ReflectedAsyncControllerDescriptor : ControllerDescriptor

   7: {

   8:     //省略成員

   9: }

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對象。

   1: public class FooActionInvoker : ControllerActionInvoker

   2: {

   3:     public new ControllerDescriptor GetControllerDescriptor(ControllerContext controllerContext)

   4:     {

   5:         return base.GetControllerDescriptor(controllerContext);

   6:     }

   7: }

8:

   9: public class BarActionInvoker : AsyncControllerActionInvoker

  10: {

  11:     public new ControllerDescriptor GetControllerDescriptor(ControllerContext controllerContext)

  12:     {

  13:         return base.GetControllerDescriptor(controllerContext);

  14:     }

  15: }

然后我們定義了兩個Controller類型，它們均是抽象類型Controller的直接繼承者。如下面的代碼片斷所示，這兩Controller類（FooController和BarController）都重寫了虛方法CreateActionInvoker，而返回的ActionInvoker類型分別是上面我們定義的FooActionInvoker和BarActionInvoker。在默認的Action方法Index中，我們利用當前的ActionInvoker得到用于描述本Controller的ControllerDescriptor對象，并將其類型呈現出來。

   1: public class FooController : Controller

   2: {

   3:     protected override IActionInvoker CreateActionInvoker()

   4:     {

   5:         return new FooActionInvoker();

   6:     }

7:

   8:     public void Index()

   9:     {

  10:         ControllerDescriptor controllerDescriptor = ((FooActionInvoker)this.ActionInvoker).GetControllerDescriptor(ControllerContext);

  11:         Response.Write(controllerDescriptor.GetType().FullName);

  12:     }

  13: }

14:

  15: public class BarController : Controller

  16: {

  17:     protected override IActionInvoker CreateActionInvoker()

  18:     {

  19:         return new BarActionInvoker();

  20:     }

21:

  22:     public void Index()

  23:     {

  24:         ControllerDescriptor controllerDescriptor = ((BarActionInvoker)this.ActionInvoker).GetControllerDescriptor(ControllerContext);

  25:         Response.Write(controllerDescriptor.GetType().FullName);

  26:     }

  27: }

現在我們運行我們的程序，并在瀏覽器中輸入相應的地址對定義在FooController和BarController的默認Action方法Index發起訪問，相應的ControllerDescriptor類型名稱會以下圖所示的形式呈現出來，它們的類型分別是ReflectedControllerDescriptor和ReflectedAsyncControllerDescriptor。

五、ActionDescriptor的執行

Controller包含一組用于描述Action方法的ActionDescriptor對象。由于Action方法可以采用同步和異步執行方法，異步Action對應的ActionDescriptor直接或者間接繼承自抽象類AsyncActionDescriptor，后者是抽象類ActionDescriptor的子類。如下面的代碼片斷所示，同步和異步Action的執行分別通過調用Execute和BeginExecute/EndExecute方法來完成。值得一提的是，AsyncActionDescriptor重寫了Execute方法并直接在此方法中拋出一個InvalidOperationException異常，也就是說AsyncActionDescriptor對象只能采用異步執行方式。

   1: public abstract class ActionDescriptor : ICustomAttributeProvider

   2: {

   3:     //其他成員

   4:     public abstract object Execute(ControllerContext controllerContext, IDictionary<string, object> parameters);

   5: }

6:

   7: public abstract class AsyncActionDescriptor : ActionDescriptor

   8: {

   9:     //其他成員

  10:     public abstract IAsyncResult BeginExecute(ControllerContext controllerContext, IDictionary<string, object> parameters, AsyncCallback callback, object state);

  11:     public abstract object EndExecute(IAsyncResult asyncResult);

  12: }

通過前面“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，然后對其進行如下的修改。

   1: public class HomeController : AsyncController

   2: {

   3:     public void Index()

   4:     {

   5:         MethodInfo method = typeof(AsyncControllerActionInvoker).GetMethod("GetControllerDescriptor", BindingFlags.Instance | BindingFlags.NonPublic);

   6:         ControllerDescriptor controllerDescriptor = (ControllerDescriptor)method.Invoke(this.ActionInvoker, new object[] { this.ControllerContext });

   7:         Response.Write(controllerDescriptor.GetType().FullName + "<br/>");

   8:         CheckAction(controllerDescriptor, "Foo");

   9:         CheckAction(controllerDescriptor, "Bar");

  10:         CheckAction(controllerDescriptor, "Baz");

11:

  12:     }

  13:      private void CheckAction(ControllerDescriptor controllerDescriptor,string actionName)

  14:     {

  15:         ActionDescriptor actionDescriptor = controllerDescriptor.FindAction(this.ControllerContext, actionName);

  16:         Response.Write(string.Format("{0}: {1}<br/>",actionName,actionDescriptor.GetType().FullName));

  17:     }

18:

  19:     public void Foo() { }

  20:     public void BarAsync() { }

  21:     public void BarCompleted() { }

  22:     public Task<ActionResult> Baz()

  23:     {

  24:         throw new NotImplementedException();

  25:     }

  26: }

我們首先將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）。

   1: public class FooController : AsyncController

   2: {

   3:     protected override IActionInvoker CreateActionInvoker()

   4:     {

   5:         return new BarActionInvoker();

   6:     }

   7:     public void Index()

   8:     {

   9:         BarActionInvoker actionInvoker = (BarActionInvoker)this.ActionInvoker;

  10:         Utility.DisplayActions(controllerContext=>actionInvoker.GetControllerDescriptor(ControllerContext),ControllerContext);

  11:     }

12:

  13:     public void DoSomethingAsync()

  14:     { }

  15:     public void DoSomethingCompleted()

  16:     { }

  17: }

18:

  19: public class BarController : Controller

  20: {

  21:     protected override IActionInvoker CreateActionInvoker()

  22:     {

  23:         return new BarActionInvoker();

  24:     }

  25:     public void Index()

  26:     {

  27:         BarActionInvoker actionInvoker = (BarActionInvoker)this.ActionInvoker;

  28:         Utility.DisplayActions(controllerContext => actionInvoker.GetControllerDescriptor(ControllerContext), ControllerContext);

  29:     }

  30:     public void DoSomethingAsync()

  31:     { }

  32:     public void DoSomethingCompleted()

  33:     { }

  34: }

35:

  36: public class BazController : Controller

  37: {

  38:     protected override IActionInvoker CreateActionInvoker()

  39:     {

  40:         return new FooActionInvoker();

  41:     }

  42:     public void Index()

  43:     {

  44:         FooActionInvoker actionInvoker = (FooActionInvoker)this.ActionInvoker;

  45:         Utility.DisplayActions(controllerContext => actionInvoker.GetControllerDescriptor(ControllerContext), ControllerContext);

  46:     }

  47:     public void DoSomethingAsync()

  48:     { }

  49:     public void DoSomethingCompleted()

  50:     { }

  51: }

52:

  53: public static class Utility

  54: {

  55:     public static void DisplayActions(Func<ControllerContext, ControllerDescriptor> controllerDescriptorAccessor, ControllerContext controllerContext)

  56:     {

  57:         ControllerDescriptor controllerDescriptor = controllerDescriptorAccessor(controllerContext);

  58:         string[] actionNames = { "DoSomething", "DoSomethingAsync", "DoSomethingCompleted" };

  59:         Array.ForEach(actionNames, actionName =>

  60:             {

  61:                 ActionDescriptor actionDescriptor = controllerDescriptor.FindAction(controllerContext,actionName);

  62:                 if (null != actionDescriptor)

  63:                 {

  64:                     HttpContext.Current.Response.Write(string.Format("{0}: {1}<br/>", actionDescriptor.ActionName, actionDescriptor.GetType().Name));

  65:                 }

  66:             });

  67:     }

  68: }

我們在三個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方法才能以異步的方式執行。

ASP.NET MVC涉及到的5個同步與異步，你是否傻傻分不清楚？[上篇]
ASP.NET MVC涉及到的5個同步與異步，你是否傻傻分不清楚？[下篇]

posted @ 2012-06-22 08:50 Artech 閱讀(9489) 評論(12) 收藏舉報

刷新頁面返回頂部