XFire 入門

【IT168 技術文檔】

Java 社區一直試圖將 POJO 的作用發揮到極致，降低 Java 應用實現的難度，最近的嘗試是將 EJB3.0 建立在 POJO 之上；另一方面，SOA 是目前 Java 社區炙手可熱的名詞，非常多的企業都在努力應用和實施 SOA；XFire 爲這兩方面的需求提供了一種魔術般的解決方式，我們很快能夠發現使用 XFire 創建和發佈 Web 服務可以直接基於 POJO，將煩人的繼承關係和一大堆其他可能的約束丟在一邊。

POJO、SOA 概述

被重新審視的 POJO

POJO（Plain Old Java Object，簡單 Java 對象）是 Java 社區中最早的成員（回想您學習 Java 時第一個興奮的時刻，那個簡單的 "Hello World！" 例子），也是最簡單、最容易實現的方式。

然而現實中 Java 的發展已經遠遠超越了 POJO 的範圍，成爲面向對象技術應用中最成功的編程語言，尤其是繼承、多態的應用爲我們造就了一大批開發框架（如 Struts）和標準（如 EJB），隨之而來的就是實現的複雜化，我們必須面對一大堆繼承關係的限制。比如說：要開發一個基於 Struts 的應用，我們必須瞭解 Struts 特定的繼承關係如 ActionForm、ValidateActionForm；要開發一個 EJB 應用，我們必須繼承 EJBObject、SessionEJB 等。

爲了拋開這些限制，降低 Java 應用實現的難度，Java 社區開始重新審視 POJO 的價值，試圖將 POJO 的作用發揮到極致，最新的努力是 EJB3.0。Java 社區將 EJB3.0 設計爲基於 POJO，而不是爲他準備更多的繼承關係等限制。

讓人愛恨交加的 SOA

SOA 已經成爲了目前 Java 社區中炙手可熱的名詞，幾乎所有的軟件廠商都在討論它，爲他提供解決方案和產品支持，大部分的企業也已經在企業內部實施或者正在考慮實施 SOA。

然而 SOA 在企業內的實施卻不是一項簡單的任務，即使拋開新建系統直接基於 SOA 架構實施的因素，要把企業已有系統納入 SOA 框架也不是一件容易的事情。企業必須在對當前架構深入瞭解的基礎上，對已有系統進行大規模的改造才能滿足新的要求。如何經濟的從原有技術架構切換到 SOA 架構成爲很多企業的難題。

XFire 概述

XFire 是 codeHaus 組織提供的一個開源框架，它構建了 POJO 和 SOA 之間的橋樑，主要特性就是支持將 POJO 通過非常簡單的方式發佈成 Web 服務，這種處理方式不僅充分發揮了 POJO 的作用，簡化了 Java 應用轉化爲 Web 服務的步驟和過程，也直接降低了 SOA 的實現難度，爲企業轉向 SOA 架構提供了一種簡單可行的方式。

XFire 目前最新的版本是 1.2.2，目前支持的特性主要包括：

支持將 Web 服務綁定到 POJO、XMLBeans、JAXB1.1、JAXB2.0 和 Castor；
支持基於 HTTP、JMS、XMPP 等多種協議訪問 Web 服務；
支持多種 Web 服務業界重要標準如 SOAP、WSDL、Web 服務尋址（WS-Addressing）、Web 服務安全（WS-Security）等；
支持 JSR181，可以通過 JDK5 配置 Web 服務；
高性能的 SOAP 實現；
服務器端、客戶端代碼輔助生成；
對 Spring、Pico、Plexus 等項目的支持等。

XFire 安裝包

XFire 框架目前的最新版本是 1.2.6，可以訪問 xfire.codehaus.org 下載 XFire 框架的安裝包，下載時請選擇“全部二進制發佈包（Binary Distribution in zip package）”，而不僅僅是“XFire jar 文件（Jar of all XFire modules）”。

下載完成後，我們可以將下載的 .zip 文件解壓縮到任意的文件夾中（後面的章節中使用 % XFIRE_HOME % 表示 XFire 框架的安裝目錄），解壓縮後形成的文件目錄結構如下：

