使用XFire开发webservice.docx

使用XFire开发webservice.docx

《使用XFire开发webservice.docx》由会员分享，可在线阅读，更多相关《使用XFire开发webservice.docx（13页珍藏版）》请在冰豆网上搜索。

使用XFire开发webservice

使用XFire+Spring构建WebService

XFire是与Axis2并列的新一代WebService框架，通过提供简单的API支持WebService各项标准协议，帮助你方便快速地开发WebService应用。

相对于Axis来说，目前XFire相对受欢迎，加上其提供了和Spring集成的支持，在目前的WebService开源社区拥有众多的追随者。

并且因为XFire为Spring提供的支持，使得我们可以很容易在Spring中使用XFire构建WebService应用。

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

1          支持一系列WebService的新标准--JSR181、WSDL2.0、JAXB2、WS-Security等；

2          使用Stax解释XML,性能有了质的提高。

XFire采用Woodstox作Stax实现；

3          容易上手，可以方便快速地从pojo发布服务；

4          支持Spring、Pico、Plexus、Loom等容器；

5          灵活的Binding机制，包括默认的Aegis,xmlbeans,jaxb2,castor；

6          高性能的SOAP栈设计；

7          支持Spring、Pico、Plexus、Loom等容器。

8          XFire比Axis1.3快2-6倍；

9          XFire的响应时间是Axis1.3的1/2到1/5。

XFire在WebService框架中开始较晚，它从现有的框架中借鉴了许多优秀的理念，力争将WebService的应用开发难度降到最低。

此外，还提供了各种绑定技术、支持多种传输协议，对WebService体系中许多新的规范提供了支持。

下面让我们来看一个XFire于Spring集成的helloWorld的简单例子。

1实现的功能和特点

   本例具有如下功能和特点：

1） 基于J2EE平台的WebService服务；

2） 开发方便，配置简单；

3） 与spring无缝集成。

XFire是完全基于流数据处理进行工作的系统，这意味着XFire不是将整个SOAP文档缓存在内存中，而是以管道的方式接收SOAP流数据。

这种工作方式的转变带来了可观的性能回报，同时节省了内存的占用。

　　XFire从管道中接收一个SOAP请求到返回一个SOAP响应，会经历一系列的阶段。

在管道调用的任何一个阶段，XFire都可以添加一些额外的Handler，在对消息进行加工处理后再传入到下一个阶段中。

在SOAP请求消息对WebService发起真正调用之前，分别会经过传输、预转发、转发、策略实施、用户信息处理、预调用、服务调用等阶段。

2开发环境

   笔者的开发环境描述如下：

 jdk:

1.5版本； Tomcat：

5.5.20； MyEclipse:

5.1.1GA。

3开发步骤

3.1工程与环境的建立

在MyEclipse中新建Web工程，名为webservice_helloworld。

选择该工程后，点击右键选择MyEclipse->AddWebServiceCapabilities，弹出AddWebServiceCapabilities对话框，点击“Next”，弹出ProjectLibraryConfiguration对话框，默认选择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的相关类。

3.2 WebService实现

   在本例中，我们只是做一个helloWorld的简单例子。

WebService服务端提供一个根据输入的名字信息回复相应的helloWorld信息的。

例如，当名字为“阿蜜果”时，恢复信息为“hello，阿蜜果”。

下面让我们一步一步来开始进行编码。

1）web.xml的配置

一般情况下，我们通过HTTP作为WebService的传输协议，这样我们只需启动一个Web服务器（如Tomcat，在本例中使用的是Tomcat5.5.20），这样客户端就可以通过HTTP访问到WebService服务。

为了集成Spring容器，XFire专门提供一个XFireSpringServlet，我们可以在web.xml中配置该Servlet，将Spring容器中定义的WebService在某个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的内容如下所示：

xmlversion="1.0"encoding="UTF-8"?

>

xsi="http:

//www.w3.org/2001/XMLSchema-instance"version="2.4"xsi:

schemaLocation="

XFireService

