XFire 入门

转:http://www.ibm.com/developerworks/cn/java/j-lo-xfire/#h1 XFire 入门 轻松将 POJO 发布成 Web 服务 文档选项 将此页作为电子邮件发送 级别： 初级 肖 菁, 自由撰稿人 2007 年 5 月 16 日 Java 社区一直试图将 POJO 的作用发挥到极致，降低 Java 应用实现的难度，最近的尝试是将 EJB3.0 建立在 POJO 之上；另一方面，SOA 是目前 Java 社区炙手可热的名词，非常多的企业都在努力应用和实施 SOA；XFire 为这两方面的需求提供了一种魔术般的解决方式，我们很快能够发现使用 XFire 创建和发布 Web 服务可以直接基于 POJO，将烦人的继承关系和一大堆其他可能的约束丢在一边。 POJO、SOA 概述 被重新审视的 POJO POJO（Plain Old Java Object，简单 Java 对象）是 Java 社区中最早的成员（回想您学习 Java 时第一个兴奋的时刻，那个简单的 "Hello World！" 例子），也是最简单、最容易实现的方式。 然而现实中 Java 的发展已经远远超越了 POJO 的范围，成为面向对象技术应用中最成功的编程语言，尤其是继承、多态的应用为我们造就了一大批开发框架（如 Struts）和标准（如 EJB），随之而来的就是实现的复杂化，我们必须面对一大堆继承关系的限制。比如说：要开发一个基于 Struts 的应用，我们必须了解 Struts 特定的继承关系如 ActionForm、ValidateActionForm；要开发一个 EJB 应用，我们必须继承 EJBObject、SessionEJB 等。 为了抛开这些限制，降低 Java 应用实现的难度，Java 社区开始重新审视 POJO 的价值，试图将 POJO 的作用发挥到极致，最新的努力是 EJB3.0。Java 社区将 EJB3.0 设计为基于 POJO，而不是为他准备更多的继承关系等限制。 让人爱恨交加的 SOA SOA 已经成为了目前 Java 社区中炙手可热的名词，几乎所有的软件厂商都在讨论它，为他提供解决方案和产品支持，大部分的企业也已经在企业内部实施或者正在考虑实施 SOA。 然而 SOA 在企业内的实施却不是一项简单的任务，即使抛开新建系统直接基于 SOA 架构实施的因素，要把企业已有系统纳入 SOA 框架也不是一件容易的事情。企业必须在对当前架构深入了解的基础上，对已有系统进行大规模的改造才能满足新的要求。如何经济的从原有技术架构切换到 SOA 架构成为很多企业的难题。 回页首 XFire 概述 XFire 是 codeHaus 组织提供的一个开源框架，它构建了 POJO 和 SOA 之间的桥梁，主要特性就是支持将 POJO 通过非常简单的方式发布成 Web 服务，这种处理方式不仅充分发挥了 POJO 的作用，简化了 Java 应用转化为 Web 服务的步骤和过程，也直接降低了 SOA 的实现难度，为企业转向 SOA 架构提供了一种简单可行的方式。 XFire 目前最新的版本是 1.2.2，目前支持的特性主要包括： 支持将 Web 服务绑定到 POJO、XMLBeans、JAXB1.1、JAXB2.0 和 Castor； 支持基于 HTTP、JMS、XMPP 等多种协议访问 Web 服务； 支持多种 Web 服务业界重要标准如 SOAP、WSDL、Web 服务寻址（WS-Addressing）、Web 服务安全（WS-Security）等； 支持 JSR181，可以通过 JDK5 配置 Web 服务； 高性能的 SOAP 实现； 服务器端、客户端代码辅助生成； 对 Spring、Pico、Plexus 等项目的支持等。 回页首 XFire 安装包 XFire 框架目前的最新版本是 1.2.6，可以访问 xfire.codehaus.org 下载 XFire 框架的安装包，下载时请选择“全部二进制发布包（Binary Distribution in zip package）”，而不仅仅是“XFire jar 文件（Jar of all XFire modules）”。 下载完成后，我们可以将下载的 .zip 文件解压缩到任意的文件夹中（后面的章节中使用 % XFIRE_HOME % 表示 XFire 框架的安装目录），解压缩后形成的文件目录结构如下： api（目录） api 目录中是 XFire 框架中所有类（class）对应的 API 文档，为开发者使用 XFire 完成应用开发提供帮助。 examples（目录） examples 目录中包含了所有随 XFire 二进制包发布的实例，包括这些实例的源代码和相关 Web 应用配置内容。 lib（目录） lib 目录中包含 XFire 运行所需要的外部支持类包（.jar文件），可以根据不同项目所需的 XFire 特性选择所需要的支持类包。保守的方法是在 Web 项目中包含所有的外部支持类包（.jar文件）。 manual（目录） manual 目录中包含有 XFire 框架的帮助文档，开发者可以从这些帮助文档中学习更多运用 XFire 框架实现 SOA 的知识和技巧。 modules（目录） modules 目录中包含了 XFire 框架根据不同特性分别编译的二进制包文件。发布基于 XFire 框架的 Web 项目时，可以选择使用该目录下的所有 .jar 文件，也可以选择 XFire-all-1.2.6.jar 文件。 XFire-all-1.2.6.jar XFire 框架的二进制包文件，包含了全部的模块（modules）。 LICENSE.txt LICENSE.txt 文件中包含了 XFire 框架的授权协议。 NOTICE.txt README.txt 这两个文件中包含了 XFire 发布时的一些有用的信息。 回页首 XFire 框架支撑环境 XFire框架是一种基于Servlet技术的SOA应用开发框架，要正常运行基于XFire应用框架开发的企业应用，除了XFire框架本身之外，还需要JDK和Servlet容器的支持。 1．JDK 版本选择、下载和安装 XFire 支持非常多的特性，其中不同的特性对 JDK 版本的要求有所不同，比如如果项目中选择基于 JSR181 标准发布 Web 服务，我们就需要选择 JDK5 或者以上版本，如果仅仅选择将 Web 服务绑定到最简单的 POJO，我们只需要选择 JDK1.4 版本即可。 JDK 各版本均可以在 java.sun.com 网站上下载，如何安装 JDK 请参考 SUN 公司的相关技术文档和 JDK 的帮助文档。 2．Servlet 容器下载和安装 XFire 是一种基于 Servlet 技术的 SOA 应用开发框架，需要 Servlet 容器的支持。XFire 支持在多种 Servlet 容器中运行，包括 Websphere、Weblogic、TOMCAT 等。为了说明的简单，我们选择使用 TOMCAT（版本5.0.30）作为 XFire 的运行容器，所有配置过程和发布步骤的说明也均是针对 TOMCAT，如果读者使用 TOMCAT 之外的其它 Servlet 容器或者选择了 TOMCAT 的其它版本，下面的配置过程和步骤可能需要做出调整，请读者根据实际 Servlet 容器的帮助文档进行相应调整。 TOMCAT 各版本均可以在 tomcat.apache.org 网站上下载，如何正确安装 TOMCAT 服务器请参考 TOMCAT 服务器的帮助文档。 3．xalan XFire 需要 xalan 项目的支持，然而 1.2.6 版本中并没有带有相应的 jar 文件，因此请访问 xml.apache.org，下载 xalan 项目的二进制包。 回页首 XFire 应用配置 前面的章节中我们下载和安装了 XFire 安装包和所需要的支持环境，现在我们开始学习如何从零开始创建 XFire 应用开发环境。下面的所有配置过程和发布步骤均针对 TOMCAT（版本5.0.30）服务器，如果选择其它的 Servlet 容器，下面的配置过程和步骤可能需要做出调整，请读者根据实际 Servlet 容器的帮助文档进行相应调整。 1、创建 Web 应用目录和基本元素 在 %TOMCAT_HOME%/webapps 目录下创建新的 Web 应用目录 “XFire” [注] 其中的 %TOMCAT_HOME% 指向 TOMCAT 的安装目录。 在 ”XFire”目录下创建 ”WEB-INF”目录、 在 ” WEB-INF”目录下创建 ”lib”目录和 ”classes”目录 在 ” WEB-INF”目录下创建 Web 应用描述文件 ”web.xml”， ”web.xml”文件的内容见 清单 1-1。 清单 1-1 WEB-INF/web.xml                  1、 <?xml version="1.0" encoding="ISO-8859-1"?> 2、 <web-app xmlns="http://java.sun.com/xml/ns/j2ee" 3、      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 4、      xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee    http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd" 5、      version="2.4"> 6、 7、      <display-name>XFire实例</display-name> 8、      <description> 9、           基于XFire框架发布Web服务的例子 10、      </description> 11、 12、 </web-app> 2、拷贝 XFire 所需的支持类包文件 拷贝 %XFIRE_HOME%/lib 目录下所有文件到 “1、创建 Web 应用目录和基本元素” 中所创建的 ”lib”目录下，将 %XFIRE_HOME%/XFire-all-1.2.6.jar 文件也拷贝到 “1、创建 Web 应用目录和基本元素” 中所创建的 ”lib”目录下。将 xalan 安装包中的所有 jar 文件和所需要的支持 jar 文件拷贝到相同的 ”lib”目录下。 [注] 为了减少拷贝的 jar 文件的数目，开发者可以根据项目的需要选择需要拷贝的 jar 文件，而不是全部拷贝，如何根据需要选择拷贝合适的类包文件请访问 XFire 站点。 3、配置 XFire 框架运行所需的 Servlet 修改 web.xml 文件，在其中增加如下 Servlet 定义内容。 1、 <servlet> 2、      <servlet-name>XFireServlet</servlet-name> 3、      <display-name>XFire Servlet</display-name> 4、      <servlet-class> 5、          org.codehaus.xfire.transport.http.XFireConfigurableServlet 6、      </servlet-class> 7、    </servlet> 8、 9、    <servlet-mapping> 10、      <servlet-name>XFireServlet</servlet-name> 11、      <url-pattern>/servlet/XFireServlet/*</url-pattern> 12、    </servlet-mapping> 13、 14、    <servlet-mapping> 15、      <servlet-name>XFireServlet</servlet-name> 16、      <url-pattern>/services/*</url-pattern> 17、 </servlet-mapping> 4、创建 XFire 框架的服务发布文件 services.xml 在 “1、创建 Web 应用目录和基本元素” 中创建的 classes 目录下新建目录 ”META-INF/xfire”； 在步骤 a) 中新建的 ”xfire”文件目录下创建新文件 services.xml，文件的默认内容如 清单1-2 。 清单 1-2 WEB-INF/classes/META-INF/xfire/services.xml                  1、 <beans xmlns="http://XFire.codehaus.org/config/1.0"> 2、 </beans> 回页首 将 POJO 发布成 Web 服务 XFire 框架中，我们有两种方式将 POJO 发布成 Web 服务： 一种方式是直接使用 Web 服务接口和 Web 服务实现类（POJO）来发布； 另一种方式是基于 JSR181 标准和注释技术将被注释的 POJO 发布成 Web 服务； 下面的章节中我们将学习使用第一种方式来完成 POJO 的 Web 服务发布。我们将使用经典的 ”Hello World!”例子来演示将 POJO 发布成 Web 服务所需要的步骤，不过我们不再是简单的访问一个 Java 方法来输出 ”Hello World!”字符串，而是转为在 SOA 环境下实现：Web 服务客户端通过访问服务器端发布成 Web 服务的 POJO 获得返回的 ”Hello World!”字符串后输出到客户端的控制台上。 将 POJO 发布成 Web 服务的基本步骤如下： 创建 Web 服务接口，声明该 Web 服务对外暴露的接口； 创建 Web 服务实现类，为 Web 服务接口提供实现； 修改 XFire 框架的服务发布文件 ---- services.xml，将 POJO 发布成 Web 服务。 下面我们通过创建 ”Hello World!”例子来具体说明如何实现这三个步骤。 1．创建 Web 服务接口 ---- HelloWorldService 要将 POJO 发布成 Web 服务，首先需要创建 Web 服务接口，在接口中声明该 Web 服务需要对外暴露的接口。 我们根据需要创建 Web 服务接口 ” HelloWorldService”，在其中声明一个 ”sayHello”方法，该方法返回 ”String ”类型的内容。” HelloWorldService”接口对应的 Java 文件代码如 清单 1-3。 清单 1-3 WEB-INF/classes/org/vivianj/xfire/pojo/HelloWorldService.java                  1．package org.vivianj.xfire.pojo; 2． 3． /** 4． * HelloWorldService 中声明需要发布成 Web 服务的所有 Java 方法 5． * HelloWorldService 作为Web服务接口 6． */ 7． public interface HelloWorldService { 8． /** 9．       * sayHello 方法声明了 Web 服务对外暴露的接口 10． * 11． * @return 返回给客户端的字符串 12． */ 13． public String sayHello(); 14．} 2．创建 Web 服务实现类 ”HelloWorldServiceImpl” 创建 Web 服务实现类 ”HelloWorldServiceImpl”，它继承 ”1、创建Web服务接口 ---- HelloWorldService” 中创建的 HelloWorldService 接口，并且为它声明的 ”sayHello”方法提供具体实现： 返回字符串”Hello World!”。 ”HelloWorldServiceImpl”类对应的 Java 文件代码如 清单 1-4。 清单 1-4 WEB-INF/classes/org/vivianj/xfire/pojo/HelloWorldServiceImpl.java                  1．package org.vivianj.xfire.pojo; 2． 3．/** 4． * HelloWorldServiceImpl 中为 Web 服务接口中声明的所有 Java 方法提供具体实现 5． * HelloWorldServiceImpl 作为 Web 服务的实现类 6． */ 7．public class HelloWorldServiceImpl implements HelloWorldService { 8． 9． /* 10． * sayHello 方法为 HelloWorldService 服务接口定义的 sayHello 方法提供具体实现 11． *   12． * @see org.vivianj.XFire.pojo.HelloWorldService#sayHelloToXFire() 13． */ 14． public String sayHello() { 15． return "Hello World!"; 16． } 17． 18．} 3．修改 services.xml，将 POJO 发布成 Web 服务 我们可以在 WEB-INF/classes/META-INF/XFire/services.xml 文件中的 <beans …> 和 </beans> 元素中间加入如下的 xml 内容将上面创建的 HelloWorldService 发布成 Web 服务。 1．<service> 2． <name>HelloWorldService</name> 3． <namespace>http://vivianj.org/HelloWorldService</namespace> 4． <serviceClass> 5． org.vivianj.xfire.pojo.HelloWorldService 6． </serviceClass> 7． <implementationClass> 8． org.vivianj.xfire.pojo.HelloWorldServiceImpl 9． </implementationClass> 10．</service> 其中各元素的功能如下： service service 标签和它所包含的 xml 内容为发布成 Web 服务的 POJO 提供完整的描述。 name Web 服务被发布时所采用的唯一名称。 namespace Web 服务发布时所使用的命名空间。 serviceClass Web 服务接口类的全名，包括包名和类名。 implemetationClass Web 服务实现类的全名，包括包名和类名。 更多 service 元素的子元素和它们的用法请参考 XFire 站点。 通过上面的三个步骤，我们已经将新创建的HelloWorldService发布成了Web服务，我们可以使用下面的步骤测试一下创建的Web服务是否能够正常运行： 编译上面的步骤中创建的 Java 接口和类； 启动 TOMCAT 服务器。 等 TOMCAT 服务器完全启动后，打开浏览器，在地址栏中输入 http://localhost:8080/XFire/services/HelloWorldService?wsdl。 其中 HelloWorldServcie 是配置文件中 service/name 元素所定义的内容，”wsdl”参数表示查看该 Web 服务的 WSDL（Web服务描述语言）文件。 如果浏览器中出现如下图所示类似的内容，表示 Web 服务发布成功，我们可以编写客户端访问该 Web 服务从服务器获取返回字符串，本文下载资源中提供的下载文件中包含有可供参考的客户端类 org.vivianj.xfire.pojo.client.HelloWorldServiceClient。 图：浏览器中访问效果 如果浏览器中出现错误提示，请按照上面的步骤和说明检查已经完成的开发、配置过程是否完全正确。 回页首 结束语 本文中作者首先讲解了 XFire 框架的主要特性，XFire 框架的运行环境以及基于 XFire 框架开发 SOA 应用的基本步骤，并且借助于 SOA 环境下的 ”Hello World!”例子，详细的讲解和演示了如何基于 XFire 框架、经过简单的开发、配置步骤就将一个 POJO 类中包含的方法发布成Web服务。从 ”Hello World!”例子实现的过程中，我们可以发现 XFire 框架最大化的发挥了 POJO 的作用，减少了 SOA 实施时对框架本身的依赖，降低了 SOA 实施的难度，企业实施 SOA 时并不需要增加太多的投入就可以实现目标。 回页首 下载 名字 大小 下载方法 xfire.war 6 KB HTTP 关于下载方法的信息 参考资料 学习 访问 XFire 框架用户指南 可以获得更多关于 XFire 的使用帮助。 访问 XFire 的 Eclipse 插件 可以获得关于 XFire 提供的 Eclipse 插件的更多信息。 获得产品和技术 访问 java.sun.com 获得 JDK 各种版本二进制安装包。 访问 tomcat.apache.org 获得 TOMCAT 服务器各种版本二进制安装包。 访问 xml.apache.org 获得 xalan 框架各种版本二进制安装包。 访问 XFire.codehaus.org 获得 XFire 框架的二进制安装包。 关于作者   肖菁是自由撰稿人，致力于研究和推广 JavaEE、Open Source、SOA 技术，发起了开源项目BuildFileDesigner（buildfiledesign.sourceforge.net）和 V-Security（v-security.sourceforge.net）。可以通过电子邮件 cto4u.cn@gmail.com 和他取得联系。