WebService之Axis2快速入門(8): WebService的異步調用

在前面幾篇文章中都是使用同步方式來調用WebService。也就是說，若是被調用的WebService方法長時間不返回，客戶端將一直被阻塞，直到該方法返回爲止。使用同步方法來調用WebService雖然很直觀，但當WebService方法因爲各類緣由須要很長時間才能返回的話，就會使客戶端程序一直處於等待狀態，這樣用戶是沒法忍受的。

固然，咱們很容易就能夠想到解決問題的方法，這就是多線程。解決問題的基本方法是將訪問WebService的任務交由一個或多個線程來完成，而主線程並不負責訪問WebService。這樣即便被訪問的WebService方法長時間不返回，客戶端仍然能夠作其餘的工做。咱們能夠管這種經過多線程訪問WebService的方式稱爲異步訪問。

雖然直接使用多線程能夠很好地解決這個問題，但比較麻煩。幸虧Axis2的客戶端提供了異步訪問WebService的功能。
RPCServiceClient類提供了一個invokeNonBlocking方法能夠經過異步的方式來訪問WebService。

下面先來創建一個WebService。
MyService是一個WebService類，代碼以下：

1 2 3 4 5 6 7 8 9 10 11 12

package service; public class MyService {     public String getName() {         try {             System.out.println("getName方法正在執行");             //  延遲5秒             Thread.sleep(5000);         } catch (Exception e) {         }         return "火星";     } }

爲了模擬須要必定時間才返回的WebService方法，在getName方法中使用了sleep方法來延遲5秒。

下面是MyService類的配置代碼：

1 2 3 4 5 6 7 8 9 10 11 12 13

<!--  services.xml  --> <service name="myService">     <description>         異步調用演示     </description>     <parameter name="ServiceClass">         service.MyService     </parameter>     <messageReceivers>         <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-out"             class="org.apache.axis2.rpc.receivers.RPCMessageReceiver" />     </messageReceivers> </service>

從上面的配置代碼能夠看出，MyService的配置方式與前幾章的WebService的配置方式徹底同樣，也就是說，MyService只是一個普通的WebService。

下面是異步調用MyService的Java客戶端代碼：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34

public class RPCAsyncClient {     public static void main(String[] args) throws Exception {         RPCServiceClient serviceClient = new RPCServiceClient();         Options options = serviceClient.getOptions();         EndpointReference targetEPR = new EndpointReference(                 "http://localhost:8080/axis2/services/myService");         options.setTo(targetEPR);         Object[] opAddEntryArgs = new Object[]{};         QName opAddEntry = new QName("http://service", "getName");         serviceClient.invokeNonBlocking(             opAddEntry, opAddEntryArgs,             new org.apache.axis2.client.async.AxisCallback() {                 @Override                 public void onComplete() {                 }                 @Override                 public void onError(Exception arg0) {                 }                 @Override                 public void onFault(MessageContext arg0) {                 }                 @Override                 public void onMessage(MessageContext mc) {                     //  輸出返回值                     System.out.println(mc.getEnvelope().getFirstElement()                             .getFirstElement().getFirstElement().getText());                 }             }         );         System.out.println("異步調用！");         //  阻止程序退出         System.in.read();     } }

從上面的代碼能夠看出，invokeNonBlocking方法有三個參數，前兩個參數分別指定了要調用的方法及方法參數的相關信息，而最後一個參數並非方法返回值的類型信息，而是一個實現org.apache.axis2.client.async.AxisCallback接口的類的對象實例。在本例中隱式實現了AxisCallback接口。在AxisCallback接口中有四個方法須要實現，其中當被異步調用的方法返回時onMessage方法被調用。當運行上面的程序後，將輸出以下的信息：

1 2

異步調用！ 火星

雖然上面的例子能夠實現異步調用，但比較麻煩。爲了更方便地實現異步調用，可使用wsdl2java命令的-a參數生成可異步調用的Stub類。下面的命令可生成同步和異步調用的客戶端代碼（兩個類），其中-s表示生成同步調用代碼，-a表示生成異步調用代碼。

1	%AXIS2_HOME%\bin\wsdl2java -uri http://localhost:8080/axis2/services/myService?wsdl -p client -s -a -o stub

在執行上面的命令後，將生成兩個類：MyServiceStub和MyServiceCallbackHandler類，其中MyServiceStub類負責同步和異步調用WebService，MyServiceCallbackHandler類是一個抽象類，也是一個回調類，當使用異步方式調用WebService方法時，若是方法返回，則MyServiceCallbackHandler類的receiveResultgetName方法被調用。

下面是使用MyServiceStub類異步訪問WebService的代碼：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

package client; import client.MyServiceStub.GetNameResponse; class MyCallback extends MyServiceCallbackHandler {     @Override     public void receiveResultgetName(GetNameResponse result) {         //  輸出getName方法的返回結果         System.out.println(result.get_return());     } } public class StubClient {     public static void main(String[] args) throws Exception {         MyServiceStub stub = new MyServiceStub();         //  異步調用WebService         stub.startgetName(new MyCallback());         System.out.println("異步調用！");         System.in.read();     } }

執行上面的程序後，將輸出以下的信息：   

1 2

異步調用！ 火星

在.net中也可使用異步的方式來調用WebService，如在C#中可以使用以下的代碼來異步調用getName方法：

1 2 3 4 5 6 7 8 9 10 11

//  回調方法 private void getNameCompletedEvent(object sender, WSC.asyn.getNameCompletedEventArgs e){     listBox1.Items.Add( e.Result.@return); } private void button1_Click(object sender, EventArgs e){          async.myService my = new WSC.async.myService();     my.getNameCompleted += new           WSC.async.getNameCompletedEventHandler(getNameCompletedEvent);     my.getNameAsync();     MessageBox.Show("完成調用"); }

其中async是引用MyService的服務名。要注意的是，在C#中不能在同一個WebService實例的getName方法未返回以前，再次調用該實例的getName方法，不然將拋出異常。以下面的代碼會拋出一個異常：

1 2 3 4 5 6

async.myService my = new WSC.async.myService(); my.getNameCompleted += new     WSC.async.getNameCompletedEventHandler(getNameCompletedEvent); my.getNameAsync(); //  將拋出異常 my.getNameAsync();

但不一樣的WebService實例的方法能夠在方法未返回時調用，以下面的代碼是能夠正常工做的：

1 2 3 4 5 6

asyn.myService my = new WSC.asyn.myService(); my.getNameAsync(); my.getNameCompleted += new WSC.asyn.getNameCompletedEventHandler(getNameCompletedEvent); asyn.myService my1 = new WSC.asyn.myService(); my1.getNameCompleted += new WSC.asyn.getNameCompletedEventHandler(getNameCompletedEvent); my1.getNameAsync();