使用XFire組件開發WebService實例

 

使用XFire組件開發WebService實例

 

1、WebService簡介

　　WebService又是一種高級應用，與之前學習的Struts、Spring、Hibernate等框架不同。WebService是面向服務的架構（SOA）。那么它到底是做什么用的？什么才是面向服務的架構？

　　讓我們來看一種需求，集團公司可能具有多種WEB應用。比如，前年開發了個進銷存系統、去年開發了一個ERP、今年又開發了一個OA。現在這家集團公司需要將這三個系統整合，難道需要重新編碼將它們整合嗎？而這三個系統又是用不同語言編寫的，這種成本對公司來說無疑是一種浪費。WebService可以很好的解決這種需求。

　　WebService是可以進行跨語言、跨平台、分布式系統間整合的方案，WebService像是一條線將這些系統穿起來——企業服務總線（ESB）。WebService使用簡單對象訪問協議（SOAP）使用http協議傳輸xml數據（xml是最常用的，也有其他格式數據。）來完成系帶間的整合。

　　什么是整合？當然是功能和數據的整合，也就是一個系統可以調用另一個系統的WebService接口來完成數據的交互。這樣我們就需要知道，提供WebService服務功能的應用公開了哪些接口，我們可以通過WebService描述文檔（WSDL）得知。WSDL不需要我們手動編寫，Java的WebService實現可以為我們自動生成。JDK1.6新增支持WebService，但還不夠成熟。所以我們可以使用一些第三方開源組織提供的WebService組件。

2、Xfire組件

　　1.XFire簡介

　　XFire 是與Axis 2並列的新一代Web Service框架，通過提供簡單的API支持Web Service各項標准協議，幫助你方便快速地開發Web Service應用。

　　相對於Axis來說，目前XFire相對受歡迎，加上其提供了和Spring集成的支持，在目前的Web Service開源社區擁有眾多的追隨者。並且因為XFire為Spring提供的支持，使得我們可以很容易在Spring中使用XFire構建Web Service應用。

　　XFire 與Axis2相比具有如下特征：

• 支持一系列Web Service的新標准--JSR181、WSDL2.0 、JAXB2、WS-Security等；
• 使用Stax解釋XML,性能有了質的提高。XFire采用Woodstox 作Stax實現；
• 容易上手，可以方便快速地從pojo發布服務；
• 靈活的Binding機制，包括默認的Aegis,xmlbeans,jaxb2,castor；
• 高性能的SOAP 棧設計；
• 支持Spring、Pico、Plexus、Loom等容器。

　　XFire 與Axis1性能的比較如下：

• XFire 比Axis1.3快2-6倍；
• XFire 的響應時間是Axis1.3的1/2到1/5。

　　XFire 在WebService框架中開始較晚，它從現有的框架中借鑒了許多優秀的理念，力爭將Web Service的應用開發難度降到最低。此外，還提供了各種綁定技術、支持多種傳輸協議，對WebService體系中許多新的規范提供了支持。

　　2.XFire組件下載

　　XFire在2007年后已停止更新。正式更名為Apache CXF,亦可以說是XFire2.0。

　　XFire - XFire安裝包：XFire框架目前最后的一個版本是1.2.6，在2007年5月3日發布，可以訪問xfire.codehaus.org下載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發布時的一些有用的信息。

3、MyEclipse使用XFire組件開發WebService實例

　　服務端（為客戶端提供WebService接口）開發：

　　1.創建工程，導入XFire組件所需jar包到lib下：xfire-all-1.2.6.jar和lib目錄所有jar包（根據實際需要確定）。

　　2.創建完成后，打開web.xml，XFire的配置如下：

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://java.sun.com/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    version="2.5" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee   http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
    <servlet>
        <servlet-name>XFireServlet</servlet-name>
        <servlet-class>org.codehaus.xfire.transport.http.XFireConfigurableServlet</servlet-class>
        <load-on-startup>0</load-on-startup>
    </servlet>
    <servlet-mapping>
        <servlet-name>XFireServlet</servlet-name>
        <url-pattern>/services/*</url-pattern>
    </servlet-mapping>
    <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>
</web-app>

　　3.創建Java Code和services.xml。

　　服務端接口和默認實現：

public interface HelloWebService {
    public String example(String message);
}

 

public class HelloWebServiceImpl implements HelloWebService {
    public String example(String message) {
        return "這是服務端返回:" + message;
    }
}

　　創建對應的services.xml配置文件，xfire默認的加載services.xml路徑是classes\META-INF。代碼如下：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://xfire.codehaus.org/config/1.0">
    <service>
        <name>HelloWebService</name>
        <serviceClass>com.server.HelloWebService</serviceClass>
        <implementationClass>com.server.HelloWebServiceImpl</implementationClass>
    </service>
</beans>

　　至此，服務端代碼生成完畢！工程結構如圖：

　　部署並測試服務端：

1. 將服務端部署到Tomcat上，並啟動Tomcat。
2. 選擇Toolbars上的Launch SOAP Web Service Explorer,Web Services Explorer窗口右側WSDL Page，輸入網址：http://localhost:8080/WebServiceServer/services/HelloWebService?wsdl，點Go，若成功則Status會提示。
3. 雙擊examlpe,輸入hello,下面會顯示out(string):hello,測試通過。

　　開發客戶端（調用服務端提供的WebService接口方法）：

　　經過以上幾步，我們已經成功發布了一個WebService，現在需要創建一個客戶端來調用該服務

1. 創建Java Project：WebServiceClient
2. 引入XFire組件所需jar包：commons-codec-1.2.jar、commons-httpclient-3.0.jar、jdom.jar、xfire-all-1.2.6.jar、wsdl4j-1.5.1.jar、commons-logging-1.0.4.jar。
3. 創建Java Code客戶端，調用WebService：

import java.net.URL;
import org.codehaus.xfire.client.Client;
public class HelloWSClient {
    public static void main(String[] args) throws Exception{
        Client client = new Client(new URL("http://localhost:8080/WebServiceServer/services/HelloWebService?wsdl"));
        Object[] result = client.invoke("example", new Object[]{"Hello World!"});
        System.out.println(result[0]);
    }
}

　　或將接口HelloWebService.java復制到工程中來，調用接口的方法。不止可以返回字符串，也可以是集合數組等。

import java.util.List;

import org.codehaus.xfire.client.Client;
import org.codehaus.xfire.client.XFireProxyFactory;
import org.codehaus.xfire.service.Service;
import org.codehaus.xfire.service.binding.ObjectServiceFactory;
import org.codehaus.xfire.transport.http.CommonsHttpMessageSender;

public class HelloWSClient {
    public static void main(String[] args) throws Exception{
        String serviceURL = "http://localhost:8080/WebServiceServer/services/HelloWebService";
        Service serviceModel = new ObjectServiceFactory().create(HelloWebService.class,null,"http://localhost:8080/WebServiceServer/services/HelloWebService?wsdl",null);
        
        XFireProxyFactory serviceFactory = new XFireProxyFactory();
        
        HelloWebService service = (HelloWebService) serviceFactory.create(serviceModel, serviceURL);
        Client client = Client.getInstance(service);
        // disable timeout
        client.setProperty(CommonsHttpMessageSender.HTTP_TIMEOUT, "0");
        
        List<String> list = service.getList();
        for (String string : list) {
            System.out.println(string);
        }
    }
}

　　客戶端工程結構如圖：

　　運行客戶端代碼，輸出：這是服務端返回:Hello World!

　　調用WebService成功！