Web Service開發(fā).doc

luoqiang1900| 退出Jivam的舞臺我的空氣，我的心情，我的世界，我的一切 主頁博客相冊|個人檔案|好友 查看文章 【整理】用XFire+Spring搭建WebService(Hello簡單版+實用版)2009年07月10日 星期五 06:39 P.M.Apache CXF 則是由 Celtix 和 XFire 項目整合而生，并且剛剛發(fā)布了 2.0.2 的最新版本，不過仍是 Apache 的一個孵化項目。一、與Axis2的不同之處1、Apache CXF 支持 WS-Addressing、WS-Policy、WS-RM、WS-Security和WS-I BasicProfile2、Axis2 支持 WS-Addressing、WS-RM、WS-Security和WS-I BasicProfile，WS-Policy將在新版本里得到支持3、Apache CXF 是根據Spring哲學來進行編寫的，即可以無縫地與Spring進行整合4、Axis2 不是5、Axis2 支持更多的 data bindings，包括 XMLBeans、JiBX、JaxMe 和 JaxBRI，以及它原生的 data binding（ADB）。6、Apache CXF 目前僅支持 JAXB 和 Aegis，并且默認是 JAXB 2.0，與 XFire 默認是支持 Aegis 不同，XMLBeans、JiBX 和 Castor 將在 CXF 2.1 版本中得到支持，目前版本是 2.0.27、Axis2 支持多種語言，它有 C/C+ 版本。8、Apache CXF 提供方便的Spring整合方法，可以通過注解、Spring標簽式配置來暴露Web Services和消費Web Services二、A simple JAX-WS service原文見/CXF20DOC/a-simple-jax-ws-service.htmla). 設置構建路徑，將下列jar包放到項目中the CXF distributioncommons-logging-1.1.jargeronimo-activation_1.1_spec-1.0-M1.jar (or Suns Activation jar)geronimo-annotation_1.0_spec-1.1.jar (JSR 250)geronimo-javamail_1.4_spec-1.0-M1.jar (or Suns JavaMail jar)geronimo-servlet_2.5_spec-1.1-M1.jar (or Suns Servlet jar)geronimo-ws-metadata_2.0_spec-1.1.1.jar (JSR 181)jaxb-api-2.0.jarjaxb-impl-2.0.5.jarjaxws-api-2.0.jarjetty-6.1.5.jarjetty-util-6.1.5.jarneethi-2.0.jarsaaj-api-1.3.jarsaaj-impl-1.3.jarstax-api-1.0.1.jarwsdl4j-1.6.1.jarwstx-asl-3.2.1.jarXmlSchema-1.2.jarxml-resolver-1.2.jarSpring jarsaopalliance-1.0.jarspring-core-2.0.4.jarspring-beans-2.0.4.jarspring-context-2.0.4.jarspring-web-2.0.4.jarCXF jarcxf-2.0-incubator.jarb). 編寫Service代碼接口HelloService.javapackage demo.cxf.server;import javax.jws.WebParam;import javax.jws.WebService;WebServicepublic interface HelloService public String sayHello(WebParam(name=text)String text);實現類HelloServiceImplpackage demo.cxf.server;import javax.jws.WebService;WebService(endpointInterface=demo.cxf.server.HelloService,serviceName=helloService)public class HelloServiceImpl implements HelloService public String sayHello(String text) return Hello .concat(text); c). 發(fā)布服務 System.out.println(Starting Server); HelloServiceImpl impl = new HelloServiceImpl(); String addr = http:/localhost:80/helloService; Endpoint.publish(addr,impl);d). 客戶端調用 JaxWsProxyFactoryBean factory = new JaxWsProxyFactoryBean(); factory.getInInterceptors().add(new LoggingInInterceptor(); factory.getOutInterceptors().add(new LoggingOutInterceptor(); factory.setServiceClass(HelloService.class); factory.setAddress(http:/localhost:9000/helloService); HelloService service = (HelloService)factory.create(); String reply = service.sayHello(cxf.); System.out.println(reply); System.exit(0);使用XFire+Spring構建Web ServiceXFire是與Axis 2并列的新一代Web Service框架，通過提供簡單的API支持Web Service各項標準協(xié)議，幫助你方便快速地開發(fā)Web Service應用。 相 對于Axis來說，目前XFire相對受歡迎，加上其提供了和Spring集成的支持，在目前的Web Service開源社區(qū)擁有眾多的追隨者。并且因為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發(fā)布服務； 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框架中開始較晚，它從現有的框架中借鑒了許多優(yōu)秀的理念，力爭將Web Service的應用開發(fā)難度降到最低。此外，還提供了各種綁定技術、支持多種傳輸協(xié)議，對WebService體系中許多新的規(guī)范提供了支持。 下面讓我們來看一個XFire于Spring集成的helloWorld的簡單例子。 一實現的功能和特點 本例具有如下功能和特點： 1） 基于J2EE平臺的Web Service服務； 2） 開發(fā)方便，配置簡單； 3） 與spring無縫集成。 XFire是完全基于流數據處理進行工作的系統(tǒng)，這意味著XFire不是將整個SOAP文檔緩存在內存中，而是以管道的方式接收SOAP流數據。這種工作方式的轉變帶來了可觀的性能回報，同時節(jié)省了內存的占用。 XFire從 管道中接收一個SOAP請求到返回一個SOAP響應，會經歷一系列的階段。在管道調用的任何一個階段，XFire都可以添加一些額外的Handler，在 對消息進行加工處理后再傳入到下一個階段中。在SOAP請求消息對Web Service發(fā)起真正調用之前，分別會經過傳輸、預轉發(fā)、轉發(fā)、策略實施、用戶信息處理、預調用、服務調用等階段。 二開發(fā)環(huán)境 筆者的開發(fā)環(huán)境描述如下： 1） jdk: 1.5版本； 2） Tomcat：5.5.20； 3） MyEclipse:5.1.1 GA。 三開發(fā)步驟 1. 工程與環(huán)境的建立 在MyEclipse 中新建Web工程，名為webservice_helloworld。選擇該工程后，點擊右鍵選擇MyEclipse-Add Web Service Capabilities，彈出Add Web Service Capabilities對話框，點擊“Next”，彈出Project Library Configuration對話框，默認選擇Core Libraries，點擊“Finish”按鈕，完成XFire核心包的添加。為了后續(xù)的客戶端的測試，還需讀者加入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 為了后續(xù)的開發(fā)和測試，在src目錄下分別建立test和webservice目錄，分別用于存放測試文件和webservice的相關類。 2Web Service實現的編寫 在本例中，我們只是做一個helloWorld的簡單例子。Web Service服務端提供一個根據輸入的名字信息回復相應的helloWorld信息的。例如，當名字為“阿蜜果”時，恢復信息為“hello，阿蜜果”。下面讓我們一步一步來開始進行編碼。 1）web.xml的配置 一 般情況下，我們通過HTTP作為Web Service的傳輸協(xié)議，這樣我們只需啟動一個Web服務器(如Tomcat，在本例中使用的是Tomcat5.5.20)，這樣客戶端就可以通過 HTTP訪問到Web Service服務。為了集成Spring容器，XFire專門提供一個XFireSpringServlet，我們可以在web.xml中配置該 Servlet，將Spring容器中定義的Web Service在某個URI下發(fā)布。 為了能正確使用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的內容如下所示： XFireService contextConfigLocation /WEB-INF/applicationContext.xml,/WEB-INF/xfire-servlet.xml org.springframework.web.context.ContextLoaderListener org.springframework.web.util.IntrospectorCleanupListener xfire org.springframework.web.servlet.DispatcherServlet xfire *.ws xfireServlet org.codehaus.xfire.spring.XFireSpringServlet xfireServlet /service/* 2）Web Service的接口類HelloWorld.java和對應實現類HelloWorldImpl.java 為了用Web Service完成HelloWorld功能，我們首先在src/webservice目錄下建立接口類HelloWold.java。它僅包含一個sayHelloWorld(String name)的方法，其詳細內容如下： package webservice; /* */* *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文件中配置對應的beanHelloWorldBean，該xml文件的內容如下： 這個配置文件很簡單，在此不詳述。 XFire為Spring 提供了方便易用的導出器XFireExporter，借助該導出器的支持，我們可以在Spring容器中將一個POJO導出為Web Service。HelloWorld是業(yè)務服務類，在此擁有一個sayHelloWorld的方法，我們希望將此方法開放為Web Service。在實際應用中，如果某個類具有眾多的方法，而其中的某些方法不需要開放為Web Service的情況下，我們可以定義一個窄接口，該接口中只需定義那些開放為Web Service的業(yè)務方法。 將一個業(yè)務類所有需要開放為Web Service的方法通過一個窄接口來描述是值得推薦的作法，這讓Web Service的接口顯得很“干凈”。其次，XFire的導出器也需要服務接口的支持，因為它采用基于接口的動態(tài)代理技術。 窄接口中的方法在真實的系統(tǒng)中可能需要引用其它的業(yè)務類或DAO獲取數據庫中的真實數據，為了簡化實例，我們在此簡化了實例。 下面讓我們看看在xfire-servlet.xml文件中導出器的設置，該文件內容如下： 在 上面的配置中，我們可以看到，在該配置文件中引入了xfire.xml這個Spring配置文件。它是在XFire核心JAR包中擁有一個預定義的 Spring配置文件，它定義了XFire在Spring中必須用到的一些Bean和資源，需要引入這個預定義的配置文件。從該配置文件中可以看出，我們 通過XFireExporter將業(yè)務類導出為Web Service，對于任何導出器，我們都需要引入XFire環(huán)境，即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方法已經被成功地發(fā)布為Web Service了。只要拿到這個WSDL就可以開發(fā)相應的客戶端調用程序了。 XFire為訪問服務端Web Service提供了各種方便的方式：我們一般根據服務地址和窄接口類創(chuàng)建客戶調用程序。 在不能獲得服務窄接口類的情況下，XFire允許我們通過WSDL文件生成客戶端調用程序，通過指定服務接口的方式調用服務。 1）通過WSDL文件生成客戶端調用程序 首先我們通過http:/localhost:8080/webservice_helloworld/HelloWorldService.ws?wsdl我們可以獲得WSDL文件HelloWorldService.wsdl，并將其放在src目錄下面，接著我們通過程序訪問該WSDL文件，并調用需測試的方法。此時測試類WebServiceClientTest.java的內容如下所示： 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的測試類. *authorAmigoXie *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創(chuàng)建客戶實例 Object objArray = new Object1; objArray0 = 阿蜜果; /調用特定的Web Service方法 Object results = client.invoke(sayHelloWorld, objArray); System.out.println(result: + results0); 運行該類，可得到如下輸出結果： result: hello,阿蜜果 可看出運行結果正確。 2）根據服務地址創(chuàng)建客戶端調用程序 接著讓我們來看一個根據服務地址創(chuàng)建客戶端調用程序的例子。我們可以通過測試類來測試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文件的詳細內容如下： webservice.HelloWorld http:/localhost:8080/webservice_helloworld/HelloWorldService.ws?wsdl 在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開發(fā)者喜愛的框架。 XFire為客戶端提供了多種訪問Web Service的方式，如果可以獲取客戶端的窄接口類，則可以采用窄接口類調用Web Service。如果僅能獲取WSDL，XFire也可以采用動態(tài)反射的機制調用Web Service。XFire為Eclipse提供了一個可以根據WSDL生成客戶端存根代碼的插件，相信XFire也將為其它非Java語言提供類似的插 件。Axis2快速開發(fā)指南關鍵字: axis2 web service/axis2/1_3/quickstartguide.html可以找到原文，這里并沒有徹底按照原文進行翻譯。準備工作1、下載并安裝JDK，Axis2要求JDK至少為1.4。設置JAVA_HOME環(huán)境變量；2、下載Axis2；3、解壓Axis2后你會找到一個名為axis2.war的文件，把它拷貝到servlet引擎的發(fā)布目錄；4、設置AXIS2_HOME環(huán)境變量，或許你應該把%AXIS2_HOME%bin變量加入到PATH中去。在很多情況下，我們需要一個Service的WSDL文件，%AXIS2_HOME%bin目錄中的Java2WSDL可以根據你的代碼自動生成該WSDL文件。同樣有的時候會根據WSDL文件自動生成Java文件，這個工具wsdl2java也同樣在%AXIS2_HOME%bin目錄中。1、編譯你的Java服務類2、用以下命令通過服務類生成WSDL文件：java2wsdl -cp . -cn package.StockQuoteService -of StockQuoteService.wsdl想通過WSDL文件生成對應的Java文件，參看wsdl2java命令。以下的例子均采用將我們定義的服務打包成aar文件拷貝到webappsaxis2WEB-INFservices目錄中。第一個簡單的Axis2 Web Service以下是要作為WebService發(fā)布的類代碼：java 代碼1 package org.jivaro.hw; 2 3 public class HelloWorldService 4 public String echo(String value) 5 System.out.println(HelloWorld Service received: + value); 6 7 return HelloWorld Service received: + value; 8 9 我們要發(fā)布這個Service，就得定義一個暴露這個類，通過定義這個services.xml：xml 代碼10 11 12 org.jivaro.hw.HelloWorldService 13 14 15 17 18 嗯，現在我們具備了一個Web Service類，和一個描述服務的XML文件，可以發(fā)布了。目錄層次應該如此，定義一個同服務名同名的文件夾（這里是HelloWorldService）作為根目錄，里面包含了類文件和META-INF文件夾，META-INF下包含了services.xml文件。不用aar文件，也可以直接將這個文件夾拷貝到發(fā)布目錄中去。aar文件的打包方式有兩種：1、你確定你使用了具備打jar包的開發(fā)工具，打包該文件夾下的所有文件，不包含根目錄，定義名稱為HelloWorldService.aar；2、使用命令行方式，請確定你設置了正確的環(huán)境變量，用jar打包服務類和META-INF，當然這種方式更適合通過build.xml文件來生成。把HelloWorldService.aar拷貝到webappsaxis2WEB-INFservices目錄中。啟動Tomcat，通過控制臺應可以看到如下信息INFO Deploying Web service: HelloWorldService.aar通過瀏覽器，輸入：http:/localhost:8080/axis2/services/listServices能看到所有現有的服務，同樣你能找到：HelloWorldServiceService EPR :http:/localhost:8080/axis2/services/HelloWorldServiceService Description :No description available for this serviceService Status : ActiveAvailable Operations echohttp:/localhost:8080/axis2/services/HelloWorldService?wsdl，能看到這個服務的wsdl定義http:/localhost:8080/axis2/services/HelloWorldService?xsd，能查看這個服務的概要http:/localhost:8080/axis2/services/HelloWorldService/echo?value=111，可以看到返回了一個xml串：xml 代碼19 20 HelloWorld Service received: 111 21 注意：因為我們的echo方法是這樣定義的：public String echo(String value)，所以在url里的參數是value而不是其它的變量。它正確返回了期待的字符串。什么是WSDL？是一種web服務描述語言，它描述了所提供的服務： 它提供了哪些服務 怎樣調用這些服務 當用戶調用業(yè)務服務時，該業(yè)務服務需要用戶提供什么信息？ 用戶如何提供這些必須信息 服務將以什么格式返回給用戶的信息XFire的下一代產品CXF的入門（一） 收藏 CXF step by step 在/cxf/download.html 下載最新版本的CXF。之后解壓到D:CXF示例的開發(fā)分為三步l 設置編譯環(huán)境l 寫一個簡單的 JAX-WS 服務l 通過JAX-WS API把你的服務發(fā)布l 通過客戶端調用你的服務 1. 設置編譯環(huán)境打開eclipse（其他的IDE也可以），引入如下的類庫（也可以省事一點，把CXFlib路徑下的所有類庫都引入）commons-logging-1.1.jargeronimo-activation_1.1_spec-1.0-M1.jar (or Suns Activation jar)geronimo-annotation_1.0_spec-1.1.jar (JSR 250)geronimo-javamail_1.4_spec-1.0-M1.jar (or Suns JavaMail jar)geronimo-servlet_2.5_spec-1.1-M1.jar (or Suns Servlet jar)geronimo-ws-metadata_2.0_spec-1.1.1.jar (JSR 181)jaxb-api-2.0.jarjaxb-impl-2.0.5.jarjaxws-api-2.0.jarjetty-6.1.5.jarjetty-util-6.1.5.jarneethi-2.0.jarsaaj-api-1.3.jarsaaj-impl-1.3.jarstax-api-1.0.1.jarwsdl4j-1.6.1.jarwstx-asl-3.2.1.jarXmlSchema-1.2.jarxml-resolver-1.2.jar 引入Spring相關的jars (只對): aopalliance-1.0.jarspring-core-2.0.4.jarspring-beans-2.0.4.jarspring-context-2.0.4.jarspring-web-2.0.4.jar 引入CXF相關的jar: cxf-2.0-incubator.jar 2. 編寫服務在eclipse里創(chuàng)建一個普通的JAVA PROJECT。服務的例子代碼在 “D:cxfsamplesjava_first_jaxws”路徑下。最方便的辦法