--beginSpring配置-->

contextConfigLocation

/WEB-INF/applicationContext.xml,/WEB-INF/xfire-servlet.xml

org.springframework.web.context.ContextLoaderListener

org.springframework.web.util.IntrospectorCleanupListener

--endSpring配置-->

--beginXFire配置-->

xfire

org.springframework.web.servlet.DispatcherServlet

xfire

*.ws

--配合Spring容器中XFire一起工作的Servlet-->

xfireServlet

org.codehaus.xfire.spring.XFireSpringServlet

xfireServlet

--在这个URI下开放WebService服务-->

/service/*

--endXFire配置-->

2）WebService的接口类HelloWorld.java和对应实现类HelloWorldImpl.java

为了用WebService完成HelloWorld功能，我们首先在src/webservice目录下建立接口类HelloWold.java。

它仅包含一个sayHelloWorld（Stringname）的方法，其详细内容如下：

packagewebservice;

/**

*HelloWorld的接口类.

*/

publicinterfaceHelloWorld{

/**

*对名字为name的人打招呼.

*@paramname名字

*@return返回打招呼的字符串

*/

StringsayHelloWorld（Stringname）;

}

我们还需要建立一个对应的实现类，来实现sayHelloWorld的功能，该实现类即为HelloWorldImpl.java。

该类的详细内容如下：

packagewebservice;

/**

*HelloWorld的实现类.

*/

publicclassHelloWorldImplimplementsHelloWorld{

publicStringsayHelloWorld（Stringname）{

StringhelloWorld="hello,"+name;

returnhelloWorld;

}

}

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

首先我们在applicationContext.xml文件中配置对应的bean——HelloWorldBean，该xml文件的内容如下：

xmlversion="1.0"encoding="UTF-8"?

>

DOCTYPEbeansPUBLIC"-//SPRING//DTDBEAN//EN"

"http:

//www.springframework.org/dtd/spring-beans.dtd">

这个配置文件很简单，在此不详述。

XFire为Spring提供了方便易用的导出器XFireExporter，借助该导出器的支持，我们可以在Spring容器中将一个POJO导出为WebService。

HelloWorld是业务服务类，在此拥有一个sayHelloWorld的方法，我们希望将此方法开放为WebService。

在实际应用中，如果某个类具有众多的方法，而其中的某些方法不需要开放为WebService的情况下，我们可以定义一个窄接口，该接口中只需定义那些开放为WebService的业务方法。

将一个业务类所有需要开放为WebService的方法通过一个窄接口来描述是值得推荐的作法，这让WebService的接口显得很“干净”。

其次，XFire的导出器也需要服务接口的支持，因为它采用基于接口的动态代理技术。

窄接口中的方法在真实的系统中可能需要引用其它的业务类或DAO获取数据库中的真实数据，为了简化实例，我们在此简化了实例。

下面让我们看看在xfire-servlet.xml文件中导出器的设置，该文件内容如下：

xmlversion="1.0"encoding="UTF-8"?

>

DOCTYPEbeansPUBLIC"-//SPRING//DTDBEAN//EN"

"http:

//www.springframework.org/dtd/spring-beans.dtd">

--引入XFire预配置信息-->

org/codehaus/xfire/spring/xfire.xml"/>

—定义访问的url-->

--使用XFire导出器-->

--引用xfire.xml中定义的工厂-->

--引用xfire.xml中的xfire实例-->

--业务服务bean-->

--业务服务bean的窄接口类-->

在上面的配置中，我们可以看到，在该配置文件中引入了xfire.xml这个Spring配置文件。

它是在XFire核心JAR包中拥有一个预定义的Spring配置文件，它定义了XFire在Spring中必须用到的一些Bean和资源，需要引入这个预定义的配置文件。

从该配置文件中可以看出，我们通过XFireExporter将业务类导出为WebService，对于任何导出器，我们都需要引入XFire环境，即serviceFactory和xfire，这是标准的配置。

ServiceFactory是XFire的核心类，它可以将一个POJO生成为一个WebService。

