javascript
使用XFire+Spring构建Web Service(一)——helloWorld篇
來源:http://www.blogjava.net/amigoxie/archive/2007/09/26/148207.html
?
?
XFire 是與Axis 2并列的新一代Web Service框架,通過提供簡單的API支持Web Service各項標準協議,幫助你方便快速地開發Web Service應用。
相 對于Axis來說,目前XFire相對受歡迎,加上其提供了和Spring集成的支持,在目前的Web Service開源社區擁有眾多的追隨者。并且因為XFire為Spring提供的支持,使得我們可以很容易在Spring中使用XFire構建Web Service應用。
XFire 與Axis2相比具有如下特征:
l???????? 支持一系列Web Service的新標準--JSR181、WSDL2.0 、JAXB2、WS-Security等;
l???????? 使用Stax解釋XML,性能有了質的提高。XFire采用Woodstox 作Stax實現;
l???????? 容易上手,可以方便快速地從pojo發布服務;
l???????? 支持Spring、Pico、Plexus、Loom等容器;
l???????? 靈活的Binding機制,包括默認的Aegis,xmlbeans,jaxb2,castor;
l???????? 高性能的SOAP 棧設計;
l???????? 支持Spring、Pico、Plexus、Loom等容器。
XFire 與Axis1性能的比較如下:
l???????? XFire 比Axis1.3快2-6倍;
l???????? XFire 的響應時間是Axis1.3的1/2到1/5。
XFire 在WebService框架中開始較晚,它從現有的框架中借鑒了許多優秀的理念,力爭將Web Service的應用開發難度降到最低。此外,還提供了各種綁定技術、支持多種傳輸協議,對WebService體系中許多新的規范提供了支持。
下面讓我們來看一個XFire于Spring集成的helloWorld的簡單例子。
一.實現的功能和特點
??? 本例具有如下功能和特點:
1)? 基于J2EE平臺的Web Service服務;
2)? 開發方便,配置簡單;
3)? 與spring無縫集成。
XFire 是完全基于流數據處理進行工作的系統,這意味著XFire不是將整個SOAP文檔緩存在內存中,而是以管道的方式接收SOAP流數據。這種工作方式的轉變帶來了可觀的性能回報,同時節省了內存的占用。
XFire 從 管道中接收一個SOAP請求到返回一個SOAP響應,會經歷一系列的階段。在管道調用的任何一個階段,XFire都可以添加一些額外的Handler,在 對消息進行加工處理后再傳入到下一個階段中。在SOAP請求消息對Web Service發起真正調用之前,分別會經過傳輸、預轉發、轉發、策略實施、用戶信息處理、預調用、服務調用等階段。
二.開發環境
??? 筆者的開發環境描述如下:
1)? jdk: 1.5 版本;
2)? Tomcat :5.5.20;
3)? MyEclipse: 5.1.1 GA 。
三.開發步驟
1. 工程與環境的建立
在 MyEclipse中新建Web工程,名為webservice_helloworld。選擇該工程后,點擊右鍵選擇MyEclipse->Add Web Service Capabilities,彈出Add Web Service Capabilities對話框,點擊“Next”,彈出Project Library Configuration對話框,默認選擇Core Libraries,點擊“Finish”按鈕,完成XFire核心包的添加。為了后續的客戶端的測試,還需讀者加入commons- httpclient.jar包到WEB-INF/lib下。
部署后可看到此時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
為了后續的開發和測試,在src目錄下分別建立test和webservice目錄,分別用于存放測試文件和webservice的相關類。
2 .Web Service實現的編寫
??? 在本例中,我們只是做一個helloWorld的簡單例子。Web Service服務端提供一個根據輸入的名字信息回復相應的helloWorld信息的。例如,當名字為“阿蜜果”時,恢復信息為“hello,阿蜜果”。下面讓我們一步一步來開始進行編碼。
1) web.xml 的配置
一 般情況下,我們通過HTTP作為Web Service的傳輸協議,這樣我們只需啟動一個Web服務器(如Tomcat,在本例中使用的是Tomcat5.5.20),這樣客戶端就可以通過 HTTP訪問到Web Service服務。為了集成Spring容器,XFire專門提供一個XFireSpringServlet,我們可以在web.xml中配置該 Servlet,將Spring容器中定義的Web Service在某個URI下發布。
為了能正確使用XFire,需在web.xml中進行相應配置,在該文件中配置XFire的 servlet 和 servlet-mapping 。同時因為本實例需要將 XFire 集成到 Spring 中,因而需要在 web.xml 文件中加載 Spring 的相應配置文件。在本實例中,我們首先在 WEB-INF 下建立兩個配置 Spring 配置文件,一個為 applicationContext.xml ,該文件用來定義本工程的 bean ,一個為 xfire-servlet.xml ,用來配置 XFire 的相關 bean 。修改后的 web.xml 的內容如下所示:
<? 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 >
???? <!-- ?begin?Spring配置? -->
???? < 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 >
???? <!-- ?end?Spring配置? -->
???? <!-- ?begin?XFire?配置? -->
???? < 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 >
??????? <!-- ?配合Spring容器中XFire一起工作的Servlet -->
??????? < servlet-name > xfireServlet </ servlet-name >
??????? < servlet-class > org.codehaus.xfire.spring.XFireSpringServlet </ servlet-class >
???? </ servlet >
???? < servlet-mapping >
??????? < servlet-name > xfireServlet </ servlet-name >
??????? <!-- ?在這個URI下開放Web?Service服務? -->
??????? < url-pattern > /service/* </ url-pattern >
???? </ servlet-mapping >
???? <!-- ?end?XFire?配置? -->
</ web-app >
??? 2) Web Service 的接口類 HelloWorld.java 和對應實現類 HelloWorldImpl.java
為了用 Web Service 完成 HelloWorld 功能,我們首先在 src/webservice 目錄下建立接口類 HelloWold.java 。它僅包含一個 sayHelloWorld(String name) 的方法,其詳細內容如下:
/**
?*HelloWorld的接口類.
? */
publicinterface?HelloWorld? {
???? /**
?????*對名字為name的人打招呼.
?????*@paramname名字
?????*@return返回打招呼的字符串
????? */
????String?sayHelloWorld(String?name);
}
我們還需要建立一個對應的實現類,來實現sayHelloWorld的功能,該實現類即為HelloWorldImpl.java。該類的詳細內容如下:
package ?webservice;
/**
?*HelloWorld的實現類.
? */
publicclass?HelloWorldImpl? implements ?HelloWorld? {
???? public ?String?sayHelloWorld(String?name)? {
???????String?helloWorld? = ? " hello, " ? + ?name;
??????? return ?helloWorld;
????}
}
3) Spring 配置文件 applicationContext.xml 和 xfire-servlet.xml 的配置
首先我們在 applicationContext.xml 文件中配置對應的 bean —— HelloWorldBean ,該 xml 文件的內容如下:
<? 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 ="HelloWorldBean" ?class ="webservice.HelloWorldImpl" />
</ beans >
???? 這個配置文件很簡單,在此不詳述。
XFire 為 Spring提供了方便易用的導出器XFireExporter,借助該導出器的支持,我們可以在Spring容器中將一個POJO導出為Web Service。HelloWorld是業務服務類,在此擁有一個sayHelloWorld的方法,我們希望將此方法開放為Web Service。在實際應用中,如果某個類具有眾多的方法,而其中的某些方法不需要開放為Web Service的情況下,我們可以定義一個窄接口,該接口中只需定義那些開放為Web Service的業務方法。
將一個業務類所有需要開放為Web Service的方法通過一個窄接口來描述是值得推薦的作法,這讓Web Service的接口顯得很“干凈”。其次,XFire的導出器也需要服務接口的支持,因為它采用基于接口的動態代理技術。
窄接口中的方法在真實的系統中可能需要引用其它的業務類或DAO獲取數據庫中的真實數據,為了簡化實例,我們在此簡化了實例。
下面讓我們看看在xfire-servlet.xml文件中導出器的設置,該文件內容如下:
<? xml?version="1.0"?encoding="UTF-8" ?><! DOCTYPE?beans?PUBLIC?"-//SPRING//DTD?BEAN//EN"
????"http://www.springframework.org/dtd/spring-beans.dtd" >
< beans >
???? <!-- ?引入XFire預配置信息? -->
???? < import? resource ="classpath:org/codehaus/xfire/spring/xfire.xml" ? />
???? <! —定義訪問的url-- >
???? < bean? class ="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping" >
??????? < property? name ="urlMap" > ?????????????
??????????? < map > ?????????????????
?????????????? < entry? key ="/HelloWorldService.ws" > ??????????????????
?????????????????? < ref? bean ="HelloWorldService" ? /> ?????????????????
?????????????? </ entry > ?????????????
??????????? </ map > ?????????
??????? </ property > ?????
???? </ bean > ?????
???? <!-- ?使用XFire導出器? -->
???? < bean? id ="baseWebService" ?class ="org.codehaus.xfire.spring.remoting.XFireExporter" ?lazy-init ="false" ?abstract ="true" >
??????? <!-- ?引用xfire.xml中定義的工廠? -->
??????? < property? name ="serviceFactory" ?ref ="xfire.serviceFactory" ? />
??????? <!-- ?引用xfire.xml中的xfire實例? -->
??????? < property? name ="xfire" ?ref ="xfire" ? />
???? </ bean >
???? < bean? id ="HelloWorldService" ?parent ="baseWebService" >
??????? <!-- ?業務服務bean? -->
??????? < property? name ="serviceBean" ?ref ="HelloWorldBean" ? />
??????? <!-- ?業務服務bean的窄接口類? -->
??????? < property? name ="serviceClass" ?value ="webservice.HelloWorld" ? />
???? </ bean >
</ beans >
在 上面的配置中,我們可以看到,在該配置文件中引入了xfire.xml這個Spring配置文件。它是在XFire核心JAR包中擁有一個預定義的 Spring配置文件,它定義了XFire在Spring中必須用到的一些Bean和資源,需要引入這個預定義的配置文件。從該配置文件中可以看出,我們 通過XFireExporter將業務類導出為Web Service,對于任何導出器,我們都需要引入XFire環境,即serviceFactory 和 xfire ,這是標準的配置。 ServiceFactory 是XFire的核心類,它可以將一個POJO生成為一個Web Service。
在本實例中,我們通過定義一個baseWebService,其余的webService配置都將該bean作為父bean,這樣可以簡化Spring的配置,不需要多次引入serviceFactory和xfire。
3. Web Service 的測試
??? 在上一步操作完成之后,我們的這個簡單的 Web Service 已經編寫完畢,下面讓我們來看看自己的勞動成果吧。
??? 在瀏覽器中輸入地址: http://localhost:8080/webservice_helloworld/HelloWorldService.ws?wsdl ,我們可以看到 HelloWorldService 對應的 WSDL 信息, 閱讀這個WSDL文檔,我們可以知道HelloWorld的sayHelloWorld方法已經被成功地發布為Web Service了。只要拿到這個WSDL就可以開發相應的客戶端調用程序了。
XFire 為訪問服務端Web Service提供了各種方便的方式:我們一般根據服務地址和窄接口類創建客戶調用程序。
在不能獲得服務窄接口類的情況下,XFire允許我們通過WSDL文件生成客戶端調用程序,通過指定服務接口的方式調用服務。
1) 通過WSDL文件生成客戶端調用程序
首先我們通過 http://localhost:8080/webservice_helloworld/HelloWorldService.ws?wsdl 我們可以獲得 WSDL 文件 HelloWorldService.wsdl ,并將其放在 src 目錄下面,接著我們通過程序訪問該 WSDL 文件,并調用需測試的方法。此時測試類 WebServiceClientTest.java 的內容如下所示:
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的測試類.
?* @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 " ;? // 對應的WSDL文件
???????Resource?resource? = ? new ?ClassPathResource(wsdl);?
???????Client?client? = ? new ?Client(resource.getInputStream(),? null );? // 根據WSDL創建客戶實例
???????
???????Object[]?objArray? = ? new ?Object[ 1 ];
???????objArray[ 0 ]? = ? " 阿蜜果 " ;
??????? // 調用特定的Web?Service方法
???????Object[]?results? = ?client.invoke( " sayHelloWorld " ,?objArray);
???????System.out.println( " result:? " ? + ?results[ 0 ]);
????}
}
運行該類,可得到如下輸出結果:
result: hello, 阿蜜果
可看出運行結果正確。
2 )根據服務地址創建客戶端調用程序
??? 接著讓我們來看一個根據服務地址創建客戶端調用程序的例子。我們可以通過測試類來測試Web Service的正確性,下面讓我們來看一個簡單的測試類,首先我們在src/test目錄建立 WebServiceClientTest.java 文件,并在 src 目錄下建立客戶端調用的 Spring 配置文件 client.xml 。在 client.xml 配置文件中我們定義了一個 testWebService 的 bean ,該 bean 訪問 wsdlDocumentUrl 為 http://localhost:8080/webservice_helloworld/HelloWorldService.ws?wsdl 的 WSDL 。該 xml 文件的詳細內容如下:
<? 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 ,并調用它的 sayHelloWorld 方法來完成測試,該類的詳細內容如下所示:
package ?test;import ?org.springframework.context.ApplicationContext;
import ?org.springframework.context.support.ClassPathXmlApplicationContext;
import ?webservice.HelloWorld;
/**
?*HelloWorld的webservice的測試類.
? */
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( " 阿蜜果 " ));
????}
}
??? 在啟動 webservice_helloworld 工程的情況下,運行 WebServiceClientTest 類,可看到控制臺包含如下信息:
??? hello, 阿蜜果
??? 由此可看出調用 Web Service 成功。
四.總結
??? 與 Axis相比,在實施Web Service時XFire更加簡潔高效,并且XFire對Spring提供了強大的支持,可以非常方便地在Spring中使用XFire實施Web Service,因此XFire在短短的時間里成為了受Web Service開發者喜愛的框架。
XFire為客戶端提供了多種訪問Web Service的方式,如果可以獲取客戶端的窄接口類,則可以采用窄接口類調用Web Service。如果僅能獲取WSDL,XFire也可以采用動態反射的機制調用Web Service。XFire為Eclipse提供了一個可以根據WSDL生成客戶端存根代碼的插件,相信XFire也將為其它非Java語言提供類似的插 件。
技術可用性的一個很大的標準是它是否方便測試,XFire提供多種方式進行Web Service的測試,簡單方便,給Web Service開發人員的測試工作帶來了福音。
在 本文中,筆者通過一個簡單的helloWorld的Web Service例子,詳細地說明了用XFire+Spring構建Web Service時配置文件的相關配置,以及測試的各種方法,也讓讀者見識了XFire與Spring的無縫集成,希望對讀者學習XFire有點幫助。
總結
以上是生活随笔為你收集整理的使用XFire+Spring构建Web Service(一)——helloWorld篇的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 史上最丝滑 长臂猿两秒进化成人:视觉错位
- 下一篇: gradle idea java ssm