2006-11-26

XFire 最新生火指南（上）

 

本文来自SpringSide WIki，请留意Wiki上的最新版本。

基于发布在JavaEye的敬畏心情，本文又修改了一遍，与前两天发在blogjava和csdn的版本稍有不同。

1. 概述

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

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

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

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/BookServiceservice/ServiceName，其中ServiceName默认为下文中的接口名。

xml 代码
  1. <servlet>  
  2.      <servlet-name>xfireservlet-name>  
  3.      <servlet-class>org.codehaus.xfire.spring.XFireSpringServletservlet-class>  
  4.  servlet>  
  5.  <servlet-mapping>  
  6.      <servlet-name>xfireservlet-name>  
  7.      <url-pattern>/service/*url-pattern>  
  8.     servlet-mapping>     
   如果应用使用了Hibernate，使用了OpenSessionInView Filter，注意配置OSIV Filter Filter覆盖xfire servlet的路径，即本例中的/service/*.

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

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

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

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

 2.3 配置Java-XML Binding

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

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

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

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

  1. <mapping>  
  2.           
  3.         <method name="findBooksByName">  
  4.             <return-type componentType="org.springside.bookstore.domain.Book"/>  
  5.         method>  
  6.          
  7.        <property name="products" ignore="true"/>  
  8. mapping>  

   其他语法详见Aegis 参考。

2.4 配置Spring导出

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

xml 代码
  1.   
  2. <import resource="classpath:org/codehaus/xfire/spring/xfire.xml"/>  
  3.   
  4. <bean id="baseWebService" class="org.codehaus.xfire.spring.remoting.XFireExporter" lazy-init="false" abstract="true">  
  5.   <property name="serviceFactory" ref="xfire.serviceFactory"/>  
  6.   <property name="xfire" ref="xfire"/>  
  7.  bean>  
 

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

xml 代码
  1. <bean id="bookService" parent="baseWebService">  
  2.   <property name="serviceBean" ref="bookManager"/>  
  3.   <property name="serviceClass" value="org.springside.bookstore.components.xfire.server.simple.BookService"/>  
  4.  bean>  


 

Web服务导出完毕，用户可在http://localhost/service/BookService?WSDL查看自动生成的WSDL。 

上半章完，关于JSR181,Client API与测试部分请看XFire 生火指南(下)
评论
dengtl 2007-04-18
支持一下！
另外原文中：“如果能写成List findBooks()就也不需要了。”有误！
应该为“如果能写成List<org.springside.bookstore.domain.Book> findBooks()就也不需要了。”
lzzzl 2006-12-01
同感，WEB中如果滚动窗口中的滚动窗口过多，无疑是失败的UI设计，感觉非常滑稽
Nirvana 2006-11-29
这个滚动条拉的实在难过！！！
对于javaEye的这个新功能实在不敢恭维。
heweiya 2006-11-28
最近也在使用web service，是引用.net的dataset对象生成的web service，因为我们的编译环境是jdk1.4，所以选择了axis使用stub方式进行接受服务（取得dataset为对象的XML文件，然后使用dom4j来解析XML文件当中的数据）的，
最新的xfire版本利用stub也可以生成WSDL2JAVA，但是默认生成的方式是JDK1.5的Annotation方式，懒得改代码，故且使用axis，但是使用起来比xfire哆嗦一些。
lighter 2006-11-27
感觉白衣起的文章名称好酷:"最新生火指南","侵入,无侵入? Annotation vs Interface","幼学琼琳","小军刀 "之类的.
江南白衣
搜索本博客
存档
最新评论