Web Service开发.doc

luoqiang1900| 退出Jivam的舞台我的空气，我的心情，我的世界，我的一切 主页博客相册|个人档案|好友 查看文章 【整理】用XFire+Spring搭建WebService(Hello简单版+实用版)2009年07月10日 星期五 06:39 P.M.Apache CXF 则是由 Celtix 和 XFire 项目整合而生，并且刚刚发布了 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). 发布服务 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各项标准协议，帮助你方便快速地开发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的相关类。 2Web 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的内容如下所示： 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是业务服务类，在此拥有一个sayHelloWorld的方法，我们希望将此方法开放为Web Service。在实际应用中，如果某个类具有众多的方法，而其中的某些方法不需要开放为Web Service的情况下，我们可以定义一个窄接口，该接口中只需定义那些开放为Web Service的业务方法。 将一个业务类所有需要开放为Web Service的方法通过一个窄接口来描述是值得推荐的作法，这让Web Service的接口显得很“干净”。其次，XFire的导出器也需要服务接口的支持，因为它采用基于接口的动态代理技术。 窄接口中的方法在真实的系统中可能需要引用其它的业务类或DAO获取数据库中的真实数据，为了简化实例，我们在此简化了实例。 下面让我们看看在xfire-servlet.xml文件中导出器的设置，该文件内容如下： 在 上面的配置中，我们可以看到，在该配置文件中引入了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的内容如下所示： 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创建客户实例 Object objArray = new Object1; objArray0 = 阿蜜果; /调用特定的Web Service方法 Object results = client.invoke(sayHelloWorld, objArray); System.out.println(result: + results0); 运行该类，可得到如下输出结果： 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文件的详细内容如下： 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开发者喜爱的框架。 XFire为客户端提供了多种访问Web Service的方式，如果可以获取客户端的窄接口类，则可以采用窄接口类调用Web Service。如果仅能获取WSDL，XFire也可以采用动态反射的机制调用Web Service。XFire为Eclipse提供了一个可以根据WSDL生成客户端存根代码的插件，相信XFire也将为其它非Java语言提供类似的插 件。Axis2快速开发指南关键字: axis2 web service/axis2/1_3/quickstartguide.html可以找到原文，这里并没有彻底按照原文进行翻译。准备工作1、下载并安装JDK，Axis2要求JDK至少为1.4。设置JAVA_HOME环境变量；2、下载Axis2；3、解压Axis2后你会找到一个名为axis2.war的文件，把它拷贝到servlet引擎的发布目录；4、设置AXIS2_HOME环境变量，或许你应该把%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发布的类代码：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 我们要发布这个Service，就得定义一个暴露这个类，通过定义这个services.xml：xml 代码10 11 12 org.jivaro.hw.HelloWorldService 13 14 15 17 18 嗯，现在我们具备了一个Web Service类，和一个描述服务的XML文件，可以发布了。目录层次应该如此，定义一个同服务名同名的文件夹（这里是HelloWorldService）作为根目录，里面包含了类文件和META-INF文件夹，META-INF下包含了services.xml文件。不用aar文件，也可以直接将这个文件夹拷贝到发布目录中去。aar文件的打包方式有两种：1、你确定你使用了具备打jar包的开发工具，打包该文件夹下的所有文件，不包含根目录，定义名称为HelloWorldService.aar；2、使用命令行方式，请确定你设置了正确的环境变量，用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服务描述语言，它描述了所提供的服务： 它提供了哪些服务 怎样调用这些服务 当用户调用业务服务时，该业务服务需要用户提供什么信息？ 用户如何提供这些必须信息 服务将以什么格式返回给用户的信息XFire的下一代产品CXF的入门（一） 收藏 CXF step by step 在/cxf/download.html 下载最新版本的CXF。之后解压到D:CXF示例的开发分为三步l 设置编译环境l 写一个简单的 JAX-WS 服务l 通过JAX-WS API把你的服务发布l 通过客户端调用你的服务 1. 设置编译环境打开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里创建一个普通的JAVA PROJECT。服务的例子代码在 “D:cxfsamplesjava_first_jaxws”路径下。最方便的办法