Web Service與Apache CXF 框架

来源:https://www.cnblogs.com/gdwkong/archive/2018/03/17/8580530.html
-Advertisement-
Play Games

本文簡單介紹了WebService服務技術，提供了在Apache CXF 框架JAX-RS模塊下WebService開發的簡單示例。 ...


一、WebService簡介

　　為了支持跨網路的機器間相互操作交互而設計，用於開發分散式的互操作的應用程式組件。

　　Web Service服務通常被定義為一組模塊化的API，它們可以通過網路進行調用，來執行遠程系統的請求服務，而XML 是 Web Services 的基礎。

二、快速入門

  • 將${JDK}\bin目錄添加到path環境變數
  • 新建一個文件夾,打開命令行,並cd到該目錄
  • 執行命令
  • wsimport -s . http://ws.webxml.com.cn/WebServices/MobileCodeWS.asmx?wsdl
  • 新建Java工程,將文件夾下的內容拷貝到src目錄
  • 創建測試類,測試功能
  • 1 public class TestService {
2    public static void main(String[] args) {
3        MobileCodeWS mobileCodeWS = new MobileCodeWS();
4        MobileCodeWSSoap soap = mobileCodeWS.getMobileCodeWSSoap();
5        String info = soap.getMobileCodeInfo("1886666", "");
6        System.out.println(info);
7    }
8 }

三、SOAP（imple Object Access Protocol）

　　使用HTTP協議傳輸XML格式的數據。

  • SOAP請求示例 
     1 POST /InStock HTTP/1.1
 2 Host: www.example.org
 3 Content-Type: application/soap+xml; charset=utf-8
 4 Content-Length: nnn
 5 
 6 <?xml version="1.0"?>
 7 <soap:Envelope
 8 xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
 9 soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
10 
11 <soap:Body xmlns:m="http://www.example.org/stock">
12   <m:GetStockPrice>
13     <m:StockName>IBM</m:StockName>
14   </m:GetStockPrice>
15 </soap:Body>
16 
17 </soap:Envelope>

  • SOAP響應示例

  •  1 HTTP/1.1 200 OK
 2 Content-Type: application/soap+xml; charset=utf-8
 3 Content-Length: nnn
 4 
 5 <?xml version="1.0"?>
 6 <soap:Envelope
 7 xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
 8 soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
 9 
10 <soap:Body xmlns:m="http://www.example.org/stock">
11   <m:GetStockPriceResponse>
12     <m:Price>34.5</m:Price>
13   </m:GetStockPriceResponse>
14 </soap:Body>
15 
16 </soap:Envelope>

四、WSDL（Web Services Description Language）

  • 網路服務描述語言是一種使用 XML 編寫的文檔。這種文檔可描述某個 Web service, 例如服務的名稱, 地址, 方法, 參數類型, 返回值類型等
  • Web服務的使用說明書
  • 每一個WebService都有一個對應的WSDL
  • WSDL地址組成 : 服務發佈地址?wsdl
  • WSDL文檔示例 
     1 <message name="getTermRequest">
 2   <part name="term" type="xs:string"/>
 3 </message>
 4 
 5 <message name="getTermResponse">
 6   <part name="value" type="xs:string"/>
 7 </message>
 8 
 9 <portType name="glossaryTerms">
10   <operation name="getTerm">
11     <input message="getTermRequest"/>
12     <output message="getTermResponse"/>
13   </operation>
14 </portType>

四、Apache CXF 框架

  • 主頁： http://cxf.apache.org/

  • Apache CXF = Celtix + XFire，開始叫 Apache CeltiXfire，後來更名為 Apache CXF 了，以下簡稱為 CXF。CXF 繼承了 Celtix 和 XFire 兩大開源項目的精華，提供了對 JAX-WS 全面的支持，並且提供了多種 Binding 、DataBinding、Transport 以及各種 Format 的支持，並且可以根據實際項目的需要，採用代碼優先（Code First）或者 WSDL 優先（WSDL First）來輕鬆地實現 Web Services 的發佈和使用。Apache CXF已經是一個正式的Apache頂級項目。

