使用XFire+Spring构建Web Service------测试工程在myeclipse的默认工作目录下的webservicetesthellworld

使用XFire+Spring构建Web Service

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.6版本；

2） Tomcat：6.0.20；

3） MyEclipse:8.5。

三．开发步骤

1. 工程与环境的建立

在MyEclipse 中新建Web工程，名为webservicehelloworld。选择该工程后，

点击右键选择MyEclipse->Add Spring Capabilities

点击右键选择MyEclipse->Add XFire  Web Service Capabilities
部署 （新建工程时让MAVEN支持，所依赖的包用MAVEN来进行管理）后可看到此时WEB-INF/lib的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/javaee" xmlns:xsi=" http://www.w3.org/2001/XMLSchema-instance" version="2.5" xsi:schemaLocation=" http://java.sun.com/xml/ns/javaee   http://java.sun.com/xml/ns/javaee/web-app_2_5.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目录下建立接口类HelloWorld.java。它仅包含一个sayHelloWorld(String name)的方法，其详细内容如下：


package webservice;

/** *//**
*HelloWorld的接口类.
*/
public interface HelloWorld {
/** *//**
*对名字为name的人打招呼.
*@paramname名字
*@return返回打招呼的字符串
*/
String sayHelloWorld(String name);
}
我们还需要建立一个对应的实现类，来实现sayHelloWorld的功能，该实现类即为HelloWorldImpl.java。该类的详细内容如下：
package webservice;
/** *//**
*HelloWorld的实现类.
*/
public class HelloWorldImpl implements HelloWorld {
public String sayHelloWorld(String name) {
String helloWorld = "hello," + name;
return helloWorld;
}
}

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

首先我们在applicationContext.xml

myeclipse自动生成的文件内容为：

(

<?xml version="1.0" encoding="UTF-8"?>
<beans
 xmlns=" http://www.springframework.org/schema/beans"
 xmlns:xsi=" http://www.w3.org/2001/XMLSchema-instance"
 xmlns:p=" http://www.springframework.org/schema/p"
 xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">

如果采用这种方式就会报错：

“

Document root element "beans", must match DOCTYPE root "null".

”

)文件中配置对应的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">
</bean>

</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/webservicehelloworld/HelloWorldService.ws?wsdl，我们可以看到HelloWorldService对应的WSDL信息，阅读这个WSDL文档，我们可以知道HelloWorld的sayHelloWorld方法已经被成功地发布为Web Service了。只要拿到这个WSDL就可以开发相应的客户端调用程序了。

XFire为访问服务端Web Service提供了各种方便的方式：我们一般根据服务地址和窄接口类创建客户调用程序。

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

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

首先我们通过 http://localhost:8080/webservicehelloworld/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的测试类.
*@author<a href="mailto:xiexingxing1121@126.com">AmigoXie</a>
*@version1.0
*Creationdate:2007-9-16-下午05:36:05
*/
public class WebServiceClientTest {
HelloWorld helloWorld = null;

public static void main(String[] args) throws Exception {
WebServiceClientTest test = new WebServiceClientTest();
test.testClient();
}

public void 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目录建立RemoteTest.java文件，并在src目录下建立客户端调用的Spring配置文件client.xml。在client.xml配置文件中我们定义了一个testWebService的bean，该bean访问wsdlDocumentUrl为 http://localhost:8080/webservicehelloworld/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>

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

package test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import webservice.HelloWorld;

public class RemoteTest {
 HelloWorld helloWorld = null;

 public static void main(String[] args) {
 RemoteTest test = new RemoteTest();
 test.testClient();
 }

 public void testClient() {
 ApplicationContext ctx = new ClassPathXmlApplicationContext(
 "client.xml");
 helloWorld = (HelloWorld) ctx.getBean("testWebService");
 System.out.println(helloWorld.sayHelloWorld("阿蜜果"));
 }
}

在启动webservicehelloworld工程的情况下，运行RemoteTest类，可看到控制台包含如下信息：

hello,阿蜜果

由此可看出调用Web Service成功。

3)使用jdk自动带的工具 wsimport 工具解析wsdl文档生成的代码如下

d:/test  下面的webservice目录

里面有文件：

