當(dāng)前位置：首頁(yè) > 前端技术 > javascript >内容正文

javascript

使用XFire+Spring构建Web Service（一）——helloWorld篇

發(fā)布時(shí)間：2023/12/15 javascript 24 豆豆

生活随笔收集整理的這篇文章主要介紹了使用XFire+Spring构建Web Service（一）——helloWorld篇小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,幫大家做個(gè)參考.

來(lái)源：http://www.blogjava.net/amigoxie/archive/2007/09/26/148207.html

XFire 是與Axis 2并列的新一代Web Service框架，通過(guò)提供簡(jiǎn)單的API支持Web Service各項(xiàng)標(biāo)準(zhǔn)協(xié)議，幫助你方便快速地開(kāi)發(fā)Web Service應(yīng)用。

相對(duì)于Axis來(lái)說(shuō)，目前XFire相對(duì)受歡迎，加上其提供了和Spring集成的支持，在目前的Web Service開(kāi)源社區(qū)擁有眾多的追隨者。并且因?yàn)閄Fire為Spring提供的支持，使得我們可以很容易在Spring中使用XFire構(gòu)建Web Service應(yīng)用。

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

l???????? 支持一系列Web Service的新標(biāo)準(zhǔn)--JSR181、WSDL2.0 、JAXB2、WS-Security等；

l???????? 使用Stax解釋XML,性能有了質(zhì)的提高。XFire采用Woodstox 作Stax實(shí)現(xiàn)；

l???????? 容易上手，可以方便快速地從pojo發(fā)布服務(wù)；

l???????? 支持Spring、Pico、Plexus、Loom等容器；

l???????? 靈活的Binding機(jī)制，包括默認(rèn)的Aegis,xmlbeans,jaxb2,castor；

l???????? 高性能的SOAP 棧設(shè)計(jì)；

l???????? 支持Spring、Pico、Plexus、Loom等容器。

XFire 與Axis1性能的比較如下：

l???????? XFire 比Axis1.3快2-6倍；

l???????? XFire 的響應(yīng)時(shí)間是Axis1.3的1/2到1/5。

XFire 在WebService框架中開(kāi)始較晚，它從現(xiàn)有的框架中借鑒了許多優(yōu)秀的理念，力爭(zhēng)將Web Service的應(yīng)用開(kāi)發(fā)難度降到最低。此外，還提供了各種綁定技術(shù)、支持多種傳輸協(xié)議，對(duì)WebService體系中許多新的規(guī)范提供了支持。

下面讓我們來(lái)看一個(gè)XFire于Spring集成的helloWorld的簡(jiǎn)單例子。

一．實(shí)現(xiàn)的功能和特點(diǎn)

??? 本例具有如下功能和特點(diǎn)：

1）? 基于J2EE平臺(tái)的Web Service服務(wù)；

2）? 開(kāi)發(fā)方便，配置簡(jiǎn)單；

3）? 與spring無(wú)縫集成。

XFire 是完全基于流數(shù)據(jù)處理進(jìn)行工作的系統(tǒng)，這意味著XFire不是將整個(gè)SOAP文檔緩存在內(nèi)存中，而是以管道的方式接收SOAP流數(shù)據(jù)。這種工作方式的轉(zhuǎn)變帶來(lái)了可觀的性能回報(bào)，同時(shí)節(jié)省了內(nèi)存的占用。

　　XFire 從管道中接收一個(gè)SOAP請(qǐng)求到返回一個(gè)SOAP響應(yīng)，會(huì)經(jīng)歷一系列的階段。在管道調(diào)用的任何一個(gè)階段，XFire都可以添加一些額外的Handler，在對(duì)消息進(jìn)行加工處理后再傳入到下一個(gè)階段中。在SOAP請(qǐng)求消息對(duì)Web Service發(fā)起真正調(diào)用之前，分別會(huì)經(jīng)過(guò)傳輸、預(yù)轉(zhuǎn)發(fā)、轉(zhuǎn)發(fā)、策略實(shí)施、用戶信息處理、預(yù)調(diào)用、服務(wù)調(diào)用等階段。

