WebService大讲堂之Axis2(8)：异步调用WebService

转自：http://space.itpub.net/12921506/viewspace-586959

 

在前面几篇文章中都是使用同步方式来调用WebService。也就是说，如果被调用的WebService方法长时间不返回，客户端将一直被阻塞，直到该方法返回为止。使用同步方法来调用WebService虽然很直观，但当WebService方法由于各种原因需要很长时间才能返回的话，就会使客户端程序一直处于等待状态，这样用户是无法忍受的。
当然，我们很容易就可以想到解决问题的方法，这就是多线程。解决问题的基本方法是将访问WebService的任务交由一个或多个线程来完成，而主线程并不负责访问WebService。这样即使被访问的WebService方法长时间不返回，客户端仍然可以做其他的工作。我们可以管这种通过多线程访问WebService的方式称为异步访问。
虽然直接使用多线程可以很好地解决这个问题，但比较麻烦。幸好Axis2的客户端提供了异步访问WebService的功能。
RPCServiceClient类提供了一个invokeNonBlocking方法可以通过异步的方式来访问WebService。下面先来建立一个WebService。
MyService是一个WebService类，代码如下：

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> -->packageservice;
publicclassMyService
{
publicStringgetName()
{
try
{
System.out.println("getName方法正在执行");
//延迟5秒
Thread.sleep(5000);
}
catch(Exceptione)
{
}
return"火星";
}
}

为了模拟需要一定时间才返回的WebService方法，在getName方法中使用了sleep方法来延迟5秒。
下面是MyService类的配置代码：

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> --><!--services.xml-->
<servicename="myService">
<description>
异步调用演示
</description>
<parametername="ServiceClass">
service.MyService
</parameter>
<messageReceivers>
<messageReceivermep="http://www.w3.org/2004/08/wsdl/in-out"
class="org.apache.axis2.rpc.receivers.RPCMessageReceiver"/>
</messageReceivers>
</service>

 

从上面的配置代码可以看出，MyService的配置方式与前几章的WebService的配置方式完全一样，也就是说，MyService只是一个普通的WebService。
下面是异步调用MyService的Java客户端代码：

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> -->packageclient;

importjavax.xml.namespace.QName;
importorg.apache.axis2.addressing.EndpointReference;
importorg.apache.axis2.client.Options;
importorg.apache.axis2.context.MessageContext;
importorg.apache.axis2.rpc.client.RPCServiceClient;

publicclassRPCAsyncClient
{
publicstaticvoidmain(String[]args)throwsException
{
RPCServiceClientserviceClient=newRPCServiceClient();
Optionsoptions=serviceClient.getOptions();
EndpointReferencetargetEPR=newEndpointReference(
"http://localhost:8080/axis2/services/myService");
options.setTo(targetEPR);
Object[]opAddEntryArgs=newObject[]{};
QNameopAddEntry=newQName("http://service","getName");
serviceClient.invokeNonBlocking(opAddEntry,opAddEntryArgs,
neworg.apache.axis2.client.async.AxisCallback()
{
@Override
publicvoidonComplete()
{
}
@Override
publicvoidonError(Exceptionarg0)
{
}}
@Override
publicvoidonFault(MessageContextarg0)
{
}
@Override
publicvoidonMessage(MessageContextmc)
{
//输出返回值
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方法被调用。当运行上面的程序后，将输出如下的信息：

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> -->异步调用！
火星

虽然上面的例子可以实现异步调用，但比较麻烦。为了更方便地实现异步调用，可以使用wsdl2java命令的-a参数生成可异步调用的Stub类。下面的命令可生成同步和异步调用的客户端代码（两个类），其中-s表示生成同步调用代码，-a表示生成异步调用代码。

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> -->%AXIS2_HOME%/bin/wsdl2java-urihttp://localhost:8080/axis2/services/myService?wsdl-pclient-s-a-ostub

在执行上面的命令后，将生成两个类：MyServiceStub和MyServiceCallbackHandler类，其中MyServiceStub类负责同步和异步调用WebService，MyServiceCallbackHandler类是一个抽象类，也是一个回调类，当使用异步方式调用WebService方法时，如果方法返回，则MyServiceCallbackHandler类的receiveResultgetName方法被调用。下面是使用MyServiceStub类异步访问WebService的代码：

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> -->packageclient;

importclient.MyServiceStub.GetNameResponse;

classMyCallbackextendsMyServiceCallbackHandler
{
@Override
publicvoidreceiveResultgetName(GetNameResponseresult)
{
//输出getName方法的返回结果
System.out.println(result.get_return());
}
}
publicclassStubClient
{
publicstaticvoidmain(String[]args)throwsException
{
MyServiceStubstub=newMyServiceStub();
//异步调用WebService
stub.startgetName(newMyCallback());
System.out.println("异步调用！");
System.in.read();
}
}

 

执行上面的程序后，将输出如下的信息：

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> -->异步调用！
火星

在.net中也可以使用异步的方式来调用WebService，如在C#中可使用如下的代码来异步调用getName方法：

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> -->//回调方法
privatevoidgetNameCompletedEvent(objectsender,WSC.asyn.getNameCompletedEventArgse)
{
listBox1.Items.Add(e.Result.@return);
}
privatevoidbutton1_Click(objectsender,EventArgse)
{
async.myServicemy=newWSC.async.myService();
my.getNameCompleted+=newWSC.async.getNameCompletedEventHandler(getNameCompletedEvent);
my.getNameAsync();
MessageBox.Show("完成调用");
}

其中async是引用MyService的服务名。要注意的是，在C#中不能在同一个WebService实例的getName方法未返回之前，再次调用该实例的getName方法，否则将抛出异常。如下面的代码会抛出一个异常：

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> -->async.myServicemy=newWSC.async.myService();
my.getNameCompleted+=newWSC.async.getNameCompletedEventHandler(getNameCompletedEvent);
my.getNameAsync();
//将抛出异常
my.getNameAsync();

 

但不同的WebService实例的方法可以在方法未返回时调用，如下面的代码是可以正常工作的：

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> -->asyn.myServicemy=newWSC.asyn.myService();
my.getNameAsync();
my.getNameCompleted+=newWSC.asyn.getNameCompletedEventHandler(getNameCompletedEvent);
asyn.myServicemy1=newWSC.asyn.myService();
my1.getNameCompleted+=newWSC.asyn.getNameCompletedEventHandler(getNameCompletedEvent);
my1.getNameAsync();