XFire 最新生火指南上

作者：江南白衣

本文来自SpringSide WIki，请留意Wiki上的最新版本。(wiki于11.27更新)。

1. 概述

XFire

是全球众多牛人在与axis系列对比后一致投票的选择。我比较欣赏的特性有：

与Spring整合，无须生成一堆文件，无须打包独立war，直接将应用中的Pojo导出为服务。
Aegis--超简约的默认Java XML 绑定机制，且可以Plugin其他绑定机制。
JSR181--annotatiton驱动的POJO WebService配置。
基于Stax的高性能框架。
脱离Web服务器的单元测试能力。

网上的文档与例子总是不新，大家抛开所有的文档，所有的Axis习惯，单看这份代表XFire1.2.2最简约做法的文档。

2. 生火指南

2.1 修改web.xml，在Web应用中增加XFire的入口

xfire的入口，注意XFire有了自己的Servlet，不再依赖Spring MVC的Servlet，也就远离了大家不熟悉的Spring MVC URL Mapping，与Spring达致完美的整合。

这里指定了路径为/service/* ，即WebService的URL会被默认生成为http://www.springside.org.cn/bookstore/service/BookService

，其中BookService默认为2.2中的接口名。

< servlet >

< servlet-name > xfire </ servlet-name >

< servlet-class > org.codehaus.xfire.spring.XFireSpringServlet </ servlet-class >

</ servlet >

< servlet-mapping >

< servlet-name > xfire </ servlet-name >

< url-pattern > /service/* </ url-pattern >

</ servlet-mapping >

2.2 编写窄接口，抽取POJO中要导出的服务

从已有的BookManager.java中，抽取出一个窄接口，仅暴露需要导出为Web Service的方法。而Bookmanger.java是POJO，不需要任何WebService相关代码。

窄接口一方面满足了安全要求，不用整个BookManager所有方法导出为Web Service；另一方面，XFire暂时也只支持基于接口的Proxy。

public interface BookService {
List < Book > findBooksByCategory(String cateoryId);
}

2.3 配置Java-XML Binding

XFire默认的Aegis Binding语法非常简单，在SpringSide的例子里几乎一行配置都不用写，是我见过最简单的binding定义，大大优于其他以设计复杂为终极目标的方案。

对象的属性、函数的参数和返回值如果为int、String、Date等普通类型以及由普通类型组成的复杂对象都无需定义。我见到只有两种情况需要定义：

无法使用泛型定义Collection中元素的类型时--如List findBooks()。如果能写成List<Book> findBooks()就也不需要了。
需要为属性定义不同的名字，或者定义复杂对象里的某些属性不要输出。

XFire以约定俗成代替配置，如果万一真的需要aegis配置，所有Service和Entity Bean的binding文件要求命名为xxx.aegis.xml，而且要和原来的类sit together在同一目录里。

< mapping >
         
         < method name ="findBooksByName" >
             < return-type componentType ="org.springside.bookstore.domain.Book" />
         </ method >
        
        < property name ="products" ignore ="true" />
</ mapping >

其他语法详见Aegis

参考。

2.4 配置Spring导出

为了节约代码，配置一个基类，注意导出的服务不能lazy-init：

< import resource ="classpath:org/codehaus/xfire/spring/xfire.xml" />

< bean id ="baseWebService" class ="org.codehaus.xfire.spring.remoting.XFireExporter" lazy-init ="false"

abstract ="true" >

< property name ="serviceFactory" ref ="xfire.serviceFactory" />

< property name ="xfire" ref ="xfire" />

</ bean >

每个Web服务的定义：parent为基类，serviceClass property设置Web Service的接口，serviceBean property设置Web Service的实现类。

   
   
    
     
     < 
     bean  
     id 
     ="bookService" 
      parent 
     ="baseWebService" 
     > 
     
   
     < 
     property  
     name 
     ="serviceBean" 
      ref 
     ="bookManager" 
     /> 
     
   
     < 
     property  
     name 
     ="serviceClass" 
      value 
     ="org.springside.bookstore.components.xfire.server.simple.BookService" 
     /> 
     
  
     </ 
     bean 
     >

Web服务导出完毕，用户可在http://localhost/service/BookService?WSDL

查看自动生成的WSDL。

上半章完，关于JSR181,Client API与测试部分请看XFire 生火指南(下)