使用開放源代碼 Web 服務框架 Apache CXF 可以很容易地創建傳統 Java™ 對象(plain old Java object ,POJO)樣式的 Web 服務。本文是本系列的第 1 部分,將向您介紹如何使用 Spring 和 CXF 將 POJO 作為 Web 服務公開。本文還將演示 CXF 與 Spring 框架的集成。
引言
在本文中,您將使用 CXF 和 Spring 來構建和開發一個訂單處理 Web 服務。該 Web 服務處理或驗證客戶所下的訂單,並返回唯一的訂單 ID。閱讀本文之後,您將能夠應用 CXF 的概念和功能來構建和開發 Web 服務。
系統要求
要運行本文中的示例,請確保已在計算機上安裝和設置了以下軟體:
安裝上述分發版以後,設置以下環境變數:
舉例來說,可以設置 CXF_HOME=C:\apache-cxf-2.1 並將以下內容添加到 PATH 環境變數:
為什麼選擇 CXF?
Apache CXF 是一個開放源代碼框架,提供了用於方便地構建和開發 Web 服務的可靠基礎架構。它允許創建高性能和可擴展的服務,您可以將這樣的服務部署在 Tomcat 和基於 Spring 的輕量級容器中,以及部署在更高級的伺服器上,例如 Jboss、IBM® WebSphere® 或 BEA WebLogic。
功能
該框架提供了以下功能:
開發 Web 服務
下面讓我們深入地研究一下如何使用 JAX-WS 前端創建訂單處理 Web 服務,然後將其註冊為 Spring Bean。您將使用代碼優先方法,這意味著您將首先開發一個 Java 類,並將其標註為 Web 服務。為此,您通常要執行以下步驟:
首先讓我們創建訂單處理 Web 服務 SEI。
創建訂單處理 Web 服務 SEI
創建名為 OrderProcess 的 SEI,它將具有一個方法 processOrder,此方法接受一個訂單 Bean 並返回一個字元串。processOrder 方法的目的是處理客戶所下的訂單,並返回唯一的訂單 ID。
package demo.order; import javax.jws.WebService; @WebService public interface OrderProcess { String processOrder(Order order); } |
從清單 1 中可以看到,OrderProcess SEI 只是一個被標註為 Web 服務的標準 Java 介面。@WebService 標註只是使該介面成為 Web 服務介面。客戶端或使用者使用該介面來調用服務方法。OrderProcess SEI 具有一個服務方法 processOrder,此方法接受 Order 作為參數,並作為字元串返回訂單 ID。
package demo.order; import javax.jws.WebService; @WebService(endpointInterface = "demo.order.OrderProcess") public class OrderProcessImpl implements OrderProcess { public String processOrder(Order order) { return order.validate(); } } |
編寫 SEI 的實現
要編寫前一部分中的 SEI 的實現,您同樣要將您的實現類 OrderProcessImpl 標註為 Web 服務,並提供屬性 endpointInterface,其值為前一步中創建的 SEI 的完全限定名稱。這告訴該類實現 OrderProcess SEI。由於它是 SEI 的實現,您必須提供返回訂單 ID 的 processOrder 方法的實現。
您已經創建了一個 SEI 及其實現。使用 CXF,現在您可以使用 JAX-WS 前端使其成為實際的服務組件。
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:jaxws="http://cxf.apache.org/jaxws" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd"> <import resource="classpath:META-INF/cxf/cxf.xml" /> <import resource="classpath:META-INF/cxf/cxf-extension-soap.xml" /> <import resource="classpath:META-INF/cxf/cxf-servlet.xml" /> <jaxws:endpoint id="orderProcess" implementor="demo.order.OrderProcessImpl" address="/OrderProcess" /> </beans> |
創建 CXF 的配置文件
CXF 配置文件實際上是包含 Bean 定義的 Spring 配置文件。您將使用 JAX-WS 前端配置來為 OrderProcess Web 服務創建 Bean 定義。beans.xml 文件中的 <jaxws:endpoint> 標記將 OrderProcess Web 服務指定為 JAX-WS 端點。這實際上意味著 CXF 在內部使用 JAX-WS 來發布此 Web 服務。您必須提供實現類名稱,即 OrderProcessImpl,以及 <jaxws:endpoint> 標記的地址。您提供的地址與 Web 上下文有關。
<web-app> <context-param> <param-name>contextConfigLocation</param-name> <param-value>WEB-INF/beans.xml</param-value> </context-param> <listener> <listener-class> org.springframework.web.context.ContextLoaderListener </listener-class> </listener> <servlet> <servlet-name>CXFServlet</servlet-name> <display-name>CXF Servlet</display-name> <servlet-class> org.apache.cxf.transport.servlet.CXFServlet </servlet-class> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>CXFServlet</servlet-name> <url-pattern>/*</url-pattern> </servlet-mapping> </web-app> |
最後,您需要執行以下操作:
您剛才已完成了必需的伺服器端組件的開發。現在您可以開發向 OrderProcess 服務發出請求的客戶端組件。
開發客戶端
從清單 5 中可以看到,創建客戶端 Bean 是非常容易的,就像創建服務端點一樣容易。JaxWsProxyFactory 用於創建 OrderProcess Web 服務的客戶端 Bean。工廠 Bean 預期獲得服務類 (OrderProcess) 和您的服務的 URL。然後通過使用工廠 Bean 引用來創建客戶端 Bean 存根 OrderProcess。
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:jaxws="http://cxf.apache.org/jaxws" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.0.xsd http://cxf.apache.org/jaxws http://cxf.apache.org/schema/jaxws.xsd"> <bean id="client" class="demo.order.OrderProcess" factory-bean="clientFactory" factory-method="create"/> <bean id="clientFactory" class="org.apache.cxf.jaxws.JaxWsProxyFactoryBean"> <property name="serviceClass" value="demo.order.OrderProcess"/> <property name="address" value="http://localhost:8080/orderapp/OrderProcess"/> </bean> </beans> |
您將創建 Java 主程序,它使用 Spring 上下文來獲取已定義的客戶端 Bean,然後調用 processOrder 方法。
public final class Client { public Client() { } public static void main(String args[]) throws Exception { ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext(new String[] {"demo/order/client/client-beans.xml"}); OrderProcess client = (OrderProcess)context.getBean("client"); Order order = new Order(); String orderID = client.processOrder(order); System.out.println("Order ID: " + orderID); System.exit(0); } } |
運行程序
在運行程序之前,請在您的 C:\ 盤根文件夾下創建如圖 1 所示的目錄結構,並將本文介紹的組件放在其中:
對於構建、部署和運行 OrderProcess Web 服務和客戶端,您將使用 Ant 工具。代碼將部署在 Tomcat 伺服器上。在 c:\orderapp 文件夾下使用 ant deploy 命令來部署代碼。
應用程序文件夾 (c:\orderapp) 具有 Ant 構建文件。在運行上述命令之後,您的 orderapp 代碼將作為 orderapp.war 文件部署在 Tomcat 伺服器環境中。現在通過在 CATALINA_HOME\bin 文件夾下提供 catalina start 命令來啟動 Tomcat Web 伺服器。
orderapp 文件夾創建在 Tomcat 的 webapps 文件夾之下。啟動伺服器之後,通過輸入 ant client 命令來運行該應用程序。輸出將顯示訂單 ID(請參見圖 2)。
結束語
本文簡要描述了 CXF 框架的功能,並演示了它如何使您無需多少代碼編寫工作即可創建 Web 服務。您了解了使用 Bean 上下文文件的 Spring 與 CXF 的集成。您還研究了該框架如何將創建 Web 服務基礎結構組件的實際語義抽象出來,並為您提供一個僅集中於 Web 服務創建的更簡單的 API 外殼。
現在您已經了解了使用 CXF 來創建 Web 服務的基礎,請繼續關注本系列的第 2 部分,其中將向您介紹如何使用 CXF 和 Spring 將 POJO 公開為 Restful 服務。(責任編輯:A6)
[火星人 ] 使用 Spring 和 Apache CXF 設計和實現 POJO Web 服務,第 1 部分: 使用 CXF 和 Spring 創建 Web 服務已經有725次圍觀