api（目錄）
api 目錄中是 XFire 框架中所有類（class）對應的 API 文檔，爲開發者使用 XFire 完成應用開發提供幫助。
examples（目錄）
examples 目錄中包含了所有隨 XFire 二進制包發佈的實例，包括這些實例的源代碼和相關 Web 應用配置內容。
lib（目錄）
lib 目錄中包含 XFire 運行所需要的外部支持類包（.jar文件），可以根據不同項目所需的 XFire 特性選擇所需要的支持類包。保守的方法是在 Web 項目中包含所有的外部支持類包（.jar文件）。
manual（目錄）
manual 目錄中包含有 XFire 框架的幫助文檔，開發者可以從這些幫助文檔中學習更多運用 XFire 框架實現 SOA 的知識和技巧。
modules（目錄）
modules 目錄中包含了 XFire 框架根據不同特性分別編譯的二進制包文件。發佈基於 XFire 框架的 Web 項目時，可以選擇使用該目錄下的所有 .jar 文件，也可以選擇 XFire-all-1.2.6.jar 文件。
XFire-all-1.2.6.jar
XFire 框架的二進制包文件，包含了全部的模塊（modules）。
LICENSE.txt
LICENSE.txt 文件中包含了 XFire 框架的授權協議。
NOTICE.txt
README.txt
這兩個文件中包含了 XFire 發佈時的一些有用的信息

XFire 框架支撐環境

XFire框架是一種基於Servlet技術的SOA應用開發框架，要正常運行基於XFire應用框架開發的企業應用，除了XFire框架本身之外，還需要JDK和Servlet容器的支持。

1．JDK 版本選擇、下載和安裝

XFire 支持非常多的特性，其中不同的特性對 JDK 版本的要求有所不同，比如如果項目中選擇基於 JSR181 標準發佈 Web 服務，我們就需要選擇 JDK5 或者以上版本，如果僅僅選擇將 Web 服務綁定到最簡單的 POJO，我們只需要選擇 JDK1.4 版本即可。

JDK 各版本均可以在 java.sun.com 網站上下載，如何安裝 JDK 請參考 SUN 公司的相關技術文檔和 JDK 的幫助文檔。

2．Servlet 容器下載和安裝

XFire 是一種基於 Servlet 技術的 SOA 應用開發框架，需要 Servlet 容器的支持。XFire 支持在多種 Servlet 容器中運行，包括 Websphere、Weblogic、TOMCAT 等。爲了說明的簡單，我們選擇使用 TOMCAT（版本5.0.30）作爲 XFire 的運行容器，所有配置過程和發佈步驟的說明也均是針對 TOMCAT，如果讀者使用 TOMCAT 之外的其它 Servlet 容器或者選擇了 TOMCAT 的其它版本，下面的配置過程和步驟可能需要做出調整，請讀者根據實際 Servlet 容器的幫助文檔進行相應調整。

TOMCAT 各版本均可以在 tomcat.apache.org 網站上下載，如何正確安裝 TOMCAT 服務器請參考 TOMCAT 服務器的幫助文檔。

3．xalan

XFire 需要 xalan 項目的支持，然而 1.2.6 版本中並沒有帶有相應的 jar 文件，因此請訪問 xml.apache.org，下載 xalan 項目的二進制包。

XFire 應用配置

前面的章節中我們下載和安裝了 XFire 安裝包和所需要的支持環境，現在我們開始學習如何從零開始創建 XFire 應用開發環境。下面的所有配置過程和發佈步驟均針對 TOMCAT（版本5.0.30）服務器，如果選擇其它的 Servlet 容器，下面的配置過程和步驟可能需要做出調整，請讀者根據實際 Servlet 容器的幫助文檔進行相應調整。

1、創建 Web 應用目錄和基本元素

在 %TOMCAT_HOME%/webapps 目錄下創建新的 Web 應用目錄 “XFire”
[注] 其中的 %TOMCAT_HOME% 指向 TOMCAT 的安裝目錄。

在 ”XFire”目錄下創建 ”WEB-INF”目錄、
在 ” WEB-INF”目錄下創建 ”lib”目錄和 ”classes”目錄
在 ” WEB-INF”目錄下創建 Web 應用描述文件 ”web.xml”， ”web.xml”文件的內容見清單 1-1。

清單 1-1 WEB-INF\web.xml

1、 <?xml version="1.0" encoding="ISO-8859-1"?>
2、 <web-app xmlns="http://java.sun.com/xml/ns/j2ee"
3、     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4、     xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee
   http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
5、     version="2.4">
6、
7、     <display-name>XFire實例</display-name>
8、     <description>
9、          基於XFire框架發佈Web服務的例子
10、     </description>
11、
12、 </web-app>

