用JAX-WS在Tomcat中发布WebService

JDK中已经内置了Webservice发布，不过要用Tomcat等Web服务器发布WebService，还需要用第三方Webservice框架。Axis2和CXF是目前最流行的Webservice框架，这两个框架各有优点，不过都属于重量级框架。

JAX-WS RI是JAX WebService参考实现。相对于Axis2和CXF，JAX-WS RI是一个轻量级的框架。虽然是个轻量级框架，JAX-WS RI也提供了在Web服务器中发布Webservice的功能。官网地址https://jax-ws.java.net/。下面用JAX-WS RI在Tomcat中发布WebService。

博客中的实例代码 http://download.csdn.net/detail/accountwcx/8922191

服务端

新建一个Maven Web项目，在项目中添加JAX-WS RI引用，pom.xml配置文件如下

[html]  view plain copy

1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
2.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">  
3.     <modelVersion>4.0.0</modelVersion>  
4.     <groupId>com.rvho</groupId>  
5.     <artifactId>jaxwsserver</artifactId>  
6.     <version>0.0.1-SNAPSHOT</version>  
7.     <packaging>war</packaging>  
8.   
9.     <properties>  
10.         <!-- 文件拷贝编码 -->  
11.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>  
12.         <!-- 输出编码 -->  
13.         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>  
14.         <!-- 编译编码 -->  
15.         <maven.compiler.encoding>UTF-8</maven.compiler.encoding>  
16.     </properties>  
17.   
18.     <dependencies>  
19.         <!-- JAXWS-RI -->  
20.         <dependency>  
21.             <groupId>com.sun.xml.ws</groupId>  
22.             <artifactId>jaxws-rt</artifactId>  
23.             <version>2.2.10</version>  
24.         </dependency>  
25.     </dependencies>  
26. </project>  

创建服务接口

1. package com.rvho.server.ws;  
2.   
3. import java.util.Date;  
4. import javax.jws.WebService;  
5.   
6. /** 
7.  * WebService接口 
8.  */  
9. @WebService(name = "HelloWS", targetNamespace = "http://www.tmp.com/ws/hello")  
10. public interface HelloWService {  
11.     /** 
12.      * 返回字符串 
13.      *  
14.      * @return 
15.      */  
16.     String index();  
17.   
18.     /** 
19.      * 两个整数相加 
20.      *  
21.      * @param x 
22.      * @param y 
23.      * @return 相加后的值 
24.      */  
25.     Integer add(Integer x, Integer y);  
26.   
27.     /** 
28.      * 返回当前时间 
29.      *  
30.      * @return 
31.      */  
32.     Date now();  
33.       
34.     /** 
35.      * 获取复杂类型 
36.      * @param name 用户姓名 
37.      * @param age 用户年龄 
38.      * @return 返回用户类 
39.      */  
40.     PersonEntity getPerson(String name, Integer age);  
41. }  

创建服务接口实现类(SEI)

1. package com.rvho.server.ws.impl;  
2.   
3. import java.util.Date;  
4.   
5. import javax.jws.WebService;  
6.   
7. import com.rvho.server.entity.PersonEntity;  
8. import com.rvho.server.ws.HelloWService;  
9.   
10. @WebService(  
11.         endpointInterface = "com.rvho.server.ws.HelloWService",  
12.         portName = "HelloWSPort",  
13.         serviceName = "HelloWSService",  
14.         targetNamespace = "http://www.tmp.com/ws/hello")  
15. public class HelloWServiceImpl implements HelloWService {  
16.     public String index() {  
17.         return "hello";  
18.     }  
19.   
20.     public Integer add(Integer x, Integer y) {  
21.         return x + y;  
22.     }  
23.   
24.     public Date now() {  
25.         return new Date();  
26.     }  
27.       
28.     public PersonEntity getPerson(String name, Integer age) {  
29.         PersonEntity person = new PersonEntity();  
30.         person.setAge(age);  
31.         person.setName(name);  
32.           
33.         return person;  
34.     }  
35. }  