1、CXF提供的服務分為兩種方式

  • JAX-WS

    • 全稱是 JavaTM API forRESTful Web Services

  • JAX-RS

    • 全稱是 Java API for RESTful Web Services

  • 關於JAX-WS與JAX-RS兩者是不同風格的SOA架構。前者以動詞為中心，指定的是每次執行函數。而後者以名詞為中心，每次執行的時候指的是資源

  • JAX-RS是JAVA EE6 引入的一個新技術。

  • 是一個Java 編程語言的應用程式介面，支持按照表述性狀態轉移(REST)架構風格創建Web服務。JAX-RS使用了Java SE5引入的Java標註來簡化Web服務的客戶端和服務端的開發和部署。

  • 簡單來理解兩種方式的區別

    • JAX-WS是基於SOAP協議傳輸XML數據

    • JAX-RS是基於HTTP協議傳輸XML數據或JSON數據

2、使用CXF開發WebService服務端(JAX-RS) 

  • RESTful

    • 一種軟體架構風格，設計風格而不是標準，只是提供了一組設計原則和約束條件。它主要用於客戶端和伺服器交互類的軟體。基於這個風格設計的軟體可以更簡潔，更有層次，更易於實現緩存等機制。

  • RESTful的好處

    • 基於這種風格架構，軟體編寫可以更簡潔

    • 基於HTTP協議， 支持多種消息格式，比如XML 、JSON

    • 更易於實現緩存機制

  • 創建Maven工程,類型為WAR

  • 引入坐標

    <!--cxf-rs的坐標 -->

 1 <dependency>
 2     <groupId>org.apache.cxf</groupId>
 3     <artifactId>cxf-rt-frontend-jaxrs</artifactId>
 4     <version>3.0.1</version>
 5 </dependency>
 6 <!-- 增強cxf-rs,可以處理json數據 -->
 7 <dependency>
 8     <groupId>org.apache.cxf</groupId>
 9     <artifactId>cxf-rt-rs-extension-providers</artifactId>
10     <version>3.0.1</version>
11 </dependency>
12 <!-- 上面的依賴必須依賴此包 -->
13 <dependency>
14     <groupId>org.codehaus.jettison</groupId>
15     <artifactId>jettison</artifactId>
16     <version>1.3.7</version>
17 </dependency>
18 <!-- spring坐標 -->
19 <dependency>
20     <groupId>org.springframework</groupId>
21     <artifactId>spring-context</artifactId>
22     <version>4.1.7.RELEASE</version>
23 </dependency>
24 <!--spring整合web開發 -->
25 <dependency>
26     <groupId>org.springframework</groupId>
27     <artifactId>spring-web</artifactId>
28     <version>4.1.7.RELEASE</version>
29 </dependency>
  • 創建實體類com.itheima.domain.User
 1 // 指定在序列化對象時,生成的根節點的名字
 2 @XmlRootElement(name = "user")
 3 public class User {
 4     private int id;
 5     private String name;
 6     private int age;
 7 ​
 8     public User() {
 9     }
10     public User(int id, String name, int age) {
11         super();
12         this.id = id;
13         this.name = name;
14         this.age = age;
15     }
16     public int getId() {
17         return id;
18     }
19     public void setId(int id) {
20         this.id = id;
21     }
22     public String getName() {
23         return name;
24     }
25     public void setName(String name) {
26         this.name = name;
27     }
28     public int getAge() {
29         return age;
30     }
31     public void setAge(int age) {
32         this.age = age;
33     }
34     @Override
35     public String toString() {
36         return "User [id=" + id + ", name=" + name + ", age=" + age + "]";
37     }
38 }

  • 創建介面com.itheima.service.UserService

 1 public interface UserService {
 2     // URL = http://localhost:8080/rs_server/webservice/userService/user
 3     @POST
 4     @Path("/user")
 5     @Consumes({ "application/xml", "application/json" })
 6     public void saveUser(User user);
 7 ​
 8     // URL = http://localhost:8080/rs_server/webservice/userService/user?id=1
 9     @DELETE
10     @Path("/user")
11     @Consumes({ "application/xml" })
12     public void delUser(@QueryParam("id") int id);
13 ​
14     // URL = http://localhost:8080/rs_server/webservice/userService/user
15     @PUT
16     @Path("/user")
17     @Consumes({ "application/xml", "application/json" })
18     public void updateUser(User user);
19 ​
20     // URL = http://localhost:8080/rs_server/webservice/userService/user
21     @GET
22     @Path("/user")
23     @Produces({ "application/xml", "application/json" })
24     public List<User> findAllUsers();
25 ​
26     // URL = http://localhost:8080/rs_server/webservice/userService/user/1
27     @GET
28     @Path("/user/{id}")
29     @Consumes({ "application/xml" })
30     @Produces({ "application/xml", "application/json" })
31     public User findUserByID(@PathParam("id") int id);
32 }
  • 創建介面實現類
 1 public class UserServiceImpl implements UserService {
 2 
 3     @Override
 4     public void saveUser(User user) {
 5         System.out.println("用戶保存成功:" + user);
 6     }
 7 ​
 8     @Override
 9     public void delUser(int id) {
10         System.out.println("ID為 " + id + " 的用戶刪除成功");
11     }
12 ​
13     @Override
14     public void updateUser(User user) {
15         System.out.println("用戶更新成功:" + user);
16     }
17 ​
18     @Override
19     public List<User> findAllUsers() {
20         List<User> list = new ArrayList<>();
21         list.add(new User(1, "zhangsan", 11));
22         list.add(new User(2, "lisi", 22));
23         return list;
24     }
25 ​
26     @Override
27     public User findUserByID(int id) {
28         return new User(1, "zhangsan", 11);
29     }
30 }
  • 在web.xml中增加以下配置
 1 <!-- 指定Spring框架配置文件的位置 -->
 2 <context-param>
 3     <param-name>contextConfigLocation</param-name>
 4     <param-value>classpath:applicationContext.xml</param-value>
 5 </context-param>
 6 <!-- 配置Spring框架的監聽器 -->
 7 <listener>
 8     <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
 9 </listener>
