CXF框架的使用，利用cxf開發webservice（六）

阿新 • • 發佈：2019-01-14

1.CXF介紹

CXF 簡介

關於 Apache CXF

Apache CXF = Celtix + XFire，Apache CXF 的前身叫 Apache CeltiXfire，現在已經正式更名為 Apache CXF 了，以下簡稱為 CXF。CXF 繼承了 Celtix 和 XFire 兩大開源專案的精華，提供了對 JAX-WS 全面的支援，並且提供了多種 Binding 、DataBinding、Transport 以及各種 Format 的支援，並且可以根據實際專案的需要，採用程式碼優先（Code First）或者 WSDL 優先（WSDL First）來輕鬆地實現 Web Services 的釋出和使用。目前它仍只是 Apache 的一個孵化專案。

Apache CXF 是一個開源的 Services 框架，CXF 幫助您利用 Frontend 程式設計 API 來構建和開發 Services ，像 JAX-WS 。這些 Services 可以支援多種協議，比如：SOAP、XML/HTTP、RESTful HTTP 或者 CORBA ，並且可以在多種傳輸協議上執行，比如：HTTP、JMS 或者 JBI，CXF 大大簡化了 Services 的建立，同時它繼承了 XFire 傳統，一樣可以天然地和 Spring 進行無縫整合。

功能特性

CXF 包含了大量的功能特性，但是主要集中在以下幾個方面：

支援 Web Services 標準：CXF 支援多種 Web Services 標準，包含 SOAP、Basic Profile、WS-Addressing、WS-Policy、WS-ReliableMessaging 和 WS-Security。

Frontends：CXF 支援多種“Frontend”程式設計模型，CXF 實現了 JAX-WS API （遵循 JAX-WS 2.0 TCK 版本），它也包含一個“simple frontend”允許客戶端和 EndPoint 的建立，而不需要 Annotation 註解。CXF 既支援 WSDL 優先開發，也支援從 Java 的程式碼優先開發模式。
容易使用： CXF 設計得更加直觀與容易使用。有大量簡單的 API 用來快速地構建程式碼優先的 Services，各種 Maven 的外掛也使整合更加容易，支援 JAX-WS API ，支援 Spring 2.0 更加簡化的 XML 配置方式，等等。

支援二進位制和遺留協議：CXF 的設計是一種可插撥的架構，既可以支援 XML ，也可以支援非 XML 的型別繫結，比如：JSON 和 CORBA。

專案目標

下面列出了來自 Apache CXF 官方網站（參見參考資源）的專案目標。

概要

高效能
可擴充套件
簡單且容易使用

支援多種標準

支援 JAX-WS、 JAX-WSA、JSR-181 和 SAAJ；
支援 SOAP 1.1、1.2、WS-I BasicProfile、WS-Security、WS-Addressing、WS-RM 和 WS-Policy；
支援 WSDL 1.1 、2.0；
支援 MTOM；

多種傳輸方式、Bindings、Data Bindings 和 Format

Bindings：SOAP、REST/HTTP；
Data Bndings：目前支援 JAXB 2.0、Aegis 兩種，預設是 JAXB 2.0。XMLBeans、Castor 和 JiBX 資料繫結方式將在 CXF 2.1 版本中得到支援；
格式（Format）：XML、JSON；
傳輸方式：HTTP、Servlet、JMS 和 Jabber；
可擴充套件的 API 允許為 CXF 增加其它的 Bindings，以能夠支援其它的訊息格式，比如：CSV 和固定記錄長度。

靈活部署

輕量級容器：可在 Tomcat 或基於 Spring 的容器中部署 Services；
整合 JBI：可以在如 ServiceMix, OpenESB or Petals 等等的 JBI 容器中將它部署為一個服務引擎；
整合 SCA：可以部署在如 Tuscany 之類的 SCA 容器中；
整合 J2EE：可以在 J2EE 應用伺服器中部署 Services，比如：Geronimo、JOnAS、JBoss、WebSphere Application Server 和 WebLogic Application Server，以及 Jetty 和 Tomcat；
獨立的 Java 客戶端／伺服器。

支援多種程式語言

全面支援 JAX-WS 2.0 客戶端／伺服器程式設計模型；
支援 JAX-WS 2.0 synchronous、asynchronous 和 one-way API's；
支援 JAX-WS 2.0 Dynamic Invocation Interface (DII) API；
支援 wrapped and non-wrapped 風格；
支援 XML messaging API；
支援 JavaScript 和 ECMAScript 4 XML (E4X) ，客戶端與服務端均支援；
通過 Yoko 支援 CORBA；
通過 Tuscany 支援 SCA；
通過 ServiceMix 支援 JBI ；

程式碼生成

Java to WSDL；
WSDL to Java；
XSD to WSDL；
WSDL to XML；
WSDL to SOAP；
WSDL to Service；

CXF 安裝包

下載及目錄結構

CXF 框架目前的最新版本是 2.0.2，可以訪問 Apache 站點（連結請見參考資源）下載 CXF 框架的安裝包，下載時請選擇“二進位制釋出包（Binary distribution）”，當然如果您有興趣也可以下載相應版本的“原始碼釋出包（Source distribution）”。