服务中用到的复杂类型PersonEntity

1. package com.rvho.server.entity;  
2.   
3. import java.io.Serializable;  
4.   
5. public class PersonEntity implements Serializable {  
6.     private static final long serialVersionUID = -7211227324542440039L;  
7.       
8.     private String name;  
9.     private Integer age;  
10.       
11.     public String getName() {  
12.         return name;  
13.     }  
14.     public void setName(String name) {  
15.         this.name = name;  
16.     }  
17.     public Integer getAge() {  
18.         return age;  
19.     }  
20.     public void setAge(Integer age) {  
21.         this.age = age;  
22.     }  
23. }  

在WEB-INF中创建WebService配置文件sun-jaxws.xml，配置文件中一个WebService对应一个Endpoint。

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <endpoints xmlns="http://java.sun.com/xml/ns/jax-ws/ri/runtime" version="2.0">  
3.     <!-- 服务路径http://网站路径/services/hello -->  
4.     <endpoint name="hello" implementation="com.rvho.server.ws.impl.HelloWServiceImpl" url-pattern="/services/hello" />  
5. </endpoints> 

在web.xml中添加WSServlet，如果Web项目使用Servlet 3.0则不需要以下配置。

1. <!-- Servlet 3.0或者以上不需要配置 -->  
2. <servlet>  
3.     <servlet-name>jaxws</servlet-name>  
4.     <servlet-class>com.sun.xml.ws.transport.http.servlet.WSServlet</servlet-class>  
5.     <load-on-startup>1</load-on-startup>  
6. </servlet>  
7. <servlet-mapping>  
8.     <servlet-name>jaxws</servlet-name>  
9.     <url-pattern>/services</url-pattern>  
10. </servlet-mapping>

发布服务后，在浏览器中输入http://<网站路径>/services/hello可以看到如下页面

客户端

在JDK的bin文件夹中，提供了一个根据wsdl生成java类的工具wsimport.exe。

1. 用法: wsimport [options] <WSDL_URI>  
2.   
3. 其中 [options] 包括:  
4.   -b <path>                 指定 jaxws/jaxb 绑定文件或附加模式  
5.                             (每个 <path> 都必须具有自己的 -b)  
6.   -B<jaxbOption>            将此选项传递给 JAXB 模式编译器  
7.   -catalog <file>           指定用于解析外部实体引用的目录文件  
8.                             支持 TR9401, XCatalog 和 OASIS XML 目录格式。  
9.   -d <directory>            指定放置生成的输出文件的位置  
10.   -encoding <encoding>      指定源文件所使用的字符编码  
11.   -extension                允许供应商扩展 - 不按规范  
12.                             指定功能。使用扩展可能会  
13.                             导致应用程序不可移植或  
14.                             无法与其他实现进行互操作  
15.   -help                     显示帮助  
16.   -httpproxy:<host>:<port>  指定 HTTP 代理服务器 (端口默认为 8080)  
17.   -keep                     保留生成的文件  
18.   -p <pkg>                  指定目标程序包  
19.   -quiet                    隐藏 wsimport 输出  
20.   -s <directory>            指定放置生成的源文件的位置  
21.   -target <version>         按给定的 JAXWS 规范版本生成代码  
22.                             默认为 2.2, 接受的值为 2.0, 2.1 和 2.2  
23.                             例如, 2.0 将为 JAXWS 2.0 规范生成兼容的代码  
24.   -verbose                  有关编译器在执行什么操作的输出消息  
25.   -version                  输出版本信息  
26.   -wsdllocation <location>  @WebServiceClient.wsdlLocation 值  
27.   -clientjar <jarfile>      创建生成的 Artifact 的 jar 文件以及  
28.                             调用 Web 服务所需的 WSDL 元数据。  
29.   -generateJWS              生成存根 JWS 实现文件  
30.   -implDestDir <directory>  指定生成 JWS 实现文件的位置  
31.   -implServiceName <name>   生成的 JWS 实现的服务名的本地部分  
32.   -implPortName <name>      生成的 JWS 实现的端口名的本地部分  
33.   
34. 扩展:  
35.   -XadditionalHeaders              映射标头不绑定到请求或响应消息不绑定到  
36.                                    Java 方法参数  
37.   -Xauthfile                       用于传送以下格式的授权信息的文件:  
38.                                    http://username:password@example.org/stock?wsdl  
39.   -Xdebug                          输出调试信息  
40.   -Xno-addressing-databinding      允许 W3C EndpointReferenceType 到 Java 的绑定  
41.   
42.   -Xnocompile                      不编译生成的 Java 文件  
43.   -XdisableAuthenticator           禁用由 JAX-WS RI 使用的验证程序,  
44.                                    将忽略 -Xauthfile 选项 (如果设置)  
45.   -XdisableSSLHostnameVerification 在提取 wsdl 时禁用 SSL 主机名  
46.                                    验证  
47.   
48. 示例:  
49.   wsimport stock.wsdl -b stock.xml -b stock.xjb  
50.   wsimport -d generated http://example.org/stock?wsdl  

