WebService axis2

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，代码如下：

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

????编译SimpleService类后，将SimpleService.class文件放到<Tomcat安装目录>webappsaxis2WEB-INFpojo目录中（如果没有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安装目录>webappsaxis2WEB-INFconfaxis2.xml，找到如下的配置代码：

????将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>元素中添加如下的子元素：

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

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

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

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

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

????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文件的代码片段：

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

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

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

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

%AXIS2_HOME%binwsdl2java -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，读者可以在程序中直接使用这个类，代码如下：

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

五、使用C#调用WebService

????从理论上说，WebService可以被任何支持SOAP协议的语言调用。在Visual Studio中使用C#调用WebService是在所有语言中最容易实现的（VB.net的调用方法类似，也同样很简单）。

????新建一个Visual Studio工程，并在引用Web服务的对话框中输入如下的URL，并输入Web引用名为“WebService”：

????http://localhost:8080/axis2/services/SimpleService?wsdl

????然后引用Web服务的对话框就会显示该WebService中的所有的方法，如图5所示。

????在完成上面的工作后，只需要如下三行C#代码就可以调用getGreeting和getPrice方法，并显示这两个方法的返回值：

????在.net解析WSDL文件时直接将getGreeting方法的参数映射为String类型，因此，可以直接进行传值。
????从上面的调用过程可以看出，添加Web引用的过程就相当于在Java中调用wsdl2java.bat自动生成stub类的过程。只是在调用stub类时与C#有一定的区别，但从总体上来说，都大大简化了调用WebService的过程。

在实际的应用中，不仅需要使用WebService来传递简单类型的数据，有时也需要传递更复杂的数据，这些数据可以被称为复合类型的数据。数组与类（接口）是比较常用的复合类型。在Axis2中可以直接使用将WebService方法的参数或返回值类型声明成数组或类（接口）。但要注意，在定义数组类型时只能使用一维数组，如果想传递多维数组，可以使用分隔符进行分隔，如下面的代码所示：

String[] strArray = new String[]{ "自行车,飞机,火箭","中国,美国,德国","超人,蜘蛛侠,钢铁侠" } ;

????上面的代码可以看作是一个3*3的二维数组。

????在传递类的对象实例时，除了直接将数组类型声明成相应的类或接口，也可以将对象实例进行序列化，也就是说，将一个对象实例转换成字节数组进行传递，然后接收方再进行反序列化，还原这个对象实例。

????下面的示例代码演示了如何传递数组与类（接口）类型的数据，并演示如何使用字节数组上传图像。本示例的客户端代码使用Java和C#编写。要完成这个例子需要如下几步：

一、实现服务端代码

??? ComplexTypeService是一个WebService类，该类的代码如下：

?

二、实现DataForm类

????DataForm是要返回的对象实例所对应的类，该类的实现代码如下：?

三、发布WebService

????由于本示例的WebService类使用了一个Java类（DataForm类），因此，在发布WebService之前，需要先将DataForm.class文件复制到<Tomcat安装目录>webappsaxis2WEB-INFclassesdata目录中，然后将ComplexTypeService.class文件复制到<Tomcat安装目录>webappsaxis2WEB-INFpojo目录中，最后启动Tomcat（如果Tomcat已经启动，由于增加了一个DataForm类，因此，需要重新启动Tomcat）。

四、使用Java编写调用WebService的客户端代码

????在客户端仍然使用了RPC的调用方式，代码如下：

????运行上面的程序，将输出如下的内容：

五、使用C#编写调用WebService的客户端代码

????在Visual Studio中使用WebService就简单得多。假设引用WebService时的引用名为complexType，则下面的代码调用了uploadImageWithByte方法来上传图像文件。在Visual Studio引用WebService时，uploadImageWithByte方法多了两个out参数，在使用时要注意。

????在获得二维数组时，可以将数据加载到DataGridView或其他类似的控件中，代码如下：

????向DataGridView控件添加数据后的效果如图1所示。

????对于其他的WebService方法的调用都非常简单，读者可以自己做这个实验。

????要注意的是，由于.net和java序列化和反序列化的差异，通过序列化的方式传递对象实例只使用于客户端与服务端为同一种语言或技术的情况，如客户端和服务端都使用Java来编写。

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

这个类有两个方法，这两个方法都需要发布成Web Service方法。这种方式和直接放在pojo目录中的POJO类不同。要想将MyService类发布成Web Service，需要一个services.xml文件，这个文件需要放在META-INF目录中，该文件的内容如下：

上面的配置代码前面的部分和以前的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类，代码如下：

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