2、拷貝 XFire 所需的支持類包文件

拷貝 %XFIRE_HOME%/lib 目錄下所有文件到 “1、創建 Web 應用目錄和基本元素” 中所創建的 ”lib”目錄下，將 %XFIRE_HOME%/XFire-all-1.2.6.jar 文件也拷貝到 “1、創建 Web 應用目錄和基本元素” 中所創建的 ”lib”目錄下。將 xalan 安裝包中的所有 jar 文件和所需要的支持 jar 文件拷貝到相同的 ”lib”目錄下。

[注] 爲了減少拷貝的 jar 文件的數目，開發者可以根據項目的需要選擇需要拷貝的 jar 文件，而不是全部拷貝，如何根據需要選擇拷貝合適的類包文件請訪問 XFire 站點。

3、配置 XFire 框架運行所需的 Servlet

修改 web.xml 文件，在其中增加如下 Servlet 定義內容。

1、 <servlet>
2、     <servlet-name>XFireServlet</servlet-name>
3、     <display-name>XFire Servlet</display-name>
4、     <servlet-class>
5、         org.codehaus.xfire.transport.http.XFireConfigurableServlet
6、     </servlet-class>
7、   </servlet>
8、
9、   <servlet-mapping>
10、     <servlet-name>XFireServlet</servlet-name>
11、     <url-pattern>/servlet/XFireServlet/*</url-pattern>
12、   </servlet-mapping>
13、
14、   <servlet-mapping>
15、     <servlet-name>XFireServlet</servlet-name>
16、     <url-pattern>/services/*</url-pattern>
17、 </servlet-mapping>

4、創建 XFire 框架的服務發佈文件 services.xml

在 “1、創建 Web 應用目錄和基本元素” 中創建的 classes 目錄下新建目錄 ”META-INF\xfire”；
在步驟 a) 中新建的 ”xfire”文件目錄下創建新文件 services.xml，文件的默認內容如清單1-2 。

清單 1-2 WEB-INF\classes\META-INF\xfire\services.xml

1、 <beans xmlns="http://XFire.codehaus.org/config/1.0">
2、 </beans>
將 POJO 發佈成 Web 服務

XFire 框架中，我們有兩種方式將 POJO 發佈成 Web 服務：

一種方式是直接使用 Web 服務接口和 Web 服務實現類（POJO）來發布；
另一種方式是基於 JSR181 標準和註釋技術將被註釋的 POJO 發佈成 Web 服務；
下面的章節中我們將學習使用第一種方式來完成 POJO 的 Web 服務發佈。我們將使用經典的 ”Hello World!”例子來演示將 POJO 發佈成 Web 服務所需要的步驟，不過我們不再是簡單的訪問一個 Java 方法來輸出 ”Hello World!”字符串，而是轉爲在 SOA 環境下實現：Web 服務客戶端通過訪問服務器端發佈成 Web 服務的 POJO 獲得返回的 ”Hello World!”字符串後輸出到客戶端的控制檯上。

將 POJO 發佈成 Web 服務的基本步驟如下：

創建 Web 服務接口，聲明該 Web 服務對外暴露的接口；
創建 Web 服務實現類，爲 Web 服務接口提供實現；
修改 XFire 框架的服務發佈文件 ---- services.xml，將 POJO 發佈成 Web 服務。
下面我們通過創建 ”Hello World!”例子來具體說明如何實現這三個步驟。

1．創建 Web 服務接口 ---- HelloWorldService

要將 POJO 發佈成 Web 服務，首先需要創建 Web 服務接口，在接口中聲明該 Web 服務需要對外暴露的接口。

我們根據需要創建 Web 服務接口 ” HelloWorldService”，在其中聲明一個 ”sayHello”方法，該方法返回 ”String ”類型的內容。” HelloWorldService”接口對應的 Java 文件代碼如清單 1-3。

清單 1-3 WEB-INF\classes\org\vivianj\xfire\pojo\HelloWorldService.java

1．package org.vivianj.xfire.pojo;
2．
3． /**
4． * HelloWorldService 中聲明需要發佈成 Web 服務的所有 Java 方法
5． * HelloWorldService 作爲Web服務接口
6． */
7． public interface HelloWorldService {
8． /**
9． * sayHello 方法聲明瞭 Web 服務對外暴露的接口
10． *
11． * @return 返回給客戶端的字符串
12． */
13． public String sayHello();
14．}