输入以下命令，即可生成Java类

[plain]  view plain copy

1. D:\Program Files\Java\jdk1.8.0_25\bin>wsimport.exe -encoding utf-8 -p com.rvho.client.wsdl.hello -d d:\wsdl\compile -s d:\wsdl\src http://localhost:8014/jaxwsserver/services/hello?wsdl  

最后生成的客户端Java类

在客户端调用服务

1. package com.rvho.client.wsdl.hello;  
2.   
3. import java.net.URL;  
4.   
5. public class Client {  
6.   
7.     public static void main(String[] args) throws Exception {  
8.           
9.         URL wsdlUrl = new URL("http://localhost:8014/jaxwsserver/services/hello?wsdl");  
10.         HelloWSService helloWSS = new HelloWSService(wsdlUrl);        
11.         HelloWS helloWS = helloWSS.getHelloWSPort();  
12.           
13.         Integer x = 3;  
14.         Integer y = 5;  
15.         Integer add = helloWS.add(x, y);  
16.         System.out.println("add");  
17.         System.out.println("3 + 5 = " + add);  
18.         System.out.println("");  
19.           
20.         String name = "小明";  
21.         Integer age = 19;  
22.         PersonEntity person = helloWS.getPerson(name, age);  
23.         System.out.println("getPerson");  
24.         System.out.println("name = " + person.getName() + " age = " + person.getAge());  
25.         System.out.println("");  
26.     }  
27.   
28. }  

注意

JAXWS-RI在Tomcat 8中部署，调用服务时会有如下错误

1. 警告: onComplete() failed for listener of type [org.apache.catalina.core.AsyncListenerWrapper]  
2. java.lang.IllegalStateException: It is illegal to call getRequest() after complete() or any of the dispatch() methods has been called  
3.     at org.apache.catalina.core.AsyncContextImpl.getRequest(AsyncContextImpl.java:225)  
4.     at com.sun.xml.ws.transport.http.servlet.WSAsyncListener$1.onComplete(WSAsyncListener.java:69)  
5.     at org.apache.catalina.core.AsyncListenerWrapper.fireOnComplete(AsyncListenerWrapper.java:35)  
6.     at org.apache.catalina.core.AsyncContextImpl.fireOnComplete(AsyncContextImpl.java:99)  
7.     at org.apache.coyote.AsyncStateMachine.asyncPostProcess(AsyncStateMachine.java:208)  
8.     at org.apache.coyote.AbstractProcessor.asyncPostProcess(AbstractProcessor.java:173)  
9.     at org.apache.coyote.AbstractProtocol$AbstractConnectionHandler.process(AbstractProtocol.java:662)  
10.     at org.apache.coyote.http11.Http11NioProtocol$Http11ConnectionHandler.process(Http11NioProtocol.java:222)  
11.     at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1566)  
12.     at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.run(NioEndpoint.java:1523)  
13.     at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142)  
14.     at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617)  
15.     at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)  
16.     at java.lang.Thread.run(Thread.java:745)