科技行者

行者学院 转型私董会 科技行者专题报道 网红大战科技行者

知识库

知识库 安全导航

至顶网软件频道基础软件在Spring中使用XFire构建Web Service应用

在Spring中使用XFire构建Web Service应用

  • 扫一扫
    分享文章到微信

  • 扫一扫
    关注官方公众号
    至顶头条

XFire是Web Service框架的后起之秀,它从现有的框架中借鉴了许多优秀的理念,力争将Web Service的应用开发难度降到最低。

作者:builder.com.cn 2007年5月22日

关键字:

  • 评论
  • 分享微博
  • 分享邮件

配置web.xml

一般情况下,我们通过HTTP作为Web Service的传输协议,这样你只需启动一个Web服务器(如Tomcat),客户端就可以通过HTTP访问到Web Service服务了。为了集成Spring容器,XFire专门提供一个XFireSpringServlet,我们可以在web.xml中配置该Servlet,将Spring容器中定义的Web Service在某个URI下发布,如代码清单2所示:

代码清单2 web.xml配置

<web-app>

<context-param>

<param-name>contextConfigLocation</param-name>

<param-value>classpath:applicationContext.xml</param-value>①刚才配置的Spring文件

</context-param>

<listener>

<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>

</listener>

<servlet>②配合Spring容器中XFire一起工作的Servlet

<servlet-name>xfireServlet</servlet-name>

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

</servlet>

<servlet-mapping>

<servlet-name>xfireServlet</servlet-name>

<url-pattern>/service/*</url-pattern>③在这个URI下开放Web Service服务

</servlet-mapping>

</web-app>

首先,我们指定在代码清单1中所配置的Spring配置文件,如①所示。然后定义一个XFireSpringServlet,让其截取所有/service URI下的请求,如②和③所示。

创建一个Tomcat配置文件baobaotao.xml,并编写一行映射配置(这里使用Tomcat 5.5),这种方式无须将Web应用打包成WAR,方便开发测试:

<Context path="/baobaotao" docBase="D:/masterSpring/chapter16/webapp"/>

将baobaotao.xml放置到<TOMCAT_HOME>/conf/Catalina/localhost目录下,启动Tomcat服务,键入http://localhost:8080/baobaotao/service/BbtForumService?wsdl,你将可以看到BbtForumService对应的WSDL,如图2所示:

在Spring中使用XFire构建Web Service应用

2 BbtForumService的WSDL

阅读这个WSDL文档,我们可以知道BbtForum的getRefinedTopicCount已经被成功地发布为Web Service了。只要拿到这个WSDL就可以开发相应的客户端调用程序了。

使用JSR 181注解导出Web Service

前面两小节中,我们领教了XFireExporter导出器的威力。在需要导出为Web Service的业务类数目不大时,XFireExporter的配置方式非常优雅。但是,如果有很多需要导出为Web Service的业务类,你必须分别为它们配置一个XFireExporter,这让我们回忆起了TransactionProxyFactoryBean(每一个需要事务功能的业务类需要分别配置)。在学习过@Transaction注解后,我们自然而然地希望使用类似注解技术完成Web Service导出的工作。

JSR 181就是为此目的而提出的,它是BEA领导的一个Web Service规范。XFire已经支持JSR 181 2.0,你既可以使用JDK 5.0的注解,也可以在JDK 5.0之前的版本中使用commons-attributes注解。

使用JSR 181的明显好处是,你仅需在业务类和窄接口标注JSR 181注解,不管你有多少需要导出为Web Service的业务类,仅须在Spring中配置一个XFire提供的JSR 181注解增强Bean就可以了。

注解增强处理器会对Spring容器中所有标注JSR 181注解的业务类进行处理,并分别将它们导出为Web Service。使用JSR 181时,必须将XFire的依赖类库xfire-jsr181-api-1.0-M1.jar添加到类路径中。

如果输入、输出的对象类型仅包括基本类型的属性,仅需要在业务类和窄接口中分别使用@WebService注解进行简单的配置就可以了,XFire将根据默认约定导出Web Service。

窄接口仅需要定义一个@WebService注解,并指定SOAP的命名空间就可以了:

package com.baobaotao.xfire.server;

import javax.jws.WebService;

@WebService(targetNamespace = "http://www.baobaotao.com")①指定SOAP的命名空间

public interface BbtForumService {

int getRefinedTopicCount(int lastDay);

}

XFire应用JSR 181比较怪的一点是,除了需要在窄接口中提供注解外,在实现业务类中也需要提供相应的注解:

package com.baobaotao.service;

import javax.jws.WebService;

import com.baobaotao.xfire.server.BbtForumService;

@WebService(serviceName = "BbtForumService",①指定导出的Web Service名称

endpointInterface = "com.baobaotao.xfire.server.BbtForumService")②对应的窄接口

public class BbtForum implements BbtForumService{

}

如果碰到以下应用场景:输入、输出对象是复杂的对象(如未使用泛型的集合类),当返回类型是一个对象但不希望输出所有的结果,或者不希望使用默认的属性名。

这时可以在业务方法中通过@WebMethod、@WebResult等注解提供额外的信息来达到目的。更多关于JSR 181的信息请参考:http://dev2dev.bea.com/webservices/jwsm.html。

按照相似的方式,可以为应用中其它的业务类进行Web Service标注,在完成标注后,需要在Spring配置中启用XFire JSR 181处理器,对Spring容器中所有标注@WebService的Bean进行统一的处理,以便执行真正Web Service的导出工作。XFire在Spring中对应的配置如下所示:

代码清单3 applicationContext.xml:使用JSR 181导出Web Service

<beans >

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

<bean id="webAnnotations"①该Bean获取Spring容器中所有标注@WebServiceBean

class="org.codehaus.xfire.annotations.jsr181.Jsr181WebAnnotations" />

<bean id="jsr181HandlerMapping"②对标注@WebServiceBean进行处理,完成导出工作

class="org.codehaus.xfire.spring.remoting.Jsr181HandlerMapping">

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

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

</bean>

③该Bean标注了@WebService注解

<bean id="bbtForum" class="com.baobaotao.service.BbtForum" />

</beans>

重启Tomcat,查看http://localhost:8080/baobaotao/service/BbtForumService?wsdl,你依旧可以看到如图2 BbtForumService的WSDL所示的WSDL。

    • 评论
    • 分享微博
    • 分享邮件
    邮件订阅

    如果您非常迫切的想了解IT领域最新产品与技术信息,那么订阅至顶网技术邮件将是您的最佳途径之一。

    重磅专题
    往期文章
    最新文章