Eclipse xFire webService学习笔记

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 等项目的支持等。

开发环境：

eclipse（Indigo Release）+JDK1.5+TOMCAT6.0+XFire1.2.6

开发准备：

一、XFire安装

XFire 框架目前的最新版本是 1.2.6，可以访问 xfire.codehaus.org 下载 XFire 框架的安装包，下载时请选择“全部二进制发布包（Binary Distribution in zip package），而不仅仅是“XFire jar 文件（Jar of all XFire modules），即xfire-distribution-1.2.6.zip和xfire-all-1.2.6.jar两个包

下载路径：http://xfire.codehaus.org/Download

下载完成后，我们可以将下载的 .zip 文件解压缩到任意的文件夹中（后面的章节中使用 % XFIRE_HOME % 表示 XFire 框架的安装目录），解压缩后形成的文件目录结构如下：

1、api（目录）

api 目录中是 XFire 框架中所有类（class）对应的 API 文档，为开发者使用 XFire 完成应用开发提供帮助。

2、examples（目录）

examples 目录中包含了所有随 XFire 二进制包发布的实例，包括这些实例的源代码和相关 Web 应用配置内容。

3、lib（目录）

lib 目录中包含 XFire 运行所需要的外部支持类包（.jar文件），可以根据不同项目所需的 XFire 特性选择所需要的支持类包。

保守的方法是在 Web 项目中包含所有的外部支持类包（.jar文件）。

4、manual（目录）

manual 目录中包含有 XFire 框架的帮助文档，开发者可以从这些帮助文档中学习更多运用 XFire 框架实现 SOA 的知识和技巧。

5、modules（目录）

modules 目录中包含了 XFire 框架根据不同特性分别编译的二进制包文件。发布基于 XFire 框架的 Web 项目时，

可以选择使用该目录下的所有 .jar 文件，也可以选择 XFire-all-1.2.6.jar 文件。

6、XFire-all-1.2.6.jar

XFire 框架的二进制包文件，包含了全部的模块（modules）。

7、LICENSE.txt

LICENSE.txt 文件中包含了 XFire 框架的授权协议。

8、NOTICE.txt

9、README.txt

这两个文件中包含了 XFire 发布时的一些有用的信息。

二、eclipse、JDK1.5、TOMCAT6.0（weblogic）软件安装（这几个不做详细介绍）

三、准备开发：

1、在eclipse中创建dynamic Web Project项目，名为xFireService，如下图所示，选择默认至最终完成

2、点击工程xFireService右键属性，修改工程java文件编译路径，将编译文件指定到xFireService/WebContent/WEB-INF/classes目录下，如没有classes则创建一个

3、将下载的XFire-all-1.2.6.jar和解压.zip包lib文件下的所有jar包都拷贝至Web-INF/lib目录下面。

 [注] 为了减少拷贝的 jar 文件的数目，开发者可以根据项目的需要选择需要拷贝的 jar 文件，而不是全部拷贝，如何根据需要选择拷贝合适的类包文件请访问 XFire 站点。

4、修改web.xml文件，并增加如下Servlet内容

 <servlet>
    <servlet-name>XFireServlet</servlet-name>
    <servlet-class>
        org.codehaus.xfire.transport.http.XFireConfigurableServlet
    </servlet-class>
  </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>

5、在classes目录下创建 META-INF/xfire目录，并”xfire”文件夹下创建新文件 services.xml，文件默认内容下

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://XFire.codehaus.org/config/1.0">
</beans>

6、创建 Web 服务接口 ---- HelloWorldService及接口实现类HelloWorldServiceImpl，代码如下

package com.xFire.service;

/**
 * HelloWorldService 中声明需要发布成 Web 服务的所有 Java 方法 HelloWorldService 作为Web服务接口
 */
public interface HelloWorldService {

	/**
	 * sayHello 方法声明了 Web 服务对外暴露的接口
	 * @return 返回给客户端的字符串
	 */
	public String sayHello(String msg);
}

package com.xFire.service.impl;

import com.xFire.service.HelloWorldService;

public class HelloWorldServiceImpl implements HelloWorldService {

	public String sayHello(String msg) {
		return "Hello " + msg;
	}

}

7、修改 services.xml，将 POJO 发布成 Web 服务，在services.xml文件<beans />中添加如下代码

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://xfire.codehaus.org/config/1.0">
<service>
	<name>HelloWorldService</name>
	<namespace>http://service.xFire.com/HelloWorldService</namespace>
	<serviceClass>
		com.xFire.service.HelloWorldService
	</serviceClass>
	<implementationClass>
		com.xFire.service.impl.HelloWorldServiceImpl
	</implementationClass>
	<style>wrapped</style>
		<use>literal</use>
		<scope>application</scope>
</service>
</beans>

其中各元素的功能如下：

service
service 标签和它所包含的 xml 内容为发布成 Web 服务的 POJO 提供完整的描述。
name
Web 服务被发布时所采用的唯一名称。
namespace
Web 服务发布时所使用的命名空间。
serviceClass
Web 服务接口类的全名，包括包名和类名。
implemetationClass
Web 服务实现类的全名，包括包名和类名。

更多 service 元素的子元素和它们的用法请参考 XFire 站点。

8、创建完成后发布，通过http://localhost:8080/xFireService/services/ 和 http://localhost:8080/xFireService/services/HelloWorldService?wsdl查看，结果下图所示：

9、编写客户端验证结果，代码如下：

package com.xFire.service;

import java.net.MalformedURLException;
import java.net.URL;
import org.codehaus.xfire.client.Client;

import org.codehaus.xfire.XFireFactory;
import org.codehaus.xfire.client.XFireProxyFactory;
import org.codehaus.xfire.service.Service;
import org.codehaus.xfire.service.binding.ObjectServiceFactory;

public class XFireTest {

	public static void main(String[] args) {

		// 调用方法一：
		// //这个是在java端调用.net写的远程Web Service 如果调用本机写的只需要把URL中的地址换成本机能访问的地址即可 
		Client client = null;
		try {
			client = new Client(
					new URL(
				"http://localhost:8080/xFireService/services/HelloWorldService?wsdl"));
			Object[] result1 = client.invoke("sayHello", new Object[] { "张三" });
			System.out.println(result1[0]);

		} catch (MalformedURLException e) {
			e.printStackTrace();
		} catch (Exception e) {
			e.printStackTrace();
		}

		// 调用方法二：
		Service s = new ObjectServiceFactory().create(HelloWorldService.class);
		XFireProxyFactory xf = new XFireProxyFactory(XFireFactory.newInstance()
				.getXFire());
		String url = "http://localhost:8080/xFireService/services/HelloWorldService";
		HelloWorldService helloWorldService;
		try {
			helloWorldService = (HelloWorldService) xf.create(s, url);
			System.out.println(helloWorldService.sayHello("李四"));
		} catch (MalformedURLException e) {
			e.printStackTrace();
		}

	}
}

执行程序测试结果为：

Hello 张三
Hello 李四