二．開(kāi)發(fā)環(huán)境

??? 筆者的開(kāi)發(fā)環(huán)境描述如下：

1）? jdk: 1.5 版本；

2）? Tomcat ：5.5.20；

3）? MyEclipse: 5.1.1 GA 。

三．開(kāi)發(fā)步驟

1. 工程與環(huán)境的建立

在 MyEclipse中新建Web工程，名為webservice_helloworld。選擇該工程后，點(diǎn)擊右鍵選擇MyEclipse->Add Web Service Capabilities，彈出Add Web Service Capabilities對(duì)話框，點(diǎn)擊“Next”，彈出Project Library Configuration對(duì)話框，默認(rèn)選擇Core Libraries，點(diǎn)擊“Finish”按鈕，完成XFire核心包的添加。為了后續(xù)的客戶端的測(cè)試，還需讀者加入commons- httpclient.jar包到WEB-INF/lib下。

部署后可看到此時(shí)WEB-INF/lib的jar包列表如下：

activation-1.1.jar 、 commons-beanutils-1.7.0.jar、commons-codec-1.3.jar、commons- httpclient.jar、commons-logging-1.0.4.jar、jaxen-1.1-beta-9.jar、jaxws-api- 2.0.jar、jdom-1.0.jar、jsr173_api-1.0.jar、mail-1.4.jar、saaj-api-1.3.jar、 saaj-impl-1.3.jar、spring-1.2.6.jar、stax-api-1.0.1.jar、wsdl4j-1.5.2.jar、 wstx-asl-3.0.1.jar、xbean-2.1.0.jar、xbean-spring-2.5.jar、xfire-aegis- 1.2.2.jar、xfire-annotations-1.2.2.jar、xfire-core-1.2.2.jar、xfire- java5-1.2.2.jar、xfire-jaxws-1.2.2.jar、xfire-jsr181-api-1.0-M1.jar、xfire- spring-1.2.2.jar、XmlSchema-1.1.jar

為了后續(xù)的開(kāi)發(fā)和測(cè)試，在src目錄下分別建立test和webservice目錄，分別用于存放測(cè)試文件和webservice的相關(guān)類。

2 ．Web Service實(shí)現(xiàn)的編寫

??? 在本例中，我們只是做一個(gè)helloWorld的簡(jiǎn)單例子。Web Service服務(wù)端提供一個(gè)根據(jù)輸入的名字信息回復(fù)相應(yīng)的helloWorld信息的。例如，當(dāng)名字為“阿蜜果”時(shí)，恢復(fù)信息為“hello，阿蜜果”。下面讓我們一步一步來(lái)開(kāi)始進(jìn)行編碼。

1） web.xml 的配置

一般情況下，我們通過(guò)HTTP作為Web Service的傳輸協(xié)議，這樣我們只需啟動(dòng)一個(gè)Web服務(wù)器(如Tomcat，在本例中使用的是Tomcat5.5.20)，這樣客戶端就可以通過(guò) HTTP訪問(wèn)到Web Service服務(wù)。為了集成Spring容器，XFire專門提供一個(gè)XFireSpringServlet，我們可以在web.xml中配置該 Servlet，將Spring容器中定義的Web Service在某個(gè)URI下發(fā)布。

為了能正確使用XFire，需在web.xml中進(jìn)行相應(yīng)配置，在該文件中配置XFire的 servlet 和 servlet-mapping 。同時(shí)因?yàn)楸緦?shí)例需要將 XFire 集成到 Spring 中，因而需要在 web.xml 文件中加載 Spring 的相應(yīng)配置文件。在本實(shí)例中，我們首先在 WEB-INF 下建立兩個(gè)配置 Spring 配置文件，一個(gè)為 applicationContext.xml ，該文件用來(lái)定義本工程的 bean ，一個(gè)為 xfire-servlet.xml ，用來(lái)配置 XFire 的相關(guān) bean 。修改后的 web.xml 的內(nèi)容如下所示：

