日期:2014-05-16  浏览次数:20663 次

[转] Apache SOAP介绍

最近在项目中用到了APACHE SOAP的客户端调用。记录一下
SOAP(简单对象访问协议)是一种利用XML编码数据的有线协议。它是同类协议中要求最低的一个规范,只定义了有线协议所要求的最关键的部分,有意地忽略了垃圾收集、对象激活等方面的细节。

SOAP对于Java开发者来说尤其重要,因为它让平台无关和可移植的Java程序更容易协同操作,使得Java的宝贵特性进一步增值。事实上,如果 Java 2平台企业版(J2EE)的下一个版本让SOAP成为一种必须遵循的有线协议,规定所有遵从J2EE规范的应用服务器都必须支持SOAP协议,我也不会感 到奇怪。不过就现在来说,我想我的猜想应该暂停了。

这个系列的文章总共四篇,这是第二篇。在这里,我要介绍的是Apache SOAP实现。

一、Apache SOAP概述
Apache SOAP,即Apache Software Foundation对SOAP规范的实现,建立在IBM的SOAP4J的基础上。和所有其他Apache工程类似,Apache SOAP源代码开放,按照Apache许可协议发行。我觉得这是当前最好的SOAP实现之一。然而,虽然Apache SOAP遵从SOAP规范1.1版本,但它缺乏SOAP 1.1所包含的某些功能(参见本文最后的“参考资源”,了解Apache SOAP支持功能的清单)。

1.1、下载和安装Apache SOAP
如前所述,Apache SOAP可以免费下载(参见“参考资源”中提供的下载链接)。我为我的Windows NT便携机下载了soap-bin-2.0.zip文件,该文件包含Apache SOAP 2.0,这是写作本文时的最新版本。安装Apache SOAP可谓轻而易举,共包含如下三个简单的步骤:

解开下载所得文件的ZIP压缩:解开压缩之后就得到了一个soap-2_0子目录。我把ZIP文件的内容解压缩到E盘的根目录下,因此有了一个包含Apache SOAP的E:\soap-2_0目录。
配置Web环境:要有一个支持Servlet和JSP的Web服务器。至此,你可能遇到下面两种情况之一:
情 况1:已经有一个支持Servlet和JSP的Web服务器,而且你觉得配置这个服务器没有问题。在这种情况下,请配置服务器,使得浏览器可以访问 http://localhost:8080/apache-soap/,打开soap-2_0 \webapps\soap\目录下面的index.html文件。
情况2:没有支持Servlet和JSP的Web服务器,或者虽然有这样一个服务器,却不想拿它做试验。在这种情 况下,我建议你下载Tomcat的最新版本(写作本文时,最新版本是3.1)(参见“参考资源”中的链接)。Tomcat是Apache创建和免费提供给 软件开发者的又一个优秀软件。下载合适的ZIP文件之后(jakarta-tomcat-3.1.1.zip),解开压缩时创建一个jakarta- tomcat子目录。和前面相似,我把解压缩得到的文件放入E盘的根目录之下。在jakarta-tomcat\conf\server.xml配置文件 中增加一个新的<Context>标记,如下所示:
<Context path="/apache-soap" docBase="E:/soap-2_0/webapps/soap"
debug="1" reloadable="true">
</Context> 在Context元素的docBase属性中,你应该在指定soap-2_0目录时把E:替换成合适的盘符。要启动Tomcat,执行 startup.bat(对于Unix,执行startup.sh)。要关闭Tomcat,执行shutdown.bat(对于Unix,执行 shutdown.sh)。但请稍等——现在请不要启动Tomcat。
设 置Web服务器classpath:Apache SOAP要求有1.1.2版本或更高的Apache Xerces(Java),它支持DOM(文档对象模型)Level 2规范,支持名称空间。我使用1.2版本的Xerces,即Apache网站的Xerces-J-bin.1.2.0.zip。解开这个压缩文件,得到 xerces-1_2_0子目录。和前面一样,我把解压缩得到的文件放到了E:盘的根目录之下。你应该配置Web服务器,使它能够用 xerces.jar(它在xerces-1_2_0子目录下)进行所有XML解析——而不是用服务器附带的库或jar解析XML。例如,Tomcat附 带了一个XML解析器(jakarta-tomcat\lib\xml.jar),支持DOM Level 1接口。即使你把xerces.jar放入了classpath,Tomcat下运行的Java代码也可能找错接口,因为在用来启动Tomcat的 Shell脚本/批命令文件中,xerces.jar被放到了classpath的最后。因此,必须编辑jakarta-tomcat\bin目录下的 tomcat.bat(对于Unix,则是tomcat.sh),把xerces.jar放到classpath的前面。下面是我在jakarta- tomcat\bin\tomcat.bat文件中所作的修改:
set CLASSPATH=E:\xerces-1_2_0\xerces.jar;%CLASSPATH%;%cp% 如果你在第二个步骤中属于情况2,也必须配置服务器,使它能够使用xerces.jar。

不管你属于哪一种情况,除了配置xerces.jar之外,你还必须配置Web服务器的classpath使它能够使用soap-2_0\lib\目录下的soap.jar。

1.2、检查安装是否成功
现在,启动Web服务器,用浏览器打开http://localhost:8080/apache-soap/admin,验证安装是否成功。这时,你应该看到下图所示的管理屏幕。


图一:Web界面的Apache SOAP管理工具

二、实例:HelloWorld
现在你已经设置好了Apache SOAP,我们来实际使用一下,构造一个简单的HelloWorld应用。在SOAP术语中,应用称为服务。一般地,创建服务分两个步骤,这两个步骤可能 由同一个人或组织实施,也可能不是。第一个步骤是在选定的语言中定义和实现服务本身,这里我们选择Java语言。第二个步骤是创建实际调用服务的客户程 序。首先我们来看HelloWorld服务。

2.1、HelloWorld服务
我在第一篇文章中讨论了一个用SOAP实现的HelloWorld服务实例。这个服务要求输入一个用户名字,返回一个定制的Hello消息给调用者。下面的代码显示了HelloWorld服务的完整Java代码。

package hello;
public class HelloServer
{
public String sayHelloTo(String name)
{
System.out.println("sayHelloTo(String name)");
return "Hello " + name + ", How are you doing?";
}
}

这就是全部的代码吗?如果这是真的话,实在太简单了!

Apache SOAP使创建服务变得极其简单。服务主要由业务逻辑构成,不管服务以哪种方式提供给外界使用,业务逻辑代码都是必须编写的。换句话说,服务不会和任何 SOAP相关的代码混合,因为Apache SOAP底层体系——它由rpcrouter Servlet和soap.jar构成——帮助我们完成了所有错综复杂的工作。我们来简要地探讨一下这些错综复杂的工作究竟包含些什么,例 如,Apache SOAP如何处理HTTP上的远程过程调用(RPC)请求?理解这一点将给创建客户程序带来方便(不错,是客户程序)。

在Apache SOAP中,org.apache.soap.rpc包支持在SOAP上进行RPC调用。Apache RPC支持的关键在于对象ID。所有的Apache SOAP服务必须有一个唯一的ID,它被视为服务的对象ID。众所周知,唯一性是一个相对的概念;在Apache SOAP中,对象ID的唯一性相对于服务所部署的Apache SOAP服务器而言。也就是说,部署在不同Apache SOAP服务器上的两个服务可能有同样的对象ID。

想要使用服务的客户程序设置一个org.apache.soap.rpc.Call对象,指定目标服务的对象ID、待调用方法的名字以及提供给方法的参数 (如果有的话)。设置好Call对象之后,客户程序调用它的invoke()方法。invoke(