WCF中的非同步實現

對於WCF中通訊的雙方來說，用戶端可以非同步調用服務；服務端對服務也能以非同步方式實現。這就涉及到兩個方面：WCF用戶端非同步呼叫服務；服務端的非同步實現本節是Artech《WCF技術剖析(卷1)》一篇讀書筆記。在文章中老A介紹了用戶端如何以非同步方式消費WCF服務，以及服務的非同步實現，個人對這幾種方式做個總結。

 

目錄：

1. WCF用戶端非同步呼叫服務
2. 服務端的非同步實現 

 

WCF用戶端非同步呼叫服務主要通過產生非同步代理類，然後調用其中的非同步方法呼叫來實現非同步呼叫。非同步代理程式類的產生：

 

• 通過SvcUtil  /async   直接生產非同步代理程式；
• 通過添加應用的方式，點擊”添加引用“的“進階”按鈕，在彈出來的對話方塊中選擇“產生非同步”。

 

產生的非同步呼叫代理類部分借口：

 

 

              [System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Advanced)]

public System.IAsyncResult BeginAdd(int x, int y, System.AsyncCallback callback, object asyncState) {
            return base.Channel.BeginAdd(x, y, callback, asyncState);
        }

        public void AddAsync(int x, int y) {
            this.AddAsync(x, y, null);
        }

        public void AddAsync(int x, int y, object userState) {
            if ((this.onBeginAddDelegate == null)) {
                this.onBeginAddDelegate = new BeginOperationDelegate(this.OnBeginAdd);
            }
            if ((this.onEndAddDelegate == null)) {
                this.onEndAddDelegate = new EndOperationDelegate(this.OnEndAdd);
            }
            if ((this.onAddCompletedDelegate == null)) {
                this.onAddCompletedDelegate = new System.Threading.SendOrPostCallback(this.OnAddCompleted);
            }
            base.InvokeAsync(this.onBeginAddDelegate, new object[] {
                        x,
                        y}, this.onEndAddDelegate, this.onAddCompletedDelegate, userState);
        }

 

1、用戶端非同步呼叫服務

用戶端非同步呼叫服務主要方式有幾種：

1.1、直接調用非同步方法呼叫：在產生的代理類中，有BeginAdd\EndAdd等服務契約中定義的Add操作的非同步實現。直接調用BeginAdd方法，實現用戶端非同步呼叫服務端方法。在調用BeginAdd方法後，可執行一些其他動作，這些操作與服務端Add調用並存執行，Add調用最終通過EndAdd方法得到。 

測試代碼如下：

用戶端代碼：IAsyncResult asyncResult = calculatorClient.BeginAdd(1, for (int i = 0; i < 10; i++) 

{
    Console.WriteLine(i);
}
int resul = calculatorClient.EndAdd(asyncResult);
Console.WriteLine(string.Format("計算結果：{0}",resul));

服務端代碼：       public int Add(int x, int y) 

    {
        for (int i = 0; i < 20; i++)
       {
        Console.WriteLine(i);
       }
       Console.WriteLine("開始計算...");
       return x + y;
    }

服務端輸出如下：

 

 用戶端輸出如下：

 

這種方式使用了EndAdd方法，如果服務端沒有執行完成，當前線程會被阻塞直到非同步呼叫的服務完成後結束。如用戶端代碼保持不變，將服務實現改為如下：for (int i = 0; i < 20; i++)  

{
    Console.WriteLine(i);
}
Thread.Sleep(5000);
Console.WriteLine("開始計算...");
return x + y;

如果在服務端讓線程睡眠幾秒，就可看到用戶端會被阻塞：

 

1.2、通過回調的方式非同步呼叫服務：在產生的非同步呼叫代理類中，還可以通過回調用服務；IAsyncResult asyncResult = calculatorClient.BeginAdd(1, 2, 

delegate(IAsyncResult asyncResult)
                                          {
                                                int [] array = asyncResult.AsyncState as int [];
                                                int result= calculatorClient.EndAdd(asyncResult1);
                                                calculatorClient.close()
                                                Console.WriteLine(string.Format("{0}+{1}={2}", array[0], array[1], result));
                                           }, new []{1,2});

 

這種方式是對服務的非同步呼叫完成以後，自動調用回調來擷取結果。

1.3、通過為非同步作業註冊事件//進行非同步呼叫 

calculatorClient.AddAsync(10, 36, new[] { 1000 });

//為非同步呼叫完成定義觸發事件 

calculatorClient.AddCompleted += calculatorClient_AddCompleted;
Console.WriteLine("服務調用完成...");
Console.ReadKey();
  

//非同步呼叫完成後執行 

privatestaticvoid calculatorClient_AddCompleted(object obj, AddCompletedEventArgs args)
{
    var array = args.UserState as int[];
    int result = args.Result;
    Console.WriteLine(result);
}

2、服務的非同步實現：將服務實現定義成非同步方式，需要將OperationContract的AsyncPattern設定為true；應用到BeginXX介面上,並且此操作的最後兩個參數必須為AsyncCallback ，object；需要有一個EndXX(IAsyncResult asyncResult)的介面與非同步呼叫的介面匹配。需要注意的是EndXX(IAsyncResult asyncResult)不能再次聲明為契約介面，也就是不能再標記為OperationContract。

將服務定義為非同步服務，契約定義如下 ：

[OperationContract(AsyncPattern = true)]  

IAsyncResult BeginCalculator 
(int x,int y ,AsyncCallback asyncCallback, object state);

 

void EndCalculator(IAsyncResult);

 

然後在實現契約介面的服務中，將方法實現為非同步。

將契約介面聲明為單向，也就是OneWay，這樣用戶端對此服務介面調用就是非同步。因為它無需等待服務端返回，用戶端只需將訊息發送到傳輸層就立即返回。那能不能將將這種用戶端對服務端的非同步呼叫直接標記為單向的，那是不是可以不用產生非同步代理程式類(即上述SvcUtil /Ayncs或者在添加引用時聲明將代理類產生非同步作業)？答案是否定的，因為OneWay要求方法的傳回值為void，而非同步方法需要IAsyncResult最為傳回值，這兩者矛盾的。