Spring与Xfire结合发布WebService

Web服务的发布者首先必须提供一个WSDL文件，即Web Services Description Language（Web服务描述语言），这个XML文件定义了调用Web服务的所有信息，包括所有的方法名称、参数类型、返回类型和数据类型的映射等。 Web服务的调用者只要获得了该WSDL文件，就可以根据WSDL文件通过相应的工具（比如XFire的WsGen）生成客户端支持类，因此，无论服务端以任何技术实现该Web服务，客户端都可以用任何编程语言来调用它。

JavaEE平台从1.3版本开始就完整地支持Web服务，包括调用和发布Web服务两部分。为了让Java应用程序获得访问和发布Web服务的能力，SUN定义了一系列相关的API标准，包括SAAJ、JAXB、JAX-RPC和最新的JAX- WS。

SAAJ(SOAP with Attachments API for Java)已经完整地实现了SOAP协议，可以直接使用SAAJ实现Web服务的底层传输。JAXB(Java Architecture for XML Binding)则实现了XML数据到Java类的绑定，通常我们不直接使用这两个API，而是调用高层的JAX-RPC(Java API for XML-Based RPC)和JAX-WS(Java API for XML-Based Web Services)。JAX-WS是JavaEE最新的Web服务标准，不过仍向下兼容JAX-RPC。

SAAJ(SOAP with Attachments API for Java)
JAXB(Java Architecture for XML Binding)
JAX-RPC(Java API for XML-Based RPC)
JAX-WS(Java API for XML-Based Web Services)

为了在Java中实现Web服务，还必须获得一个具体的实现。Axis和XFire都是实现了完整的Web服务协议的库，可以用于访问和发布Web服务。

相比其他的Web服务引擎，XFire在实现Web服务上有巨大的配置和性能优势，因此，XFire应当作为JavaEE环境下发布Web服务的首选。

Spring框架的另一个子项目Spring Web Services的目标就是提供一个与Spring紧密结合的Web服务模块，并与Spring的MVC框架集成，这个项目可以作为Spring框架下发布Web服务的又一个选择。不过，Spring Web Services项目目前仍处于开发阶段，尚未有稳定版本发布。现在，Java 6已经正式发布了。Java 6的一个重大特性就是对Web服务的内在支持，发布和访问
Web服务都将变得轻而易举。如果采用Java 6的的Web服务器，那么不必使用任何第三方Web服务的支持库，就可以直接将Web服务完美地集成进来。不过，Java 6从正式发布到各Web服务器对其支持尚需一段较长的时间，目前，在服务器端发布Web服务的最佳选择仍是XFire。


XFire发布WebService

public interface BookService {
  Book[] search(String keyword);
}

public class BookServiceImpl implements BookService {
  public Book[] search(String keyword) {
    if ("j2ee".equalsIgnoreCase(keyword)) {
      return new Book[] { new Book("Core J2EE Patterns", "Dan Malks"),
          new Book("The J2EE Tutorial", "Bode Carson"),
          new Book("J2EE Design Patterns", "William Crawford"),
          new Book("J2EE Platform Web Services", "Ray Lai") };
    }
    return new Book[0];
  }
}

public class Book {
  private String name;
  private String author;
  public Book() {
  }
  public Book(String name, String author) {
    this.name = name;
    this.author = author;
  }
  public String getName() {
    return name;
  }
  public void setName(String name) {
    this.name = name;
  }
  public String getAuthor() {
    return author;
  }
  public void setAuthor(String author) {
    this.author = author;
  }
}

编写XFire必须的Web服务描述文件services.xml
该文件必须放到META-INF/xfire/ 目录下

<beans>
  <service xmlns="http://xfire.codehaus.org/config/1.0">
    <name>BookService</name>
    <namespace>http://www.livebookstore.net/BookService</namespace>
    <serviceClass>example.chapter8.BookService</serviceClass>
    <implementationClass>example.chapter8.BookServiceImpl</implementationClass>
  </service>
</beans>

最后，在web.xml中加入

<web-app>
  <servlet>
    <servlet-name>XFireServlet</servlet-name>
    <servlet-class>
      org.codehaus.xfire.transport.http.XFireConfigurableServlet
        </servlet-class>
    <load-on-startup>0</load-on-startup>
  </servlet>

  <servlet-mapping>
    <servlet-name>XFireServlet</servlet-name>
    <url-pattern>/servlet/XFireServlet/*</url-pattern>
  </servlet-mapping>

  <servlet-mapping>
    <servlet-name>XFireServlet</servlet-name>
    <url-pattern>/services/*</url-pattern>
  </servlet-mapping>
</web-app>

启动服务器，浏览器中输入 http://localhost:8080/services/BookService?wsdl
就能看到BookService Web服务的WSDL描述文档




在Spring中集成XFire
删除META-INF/xfire/ 目录，相关信息在Spring的 dispatcher-servlet.xml中定义

使用JSR 181 Web服务注解来标注Web服务

@WebService(
    name="BookService",
    serviceName="BookService",
    targetNamespace="http://www.livebookstore.net/BookService"
)
public class BookServiceImpl implements BookService {
  @WebMethod
  @WebResult
  public Book[] search(@WebParam String keyword) {
    if("j2ee".equalsIgnoreCase(keyword)) {
      return new Book[] {
        new Book("Core J2EE Patterns", "Dan Malks"),
        new Book("The J2EE Tutorial", "Bode Carson"),
        new Book("J2EE Design Patterns", "William Crawford"),
        new Book("J2EE Platform Web Services", "Ray Lai")
      };
    }
    return new Book[0];
  }
}

和普通Spring Web程序一样，在web.xml中声明Dispatcher Servlet

<web-app>
  <servlet>
    <servlet-name>dispatcher</servlet-name>
    <servlet-class>
      org.springframework.web.servlet.DispatcherServlet
        </servlet-class>
    <load-on-startup>0</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>dispatcher</servlet-name>
    <url-pattern>/*</url-pattern>
  </servlet-mapping>
</web-app>

在dispatcher-servlet.xml中

  <!-- 引用XFire预定义的Bean配置 -->
  <import resource="classpath:org/codehaus/xfire/spring/xfire.xml" />
  <!-- Web服务实现类 -->
  <bean id="bookService" class="example.chapter8.BookServiceImpl" />
  <!-- 定义URL映射 -->
  <bean class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping">
    <property name="urlMap">
      <map>
        <entry key="/BookService" value="bookExporter" />
      </map>
    </property>
  </bean>
  <!-- bookExporter将处理来自客户端的调用 -->
  <bean id="bookExporter" 
    class="org.codehaus.xfire.spring.remoting.XFireExporter">
    <!-- 对外提供的Web服务的接口 -->
    <property name="serviceClass" value="example.chapter8.BookService" />
    <!-- 实现Web服务的Bean -->
    <property name="serviceBean" ref="bookService" />
    <!-- 下面引用的Bean都已被import引入了 -->
    <property name="serviceFactory" ref="xfire.serviceFactory" />
    <property name="xfire" ref="xfire" />
  </bean>

注意，这个XML配置文件必须首先通过<import>引入XFire的一些预定义的Bean，
这样就可以直接使用XFireExporter来处理Web服务请求。

此时我们访问WSDL文件的路径为 http://localhost:8080/BookService?wsdl

评论

1 楼 paper 2011-02-12  

不错，多谢