XFire体系及重要API(3)

根据WSDL生成客户端代码

XFire允许通过运行Ant任务，根据WSDL文件生成访问WEB Service的客户端代码存根，同时XFire还提供了一个Eclipse插件完成相同的任务。本节里，我们将学习通过XFire Eclipse插件生成BbtForumService客户端存根代码的知识。

安装Eclipse XFire 插件

1．Help->Software Updates->Find and Install...

2．选择“Search for new features to install”，并点击Next；

3．选择“New Remote Site...”，创建一个Name为XFire，URL为

Http://dist.codehaus.org/xfire/update/的网站；

4．点击Finish安装XFire插件。

使用插件创建客户端代码存根
File->New->Other...->XFire->Code generation from WSDL document； 
弹出一个对话框，如图3所示：

图3创建客户端代码存根

指定WSDL文件的位置，存根代码的输出地址及对应的类包，点击Finish。

XFire插件将在生成客户端代码存根的同时生成服务端代码的存根，如下图所示：

图4生成的代码

BbtForumServiceClient是BbtForumServicePortType的工厂类，它提供了若干个获取BbtForumServicePortType实例的重载方法。BbtForumServicePortType对应服务端的窄接口BbtForumService类。而BbtForumServiceImpl是服务端的存根代码，在META-INF中还有XFire的服务配置文件。对于客户端来说，一般不需要服务端的代码，所以你可以将BbtForumServiceImpl和META-INF删除。

下面，我们利用XFire生成的BbtForumServiceClient对服务端的Web Service进行调用：

package com.baobaotao.xfire.client;

public class StubClient {

public static void main(String[] args) {

BbtForumServiceClient client = new BbtForumServiceClient();

String serviceUrl = "http://localhost:8080/baobaotao/service/BbtForumService";

①获取对应服务窄接口实例

BbtForumServicePortType portType = client.getBbtForumServiceHttpPort(serviceUrl);

int count = portType.getRefinedTopicCount(20);②对服务进行调用

System.out.println("count:" + count);

}

}

我们首先实例化一个BbtForumServiceClient，然后通过URL指定Web Service的服务地址，然后创建一个服务的窄接口实例，如①所示，接着我们就可以使用这个窄接口实例进行Web Service服务的调用了。

Web Service的测试

在实际应用中，在开放Web Service之前需要进行严格的测试，以保证功能的正确性。在一般框架中，测试Web Service往往这是一个炼狱般痛苦的过程。

XFire通过AbstractXFireTest极大地简化Web Service的测试。AbstractXFireTest允许我们无需构造客户端调用程序，在SOAP报文层面开展对服务端代码的测试，AbstractXFireTest提供了一系列方便的方法对SOAP报文进行验证。XFire还特别为spring环境下进行Web Service测试提供了一个AbstractXFireSpringTest子类，仅通过启用Spring容器就可以完成Web Service的测试。通过XFire精心设计的测试工具类，对Web Service的测试工作已经是一项可以轻松应对的工作。

如果你在编写服务端Web Service的同时，还需要编写客户端调用程序，这时不可避免的，你希望从客户端角度对Web Service进行测试。由于客户端程序需要访问真实的Web Service，所以需要开启Web服务器，让服务端的Web Service能够提供服务共客户端访问调用。如果客户端和服务端都在同一个项目中开发，XFire允许你在不启动Web服务器的情况下测试客户端程序，其原理是让Web Service运行于JVM模式下。

基于SOAP报文的纯服务端测试

AbstractXFireTest扩展于JUnit标准的TestCase类，提供了向某个Web Service发送SOAP请求报文并对返回的SOAP响应报文进行检验的能力。该测试类提供了若干个方便的断言方法，分别介绍如下：

