使用Axis2方式发布webService的三种方式

时间：2023-03-09 19:48:13
使用Axis2方式发布webService的三种方式

1、Axis2的下载和安装

首先可以下载如下两个zip包：
axis2-1.6.1-bin.zip
axis2-1.6.1-war.zip
其中 axis2-1.6.1-bin.zip文件中包含了Axis2中所有的jar文件, 
axis2-1.6.1-war.zip文件用于将WebService发布到Web容器中。

将axis2-1.6.1-war.zip文件解压到相应的目录，将目录中的axis2.war文件放到<Tomcat安装目录>\webapps目录中，
并启动Tomcat,在浏览器地址栏中输入如下的URL：

http://localhost:8080/axis2/，如看到axis2的主页面则安装成功。

2、简单的pojo方式（无需配置）：

在Axis2中不需要进行任何的配置，就可以直接将一个简单的POJO发布成WebService。
    其中POJO中所有的public方法将被发布成WebService方法。

示例代码如下：

  1. public class HelloService {
  2. public String sayHello(){
  3. return "hello";
  4. }
  5. public String sayHelloToPerson(String name){
  6. if(name==null){
  7. name = "nobody";
  8. }
  9. return "hello,"+name;
  10. }
  11. }

编译HelloService类后，将HelloService.class文件放到<Tomcat安装目录>\webapps\axis2\WEB-INF\pojo目录中
  （如果没有pojo目录，则建立该目录）。现在我们已经成功将HelloService类发布成了WebService。
  在浏览器地址栏中输入如下的URL：
     http://localhost:8080/axis2/services/listServices

在浏览器地址栏中输入如下的两个URL来分别测试sayHelloToPerson和sayHello方法：
    1.http://localhost:8080/axis2/services/HelloService/sayHello 
    2.http://localhost:8080/axis2/services/HelloService/sayHelloToPerson?name=bill

页面显示如下结果：

  1. <ns:sayHelloToPersonResponse xmlns:ns="http://ws.apache.org/axis2">
  2. <return>hello,bill</return>
  3. </ns:sayHelloToPersonResponse>

在编写、发布和测试WebService时应注意如下几点：
     1. POJO类不能使用package关键字声明包。

2. Axis2在默认情况下可以热发布WebService，也就是说，将WebService的.class文件复制到pojo目录中时，
        Tomcat不需要重新启动就可以自动发布WebService。
        如果想取消Axis2的热发布功能，可以打开<Tomcat安装目录>\webapps\axis2\WEB-INF\conf\axis2.xml，
        找到如下的配置代码：

  1. <parameter name="hotdeployment">true</parameter>

将true改为false即可。要注意的是，Axis2在默认情况下虽然是热发布，但并不是热更新.
  也就是说，一旦成功发布了WebService，再想更新该WebService，就必须重启Tomcat。
  这对于开发人员调试WebService非常不方便，因此，在开发WebService时，可以将Axis2设为热更新。
  在axis2.xml文件中找到

  1. <parameter name="hotupdate">false</parameter>

将false改为true即可。

3. 在浏览器中测试WebService时，如果WebService方法有参数，需要使用URL的请求参数来指定该WebService方法
     参数的值，请求参数名与方法参数名要一致，例如，要测试sayHelloToPerson方法，请求参数名应为name，如上面的URL所示。

4. 发布WebService的pojo目录只是默认的，如果读者想在其他的目录发布WebService，
     可以打开axis2.xml文件，并在<axisconfig>元素中添加如下的子元素：

  1. <deployer extension=".class" directory="my" class="org.apache.axis2.deployment.POJODeployer"/>

上面的配置允许在<Tomcat安装目录>\webapps\axis2\WEB-INF\my目录中发布WebService。
   例如，将本例中的HelloService.class复制到my目录中也可以成功发布
   （但要删除pojo目录中的SimpleService.class，否则WebService会重名）。

3、打jar包的方式：

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

  1. package com.sinosoft.webservice;
  2. public class HelloServiceNew {
  3. public String sayHelloNew(){
  4. return "hello";
  5. }
  6. public String sayHelloToPersonNew(String name){
  7. if(name==null){
  8. name = "nobody";
  9. }
  10. return "hello,"+name;
  11. }
  12. public void updateData(String data){
  13. System.out.println(data+" 已更新。");
  14. }
  15. }

要想将HelloServiceNew类发布成Web Service，需要一个services.xml文件，
   这个文件需要放在META-INF目录中，该文件的内容如下：

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- webService发布名称,命名空间 -->
  3. <service name="HelloServiceNew" targetNamespace="http://ws.apache.org/ax2">
  4. <!-- 更改schemaNamespace，也可使用默认值，客户端调用时会使用 -->
  5. <schema schemaNamespace="http://sdjxd.com.cn"/>
  6. <!-- webService描述 -->
  7. <description>Web Service实例一</description>
  8. <!-- webService的实现类 -->
  9. <parameter name="ServiceClass">com.sinosoft.webservice.HelloServiceNew</parameter>
  10. <messageReceivers>
  11. <!-- 配置消息接收器，Axis2会自动选择 -->
  12. <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-out"
  13. class="org.apache.axis2.rpc.receivers.RPCMessageReceiver" />
  14. <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-only"
  15. class="org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver"/>
  16. </messageReceivers>
  17. </service>

