用JAX-WS在Tomcat中發佈WebService_ZenDei技術網路在線

JDK中已經內置了Webservice發佈，不過要用Tomcat等Web伺服器發佈WebService，還需要用第三方Webservice框架。Axis2和CXF是目前最流行的Webservice框架，這兩個框架各有優點，不過都屬於重量級框架。 JAX-WS RI是JAX 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。

服務端

1、新建一個Maven Web項目，在項目中添加JAX-WS RI引用，pom.xml配置文件如下：

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <project xmlns="http://maven.apache.org/POM/4.0.0"
 3          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 5     <modelVersion>4.0.0</modelVersion>
 6 
 7     <groupId>top.jimc</groupId>
 8     <artifactId>wsi</artifactId>
 9     <version>1.0-SNAPSHOT</version>
10     <packaging>war</packaging>
11 
12     <properties>
13         <junit.version>4.12</junit.version>
14         <jaxws-rt.version>2.2.10</jaxws-rt.version>
15     </properties>
16 
17     <dependencies>
18         <!-- junit -->
19         <dependency>
20             <groupId>junit</groupId>
21             <artifactId>junit</artifactId>
22             <version>${junit.version}</version>
23             <scope>test</scope>
24         </dependency>
25 
26         <!-- JAXWS-RI -->
27         <dependency>
28             <groupId>com.sun.xml.ws</groupId>
29             <artifactId>jaxws-rt</artifactId>
30             <version>${jaxws-rt.version}</version>
31         </dependency>
32     </dependencies>
33 
34     <build>
35         <plugins>
36             <!-- 配置控制jdk版本的插件 -->
37             <plugin>
38                 <groupId>org.apache.maven.plugins</groupId>
39                 <artifactId>maven-compiler-plugin</artifactId>
40                 <version>3.7.0</version>
41                 <configuration>
42                     <source>1.8</source>
43                     <target>1.8</target>
44                     <encoding>utf-8</encoding>
45                 </configuration>
46             </plugin>
47         </plugins>
48     </build>
49 
50 </project>

View Code

2、創建服務介面：

 1 package top.jimc.wsi.api;
 2 
 3 import top.jimc.wsi.entity.Person;
 4 
 5 import javax.jws.WebService;
 6 import java.util.Date;
 7 
 8 /**
 9  * WebService介面
10  * @author Jimc.
11  * @since 2018/8/31.
12  */
13 @WebService(name = "helloWSoap", targetNamespace = "http://wsi.jimc.top/api/hello")
14 public interface HelloWService {
15 
16     /**
17      * 兩個整數相加
18      *
19      * @param x
20      * @param y
21      * @return 相加後的值
22      */
23     Integer add(Integer x, Integer y);
24 
25     /**
26      * 返回當前時間
27      *
28      * @return
29      */
30     Date now();
31 
32     /**
33      * 獲取複雜類型
34      * @param name 用戶姓名
35      * @param age 用戶年齡
36      * @return 返回用戶類
37      */
38     Person getPerson(String name, Integer age);
39 
40 }

View Code

3、服務中用到的複雜類型(實體)Person：

 1 package top.jimc.wsi.entity;
 2 
 3 import java.io.Serializable;
 4 
 5 /**
 6  * @author Jimc.
 7  * @since 2018/8/31.
 8  */
 9 public class Person implements Serializable {
10     private static final long serialVersionUID = -7211227224542440039L;
11 
12     private String name;
13     private Integer age;
14 
15     public String getName() {
16         return name;
17     }
18     public void setName(String name) {
19         this.name = name;
20     }
21     public Integer getAge() {
22         return age;
23     }
24     public void setAge(Integer age) {
25         this.age = age;
26     }
27 }

View Code

4、創建服務介面實現類：

 1 package top.jimc.wsi.api.impl;
 2 
 3 import top.jimc.wsi.api.HelloWService;
 4 import top.jimc.wsi.entity.Person;
 5 
 6 import javax.jws.WebService;
 7 import java.util.Date;
 8 
 9 /**
10  * WebService介面實現
11  * @author Jimc.
12  * @since 2018/8/31.
13  */
14 @WebService(endpointInterface = "top.jimc.wsi.api.HelloWService",
15             portName = "HelloWSoap",
16             serviceName = "HelloWService",
17             targetNamespace = "http://wsi.jimc.top/api/hello")
18 public class HelloWServiceImpl implements HelloWService {
19 
20     @Override
21     public Integer add(Integer x, Integer y) {
22         return x + y;
23     }
24 
25     @Override
26     public Date now() {
27         return new Date();
28     }
29 
30     @Override
31     public Person getPerson(String name, Integer age) {
32         Person person = new Person();
33         person.setName(name);
34         person.setAge(age);
35         return person;
36     }
37 }

View Code

5、在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     <endpoint name="hello" implementation="top.jimc.wsi.api.impl.HelloWServiceImpl" url-pattern="/api/hello"/>
4 </endpoints>

View Code

6、在web.xml中添加WSServlet，如果Web項目使用Servlet 3.0則不需要以下配置：

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
 3          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4          xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
 5          version="3.1">
 6 
 7     <!-- Servlet 3.0或者以上不需要配置 -->
 8     <servlet>
 9         <servlet-name>jaxws</servlet-name>
10         <servlet-class>com.sun.xml.ws.transport.http.servlet.WSServlet</servlet-class>
11         <load-on-startup>1</load-on-startup>
12     </servlet>
13     <servlet-mapping>
14         <servlet-name>jaxws</servlet-name>
15         <url-pattern>/api/hello</url-pattern>
16     </servlet-mapping>
17 </web-app>

View Code

7、啟動tomcat，查看效果：

地址欄輸入：http://localhost:8080/api/hello?wsdl

出現上面的畫面，說明介面已成功發佈。

客戶端

1、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:[email protected]/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

View Code

2、生成java類，並把生成的類添加到客戶端相應的package下：

wsimport -encoding utf-8 -p top.jimc.wst -s E:\Code\Projects\wsp\wst\src\main\java http://localhost:8080/api/hello?wsdl

3、調用介面

 1 import org.junit.Test;
 2 import top.jimc.wst.HelloWService;
 3 import top.jimc.wst.HelloWSoap;
 4 
 5 /**
 6  * @author Jimc.
 7  * @since 2018/8/31.
 8  */
 9 public class WSTest {
10 
11 
12     /**
13      * 調用
14      */
15     @Test
16     public void helloTest() {
17         HelloWService helloWService = new HelloWService();
18         HelloWSoap hello = helloWService.getHelloWSoap();
19         System.out.println(hello.add(8, 9));
20         System.out.println(hello.now());
21         System.out.println(hello.getPerson("John", 22));
22     }
23 }

View Code

示例源碼下載