<? xml?version="1.0"?encoding="UTF-8" ?>
< web-app? xmlns ="http://java.sun.com/xml/ns/j2ee" ?xmlns:xsi ="http://www.w3.org/2001/XMLSchema-instance" ?version ="2.4" ?xsi:schemaLocation ="http://java.sun.com/xml/ns/j2ee???http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd" >
???? < display-name > XFireService </ display-name >
???? 
???? < context-param >
??????? < param-name > contextConfigLocation </ param-name >
??????? < param-value > /WEB-INF/applicationContext.xml,/WEB-INF/xfire-servlet.xml </ param-value >
???? </ context-param >
???? < listener >
??????? < listener-class > ?org.springframework.web.context.ContextLoaderListener
??????? </ listener-class >
???? </ listener >
????? < listener > ?
??????? < listener-class > ?????org.springframework.web.util.IntrospectorCleanupListener
??????? </ listener-class >
???? </ listener >
???? 

???? 
???? < servlet > ???
??????? < servlet-name > xfire </ servlet-name > ???
??????? < servlet-class > org.springframework.web.servlet.DispatcherServlet </ servlet-class >
???? </ servlet > ???
???? < servlet-mapping > ?
??????? < servlet-name > xfire </ servlet-name >
??????? < url-pattern > *.ws </ url-pattern >
???? </ servlet-mapping >
???? < servlet >
??????? 
??????? < servlet-name > xfireServlet </ servlet-name >
??????? < servlet-class > org.codehaus.xfire.spring.XFireSpringServlet </ servlet-class >
???? </ servlet >
???? < servlet-mapping >
??????? < servlet-name > xfireServlet </ servlet-name >
??????? 
??????? < url-pattern > /service/* </ url-pattern >
???? </ servlet-mapping >
???? 
</ web-app >

??? 2） Web Service 的接口類 HelloWorld.java 和對(duì)應(yīng)實(shí)現(xiàn)類 HelloWorldImpl.java

為了用 Web Service 完成 HelloWorld 功能，我們首先在 src/webservice 目錄下建立接口類 HelloWold.java 。它僅包含一個(gè) sayHelloWorld(String name) 的方法，其詳細(xì)內(nèi)容如下：

package ?webservice;

/**
?*HelloWorld的接口類.
? */
publicinterface?HelloWorld? {
???? /**
?????*對(duì)名字為name的人打招呼.
?????*@paramname名字
?????*@return返回打招呼的字符串
????? */
????String?sayHelloWorld(String?name);
}
我們還需要建立一個(gè)對(duì)應(yīng)的實(shí)現(xiàn)類，來(lái)實(shí)現(xiàn)sayHelloWorld的功能，該實(shí)現(xiàn)類即為HelloWorldImpl.java。該類的詳細(xì)內(nèi)容如下：
package ?webservice;
/**
?*HelloWorld的實(shí)現(xiàn)類.
? */
publicclass?HelloWorldImpl? implements ?HelloWorld? {
???? public ?String?sayHelloWorld(String?name)? {
???????String?helloWorld? = ? " hello, " ? + ?name;
??????? return ?helloWorld;
????}
}

3） Spring 配置文件 applicationContext.xml 和 xfire-servlet.xml 的配置

首先我們?cè)?/span> applicationContext.xml 文件中配置對(duì)應(yīng)的 bean —— HelloWorldBean ，該 xml 文件的內(nèi)容如下：

???? 這個(gè)配置文件很簡(jiǎn)單，在此不詳述。

XFire 為 Spring提供了方便易用的導(dǎo)出器XFireExporter，借助該導(dǎo)出器的支持，我們可以在Spring容器中將一個(gè)POJO導(dǎo)出為Web Service。HelloWorld是業(yè)務(wù)服務(wù)類，在此擁有一個(gè)sayHelloWorld的方法，我們希望將此方法開(kāi)放為Web Service。在實(shí)際應(yīng)用中，如果某個(gè)類具有眾多的方法，而其中的某些方法不需要開(kāi)放為Web Service的情況下，我們可以定義一個(gè)窄接口，該接口中只需定義那些開(kāi)放為Web Service的業(yè)務(wù)方法。

