信步漫谈之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后控制台打印结果：