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最為返回值，這兩者矛盾的。