將一個(gè)業(yè)務(wù)類所有需要開(kāi)放為Web Service的方法通過(guò)一個(gè)窄接口來(lái)描述是值得推薦的作法，這讓W(xué)eb Service的接口顯得很“干凈”。其次，XFire的導(dǎo)出器也需要服務(wù)接口的支持，因?yàn)樗捎没诮涌诘膭?dòng)態(tài)代理技術(shù)。

窄接口中的方法在真實(shí)的系統(tǒng)中可能需要引用其它的業(yè)務(wù)類或DAO獲取數(shù)據(jù)庫(kù)中的真實(shí)數(shù)據(jù)，為了簡(jiǎn)化實(shí)例，我們?cè)诖撕?jiǎn)化了實(shí)例。

下面讓我們看看在xfire-servlet.xml文件中導(dǎo)出器的設(shè)置，該文件內(nèi)容如下：

<? xml?version="1.0"?encoding="UTF-8" ?>
<! DOCTYPE?beans?PUBLIC?"-//SPRING//DTD?BEAN//EN"
????"http://www.springframework.org/dtd/spring-beans.dtd" >
< beans >
???? 
???? < import? resource ="classpath:org/codehaus/xfire/spring/xfire.xml" ? />
???? <! —定義訪問(wèn)的url-- >
???? < bean? class ="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping" >
??????? < property? name ="urlMap" > ?????????????
??????????? < map > ?????????????????
?????????????? < entry? key ="/HelloWorldService.ws" > ??????????????????
?????????????????? < ref? bean ="HelloWorldService" ? /> ?????????????????
?????????????? </ entry > ?????????????
??????????? </ map > ?????????
??????? </ property > ?????
???? </ bean > ?????

???? 
???? < bean? id ="baseWebService" ?class ="org.codehaus.xfire.spring.remoting.XFireExporter" ?lazy-init ="false" ?abstract ="true" >
??????? 
??????? < property? name ="serviceFactory" ?ref ="xfire.serviceFactory" ? />
??????? 
??????? < property? name ="xfire" ?ref ="xfire" ? />
???? </ bean >
???? < bean? id ="HelloWorldService" ?parent ="baseWebService" >
??????? 
??????? < property? name ="serviceBean" ?ref ="HelloWorldBean" ? />
??????? 
??????? < property? name ="serviceClass" ?value ="webservice.HelloWorld" ? />
???? </ bean >
</ beans >

在上面的配置中，我們可以看到，在該配置文件中引入了xfire.xml這個(gè)Spring配置文件。它是在XFire核心JAR包中擁有一個(gè)預(yù)定義的 Spring配置文件，它定義了XFire在Spring中必須用到的一些Bean和資源，需要引入這個(gè)預(yù)定義的配置文件。從該配置文件中可以看出，我們通過(guò)XFireExporter將業(yè)務(wù)類導(dǎo)出為Web Service，對(duì)于任何導(dǎo)出器，我們都需要引入XFire環(huán)境，即serviceFactory 和 xfire ，這是標(biāo)準(zhǔn)的配置。 ServiceFactory 是XFire的核心類，它可以將一個(gè)POJO生成為一個(gè)Web Service。

在本實(shí)例中，我們通過(guò)定義一個(gè)baseWebService，其余的webService配置都將該bean作為父bean，這樣可以簡(jiǎn)化Spring的配置，不需要多次引入serviceFactory和xfire。

3. Web Service 的測(cè)試

??? 在上一步操作完成之后，我們的這個(gè)簡(jiǎn)單的 Web Service 已經(jīng)編寫完畢，下面讓我們來(lái)看看自己的勞動(dòng)成果吧。

