WebService大讲堂之Axis2系列教程之一：用POJO实现0配置的WebService

前 言:

       Axis2是目前比较流行的WebService引擎。WebService被应用在很多不同的场景。例如，可以使用WebService来发布服务端 Java类的方法，以便使用不同的客户端进行调用。这样可以有效地集成多种不同的技术来完成应用系统。WebService还经常被使用在SOA中，用于 SOA各个部分交换数据。本课程重点讲解了Axis2的核心功能，并提供了三个项目以使学员理解并掌握如何将Axis2应用于不同的场景。
本课程站在初学者角度介绍了Axis2的大多数常用的功能，例如，以多种方式编写和发布WebService、JAX-RPC、JAX-WS、复杂类型传输、WebService会话管理、Axis2模块等。本课程共分为两部分，其中第一部分为Axis2基础知识讲解。在这部分介绍了前面所述的Axis2 知识。第二部分介绍了三个小的项目。这三个项目的功能类似。所不同的是，它们使用了不同的技术来实现。第一个项目使用Java Swing技术实现了个人信息管理（PIM）系统，这个系统可以对个人信息（如姓名、职位、电话等）进行增、删、改、查。在这些操作中，涉及到了如何使用 WebService来传输和下载图像文件、传输查询结果（Resultset对象）等技术难点。第二个项目使用Struts 2.1.6（目前Struts 2的最新版，2009年1月发布）来实现PIM。功能与第一个PIM类似。只是这个系统为Web版。在这个项目中学员可以学习到如果将 WebService应用在Web程序中。该系统的主要思想是如果Web程序和WebService部署在同一台机器上，Web程序可以直接调用 WebService所对应的Java类。当然，也可以象第一个项目一样，直接通过HTTP SOAP协议调用WebService。在第二个项目中同时使用了这两种方式来实现。这两种调用方式分别封装在两组Model类中。可以通过配置 struts.xml文件来提定使用哪组模型类（调用方式）。第三个项目使用了C#来实现PIM。这个项目的目的是为了演示如何将.net技术与Java 技术集成来实现一个完整的应用。一个团队要想获得成功，需要每个成员通力合作，各尽所长。而在一个项目中，也和一个团队是一样的，没有哪一种技术适合做所有的事情，因此，需要将各个领域的杰出代表组成一个技术团队。例如，Java适合做企业应用，也能跨平台，比较适合做服务端程序，但它在客户端（C/S）的实现上略显不足，而.net（以C#为代表）和visual studio是windows上语言和开发工具的王者，在GUI上有着无法超越的优势。因此，将Java和.net结合是最完美的联姻。学员从这个项目中就会体会到这个优势所在。

 

用POJO实现0配置的WebService:

 

Axis2是一套崭新的 WebService引擎，该版本是对 Axis1.x重新设计的产物。 Axis2不仅支持 SOAP1.1和 SOAP1.2，还集成了非常流行的 REST WebService，同时还支持 Spring、 JSON等技术。这些都将在后面的系列教程中讲解。在本文中主要介绍了如何使用 Axis2开发一个不需要任何配置文件的 WebService，并在客户端使用 Java和 C#调用这个 WebService。

一、 Axis2 的下载和安装

    读者可以从如下的网址下载 Axis2的最新版本：

    http://ws.apache.org/axis2/

    在本文使用了目前 Axis2的最新版本 1.4.1。读者可以下载如下两个 zip包：

    axis2-1.4.1-bin.zip

    axis2-1.4.1-war.zip

    其中 axis2-1.4.1-bin.zip文件中包含了 Axis2中所有的 jar文件 , axis2-1.4.1-war.zip文件用于将 WebService发布到 Web容器中。

    将 axis2-1.4.1-war.zip文件解压到相应的目录，将目录中的 axis2.war文件放到 <Tomcat安装目录 >\webapps目录中（本文使用的 Tomcat的版本是 6.x），并启动 Tomcat。

    在浏览器地址栏中输入如下的 URL：

    http://localhost:8080/axis2/

    如果在浏览器中显示出如图 1所示的页面，则表示 Axis2安装成功。

