使用 services.xml 文件发布 WebService

优质

小牛编辑

133浏览

2023-12-01

用Axis2实现Web Service，虽然可以将POJO类放在axis2\WEB-INF\pojo目录中直接发布成Web Service，这样做不需要进行任何配置，但这些POJO类不能在任何包中。这似乎有些不方便，为此，Axis2也允许将带包的POJO类发布成Web Service。
先实现一个POJO类，代码如下：

package service;

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目录中，该文件的内容如下：

<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>元素用于发布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了。

另外services.xml文件中也可以直接指定WebService类的方法，如可以用下面的配置代码来发布WebService：

<service name="myService">
  <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类，代码如下：

package service
public class MyService1{
  public String getName(){ 
    return "bill";
  }
}

在services.xml文件中可以使用如下的配置代码来配置MyService和MyService1类：

<serviceGroup>
<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>

如果要传递二进制文件（如图像、音频文件等），可以使用byte[]作为数据类型进行传递，然后客户端使用RPC方式进行调用。这样做只是其中的一种方法，除此之外，在客户端还可以使用wsdl2java命令生成相应的stub类来调用WebService。

WebService类中包含byte[]类型参数的方法在wsdl2java生成的stub类中对应的数据类型不再是byte[]类型，而是javax.activation.DataHandler。DataHandler类是专门用来映射WebService二进制类型的。

在WebService类中除了可以使用byte[]作为传输二进制的数据类型外，也可以使用javax.activation.DataHandler作为数据类型。不管是使用byte[]，还是使用javax.activation.DataHandler作为WebService方法的数据类型，使用wsdl2java命令生成的stub类中相应方法的类型都是javax.activation.DataHandler。而象使用.net、delphi生成的stub类的相应方法类型都是byte[]。

这是由于javax.activation.DataHandler类是Java特有的，对于其他语言和技术来说，并不认识javax.activation.DataHandler类，因此，也只有使用最原始的byte[]了。