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
- <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
- <modelVersion>4.0.0</modelVersion>
- <groupId>com.rvho</groupId>
- <artifactId>jaxwsserver</artifactId>
- <version>0.0.1-SNAPSHOT</version>
- <packaging>war</packaging>
- <properties>
- <!-- 文件拷贝编码 -->
- <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
- <!-- 输出编码 -->
- <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
- <!-- 编译编码 -->
- <maven.compiler.encoding>UTF-8</maven.compiler.encoding>
- </properties>
- <dependencies>
- <!-- JAXWS-RI -->
- <dependency>
- <groupId>com.sun.xml.ws</groupId>
- <artifactId>jaxws-rt</artifactId>
- <version>2.2.10</version>
- </dependency>
- </dependencies>
- </project>
创建服务接口
[java] view plain copy
- package com.rvho.server.ws;
- import java.util.Date;
- import javax.jws.WebService;
- /**
- * WebService接口
- */
- @WebService(name = "HelloWS", targetNamespace = "http://www.tmp.com/ws/hello")
- public interface HelloWService {
- /**
- * 返回字符串
- *
- * @return
- */
- String index();
- /**
- * 两个整数相加
- *
- * @param x
- * @param y
- * @return 相加后的值
- */
- Integer add(Integer x, Integer y);
- /**
- * 返回当前时间
- *
- * @return
- */
- Date now();
- /**
- * 获取复杂类型
- * @param name 用户姓名
- * @param age 用户年龄
- * @return 返回用户类
- */
- PersonEntity getPerson(String name, Integer age);
- }
创建服务接口实现类(SEI)
[java] view plain copy
- package com.rvho.server.ws.impl;
- import java.util.Date;
- import javax.jws.WebService;
- import com.rvho.server.entity.PersonEntity;
- import com.rvho.server.ws.HelloWService;
- @WebService(
- endpointInterface = "com.rvho.server.ws.HelloWService",
- portName = "HelloWSPort",
- serviceName = "HelloWSService",
- targetNamespace = "http://www.tmp.com/ws/hello")
- public class HelloWServiceImpl implements HelloWService {
- public String index() {
- return "hello";
- }
- public Integer add(Integer x, Integer y) {
- return x + y;
- }
- public Date now() {
- return new Date();
- }
- public PersonEntity getPerson(String name, Integer age) {
- PersonEntity person = new PersonEntity();
- person.setAge(age);
- person.setName(name);
- return person;
- }
- }
服务中用到的复杂类型PersonEntity
[java] view plain copy
- package com.rvho.server.entity;
- import java.io.Serializable;
- public class PersonEntity implements Serializable {
- private static final long serialVersionUID = -7211227324542440039L;
- private String name;
- private Integer age;
- public String getName() {
- return name;
- }
- public void setName(String name) {
- this.name = name;
- }
- public Integer getAge() {
- return age;
- }
- public void setAge(Integer age) {
- this.age = age;
- }
- }
在WEB-INF中创建WebService配置文件sun-jaxws.xml,配置文件中一个WebService对应一个Endpoint。
[html] view plain copy
- <?xml version="1.0" encoding="UTF-8"?>
- <endpoints xmlns="http://java.sun.com/xml/ns/jax-ws/ri/runtime" version="2.0">
- <!-- 服务路径http://网站路径/services/hello -->
- <endpoint name="hello" implementation="com.rvho.server.ws.impl.HelloWServiceImpl" url-pattern="/services/hello" />
- </endpoints>
在web.xml中添加WSServlet,如果Web项目使用Servlet 3.0则不需要以下配置。
[html] view plain copy
- <!-- Servlet 3.0或者以上不需要配置 -->
- <servlet>
- <servlet-name>jaxws</servlet-name>
- <servlet-class>com.sun.xml.ws.transport.http.servlet.WSServlet</servlet-class>
- <load-on-startup>1</load-on-startup>
- </servlet>
- <servlet-mapping>
- <servlet-name>jaxws</servlet-name>
- <url-pattern>/services</url-pattern>
- </servlet-mapping>
发布服务后,在浏览器中输入http://<网站路径>/services/hello可以看到如下页面
客户端
在JDK的bin文件夹中,提供了一个根据wsdl生成java类的工具wsimport.exe。
[plain] view plain copy
- 用法: wsimport [options] <WSDL_URI>
- 其中 [options] 包括:
- -b <path> 指定 jaxws/jaxb 绑定文件或附加模式
- (每个 <path> 都必须具有自己的 -b)
- -B<jaxbOption> 将此选项传递给 JAXB 模式编译器
- -catalog <file> 指定用于解析外部实体引用的目录文件
- 支持 TR9401, XCatalog 和 OASIS XML 目录格式。
- -d <directory> 指定放置生成的输出文件的位置
- -encoding <encoding> 指定源文件所使用的字符编码
- -extension 允许供应商扩展 - 不按规范
- 指定功能。使用扩展可能会
- 导致应用程序不可移植或
- 无法与其他实现进行互操作
- -help 显示帮助
- -httpproxy:<host>:<port> 指定 HTTP 代理服务器 (端口默认为 8080)
- -keep 保留生成的文件
- -p <pkg> 指定目标程序包
- -quiet 隐藏 wsimport 输出
- -s <directory> 指定放置生成的源文件的位置
- -target <version> 按给定的 JAXWS 规范版本生成代码
- 默认为 2.2, 接受的值为 2.0, 2.1 和 2.2
- 例如, 2.0 将为 JAXWS 2.0 规范生成兼容的代码
- -verbose 有关编译器在执行什么操作的输出消息
- -version 输出版本信息
- -wsdllocation <location> @WebServiceClient.wsdlLocation 值
- -clientjar <jarfile> 创建生成的 Artifact 的 jar 文件以及
- 调用 Web 服务所需的 WSDL 元数据。
- -generateJWS 生成存根 JWS 实现文件
- -implDestDir <directory> 指定生成 JWS 实现文件的位置
- -implServiceName <name> 生成的 JWS 实现的服务名的本地部分
- -implPortName <name> 生成的 JWS 实现的端口名的本地部分
- 扩展:
- -XadditionalHeaders 映射标头不绑定到请求或响应消息不绑定到
- Java 方法参数
- -Xauthfile 用于传送以下格式的授权信息的文件:
- http://username:password@example.org/stock?wsdl
- -Xdebug 输出调试信息
- -Xno-addressing-databinding 允许 W3C EndpointReferenceType 到 Java 的绑定
- -Xnocompile 不编译生成的 Java 文件
- -XdisableAuthenticator 禁用由 JAX-WS RI 使用的验证程序,
- 将忽略 -Xauthfile 选项 (如果设置)
- -XdisableSSLHostnameVerification 在提取 wsdl 时禁用 SSL 主机名
- 验证
- 示例:
- wsimport stock.wsdl -b stock.xml -b stock.xjb
- wsimport -d generated http://example.org/stock?wsdl
输入以下命令,即可生成Java类
[plain] view plain copy
- 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类
把生成的Java类添加到客户端相应的Package下
在客户端调用服务
[java] view plain copy
- package com.rvho.client.wsdl.hello;
- import java.net.URL;
- public class Client {
- public static void main(String[] args) throws Exception {
- URL wsdlUrl = new URL("http://localhost:8014/jaxwsserver/services/hello?wsdl");
- HelloWSService helloWSS = new HelloWSService(wsdlUrl);
- HelloWS helloWS = helloWSS.getHelloWSPort();
- Integer x = 3;
- Integer y = 5;
- Integer add = helloWS.add(x, y);
- System.out.println("add");
- System.out.println("3 + 5 = " + add);
- System.out.println("");
- String name = "小明";
- Integer age = 19;
- PersonEntity person = helloWS.getPerson(name, age);
- System.out.println("getPerson");
- System.out.println("name = " + person.getName() + " age = " + person.getAge());
- System.out.println("");
- }
- }
注意
JAXWS-RI在Tomcat 8中部署,调用服务时会有如下错误
[plain] view plain copy
- 警告: onComplete() failed for listener of type [org.apache.catalina.core.AsyncListenerWrapper]
- java.lang.IllegalStateException: It is illegal to call getRequest() after complete() or any of the dispatch() methods has been called
- at org.apache.catalina.core.AsyncContextImpl.getRequest(AsyncContextImpl.java:225)
- at com.sun.xml.ws.transport.http.servlet.WSAsyncListener$1.onComplete(WSAsyncListener.java:69)
- at org.apache.catalina.core.AsyncListenerWrapper.fireOnComplete(AsyncListenerWrapper.java:35)
- at org.apache.catalina.core.AsyncContextImpl.fireOnComplete(AsyncContextImpl.java:99)
- at org.apache.coyote.AsyncStateMachine.asyncPostProcess(AsyncStateMachine.java:208)
- at org.apache.coyote.AbstractProcessor.asyncPostProcess(AbstractProcessor.java:173)
- at org.apache.coyote.AbstractProtocol$AbstractConnectionHandler.process(AbstractProtocol.java:662)
- at org.apache.coyote.http11.Http11NioProtocol$Http11ConnectionHandler.process(Http11NioProtocol.java:222)
- at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1566)
- at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.run(NioEndpoint.java:1523)
- at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142)
- at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617)
- at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)
- at java.lang.Thread.run(Thread.java:745)