原文地址:WebService大讲堂之Axis2(3):使用services.xml文件发布WebService
上一篇: WebService大讲堂之Axis2(2):复合类型数据的传递
下一篇:
用 Axis2实现 Web Service,虽然可以将 POJO类放在 axis2\WEB-INF\pojo目录中直接发布成 Web Service,这样做不需要进行任何配置,但这些 POJO类不能在任何包中。这似乎有些不方便,为此, Axis2也允许将带包的 POJO类发布成 Web Service。
先实现一个 POJO类,代码如下:
public class MyService
{
public String getGreeting(String name)
{
return " 您好 " + name;
}
public void update(String data)
{
System.out.println( " < " + data + " >已经更新 " );
}
}
这个类有两个方法,这两个方法都需要发布成 Web Service方法。这种方式和直接放在 pojo目录中的 POJO类不同。要想将 MyService类发布成 Web Service,需要一个 services.xml文件,这个文件需要放在 META-INF目录中,该文件的内容如下:
< description >
Web Service例子
</ 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" />
< messageReceiver mep ="http://www.w3.org/2004/08/wsdl/in-only"
class ="org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver" />
</ messageReceivers >
</ service >
其中 <service>元素用于发布 Web Service,一个 <service>元素只能发布一个 WebService类, name属性表示 WebService名,如下面的 URL可以获得这个 WebService的 WSDL内容:
http://localhost:8080/axis2/services/myService?wsdl
其中 name属性名就是上面 URL中 "?"和 "/"之间的部分。
<description>元素表示当前 Web Service的描述, <parameter>元素用于设置 WebService的参数,在这里用于设置 WebService对应的类名。在这里最值得注意的是 <messageReceivers>元素,该元素用于设置处理 WebService方法的处理器。例如, getGreeting方法有一个返回值,因此,需要使用可处理输入输出的 RPCMessageReceiver类,而 update方法没有返回值,因此,需要使用只能处理输入的 RPCInOnlyMessageReceiver类。
使用这种方式发布 WebService,必须打包成 .aar文件, ..aar文件实际上就是改变了扩展名的 .jar文件。在现在建立了两个文件: MyService.java和 services.xml。将 MyService.java编译,生成 MyService.class。 services.xml和 MyService.class文件的位置如下:
D:\ws\service\MyService.class
D:\ws\META-INF\services.xml
在 windows控制台中进入 ws目录,并输入如下的命令生成 .aar文件(实际上,.jar文件也可以发布webservice,但axis2官方文档中建议使用.aar文件发布webservice):
jar cvf ws.aar .
最后将 ws.aar文件复制到 <Tomcat安装目录 >\webapps\axis2\WEB-INF\services目录中,启动 Tomcat后,就可以调用这个 WebService了。调用的方法和 《WebService大讲堂之Axis2(1):用POJO实现0配置的WebService》 所讲的方法类似。
另外 services.xml文件中也可以直接指定 WebService类的方法,如可以用下面的配置代码来发布 WebService:
< description >
Web Service例子
</ description >
< parameter name ="ServiceClass" >
service.MyService
</ parameter >
< operation name ="getGreeting" >
< messageReceiver class ="org.apache.axis2.rpc.receivers.RPCMessageReceiver" />
</ operation >
< operation name ="update" >
< messageReceiver
class ="org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver" />
</ operation >
</ service >
上面的配置代码前面的部分和以前的 services.xml文件的内容相同,但后面使用了 <operation>元素来指定每一个 WebService方法,并单独指定了处理每一个方法的处理器。对于客户端来说,调用使用这两个 services.xml文件发布的 WebService并没有太大我区别,只是使用第二个 services.xml文件发布 WebServices后,在使用 wsdl2java命令或使用 C#、 delphi等生成客户端的 stub时, update方法的 String类型被封装在了 update类中,在传递 update方法的参数时需要建立 update类的对象实例。而使用第一个 services.xml文件发布的 WebService在生成 stub时直接可以为 update方法传递 String类型的参数。从这一点可以看出,这两种方法生成的 WSDL有一定的区别。但实际上,如果客户端程序使用第一个 services.xml文件发布的 WebService生成 stub类时(这时 update方法的参数是 String),在服务端又改为第二个 services.xml文件来发布 WebService,这时客户端并不需要再重新生成 stub类,而可以直接调用 update方法。也就是说,服务端使用什么样的方式发布 WebService,对客户端并没有影响。
如果想发布多个 WebService,可以使用 <serviceGroup>元素,如再建立一个 MyService1类,代码如下:
public class MyService1
{
public String getName()
{
return " bill " ;
}
}
在 services.xml文件中可以使用如下的配置代码来配置 MyService和 MyService1类:
< service name ="myService" >
< description >
Web Service例子
</ 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" />
< messageReceiver mep ="http://www.w3.org/2004/08/wsdl/in-only"
class ="org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver" />
</ messageReceivers >
</ service >
< service name ="myService1" >
< description >
Web Service例子
</ description >
< parameter name ="ServiceClass" >
service.MyService1
</ parameter >
< messageReceivers >
< messageReceiver mep ="http://www.w3.org/2004/08/wsdl/in-out"
class ="org.apache.axis2.rpc.receivers.RPCMessageReceiver" />
< messageReceiver mep ="http://www.w3.org/2004/08/wsdl/in-only"
class ="org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver" />
</ messageReceivers >
</ service >
</ serviceGroup >