2．創建 Web 服務實現類 ”HelloWorldServiceImpl”

創建 Web 服務實現類 ”HelloWorldServiceImpl”，它繼承 ”1、創建Web服務接口 ---- HelloWorldService” 中創建的 HelloWorldService 接口，並且爲它聲明的 ”sayHello”方法提供具體實現：返回字符串”Hello World!”。 ”HelloWorldServiceImpl”類對應的 Java 文件代碼如清單 1-4。

清單 1-4 WEB-INF\classes\org\vivianj\xfire\pojo\HelloWorldServiceImpl.java

1．package org.vivianj.xfire.pojo;
2．
3．/**
4． * HelloWorldServiceImpl 中爲 Web 服務接口中聲明的所有 Java 方法提供具體實現
5． * HelloWorldServiceImpl 作爲 Web 服務的實現類
6． */
7．public class HelloWorldServiceImpl implements HelloWorldService {
8．
9． /*
10． * sayHello 方法爲 HelloWorldService 服務接口定義的 sayHello 方法提供具體實現
11． *
12． * @see org.vivianj.XFire.pojo.HelloWorldService#sayHelloToXFire()
13． */
14． public String sayHello() {
15． return "Hello World!";
16． }
17．
18．}

3．修改 services.xml，將 POJO 發佈成 Web 服務

我們可以在 WEB-INF\classes\META-INF\XFire\services.xml 文件中的 <beans …> 和 </beans> 元素中間加入如下的 xml 內容將上面創建的 HelloWorldService 發佈成 Web 服務。

1．<service>
2． <name>HelloWorldService</name>
3． <namespace>http://vivianj.org/HelloWorldService</namespace>
4． <serviceClass>
5． org.vivianj.xfire.pojo.HelloWorldService
6． </serviceClass>
7． <implementationClass>
8． org.vivianj.xfire.pojo.HelloWorldServiceImpl
9． </implementationClass>
10．</service>

其中各元素的功能如下：

service
service 標籤和它所包含的 xml 內容爲發佈成 Web 服務的 POJO 提供完整的描述。

name
Web 服務被髮布時所採用的唯一名稱。

namespace
Web 服務發佈時所使用的命名空間。

serviceClass
Web 服務接口類的全名，包括包名和類名。

implemetationClass
Web 服務實現類的全名，包括包名和類名。

更多 service 元素的子元素和它們的用法請參考 XFire 站點。

通過上面的三個步驟，我們已經將新創建的HelloWorldService發佈成了Web服務，我們可以使用下面的步驟測試一下創建的Web服務是否能夠正常運行：

編譯上面的步驟中創建的 Java 接口和類；
啓動 TOMCAT 服務器。
等 TOMCAT 服務器完全啓動後，打開瀏覽器，在地址欄中輸入 http://localhost:8080/XFire/services/HelloWorldService?wsdl。
其中 HelloWorldServcie 是配置文件中 service\name 元素所定義的內容，”wsdl”參數表示查看該 Web 服務的 WSDL（Web服務描述語言）文件。

如果瀏覽器中出現如下圖所示類似的內容，表示 Web 服務發佈成功，我們可以編寫客戶端訪問該 Web 服務從服務器獲取返回字符串，本文下載資源中提供的下載文件中包含有可供參考的客戶端類 org.vivianj.xfire.pojo.client.HelloWorldServiceClient。

圖：瀏覽器中訪問效果

如果瀏覽器中出現錯誤提示，請按照上面的步驟和說明檢查已經完成的開發、配置過程是否完全正確。

結束語

本文中作者首先講解了 XFire 框架的主要特性，XFire 框架的運行環境以及基於 XFire 框架開發 SOA 應用的基本步驟，並且藉助於 SOA 環境下的 ”Hello World!”例子，詳細的講解和演示瞭如何基於 XFire 框架、經過簡單的開發、配置步驟就將一個 POJO 類中包含的方法發佈成Web服務。從 ”Hello World!”例子實現的過程中，我們可以發現 XFire 框架最大化的發揮了 POJO 的作用，減少了 SOA 實施時對框架本身的依賴，降低了 SOA 實施的難度，企業實施 SOA 時並不需要增加太多的投入就可以實現目標。

原文地址：http://tech.it168.com/j/2007-12-19/200712191247685.shtml