web service开发 java

很多时候我们需要开发web service

下面我就介绍一下

使用到的工具:Tomcat + axis2 + eclipse

我们需要下载两个zip包,可从http://ws.apache.org/axis2/ 下载Axis2的最新版本：

axis2-1.7.3-bin.zip

axis2-1.7.3-war.zip

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

解压axis2-1.7.3-war.zip文件得到axis2.war包,将war包放到apache-tomcat-8.0.36\webapps目录下,启动tomcat

浏览器访问 http://localhost:8080/axis2/,如看到下面页面则表示axis2安装成功

发布web service

一POJO形式发布,不需要任何配置,会将所有的public方法都发布出去

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

页面显示如下结果：

Xml代码  

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，

找到如下的配置代码：

Xml代码  

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

将true改为false即可。要注意的是，Axis2在默认情况下虽然是热发布，但并不是热更新.

也就是说，一旦成功发布了WebService，再想更新该WebService，就必须重启Tomcat。

这对于开发人员调试WebService非常不方便，因此，在开发WebService时，可以将Axis2设为热更新。

在axis2.xml文件中找到

Xml代码  

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

将false改为true即可。

3. 在浏览器中测试WebService时，如果WebService方法有参数，需要使用URL的请求参数来指定该WebService方法

参数的值，请求参数名与方法参数名要一致，例如，要测试sayHelloToPerson方法，请求参数名应为name，如上面的URL所示。

4. 发布WebService的pojo目录只是默认的，如果读者想在其他的目录发布WebService，

可以打开axis2.xml文件，并在<axisconfig>元素中添加如下的子元素：

Xml代码  

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会重名）。

使用services.xml配置文件发布

用Axis2实现Web Service，虽然可以将POJO类放在axis2\WEB-INF\pojo目录中直接发布成Web Service，

这样做不需要进行任何配置，但这些POJO类不能在任何包中。这似乎有些不方便.

为此，Axis2也允许将带包的POJO类发布成Web Service。先实现一个POJO类，代码如下：

Java代码  

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

Xml代码  

1. <?xml version="1.0" encoding="UTF-8"?>
2. <service name="HelloServiceNew">
3. <description>
4. Web Service例子
5. </description>
6. <parameter name="ServiceClass">
7. com.sinosoft.webservice.HelloServiceNew
8. </parameter>
9. <messageReceivers>
10. <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-out"
11. class="org.apache.axis2.rpc.receivers.RPCMessageReceiver" />
12. <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-only"
13. class="org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver" />
14. </messageReceivers>
15. </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

Xml代码  

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>

如果想发布多个WebService，可以使用<serviceGroup>元素

Xml代码  

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

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

使用打包方式时,需要重新下载jstl的相关jar包jstl-1.2.jar,standard-1.1.2.jar,不然会出错

用java 实现调用Web Service的客户端

这里用到了wsdl2java简化客户端的编写

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/HelloService?wsdl

-p client -s -o stub

其中-url参数指定了wsdl文件的路径，可以是本地路径，也可以是网络路径。

-p参数指定了生成的Java类的包名，-o参数指定了生成的一系列文件保存的根目录。

在执行完上面的命令后，就会发现在当前目录下多了个stub目录，

在stub/src/client目录可以找到一个HelloServiceStub.java文件，

该文件复杂调用WebService，可以在程序中直接使用这个类，代码如下：

Java代码  

1. package client;
2. public class StupTest {
3. public static void main(String[] args) throws Exception
4. {
5. HelloServiceStub stub = new HelloServiceStub();
6. HelloServiceStub.SayHelloToPerson gg = new HelloServiceStub.SayHelloToPerson();
7. gg.setName("美女");
8. System.out.println( stub.sayHello().get_return());
9. System.out.println(stub.sayHelloToPerson(gg).get_return());
10. }
11. }

输出结果如下：

hello

hello,美女

上面的代码大大简化了调用WebService的步骤，并使代码更加简洁。

但要注意的是，wsdl2java.bat命令生成的Stub类将WebService方法的参数都封装在了相应的类中，

类名为方法名，例如，sayHelloToPerson方法的参数都封装在了SayHelloToPerson类中，

要想调用sayHelloToPerson方法，必须先创建SayHelloToPerson类的对象实例。