XFire 最新生火指南(上)
作者: 江南白衣,作者保留版权,转载请注明出处。
1. 概述
XFire 是全球众多牛人在与axis系列对比后一致投票的选择。我比较欣赏的特性有:
- 与Spring整合,无须生成一堆文件,无须打包独立war,直接将应用中的Pojo导出为Web服务。
- Aegis--超简约的默认Java XML 绑定机制,且可以Plugin其他绑定机制。
- JSR181--annotatiton驱动的POJO WebService配置。
- 基于Stax的高性能框架。
- 脱离Web服务器的单元测试能力。
网上的文档与例子总是不新,请大家抛开所有的文档,所有的Axis习惯,单看这份代表XFire1.2.2最简约做法的指南。
1.1 SpringSide的封装与演示
2. 生火指南
2.1 修改web.xml,在Web应用中增加XFire的入口
注意XFire已有了自己的Servlet,不再依赖Spring MVC的DispatchServlet,也就远离了大家不熟悉的Spring MVC URL Mapping,与Spring达致完美的整合。
这里指定了路径为/service/* ,即WebService的URL会被默认生成为http://www.xxx.com/yyy/service/ServiceName,其中ServiceName默认为下面的接口名。
<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>
如果应用使用了Hibernate,使用了OpenSessionInView Filter,注意配置OSIV filter覆盖 xfire servlet的路径,即本例中的/service/*。
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()就也不需要了。
- 需要为属性定义不同的名字,或者定义复杂对象里的某些属性不要输出。
如果实在需要aegis配置, XFire以约定俗成代替配置,所有Service和Entity Bean的binding文件要求命名为xxx.aegis.xml,而且要和原来的类sit together在同一目录里。
<mapping>
<!--配置findBooksByName服务的返回值,List内对象为Book-->
<method name="findBooksByName">
<return-type componentType="org.springside.bookstore.domain.Book"/>
</method>
<!--配置Category类,忽略内嵌的products属性不要输出XML-->
<property name="products" ignore="true"/>
</mapping>
其他语法详见Aegis 参考。
2.4 配置Spring导出
为了节约配置代码,先配置一个基类。注意导出Web服务的Bean不能lazy-init:
<!-- 导入XFire基本配置文件 -->
<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 为Web Service的接口,serviceBean为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。