下載完成後，將下載的檔案解壓縮到任意的資料夾中，比如：C:/Java/CXF，在後面的章節中使用 %CXF_HOME% 表示 CXF 框架的存放目錄，解壓縮後形成的檔案目錄結構按名稱排序如下：

圖 1、Apache CXF 發行包的目錄結構示意圖

檔案目錄結構及相關檔案的詳細說明：

bin（目錄）
bin 目錄中是 CXF 框架中所提供的程式碼生成、校驗、管理控制檯工具：
- Java to WSDL : java2wsdl
- CXF Management Console Tool : mc
- WSDL to Java : wsdl2java
- WSDL to Service : wsdl2service
- WSDL to SOAP : wsdl2soap
- WSDL to XML : wsdl2xml
- WSDL Validation : wsdlvalidator
- XSD to WSDL : xsd2wsdl

2. CXF的安裝和配置：

直接解壓到某個盤下就可以使用：

2.1 CXF的環境變數的配置

環境變數：

•JAVA_HOME,

•CXF_HOME

•Path = %JAVA_HOME%\bin;%CXF_HOME%\bin;

•CLASSPATH=.;%CXF_HOME%\lib\cxf-manifest.jar

2.2cxf建立一個java工程

2.2.1 服務端程式：

（1）建立一個java工程

（2）將第一天查詢天氣資訊的程式碼拷貝到這個專案中，例如程式碼：

（3）匯入jar包（目錄下全部的jar包）

（4）CXF是面向介面的程式設計，建立介面WeatherServerInterface

（5）建立類WeatherServer實現以上的介面

（6）建立QueryWebxmlClient呼叫網路天氣預報的服務

（7）Result的javabean物件，返回封裝的結果集

（8）使用JaxWsServerFactoryBean釋出CXF的服務端

附錄：

伺服器端釋出的類

lServerFactoryBean

lJaxWsServerFactoryBean(建議使用)

2個物件，都可以釋出服務端，但是我們建議使用JaxWsServerFactoryBean，因為它生成的wsdl檔案更加規範。

伺服器端的攔截器：

// 輸入攔截器

jaxWsServerFactoryBean.getInInterceptors().add(new LoggingInInterceptor());

// 輸出攔截器

jaxWsServerFactoryBean.getOutInterceptors().add(new LoggingOutInterceptor());

目的是用來輸出響應的頭部資訊，可以看到soap協議的格式（http請求+Xml資料）：

例如：

Soap1.1：

ID: 10

Address: http://127.0.0.1:9999/weather

Encoding: UTF-8

Http-Method: POST

Content-Type: text/xml; charset=UTF-8

Headers: {Accept=[text/xml, multipart/related], connection=[keep-alive], Content-Length=[218], content-type=[text/xml; charset=UTF-8], Host=[127.0.0.1:9999], SOAPAction=[""], User-Agent=[JAX-WS RI 2.2.4-b01]}

Payload: <?xml version="1.0" ?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"><S:Body><ns2:queryWeather xmlns:ns2="http://server.jaxws.ws.itcast.cn/">

</S:Envelope>

Soap1.2：

ID: 2

Address: http://127.0.0.1:9999/weather

Encoding: UTF-8

Http-Method: POST

Content-Type: application/soap+xml; charset=utf-8;action=""

Headers: {Accept=[application/soap+xml, multipart/related], connection=[keep-alive], Content-Length=[216], content-type=[application/soap+xml; charset=utf-8;action=""], Host=[127.0.0.1:9999], User-Agent=[JAX-WS RI 2.2.4-b01]}

Payload:

<?xml version="1.0" ?>

<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope"><S:Body><ns2:queryWeather xmlns:ns2="http://server.jaxws.ws.itcast.cn/">

2.3 客戶端程式（使用jdk提供的jaxws）

（1）建立一個java工程

（2）使用wsimport生成客戶端程式碼：

（3）客戶端程式碼測試：

2.4 客戶端程式（使用CXF）

使用CXF的wsdl2java工具，它的功能就如同wsimport一樣，可以生成一堆客戶端呼叫的程式碼。

在命令列執行：

這裡注意：

生成後WeatherService報錯：

原因是cxf需要JAX-WS API 2.2，而jdk6的jax-ws是2.1 版本，需要

wsdl2java 使用“-frontend jaxws21“，或者如果使用jdk1.7就不用加frontend

即如下：

（1）建立java工程

（2）使用wsdl2java生成客戶端程式碼，並拷貝到專案中

（3）客戶端測試程式碼：

2.2.4 客戶端程式（使用物件Service、URL，QName等）

（1）客戶端測試程式碼

2.2.5 客戶端程式（使用JaxWsProxyFactoryBean）

（1）匯入CXF的jar包

（2）測試程式碼：

這裡：大家把服務端的介面和實現類上的@bindingType改成SOAP12HTTP_BINDING看看會有什麼變化

可以通過攔截器看到Soap1.1和Soap1.2之前的區別。