在本实例中，我们通过定义一个baseWebService，其余的webService配置都将该bean作为父bean，这样可以简化Spring的配置，不需要多次引入serviceFactory和xfire

3.3 WebService服务端的测试

   在上一步操作完成之后，我们的这个简单的WebService已经编写完毕，下面让我们来看看自己的劳动成果吧。

   在浏览器中输入地址：

http:

//localhost:

8080/webservice_helloworld/HelloWorldService.ws?

wsdl，我们可以看到HelloWorldService对应的WSDL信息，阅读这个WSDL文档，我们可以知道HelloWorld的sayHelloWorld方法已经被成功地发布为WebService了。

只要拿到这个WSDL就可以开发相应的客户端调用程序了。

3.4 WebService的客户端编写

XFire为访问服务端WebService提供了各种方便的方式：

我们一般根据服务地址和窄接口类创建客户调用程序。

　　在不能获得服务窄接口类的情况下，XFire允许我们通过WSDL文件生成客户端调用程序，通过指定服务接口的方式调用服务。

1）通过WSDL文件生成客户端调用程序

首先我们通过http:

//localhost:

8080/webservice_helloworld/HelloWorldService.ws?

wsdl我们可以获得WSDL文件HelloWorldService.wsdl，并将其放在src目录下面，接着我们通过程序访问该WSDL文件，并调用需测试的方法。

此时测试类WebServiceClientTest.java的内容如下所示：

packagetest;

importorg.codehaus.xfire.client.Client;

importorg.springframework.core.io.ClassPathResource;

importorg.springframework.core.io.Resource;

importwebservice.HelloWorld;

/**

*Copyright2007GuangZhouAmigo.

*Allrightreserved.

*HelloWorld的webservice的测试类.

*@author

xiexingxing1121@">AmigoXie

*@version1.0

*Creationdate:

2007-9-16-下午05:

36:

05

*/

publicclassWebServiceClientTest{

HelloWorldhelloWorld=null;

publicstaticvoidmain（String[]args）throwsException{

WebServiceClientTesttest=newWebServiceClientTest（）;

test.testClient（）;

}

publicvoidtestClient（）throwsException{

Stringwsdl="HelloWorldService.wsdl";//对应的WSDL文件

Resourceresource=newClassPathResource（wsdl）;

Clientclient=newClient（resource.getInputStream（）,null）;//根据WSDL创建客户实例

Object[]objArray=newObject[1];

objArray[0]="阿蜜果";

//调用特定的WebService方法

Object[]results=client.invoke（"sayHelloWorld",objArray）;

System.out.println（"result:

"+results[0]）;

}

}

运行该类，可得到如下输出结果：

result:

hello,阿蜜果

可看出运行结果正确。

2）根据服务地址创建客户端调用程序

   接着让我们来看一个根据服务地址创建客户端调用程序的例子。

我们可以通过测试类来测试WebService的正确性，下面让我们来看一个简单的测试类，首先我们在src/test目录建立WebServiceClientTest.java文件，并在src目录下建立客户端调用的Spring配置文件client.xml。

在client.xml配置文件中我们定义了一个testWebService的bean，该bean访问wsdlDocumentUrl为http:

//localhost:

8080/webservice_helloworld/HelloWorldService.ws?

wsdl的WSDL。

该xml文件的详细内容如下：

xmlversion="1.0"encoding="UTF-8"?

>

DOCTYPEbeansPUBLIC"-//SPRING//DTDBEAN//EN"

"http:

//www.springframework.org/dtd/spring-beans.dtd">

webservice.HelloWorld

http:

//localhost:

8080/webservice_helloworld/HelloWorldService.ws?

wsdl

在WebServiceClientTest.java文件中获得HelloWorld，并调用它的sayHelloWorld方法来完成测试，该类的详细内容如下所示：

packagetest;

importorg.springframework.context.ApplicationContext;

importorg.springframework.context.support.ClassPathXmlApplicationContext;

importwebservice.HelloWorld;

/*