其中<service>元素用于发布Web Service，一个<service>元素只能发布一个WebService类，
  name属性表示WebService名，如下面的URL可以获得这个WebService的WSDL内容：
  http://localhost:8080/axis2/services/HelloServiceNew?wsdl
  其中name属性名就是上面URL中"?"和"/"之间的部分。
  <description>元素表示当前Web Service的描述，<parameter>元素用于设置WebService的参数，
  在这里用于设置WebService对应的类名。
  在这里最值得注意的是<messageReceivers>元素，该元素用于设置处理WebService方法的处理器。
  例如，sayHelloNew方法有一个返回值，因此，需要使用可处理输入输出的RPCMessageReceiver类，
  而updateData方法没有返回值，因此，需要使用只能处理输入的RPCInOnlyMessageReceiver类。
  
  使用这种方式发布WebService，必须打包成.aar文件，.aar文件实际上就是改变了扩展名的.jar文件。
  现在建立了两个文件：HelloServiceNew.Java和services.xml。
  将HelloServiceNew.java编译，生成HelloServiceNew.class。
  services.xml和HelloServiceNew.class文件的位置如下：
  D:\ws\ com\sinosoft\webservice\HelloServiceNew.class
  D:\ws\META-INF\services.xml
  在windows控制台中进入ws目录，并输入如下的命令生成.aar文件.

jar cvf ws.aar .(注意：最后面是空格+小数点)

实际上，.jar文件也可以发布webservice，但axis2官方文档中建议使用.aar文件发布webservice.
  最后将ws.aar文件复制到<Tomcat安装目录>\webapps\axis2\WEB-INF\services目录中，
  启动Tomcat后，就可以调用这个WebService了。

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

  1. <service name=" HelloServiceNew ">
  2. <description>
  3. Web Service例子
  4. </description>
  5. <parameter name="ServiceClass">
  6. com.sinosoft.webservice.HelloServiceNew
  7. </parameter>
  8. <operation name="sayHello">
  9. <messageReceiver class="org.apache.axis2.rpc.receivers.RPCMessageReceiver"/>
  10. </operation>
  11. <operation name="updateData">
  12. <messageReceiver
  13. class="org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver"/>
  14. </operation>
  15. </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>元素

  1. <serviceGroup>
  2. <service name="myService1">
  3. ...
  4. </service>
  5. <service name="myService2">
  6. ...
  7. </service>
  8. </serviceGroup>

中间省略的代码同上面services.xml文件的配置。

4、不打jar包的方式：（重点）

有一个最简单的方法就是把axis2.war中的内容作为Web Project的基础, 来进行开发.

不过为了更清楚的了解如何在一个已有的Web Project中嵌入axis2, 那就手动来配置。大致分如下几个步骤：

一、新建Web Project，名为“WebServiceDemo”

二、下载axis2-1.6.1-war.zip包，解压缩

将axis2/WEB-INF/lib 里的jar包拷贝到 WebServiceDemo/WebRoot/WEB-INF/lib/

将axis2.war/axis2-web拷贝至WebServiceDemo/ WebRoot/axis2-web/

三、配置axis2 servlet

打开WebServiceDemo/WebRoot/WEB-INF/web.xml，增加如下配置：

  1. <span style="font-size:14px;"><servlet>
  2. <servlet-name>AxisServlet</servlet-name>
  3. <servlet-class>org.apache.axis2.transport.http.AxisServlet</servlet-class>
  4. <load-on-startup>1</load-on-startup>
  5. </servlet>
  6. <servlet-mapping>
  7. <servlet-name>AxisServlet</servlet-name>
  8. <url-pattern>/services/*</url-pattern>
  9. </servlet-mapping>  </span>

四、写一个简单的web服务类

  1. <span style="font-size:14px;">package service;
  2. public class MyService {
  3. public String sayHello(String name) {
  4. return name + "says /"Hello!/"";
  5. }
  6. } </span>

五、配置Web Service.

由于axis2已嵌入到WebServiceDemo项目中，所以web service就不用打包成aar，而是直接在/WEB-INF目录下创建相应的文件夹和services.xml，目录结构如下图：

使用Axis2方式发布webService的三种方式

使用Axis2方式发布webService的三种方式

六、services.xml

  1. <span style="font-size:14px;"><?xml version="1.0" encoding="UTF-8"?>
  2. <serviceGroup>
  3. <service name="myService">
  4. <description>Web Service例子</description>
  5. <parameter name="ServiceClass">service.MyService</parameter>
  6. <messageReceivers>
  7. <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-out" class="org.apache.axis2.rpc.receivers.RPCMessageReceiver" />
  8. <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-only" class="org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver" />
  9. </messageReceivers>
  10. </service>
  11. </serviceGroup></span>

七、在浏览器中访问http://localhost:8080/WebServiceDemo/services/listServices

可以看到myService服务，说明服务已部署成功

输入http://localhost:8080/WebServiceDemo/services/myService?wsdl

可以查看到该Web服务的描述文件

使用Axis2方式发布webService的三种方式

其实，axis2-web下面的东西可以不要那么多，我就只保留了index.jsp,httpbase.jsp和listServices.jsp这三个文件，这样集成后的工程就瘦身了

相关文章