二、编写和发布WebService

  对于用 Java实现的服务程序给人的印象就是需要进行大量的配置，不过这一点在 Axis2中将被终结。在 Axis2中不需要进行任何的配置，就可以直接将一个简单的 POJO发布成 WebService。其中 POJO中所有的 public方法将被发布成 WebService方法。

    下面我们来实现一个简单的 POJO，代码如下：

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> -->public   class  SimpleService
{
     public  String getGreeting(String name)
    {
         return   " 你好  "   +  name;
    }    
     public   int  getPrice()
    {
         return   new  java.util.Random().nextInt( 1000 );
    }    
}

 

    在 SimpleService类中有两个方法，由于这两个方法都是 public方法，因此，它们都将作为 WebService方法被发布。

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

http://localhost:8080/axis2/services/listServices

    这时当前页面将显示所有在 Axis2中发布的 WebService，如图 2所示。

 

    在浏览器地址栏中输入如下的两个 URL来分别测试 getGreeting和 getPrice方法：

http://localhost:8080/axis2/services/SimpleService/getGreeting?name=bill

http://localhost:8080/axis2/services/SimpleService/getPrice

    图 3和图 4分别显示了 getGreeting和 getPrice方法的测试结果。

 

图3  getGreeting方法的测试结果

 

 

图4  getPrice方法的测试结果

 

    在编写、发布和测试 0配置的 WebService时应注意如下几点：

    1. POJO 类不能使用 package关键字声明包。

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

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> -->< parameter  name ="hotdeployment" > true </ parameter >

 

 

 

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

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

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

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> -->     < deployer  extension =".class"  directory ="my"  class ="org.apache.axis2.deployment.POJODeployer" />

 

 

 

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

 

三、 用 Java 实现调用 WebService 的客户端程序

    WebService是为程序服务的，只在浏览器中访问 WebService是没有意义的。因此，在本节使用 Java实现了一个控制台程序来调用上一节发布的 WebService。调用 WebService的客户端代码如下：

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

import  javax.xml.namespace.QName;
import  org.apache.axis2.addressing.EndpointReference;
import  org.apache.axis2.client.Options;
import  org.apache.axis2.rpc.client.RPCServiceClient;

public   class  RPCClient
{
     public   static   void  main(String[] args)  throws  Exception  
    {
         //   使用RPC方式调用WebService        
        RPCServiceClient serviceClient  =   new  RPCServiceClient();
        Options options  =  serviceClient.getOptions();
         //   指定调用WebService的URL
        EndpointReference targetEPR  =   new  EndpointReference(
                 " http://localhost:8080/axis2/services/SimpleService " );
        options.setTo(targetEPR);
         //   指定getGreeting方法的参数值
        Object[] opAddEntryArgs  =   new  Object[] { " 超人 " };
         //   指定getGreeting方法返回值的数据类型的Class对象
        Class[] classes  =   new  Class[] {String. class };
         //   指定要调用的getGreeting方法及WSDL文件的命名空间
        QName opAddEntry  =   new  QName( " http://ws.apache.org/axis2 " ,  " getGreeting " );
         //   调用getGreeting方法并输出该方法的返回值
        System.out.println(serviceClient.invokeBlocking(opAddEntry, opAddEntryArgs, classes)[ 0 ]);
         //   下面是调用getPrice方法的代码，这些代码与调用getGreeting方法的代码类似
        classes  =   new  Class[] { int . class };
        opAddEntry  =   new  QName( " http://ws.apache.org/axis2 " ,  " getPrice " );
        System.out.println(serviceClient.invokeBlocking(opAddEntry,  new  Object[]{}, classes)[ 0 ]);
    } 
}

 

 

 

 

