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配置檔案如下
<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>
建立服務接口
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)
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
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。
<?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則不需要以下配置。
<!-- 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。
用法: 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:[email protected]/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類
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下
在用戶端調用服務
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中部署,調用服務時會有如下錯誤
警告: 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)