XFire WebService开发快速起步
XFire WebService开发快速起步
?
环境:
XFire-1.2.6
JDK1.5
MyEclipse 6.5
Tomcat-5.5.27
Windows XP Professional简体中文版
?
软件下载地址:
[url]http://repository.codehaus.org/org/codehaus/xfire/xfire-distribution/1.2.6/xfire-distribution-1.2.6.zip[/url]
[url]http://apache.mirror.phpchina.com/tomcat/tomcat-5/v5.5.27/bin/apache-tomcat-5.5.27.zip[/url]
?
有关WebService的概念、原理、数据发现、描述、绑定等过程、方式也不说了。这里就只关注如何快速开发出来一个通用的、易懂的Hello World例子。
?
以下是开发步骤:
?
1、创建工程
?
打开MyEclipse 6.5,新建一个WebService工程。如下图
?
?
然后一路next,直到完成。
?
创建完成后,打开生成的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???? [url]http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd[/url]" > ???? < 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 >
?
2、创建WebService服务
?
创建两个个包“wstest.server”和“wstest.client”,用来保存服务端和客户端程序。然后开始创建服务端程序,如下图
?
?
?
完成后,生成了一个Service的配置services.xml:
?
<?
xml
version
="1.0"
encoding
="UTF-8"
?>
< beans xmlns ="http://xfire.codehaus.org/config/1.0" > ?? < service > ???? < name >MyService </ name > ???? < serviceClass >wstest.server.IMyService </ serviceClass > ???? < implementationClass > ??????wstest.server.MyServiceImpl ???? </ implementationClass > ???? < style >wrapped </ style > ???? < use >literal </ use > ???? < scope >application </ scope > ?? </ service > </ beans >
?
也生成了接口和默认实现,改写后如下:
package wstest.server;
//Generated by MyEclipse public interface IMyService { ???? ?? public String sayHello(String user); ???? }
?
package wstest.server;
//Generated by MyEclipse public class MyServiceImpl implements IMyService { ???? ?? public String sayHello(String user) { ???? return "您好,"+user; ??} ???? }
?
至此,服务端代码已经完成。
?
3、测试服务端代码
?
测试依赖与Servlet容器Tomcat,需要将做好的服务端打包部署到tomcat上,然后启动。才可以进行测试。假设你已经配置了Tomcat服务器,并完成了WebService服务端的部署。那么,现在就启动Tomcat,然后:
?
?
?
输入访问地址:
[url]http://localhost:8080/xfire126Demo/services/MyService?wsdl[/url]? ,然后go一把!
?
?
?
这样,出现上上面的结果,表明测试成功了。
?
4、生成客户端代码
?
?
?
?
?
很郁闷,这个生成的客户端代码一部分跑到服务端的包里面了。真是垃圾,rubbish!!!
?
但是,这就是MyEclipse的功能,我改变不了。
?
5、客户端测试
?
下面就耐心看怎么用这个客户端代码。
打开生成的代码如下:
package wstest.client; import java.net.MalformedURLException; import java.util.Collection; import java.util.HashMap; import javax.xml.namespace.QName; import org.codehaus.xfire.XFireRuntimeException; import org.codehaus.xfire.aegis.AegisBindingProvider; import org.codehaus.xfire.annotations.AnnotationServiceFactory; import org.codehaus.xfire.annotations.jsr181.Jsr181WebAnnotations; import org.codehaus.xfire.client.XFireProxyFactory; import org.codehaus.xfire.jaxb2.JaxbTypeRegistry; import org.codehaus.xfire.service.Endpoint; import org.codehaus.xfire.service.Service; import org.codehaus.xfire.soap.AbstractSoapBinding; import org.codehaus.xfire.transport.TransportManager; public class MyServiceClient { ???????? private static XFireProxyFactory proxyFactory = new XFireProxyFactory(); ???????? private HashMap endpoints = new HashMap(); ???????? private Service service0; ???????? public MyServiceClient() { ????????????????create0(); ????????????????Endpoint MyServicePortTypeLocalEndpointEP = service0 .addEndpoint( new QName( "http://server.wstest","MyServicePortTypeLocalEndpoint"),new QName("http://server.wstest","MyServicePortTypeLocalBinding"),"xfire.local://MyService"); ????????????????endpoints.put(new QName("http://server.wstest",MyServicePortTypeLocalEndpointEP); ????????????????Endpoint MyServiceHttpPortEP = service0 .addEndpoint(new QName("http://server.wstest","MyServiceHttpPort"),"MyServiceHttpBinding"),"http://localhost:8080/xfire126Demo/services/MyService"); ????????????????endpoints.put(new QName("http://server.wstest",MyServiceHttpPortEP); ????????} ????????public Object getEndpoint(Endpoint endpoint) { ????????????????try { ????????????????????????return proxyFactory.create((endpoint).getBinding(),(endpoint).getUrl()); ????????????????} catch (MalformedURLException e) { ????????????????????????throw new XFireRuntimeException("Invalid URL",e); ????????????????} ????????} ????????public Object getEndpoint(QName name) { ????????????????Endpoint endpoint = ((Endpoint) endpoints.get((name))); ????????????????if ((endpoint) == null) { ????????????????????????throw new IllegalStateException("No such endpoint!"); ????????????????} ????????????????return getEndpoint((endpoint)); ????????} ????????public Collection getEndpoints() { ????????????????return endpoints.values(); ????????} ????????private void create0() { ????????????????TransportManager tm = (org.codehaus.xfire.XFireFactory.newInstance().getXFire().getTransportManager()); ????????????????HashMap props = new HashMap(); ????????????????props.put("annotations.allow.interface",true); ????????????????AnnotationServiceFactory asf = new AnnotationServiceFactory(new Jsr181WebAnnotations(),tm,new AegisBindingProvider(new JaxbTypeRegistry())); ????????????????asf.setBindingCreationEnabled(false); ????????????????service0 = asf.create((wstest.client.MyServicePortType.class),props); ????????????????{ ????????????????????????AbstractSoapBinding soapBinding = asf.createSoap11Binding(service0,new QName("http://server.wstest","http://schemas.xmlsoap.org/soap/http"); ????????????????} ????????????????{ ????????????????????????AbstractSoapBinding soapBinding = asf.createSoap11Binding(service0,"urn:xfire:transport:local"); ????????????????} ????????} ????????public MyServicePortType getMyServicePortTypeLocalEndpoint() { ????????????????return ((MyServicePortType)(this).getEndpoint(new QName("http://server.wstest","MyServicePortTypeLocalEndpoint"))); ????????} ????????public MyServicePortType getMyServicePortTypeLocalEndpoint(String url) { ????????????????MyServicePortType var = getMyServicePortTypeLocalEndpoint(); ????????????????org.codehaus.xfire.client.Client.getInstance(var).setUrl(url); ????????????????return var; ????????} ????????public MyServicePortType getMyServiceHttpPort() { ????????????????return ((MyServicePortType)(this).getEndpoint(new QName("http://server.wstest","MyServiceHttpPort"))); ????????} ????????public MyServicePortType getMyServiceHttpPort(String url) { ????????????????MyServicePortType var = getMyServiceHttpPort(); ????????????????org.codehaus.xfire.client.Client.getInstance(var).setUrl(url); ????????????????return var; ????????} ????????public static void main(String[] args) { ???????????????? ????????????????MyServiceClient client = new MyServiceClient(); ???????????????? ????//create a default service endpoint ????????????????MyServicePortType service = client.getMyServiceHttpPort(); ???????????????? ????//TODO: Add custom client code here ????????????????????// ????????????????????//service.yourServiceOperationHere(); ???????????????? ????System.out.println("test client completed"); ????????????????????System.exit(0); ????????} }
?
看得很晕,不知道啥意思,但是从“TODO”标记处,我知道了:
????
//TODO: Add custom client code here
???????????????????? // ???????????????????? //service.yourServiceOperationHere();
?
现在就在这里添加测试代码吧:
????
//TODO: Add custom client code here
???????????????????? // ???????????????????? //service.yourServiceOperationHere(); ????????????????String helloString = service.sayHello( "熔岩"); ????????????????System.out.println(helloString);
?
添加了很傻蛋的两行代码后,就可以运行起来看看测试代码了。
?
运行结果如下:
您好,熔岩
test client completed
?
终于可以松一口气了。完整的例子跑起来了。
?
6、总结
?
总感觉这个开发过程不爽,其实有更好的工具和开发方式:
?
WebService的编写,比较麻烦的是客户端代码,客户端代码依靠人工去写基本上是不可能的,除非你愿意付出惊人的时间和精力,既便如此也得不偿失。
?
MyEclipse的客户端开发太差,主要是生成的客户端代码混乱,解决办法是将客户端的编写放到单独一个工程里面来做。
?
其实,只要服务端编写好了,就完全可以用别的方式根据wsdl的url去生成客户端代码,在这里不得不将一个强大的工具IDEA8推荐出来,IDEA8自带WebService开发工具,插件非常强大,易用。在后面的篇幅中,我会做专门介绍,敬请关注。
?
当然,MyEclipse也并非一无是处,MyEclipse的服务端调试工具就很不错,很喜欢。提高了开发效率,这也是MyEclipse的过人之处。
?
最后,告诫各位,即使WebService支持复杂对象参数,也不建议使用,因为数据绑定还不是那么完美,总有些缺憾,为了保险起见,还是建议使用String作为参数最好了。
? ? from:http://lavasoft.blog.51cto.com/62575/105956 ? ? XFire是与Axis 2并列的新一代Web Service框架,通过提供简单的API支持Web Service各项标准协议,帮助你方便快速地开发Web Service应用。 相对于Axis来说,目前XFire相对受欢迎,加上其提供了和Spring集成的支持,在目前的WebService开源社区拥有众多的追随者。并且因为XFire为Spring提供的支持,使得我们可以很容易在Spring中使用XFire构建WebService应用。 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请求消息对WebService发起真正调用之前,分别会经过传输、预转发、转发、策略实施、用户信息处理、预调用、服务调用等阶段。 二.开发环境 ??? 笔者的开发环境描述如下: 1)?jdk: 1.5版本; 2)?Tomcat:5.5.20; 3)?MyEclipse:5.1.1 GA。 三.开发步骤 1. 工程与环境的建立 在MyEclipse中新建Web工程,名为webservice_helloworld。选择该工程后,点击右键选择MyEclipse->AddWeb Service Capabilities,弹出Add Web ServiceCapabilities对话框,点击“Next”,弹出Project Library Configuration对话框,默认选择CoreLibraries,点击“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作为WebService的传输协议,这样我们只需启动一个Web服务器(如Tomcat,在本例中使用的是Tomcat5.5.20),这样客户端就可以通过HTTP访问到WebService服务。为了集成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的内容如下所示: ??? 2)Web Service的接口类HelloWorld.java和对应实现类HelloWorldImpl.java 为了用Web Service完成HelloWorld功能,我们首先在src/webservice目录下建立接口类HelloWold.java。它仅包含一个sayHelloWorld(String name)的方法,其详细内容如下: 3)Spring配置文件applicationContext.xml和xfire-servlet.xml的配置 首先我们在applicationContext.xml文件中配置对应的bean——HelloWorldBean,该xml文件的内容如下: ???? 这个配置文件很简单,在此不详述。 XFire为Spring提供了方便易用的导出器XFireExporter,借助该导出器的支持,我们可以在Spring容器中将一个POJO导出为WebService。HelloWorld是业务服务类,在此拥有一个sayHelloWorld的方法,我们希望将此方法开放为WebService。在实际应用中,如果某个类具有众多的方法,而其中的某些方法不需要开放为WebService的情况下,我们可以定义一个窄接口,该接口中只需定义那些开放为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的内容如下所示: 运行该类,可得到如下输出结果: 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文件的详细内容如下: ???? 在WebServiceClientTest.java文件中获得HelloWorld,并调用它的sayHelloWorld方法来完成测试,该类的详细内容如下所示: ??? 在启动webservice_helloworld工程的情况下,运行WebServiceClientTest类,可看到控制台包含如下信息: ??? hello,阿蜜果 ??? 由此可看出调用Web Service成功。 四.总结 ??? 与Axis相比,在实施WebService时XFire更加简洁高效,并且XFire对Spring提供了强大的支持,可以非常方便地在Spring中使用XFire实施WebService,因此XFire在短短的时间里成为了受Web Service开发者喜爱的框架。 XFire为客户端提供了多种访问Web Service的方式,如果可以获取客户端的窄接口类,则可以采用窄接口类调用WebService。如果仅能获取WSDL,XFire也可以采用动态反射的机制调用WebService。XFire为Eclipse提供了一个可以根据WSDL生成客户端存根代码的插件,相信XFire也将为其它非Java语言提供类似的插件。 技术可用性的一个很大的标准是它是否方便测试,XFire提供多种方式进行Web Service的测试,简单方便,给Web Service开发人员的测试工作带来了福音。 在本文中,笔者通过一个简单的helloWorld的Web Service例子,详细地说明了用XFire+Spring构建WebService时配置文件的相关配置,以及测试的各种方法,也让读者见识了XFire与Spring的无缝集成,希望对读者学习XFire有点帮助。 ? ? from :http://blog.csdn.net/alex197963/archive/2009/07/20/4363328.aspx (编辑:李大同) 【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容! |