运行上面的程序后，将在控制台输出如下的信息：

 

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> -->你好 超人
443

    在编写客户端代码时应注意如下几点：

    1.  客户端代码需要引用很多 Axis2的 jar包，如果读者不太清楚要引用哪个 jar包，可以在 Eclipse的工程中引用 Axis2发行包的 lib目录中的所有 jar包。

    2.  在本例中使用了 RPCServiceClient类的 invokeBlocking方法调用了 WebService中的方法。 invokeBlocking方法有三个参数，其中第一个参数的类型是 QName对象，表示要调用的方法名；第二个参数表示要调用的 WebService方法的参数值，参数类型为 Object[]；第三个参数表示 WebService方法的返回值类型的 Class对象，参数类型为 Class[]。当方法没有参数时， invokeBlocking方法的第二个参数值不能是 null，而要使用 new Object[]{}。

    3.  如果被调用的 WebService方法没有返回值，应使用 RPCServiceClient类的 invokeRobust方法，该方法只有两个参数，它们的含义与 invokeBlocking方法的前两个参数的含义相同。

    4.  在创建 QName对象时， QName类的构造方法的第一个参数表示 WSDL文件的命名空间名，也就是 <wsdl:definitions>元素的 targetNamespace属性值，下面是 SimpleService类生成的 WSDL文件的代码片段：

<!--<br /> <br /> Code highlighting produced by Actipro CodeHighlighter (freeware)<br /> http://www.CodeHighlighter.com/<br /> <br /> --><? xml version="1.0" encoding="UTF-8" ?>
< wsdl:definitions  xmlns:wsdl ="http://schemas.xmlsoap.org/wsdl/"  xmlns:ns1 ="http://org.apache.axis2/xsd"
xmlns:ns ="http://ws.apache.org/axis2"  xmlns:wsaw ="http://www.w3.org/2006/05/addressing/wsdl"
xmlns:http ="http://schemas.xmlsoap.org/wsdl/http/"  xmlns:xs ="http://www.w3.org/2001/XMLSchema"
xmlns:mime ="http://schemas.xmlsoap.org/wsdl/mime/"  xmlns:soap ="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:soap12 ="http://schemas.xmlsoap.org/wsdl/soap12/"
targetNamespace ="http://ws.apache.org/axis2" >
     < wsdl:types >
          
     </ wsdl:types >
      
</ wsdl:definitions >

 

四、用 wsdl2java 简化客户端的编写

    也许有很多读者会说“有没有搞错啊，只调用两个 WebService方法用要写这么多代码，太麻烦了”。

    不过幸好 Axis2提供了一个 wsdl2java.bat命令可以根据 WSDL文件自动产生调用 WebService的代码。 wsdl2java.bat命令可以在 <Axis2安装目录 >"bin目录中找到。在使用 wsdl2java.bat命令之前需要设置 AXIS2_HOME环境变量，该变量值是 <Axis2安装目录 >。

    在 Windows控制台输出如下的命令行来生成调用 WebService的代码：

%AXIS2_HOME%\bin\wsdl2java -uri http://localhost:8080/axis2/services/SimpleService?wsdl -p client -s -o stub

    其中 -url参数指定了 wsdl文件的路径，可以是本地路径，也可以是网络路径。 -p参数指定了生成的 Java类的包名， -o参数指定了生成的一系列文件保存的根目录。在执行完上面的命令后，读者就会发现在当前目录下多了个 stub目录，在 ."stub"src"client目录可以找到一个 SimpleServiceStub.java文件，该文件复杂调用 WebService，读者可以在程序中直接使用这个类，代码如下：

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

import  javax.xml.namespace.QName;
import  org.apache.axis2.addressing.EndpointReference;
import  org.apache.axis2.client.Options;
import  org.apache.axis2.rpc.client.RPCServiceClient;

public   class  StubClient
{
     public   static   void  main(String[] args)  throws  Exception  
    {
        SimpleServiceStub stub  =   new  SimpleServiceStub();
        SimpleServiceStub.GetGreeting gg  =   new  SimpleServiceStub.GetGreeting();
        gg.setName( " 比尔 " );
        System.out.println( stub.getGreeting(gg).get_return());
        System.out.println(stub.getPrice().get_return());
    } 
}

 

 

    上面的代码大大简化了调用 WebService的步骤，并使代码更加简洁。但要注意的是， wsdl2java.bat命令生成的 Stub类将 WebService方法的参数都封装在了相应的类中，类名为方法名，例如， getGreeting方法的参数都封装在了 GetGreeting类中，要想调用 getGreeting方法，必须先创建 GetGreeting类的对象实例。

 

本文来自CSDN博客：http://blog.csdn.net/ycyangcai/archive/2009/10/15/4675239.aspx