信步漫談之Axis2—異步調用

主要介紹axis2接口的異步調用方式。

一般情況下，我們使用同步方法（invokeBlocking）調用 axis2 接口，如果被調用的 WebService 方法長時間不返回，客戶端將一直被阻塞，直到該方法返回為止。使用同步方法來調用 WebService 雖然很直觀，但當 WebService 方法由於各種原因需要很長時間才能返回的話，就會使客戶端程序一直處於等待狀態，這樣用戶是無法忍受的。

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

雖然直接使用多線程可以很好地解決這個問題，但比較麻煩。幸好 Axis2 的客戶端提供了異步訪問 WebService 的功能。
RPCServiceClient 類提供了一個 invokeNonBlocking 方法可以通過異步的方式來訪問 WebService。下面結合實例說明。

目錄結構：

關鍵代碼：

package com.alfred.client;

import java.io.IOException;

import javax.xml.namespace.QName;
import org.apache.axis2.addressing.EndpointReference;
import org.apache.axis2.client.Options;
import org.apache.axis2.client.async.AxisCallback;
import org.apache.axis2.context.MessageContext;
import org.apache.axis2.rpc.client.RPCServiceClient;

public class ServiceClient {
	public static void main(String args[]) throws IOException {
		sendAxis2();
	}

	/**
	 * 發送axis2的接口信息
	 *
	 * @throws IOException
	 */
	private static void sendAxis2() throws IOException {
		// 使用RPC方式調用WebService
		RPCServiceClient serviceClient = new RPCServiceClient();

		Options options = serviceClient.getOptions();
		// 指定調用WebService的URL
		EndpointReference targetEPR = new EndpointReference(
				"http://127.0.0.1:8080/awyb/services/mySoapService");
		options.setTo(targetEPR);
		// 指定sayHello方法的參數值，如果有多個，繼續往后面增加即可
		Object[] opAddEntryArgs = new Object[] { "alfred" };
		// 在創建QName對象時，QName類的構造方法的第一個參數表示WSDL，文件的命名空間名，也就是<wsdl:definitions>元素的targetNamespace屬性值
		// 第二個參數是要調用的方法名
		QName opAddEntry = new QName("http://service.alfred.com", "sayHello");
		serviceClient.invokeNonBlocking(opAddEntry, opAddEntryArgs,new AxisCallback() {
			public void onComplete() {}

			public void onError(Exception arg0) {}

			public void onFault(MessageContext arg0) {}

			public void onMessage(MessageContext mc) {
				// 輸出返回值
				System.out.println(mc.getEnvelope().getFirstElement()
						.getFirstElement().getFirstElement().getText());
			}
		});
		System.out.println("異步調用！");
		// 阻止程序退出
		System.in.read();
	}

}

package com.alfred.service;

import org.apache.axis2.AxisFault;

public class SoapService {
	public String sayHello(String name) throws AxisFault {
		try {
			System.out.println("sayHello方法正在執行 ");
			// 延遲5秒
			Thread.sleep(5000);
		} catch (Exception e) {
			e.printStackTrace();
		}
		return "Hello," + name;
	}

	public String getWorld() {
		return "Hello,World";
	}
}

客戶端異步訪問 axis2 的 sayHello，控制台打印信息：

可以看到程序並沒有等待接口返回就繼續執行之后的操作。

異步調用使用的方法是 invokeNonBlocking，從上面的代碼可以看出，invokeNonBlocking 方法有三個參數，前兩個參數分別指定了要調用的方法及方法參數的相關信息，而最后一個參數並不是方法返回值的類型信息，而是一個實現 org.apache.axis2.client.async.AxisCallback 接口的類的對象實例。在本例中隱式實現了 AxisCallback 接口。在 AxisCallback 接口中有四個方法需要實現，其中當被異步調用的方法返回時 onMessage 方法被調用。

我們也可以使用 wsdl2java 命令的 -a 參數生成可異步調用的 Stub 類（需先安裝 axis2，配置好 AXIS2_HOME 環境變量）。下面的命令可生成同步和異步調用的客戶端代碼（兩個類），其中 –s 表示生成同步調用代碼，-a 表示生成異步調用代碼。

%AXIS2_HOME%\bin\wsdl2java -uri http://127.0.0.1:8080/awyb/services/mySoapService?wsdl -p client -s -a -o stub

在執行上面的命令后，將生成兩個類：MySoapServiceStub 和 MySoapServiceCallbackHandler 類，其中 MySoapServiceStub 類負責同步和異步調用 WebService，MySoapServiceCallbackHandler 類是一個抽象類，也是一個回調類，當使用異步方式調用 WebService 方法時，如果方法返回，則 MySoapServiceCallbackHandler 類的 receiveResultgetName 方法被調用。下面是使用 MySoapServiceStub 類異步訪問 WebService 的代碼。

目錄結構：

關鍵代碼：

package client;

import client.MySoapServiceStub.GetWorldResponse;
import client.MySoapServiceStub.SayHelloResponse;

public class MyCallback extends MySoapServiceCallbackHandler {

	@Override
	public void receiveResultgetWorld(GetWorldResponse result) {
		// 輸出getWorld方法的返回結果
		System.out.println(result.get_return());
	}

	@Override
	public void receiveResultsayHello(SayHelloResponse result) {
		// 輸出sayHello方法的返回結果
		System.out.println(result.get_return());
	}

}

package client;

import client.MySoapServiceStub.SayHello;

public class StubClient {
	public static void main(String[] args) throws Exception {
		MySoapServiceStub stub = new MySoapServiceStub();
		// 異步調用WebService
		SayHello sayHello = new SayHello();
		sayHello.setName("alfred other");
		stub.startsayHello(sayHello, new MyCallback());
		System.out.println("異步調用！");
		System.in.read();
	}
}

MySoapServiceCallbackHandler 和 MySoapServiceStub 是自動生成的代碼。

訪問sayHello后控制台打印結果：