10 <!-- 配置CXF的Servlet -->
11 <servlet>
12     <servlet-name>cxf</servlet-name>
13     <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
14 </servlet>
15 <!--指定Servlet的訪問路徑 -->
16 <servlet-mapping>
17     <servlet-name>cxf</servlet-name>
18     <url-pattern>/webservice/*</url-pattern>
19 </servlet-mapping>

 

  • 配置applicationContext.xml
 1 <?xml version="1.0" encoding="UTF-8"?>
 2 
 3 <beans xmlns="http://www.springframework.org/schema/beans"
 4     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:jaxrs="http://cxf.apache.org/jaxrs"
 5     xmlns:soap="http://cxf.apache.org/bindings/soap"
 6     xsi:schemaLocation="http://www.springframework.org/schema/beans 
 7               http://www.springframework.org/schema/beans/spring-beans.xsd
 8               http://www.springframework.org/schema/tx
 9                http://www.springframework.org/schema/tx/spring-tx.xsd
10               http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd ">
11     <!-- 註冊服務提供者 -->
12     <bean id="userServiceImpl" class="com.itheima.service.impl.UserServiceImpl"></bean>
13     <!--
14         發佈Web服務
15         address : 請求地址
16     -->
17     <jaxrs:server address="/userService">
18         <jaxrs:serviceBeans>
19             <ref bean="userServiceImpl" />
20         </jaxrs:serviceBeans>
21         <!--
22             攔截請求信息,非必須
23             設置後,可以在控制台觀察到請求信息
24         -->
25         <jaxrs:inInterceptors>
26             <bean class="org.apache.cxf.interceptor.LoggingInInterceptor"></bean>
27         </jaxrs:inInterceptors>
28         <!--
29             攔截響應信息,非必須
30             設置後,可以在控制台觀察到響應信息
31         -->
32         <jaxrs:outInterceptors>
33             <bean class="org.apache.cxf.interceptor.LoggingOutInterceptor"></bean>
34         </jaxrs:outInterceptors>
35     </jaxrs:server>
36 </beans>

3、使用CXF開發WebService客戶端(JAX-RS)

  • 創建Maven工程,類型為JAR

  • 引入坐標
 1 <!-- cxf-rs的坐標 -->
 2 
 3 <dependency>
 4     <groupId>org.apache.cxf</groupId>
 5     <artifactId>cxf-rt-frontend-jaxrs</artifactId>
 6     <version>3.0.1</version>
 7 </dependency>
 8 <!-- cxf-rs客戶端的坐標 -->
 9 <dependency>
10     <groupId>org.apache.cxf</groupId>
11     <artifactId>cxf-rt-rs-client</artifactId>
12     <version>3.0.1</version>
13 </dependency>
14 <!-- 增強cxf-rs,可以處理json數據 -->
15 <dependency>
16     <groupId>org.apache.cxf</groupId>
17     <artifactId>cxf-rt-rs-extension-providers</artifactId>
18     <version>3.0.1</version>
19 </dependency>
20 <!-- 上面的依賴必須依賴此包 -->
21 <dependency>
22     <groupId>org.codehaus.jettison</groupId>
23     <artifactId>jettison</artifactId>
24     <version>1.3.7</version>
25 </dependency>
26 </dependencies>

  • 將Server工程的實體類拷貝過來

  • 示例測試代碼

 1 public class CXFTest { 
 2 　　​// HTTP 405 Method Not Allowed : 請求方式錯誤,例如,服務端要求使用POST請求,客戶端發起請求的時候,使用了PUT請求
 3 　　//保存
 4 　　​@Test
 5 　　​public void test1() {
 6 　　　　​​WebClient// 伺服器地址 : 埠號/項目名/
 7 ​​​​​　　　　　　　　// web.xml中cxfServlet指定的地址/applicationContext.xml中指定的地址/類上Path指定的地址/方法上Path指定的地址
 8 　　　　　　​​​​.create("http://localhost:8080/cxf_rs_server/webService/userService/user")// 指定請求的地址
 9 　　　　​​​​　　.post(new User(11, "張三", "123"));
10 　　​}
11  　 //刪除
12 　　​@Test
13 　　​public void test2() {
14 　　　　​​WebClient
15 　　　　　　​​​​.create("http://localhost:8080/cxf_rs_server/webService/userService/user")
16 ​​​​　　　　　　.query("id", 100).delete();
17 ​　　}
18  
19 　　//更新
20 　　​@Test
21 　　​public void test3() {
22 　　　　​​WebClient
23 ​​​​　　　　　　.create("http://localhost:8080/cxf_rs_server/webService/userService/user")
24 ​​​​　　　　　　.put(new User(11, "張三", "123"));
25 ​　　}　
26 　　
27    //查詢所有
28 　　​@Test
29 　　​public void test4() {
30 　　　　​​Collection<? extends User> collection = WebClient
31 　　　　　　​​​​.create("http://localhost:8080/cxf_rs_server/webService/userService/user")
32 　　　　　　​​​​.getCollection(User.class);
33 　　　　for (User user : collection) {
34 　　　　　　　　​​​System.out.println(user);
35 ​​　　　　}
36 ​　　}
37  
38 　　//根據欄位查詢結果
39 ​　　@Test
40 ​　　public void test5() {
41 　　　　​​User user = WebClient
42 　　　　​​​​　　.create("http://localhost:8080/cxf_rs_server/webService/userService/user")
43 ​​​​　　　　　　.query("id", 11).get(User.class);
44  
45 　　　　​​System.out.println(user);
46 　　​}
47  
48 　　​@Test
49 　　​public void test6() {
50 ​​　　　　User user = WebClient
51 　　　　　　​​​​.create("http://localhost:8080/cxf_rs_server/webService/userService/user/" + 22 + "/icon")
52 　　　　　　​​​​.get(User.class);
53  
54 　　　　​​System.out.println(user);
55 ​　　}
56 ​
57 　　​@Test
58 　　​public void test7() {
59 　　　　​​WebClient
60 ​​​​　　　　　　.create("http://localhost:8080/cxf_rs_server/webService/userService/user")// 指定請求的地址
61 　　　　　　​​​​.type(MediaType.APPLICATION_JSON)// 指定本客戶端傳遞給伺服器的數據格式
62 　　　　　　​​​​.accept(MediaType.APPLICATION_JSON)//指定伺服器傳遞迴來的數據格式,本客戶端能處理的數據格式
63 ​​​​　　　　　　.post(new User(11, "張三", "123"));
64 　　​}
65 }

4、RESTFul常用註解

4.1 路徑相關

  • @Path : 設置訪問路徑. 可以用在方法或類上面

4.2 參數類型相關

  • @Consumers： 定義方法參數類型,常用值為 : "application/xml", "application/json"

  • @Producers： 定義方法返回值類型,常用值為 : "application/xml", "application/json"

4.3 參數相關

  • @QueryParam : 查詢參數. 客戶端傳參：url?id=10

  • @PathParam : 路徑參數. 客戶端傳參：url/10

4.4 操作類型相關

  • @GET： 查詢操作

  • @POST： 添加操作

  • @DELETE ： 刪除操作

  • @PUT: 修改操作


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Cas簡介（一）
    Cas的全稱是Centeral Authentication Service，是對單點登錄SSO（Single Sign On）的一種實現。其由Cas Server和Cas Client兩部分組成，Cas Server是核心，而Cas Client通常就對應於我們的應用。一個Cas Server可以 ...
  • java 核心技術捲一筆記 6 .1.介面 lambda 表達式 內部類
    6.1.2 介面不是類，不能實例化一個介面；但是可以聲明介面的變數；Comparable x; 介面變數必須引用實現了介面的類對象；x = new Employee(); 檢查一個對象是否屬於某個特定類（instanceof）; 檢查一個對象是否屬於某個特定的介面（instance）；if (anO ...
  • webService基礎入門
    webService入門 Web service是一個平臺獨立的，低耦合的，自包含的、基於可編程的web的應用程式，可使用開放的XML（標準通用標記語言下的一個子集）標準來描述、發佈、發現、協調和配置這些應用程式，用於開發分散式的互操作的應用程式。[1] Webservice跨平臺跨語言； Java... ...
  • WebService就是這麼簡單
    WebService介紹 首先我們來談一下為什麼需要學習webService這樣的一個技術吧.... 問題一 如果我們的網站需要提供一個 天氣預報 這樣一個需求的話，那我們該怎麼做？？？？？ 天氣預報這麼一個功能並不是簡單的JS組件就能夠實現的，它的數據是依賴資料庫分析出來的，甚至需要衛星探測..我 ...
  • 整理筆記--Web基礎
    c/s是客戶機/伺服器，b/s是瀏覽器/伺服器。 ipv4 192.168.....(內網ip) 通過路由器的NAT(維護了一張表，用來轉換ip對應外網)。 當ipv6推廣開，就不用使用路由器了。 通信原理： 寫ip地址訪問太麻煩，於是有了功能變數名稱，它會先訪問本地的hosts，沒有則去網路訪問DNS服務 ...
  • Django admin 組件 原理分析與擴展使用 之 sites.py (一)
    一 、 前言 Django 提供了admin 組件 為項目提供基本的管理後臺功能（對數據表的增刪改查）。 本篇文章通過 admin源碼 簡單分析admin 內部原理 ，擴展使用方式，為以後進行定製和自己開發組件做鋪墊。 二、 簡單使用 1.在app 目錄下的admin.py 中通過註冊表 2. 創建 ...
  • 扒一扒JVM的垃圾回收機制，下次面試你準備好了嗎
    相信和小編一樣的程式猿們在日常工作或面試當中經常會遇到JVM的垃圾回收問題，有沒有在夜深人靜的時候詳細捋一捋JVM垃圾回收機制中的知識點呢？沒時間捋也沒關係，因為小編接下來會給你捋一捋。 ...
  • 杭電ACM1013
    Digital RootsTime Limit: 2000/1000 MS (Java/Others) Memory Limit: 65536/32768 K (Java/Others)Total Submission(s): 74529 Accepted Submission(s): 23232 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類