void assertNoFault(Document node)：确认SOAP响应报文无错误； 
java.util.List assertValid(java.lang.String xpath, java.lang.Object node)：确认在DOM节点特定路径下有对应的元素，路径通过XPath表达式进行定义，该方法还将匹配的元素以List对象返回，你可以对匹配的元素进行进一步的检验； 
void assertXPathEquals(java.lang.String xpath, java.lang.String value, Document node)：确认特定路径DOM节点为某一特定值； 
java.util.List assertValid(java.lang.String xpath, java.lang.Object node)：确认DOM节点特定路径下未包含元素。 
AbstractXFireSpringTest是AbstractXFireTest的子类，在Spring中你仅需要扩展该类并实现该类的抽象方法ApplicationContext createContext()，就可以对Spring容器中用XFire定义的Web Service进行测试了。

为了测试Web Service，我们必须准备一个SOAP请求报文，你可以简单地手工编写一个，或通过SOAP报文截取工具（如前面我们介绍的tcpTrace、SOAPScope、Apache Axis的TCPMon等）获得一些可用的SOAP请求报文。下面是一个访问BbtForumService 服务的请求SOAP报文：

代码清单6 request_soap.xml：SOAP报文层面测试

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:xsd="http://www.w3.org/2001/XMLSchema"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<soap:Body>

<getRefinedTopicCount

xmlns="http://server.xfire.baobaotao.com">

<in0 xmlns="http://server.xfire.baobaotao.com">20</in0>

</getRefinedTopicCount>

</soap:Body>

</soap:Envelope>

我们将其保存在request_soap.xml文件中放置在类路径com/baobaotao/xfire/server下。当该SOAP请求报文发送给BbtForumService的Web Service后，我们预计它应该返回对应代码清单7所示的正确的SOAP响应报文：

代码清单7 SOAP响应报文

<?xml version="1.0" encoding="UTF-8"?>

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<soap:Body>

<getRefinedTopicCountResponse xmlns="http://www.baobaotao.com">

<out>32</out>

</getRefinedTopicCountResponse>

</soap:Body>

</soap:Envelope>

下面，我们着手编写测试BbtForumService Web Service的测试类，以验证实际SOAP响应报文是否和代码清单7中的一样：

代码清单8 TestBbtForumService

package com.baobaotao.xfire.server;

import org.codehaus.xfire.spring.AbstractXFireSpringTest;

import org.jdom.Document;

import org.springframework.context.ApplicationContext;

import org.springframework.context.support.ClassPathXmlApplicationContext;

public class TestBbtForumService extends AbstractXFireSpringTest {

protected ApplicationContext createContext() {①创建包含Web Service的Spring容器

return new ClassPathXmlApplicationContext(

new String[]);

}

public void testUsingSoapRequest() throws Throwable {

②通过SOAP请求报文访问BbtForumService的Web Service，对返回

SOAP响应报文进行检测

Document response = invokeService("BbtForumService",

"/com/baobaotao/xfire/server/request_soap.xml");

assertNoFault(response);③确认不包含错误

④为命名空间指定一个别名，方便后续XPath表示式的编写

addNamespace("k", "http://www.baobaotao.com");

assertValid("//soap:Body/k:getRefinedTopicCountResponse", response);⑤

assertXPathEquals("//k:getRefinedTopicCountResponse/k:out/text()", "32",response);⑥

printNode(response);⑦打印响应报文，以便肉眼查看

}

}

使用AbstractXFireSpringTest测试Web Service首先要做的第一件事是通过实现createContext()方法构造Spring容器，如①所示。当Spring容器启动时，XFire将自动让容器中的Web Service生效（仅进行测试，不能对外提供服务）。

第二步需要向Web Service发送一个SOAP请求报文以得到一个SOAP响应报文，如②所示。接下来，就是通过AbstractXFireTest提供的检测DOM内容的方法对报文进行正确性验证。由于代码清单7的SOAP报文体中对应的<getRefinedTopicCountResponse>元素及内部元素都位于http://www.baobaotao.com命名空间中，报文体中没有为这个命名空间定义相应的别名，为了在后续断言方法中能够使用简单的方式定义XPath表达式，我们在④处为http://www.baobaotao.com命名空间定义了一个别名。

理解以上测试代码中几个断言方法的关键在于理解XPath表达式语言，XPath语法内容很丰富，不可能在这里逐一讲解，我们在这里介绍一些典型的XPath语法以满足常见的测试需求：