??? 在瀏覽器中輸入地址： http://localhost:8080/webservice_helloworld/HelloWorldService.ws?wsdl ，我們可以看到 HelloWorldService 對(duì)應(yīng)的 WSDL 信息，閱讀這個(gè)WSDL文檔，我們可以知道HelloWorld的sayHelloWorld方法已經(jīng)被成功地發(fā)布為Web Service了。只要拿到這個(gè)WSDL就可以開(kāi)發(fā)相應(yīng)的客戶端調(diào)用程序了。

XFire 為訪問(wèn)服務(wù)端Web Service提供了各種方便的方式：我們一般根據(jù)服務(wù)地址和窄接口類創(chuàng)建客戶調(diào)用程序。

　　在不能獲得服務(wù)窄接口類的情況下，XFire允許我們通過(guò)WSDL文件生成客戶端調(diào)用程序，通過(guò)指定服務(wù)接口的方式調(diào)用服務(wù)。

1） 通過(guò)WSDL文件生成客戶端調(diào)用程序

首先我們通過(guò) http://localhost:8080/webservice_helloworld/HelloWorldService.ws?wsdl 我們可以獲得 WSDL 文件 HelloWorldService.wsdl ，并將其放在 src 目錄下面，接著我們通過(guò)程序訪問(wèn)該 WSDL 文件，并調(diào)用需測(cè)試的方法。此時(shí)測(cè)試類 WebServiceClientTest.java 的內(nèi)容如下所示：

package ?test;

import ?org.codehaus.xfire.client.Client;
import ?org.springframework.core.io.ClassPathResource;
import ?org.springframework.core.io.Resource;
import ?webservice.HelloWorld;

/**
?*Copyright2007GuangZhouAmigo.
?*Allrightreserved.???
?*HelloWorld的webservice的測(cè)試類.
?* @author <a?href="mailto:xiexingxing1121@126.com">AmigoXie</a>
?*@version1.0
?*Creationdate:2007-9-16-下午05:36:05
? */
publicclass?WebServiceClientTest? {?
????HelloWorld?helloWorld? = ? null ;

????publicstaticvoid?main(String[]?args)? throws ?Exception? {
???????WebServiceClientTest?test? = ? new ?WebServiceClientTest();
???????test.testClient();
????} ?
????
????publicvoid?testClient()? throws ?Exception? {
???????String?wsdl? = ? " HelloWorldService.wsdl " ;? // 對(duì)應(yīng)的WSDL文件
???????Resource?resource? = ? new ?ClassPathResource(wsdl);?
???????Client?client? = ? new ?Client(resource.getInputStream(),? null );? // 根據(jù)WSDL創(chuàng)建客戶實(shí)例
???????
???????Object[]?objArray? = ? new ?Object[ 1 ];
???????objArray[ 0 ]? = ? " 阿蜜果 " ;
??????? // 調(diào)用特定的Web?Service方法
???????Object[]?results? = ?client.invoke( " sayHelloWorld " ,?objArray);
???????System.out.println( " result:? " ? + ?results[ 0 ]);
????}
}

運(yùn)行該類，可得到如下輸出結(jié)果：

result: hello, 阿蜜果

可看出運(yùn)行結(jié)果正確。

2 ）根據(jù)服務(wù)地址創(chuàng)建客戶端調(diào)用程序

??? 接著讓我們來(lái)看一個(gè)根據(jù)服務(wù)地址創(chuàng)建客戶端調(diào)用程序的例子。我們可以通過(guò)測(cè)試類來(lái)測(cè)試Web Service的正確性，下面讓我們來(lái)看一個(gè)簡(jiǎn)單的測(cè)試類，首先我們?cè)趕rc/test目錄建立 WebServiceClientTest.java 文件，并在 src 目錄下建立客戶端調(diào)用的 Spring 配置文件 client.xml 。在 client.xml 配置文件中我們定義了一個(gè) testWebService 的 bean ，該 bean 訪問(wèn) wsdlDocumentUrl 為 http://localhost:8080/webservice_helloworld/HelloWorldService.ws?wsdl 的 WSDL 。該 xml 文件的詳細(xì)內(nèi)容如下：