2011-03-17  12:08             1,545 HelloWorld.class
2011-03-17  12:08             2,102 HelloWorld.java
2011-03-17  12:08               806 HelloWorldPortType.class
2011-03-17  12:08             1,151 HelloWorldPortType.java
2011-03-17  12:08               589 ObjectFactory.class
2011-03-17  12:08             1,270 ObjectFactory.java
2011-03-17  12:08               313 package-info.class
2011-03-17  12:08               160 package-info.java
2011-03-17  12:08               802 SayHelloWorld.class
2011-03-17  12:08             1,495 SayHelloWorld.java
2011-03-17  12:08               826 SayHelloWorldResponse.class
2011-03-17  12:08             1,511 SayHelloWorldResponse.java

测试代码：

 
import webservice.HelloWorld;
import webservice.HelloWorldPortType;

public class RemoteTest {
 HelloWorld helloWorld = null;

 public static void main(String[] args) {
 RemoteTest test = new RemoteTest();
 test.testClient();
 }

 public void testClient() {
 //ApplicationContext ctx = new ClassPathXmlApplicationContext(
 //"client.xml");
 helloWorld = new HelloWorld();
        HelloWorldPortType  port =helloWorld.getHelloWorldHttpPort();
 System.out.println(port.sayHelloWorld("阿蜜果"));
 }
}

（1） 没有启动服务的情况下：

D:/test>java RemoteTest
Exception in thread "main" javax.xml.ws.WebServiceException: Failed to access th
e WSDL at: http://localhost:8080/webservicehelloworld/HelloWorldService.ws?wsdl.
 It failed with:
        Connection refused: connect.
        at com.sun.xml.internal.ws.wsdl.parser.RuntimeWSDLParser.tryWithMex(Unkn
own Source)
        at com.sun.xml.internal.ws.wsdl.parser.RuntimeWSDLParser.parse(Unknown S
ource)
        at com.sun.xml.internal.ws.client.WSServiceDelegate.parseWSDL(Unknown So
urce)
        at com.sun.xml.internal.ws.client.WSServiceDelegate.<init>(Unknown Sourc
e)
        at com.sun.xml.internal.ws.client.WSServiceDelegate.<init>(Unknown Sourc
e)
        at com.sun.xml.internal.ws.spi.ProviderImpl.createServiceDelegate(Unknow
n Source)
        at javax.xml.ws.Service.<init>(Unknown Source)
        at webservice.HelloWorld.<init>(HelloWorld.java:41)
        at RemoteTest.testClient(RemoteTest.java:16)
        at RemoteTest.main(RemoteTest.java:10)
Caused by: java.net.ConnectException: Connection refused: connect
        at java.net.PlainSocketImpl.socketConnect(Native Method)
        at java.net.PlainSocketImpl.doConnect(Unknown Source)
        at java.net.PlainSocketImpl.connectToAddress(Unknown Source)
        at java.net.PlainSocketImpl.connect(Unknown Source)
        at java.net.SocksSocketImpl.connect(Unknown Source)
        at java.net.Socket.connect(Unknown Source)
        at java.net.Socket.connect(Unknown Source)
        at sun.net.NetworkClient.doConnect(Unknown Source)
        at sun.net.www.http.HttpClient.openServer(Unknown Source)
        at sun.net.www.http.HttpClient.openServer(Unknown Source)
        at sun.net.www.http.HttpClient.<init>(Unknown Source)
        at sun.net.www.http.HttpClient.New(Unknown Source)
        at sun.net.www.http.HttpClient.New(Unknown Source)
        at sun.net.www.protocol.http.HttpURLConnection.getNewHttpClient(Unknown
Source)
        at sun.net.www.protocol.http.HttpURLConnection.plainConnect(Unknown Sour
ce)
        at sun.net.www.protocol.http.HttpURLConnection.connect(Unknown Source)
        at sun.net.www.protocol.http.HttpURLConnection.getInputStream(Unknown So
urce)
        at java.net.URL.openStream(Unknown Source)
        at com.sun.xml.internal.ws.wsdl.parser.RuntimeWSDLParser.createReader(Un
known Source)
        at com.sun.xml.internal.ws.wsdl.parser.RuntimeWSDLParser.resolveWSDL(Unk
nown Source)
        ... 9 more

（2） webservicehelloworld启动Tomcat，服务启动了。

D:/test>java RemoteTest
hello,阿蜜果


四．总结

与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语言提供类似的插 件。