以“/”为前缀的路径表示从DOM根路径开始，如“/soap:Envelope/soap:Body”； 
以“//”为前缀的路径表示从DOM任意元素开始查询，如“//out”表示任意元素为out的元素； 
元素的属性通过@attrName表示，如“//xsd:complexType[@name="Book"]”表示DOM中任意元素名为complexType并且拥有一个值为Book的name属性的元素； 
元素的值通过text()表示，如“//test:Response[text()='32']”表示DOM中任意值为32，元素名为Response，且位于test命名空间中的元素。 
现在回过头来看⑤、⑥两处的断言方法，相信大家就可以很容易地理解断言规则了，⑤处的断言检测SOAP响应报文是否包含某一特定元素，而⑥处的断言则对元素内的值进行检测。我们也可以通过printNode()方法将一个节点打印到控制台上，方便肉眼查看。

在JVM模式通过客户端进行测试

能够不启动Web服务器的情况下通过客户端程序测试Web Service的功能，这一崭新的测试方法对于开发人员来说一定深具吸引力。因为，这意味着你可以完全在IDE环境中运行测试，不需要外部环境的支持。

不过享受这一测试好处的应用必须保证客户端和服务端的Web Service都位于同一JVM中，这时请求报文和响应报文直接在JVM 内部通道中传输。当使用JVM内部通道传输请求和响应的SOAP报文时，我们仅需要调整服务的地址就可以了：

代码清单9 TextBbtForumService：JVM模式测试

package com.baobaotao.xfire.client;

import org.codehaus.xfire.client.XFireProxyFactory;

import org.codehaus.xfire.service.Service;

import org.codehaus.xfire.service.binding.ObjectServiceFactory;

import org.codehaus.xfire.spring.AbstractXFireSpringTest;

import org.springframework.context.ApplicationContext;

import org.springframework.context.support.ClassPathXmlApplicationContext;

import com.baobaotao.xfire.server.BbtForumService;

public class TextBbtForumService extends AbstractXFireSpringTest {

protected ApplicationContext createContext() {

return new ClassPathXmlApplicationContext(

new String[]);

}

public void testGetRefinedTopicCount() throws Throwable {

Service serviceModel = new ObjectServiceFactory().create(BbtForumService.class);

XFireProxyFactory factory = new XFireProxyFactory(getXFire());

①在JVM内部通道中进行SOAP请求和响应报文的传输，请注意粗体所示的服务地址

BbtForumService service = (BbtForumService) factory.create(serviceModel,

"xfire.local://BbtForumService");

int count = service.getRefinedTopicCount(20);

assertEquals(count,32);

}

}

以上代码中，①处的服务地址采用了JVM模式的地址，和其对应的HTTP地址则是http://localhost:8080/baobaotao/service/BbtForumService，所以仅需将服务名前的部分替换为“xfire.local://”就可以了。

小结

比之于Axis，XFire在实施Web Service更加简洁高效，因此XFire在短短的时间里成为了Web Service开发者的炙手可热的框架。更可贵的是XFire对Spring提供了强大的支持，可以非常方便地在Spring中使用XFire实施Web Service。

XFire可以通过多种方式将Spring容器中的Bean导出为Web Service，这包括使用XFireExporter导出器或jsR 181注解。JSR 181和STAX一起都将融入到jdk 6.0中，因此，JSR 181 Web Service定义方式将成为标准的实现。

XFire为客户端提供了多种访问Web Service的方式，如果可以获取客户端的窄接口类，则可以采用窄接口类调用Web Service。如果仅能获取WSDL，XFire也可以采用动态反射的机制调用Web Service。XFire为Eclipse提供了一个可以根据WSDL生成客户端存根代码的插件，相信XFire也将为其它非Java语言提供类似的插件。

技术可用性的一个很大的标准是它是否方便测试，XFire为在Spring中测试Web Service提供了一流的支持，通过JVM模式，你能够在不启动Web容器的情况下测试Web Service，Web Service的测试工作变得不再象原来那样让人畏惧。