<? xml?version="1.0"?encoding="UTF-8" ?>
<! DOCTYPE?beans?PUBLIC?"-//SPRING//DTD?BEAN//EN"
????"http://www.springframework.org/dtd/spring-beans.dtd" >
< beans >
???? < bean? id ="testWebService" ?class ="org.codehaus.xfire.spring.remoting.XFireClientFactoryBean" >
??????? < property? name ="serviceClass" > ??????????
??? < value > webservice.HelloWorld </ value > ???????
??????? </ property > ??????
???????? < property? name ="wsdlDocumentUrl" > ?????????
< value > http://localhost:8080/webservice_helloworld/HelloWorldService.ws?wsdl </ value > ???????
???????? </ property > ??????
????? </ bean >
</ beans >

???? 在 WebServiceClientTest.java 文件中獲得 HelloWorld ，并調(diào)用它的 sayHelloWorld 方法來(lái)完成測(cè)試，該類的詳細(xì)內(nèi)容如下所示：

package ?test;

import ?org.springframework.context.ApplicationContext;
import ?org.springframework.context.support.ClassPathXmlApplicationContext;
import ?webservice.HelloWorld;

/**
?*HelloWorld的webservice的測(cè)試類.
? */
publicclass?WebServiceClientTest? {?
????HelloWorld?helloWorld? = ? null ;

????publicstaticvoid?main(String[]?args)? {
???????WebServiceClientTest?test? = ? new ?WebServiceClientTest();
???????test.testClient();
????} ?

????publicvoid?testClient()? {
???????ApplicationContext?ctx? = ? new ?ClassPathXmlApplicationContext(
?????????????? " client.xml " );
???????helloWorld? = ?(HelloWorld)?ctx.getBean( " testWebService " );
???????System.out.println(helloWorld.sayHelloWorld( " 阿蜜果 " ));
????}
}

??? 在啟動(dòng) webservice_helloworld 工程的情況下，運(yùn)行 WebServiceClientTest 類，可看到控制臺(tái)包含如下信息：

??? hello, 阿蜜果

??? 由此可看出調(diào)用 Web Service 成功。

四．總結(jié)

??? 與 Axis相比，在實(shí)施Web Service時(shí)XFire更加簡(jiǎn)潔高效，并且XFire對(duì)Spring提供了強(qiáng)大的支持，可以非常方便地在Spring中使用XFire實(shí)施Web Service，因此XFire在短短的時(shí)間里成為了受Web Service開(kāi)發(fā)者喜愛(ài)的框架。

　　XFire為客戶端提供了多種訪問(wèn)Web Service的方式，如果可以獲取客戶端的窄接口類，則可以采用窄接口類調(diào)用Web Service。如果僅能獲取WSDL，XFire也可以采用動(dòng)態(tài)反射的機(jī)制調(diào)用Web Service。XFire為Eclipse提供了一個(gè)可以根據(jù)WSDL生成客戶端存根代碼的插件，相信XFire也將為其它非Java語(yǔ)言提供類似的插件。

技術(shù)可用性的一個(gè)很大的標(biāo)準(zhǔn)是它是否方便測(cè)試，XFire提供多種方式進(jìn)行Web Service的測(cè)試，簡(jiǎn)單方便，給Web Service開(kāi)發(fā)人員的測(cè)試工作帶來(lái)了福音。

在本文中，筆者通過(guò)一個(gè)簡(jiǎn)單的helloWorld的Web Service例子，詳細(xì)地說(shuō)明了用XFire+Spring構(gòu)建Web Service時(shí)配置文件的相關(guān)配置，以及測(cè)試的各種方法，也讓讀者見(jiàn)識(shí)了XFire與Spring的無(wú)縫集成，希望對(duì)讀者學(xué)習(xí)XFire有點(diǎn)幫助。

總結(jié)

以上是生活随笔為你收集整理的使用XFire+Spring构建Web Service（一）——helloWorld篇的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。

上一篇：史上最丝滑长臂猿两秒进化成人：视觉错位
下一篇： ARP简介