soap实例入门（转）

SOAP的HelloWord实例- -

                                      

1.1  前言

2005-3-2公司开会并分给我一个任务：写一个程序从福建移动的BOSS系统取出一些相关数据。我得到的资料仅仅有一个“福建移动BOSS与业务增值平台接口规范V1.2.2(新）.doc”，这个规范页数不多，一下就浏览完了。但之后依旧不知所措，感觉到了一条河边，河前有一条大道(就是这份文档)能让我直达目的地，但却找不到过河的桥。这份文档仅仅给出了数据的格式编码规范，但没有告诉你用什么技术，怎么去取这些数据，甚至连一个数据格式的XML样例文件也没有。

里面仅仅有这样几句话：“交易消息(包含请求和应答)是以XML格式表达的，包含两个部分：Message Header(消息头)与Service Content(交易业务内容)。”  “接口协议使用HTTP协议，落地方为发起方提供訪问的URL，发起方使用HTTP POST方法发送请求报文并得到应答报文，发起方作为落地方的HTTPclient，落地方作为发起方的HTTPserver。因此，各个參与方须要同一时候实现HTTPclient以及server的功能。”

这里面有两个keyword：XML、HTTP，再加上老大说用SOAP，我想这个BOSS系统和外界的信息交换技术也是基于SOAP实现的吧。于是我上网搜索了一些资料，始有此文。

注：Boss Connector就是这个项目的名称

1.2  SOAP简单介绍

企业系统内部各个系统之间的信息交换一直是一个难题，在过去有DCOM、CORBA等解决方式，但都不是非常完美，不是太复杂就是有缺陷。如今则较流行SOAP（全称：Simple Object Access Protocol，简单对象訪问协议）。

SOAP和Web Service和Apache SOAP这些新概念（应该也不算新了）常搞的人头昏。我是这么理解的，Web service（也称Web服务）是一个大的概念范畴，它表现了一种设计思想。SOAP是Web service的一个重要组成部份，假设把Web service比喻成Internet，那么SOAP就能够比喻成TCP/IP。SOAP是一种协议而非详细产品，微软也有自己的SOAP实现产品，而Java下比較流行的SOAP实现产品就是Apache SOAP，只是它的下一个版本号已经改名成AXIS了。

SOAP是通过XML文件来做为数据转输的的载体，走HTTP的线路，一般企业的防火墙都开放HTTP的80port，所以SOAP不会被防火墙阻断，这算是SOAP的一个长处。

信息转输的两方都要求支持SOAP服务，由于XML文件发过去，则对方须要有SOAP服务来接收，然后对方会有反馈也是XML文件，这时你也须要安装SOAP服务来接收，例如以下图所看到的：

XML文件

 

XML文件转输到SOAP中，SOAP服务还会有一些内部处理，它详细的处理过程就临时无论这么多了，以下先来写一个HelloWorld实例感受一下先。

1.3  下载

一共要下载四个软件包，它们都是开源免费的。当中，前两个是Apache的，后两个是SUN站点，例如以下所看到的：

l           SOAP：http://apache.freelamp.com/ws/soap/version-2.3.1/

l           Xerces：http://xml.apache.org/dist/xerces-j/ 

l           JavaMail：http://java.sun.com/products/javamail/downloads/index.html 

l           JAF：http://java.sun.com/products/javabeans/glasgow/jaf.html 

详细怎么下载就不说了，说说要注意的事项：尽量用IE的“目标另存为”的来下载，有些用FlashGet是无法下载的。下载之前先不要关闭网页。

下载后的版本号是：JAF1.0.2 + JavaMail 1.3.2 + SOAP2.3.1 + Xerces1.4.4，例如以下图所看到的。

下载后将它们分别解压缩。当中，soap包有些怪异，第一次解压得到的是一个没有扩展名的文件soap-bin-2.3.1，要将这个文件加一个ZIP或JAR后缀名，然后再解压一次。

1.4  安装及编写HelloWorld实例（CVS：V0001版）

本机安装环境：WindowsXP + JDK1.4.2_06 + Tomcat5.0.28 + SOAP2.3.1

1.4.1  复制JAR文件

1、安装JDK和Tomcat。这种文章网上遍地都是，本文不再细述。它们的安装也非常easy：安装JDK基本是一直单击“下一步”，装完后我没有设置不论什么环境变量，就也能够用了；Tomcat也基本是单击“下一步”就能安装完毕。

2、分别在这四个包的解压文件夹中找到：xerces.jar、soap.jar、mail.jar、activation.jar（jaf的），将它们拷贝到Tomcat的“Tomcat 5.0/common/lib”文件夹下，这个文件夹是Tomcat的默认包文件夹，在这个文件夹中的全部包在Tomcat启动时都会被自己主动载入。

3、将c:/jdk/lib/路径下的tools.jar也拷贝到Tomcat的“Tomcat 5.0/common/lib”文件夹下。

注：在显示SOAP的管理页面须要用到这个包，设置classpath指向c:/jdk/lib/tools.jar是没实用的，我也从来没有将tools.jar包增加到classpath中，也没有设置JDK_HOME，也没有将c:/jdk/bin增加到path路径中，基本我安装JDK时什么都没有做。

4、将soap解压文件夹的webapps文件夹下的soap.war文件，拷贝到Tomcat的“Tomcat 5.0/webapps”文件夹下，这个文件夹是Tomcat的WEB应用所在文件夹，soap.war是SOAP的站点，例如以下图所看到的：

 

5、重新启动Tomcat服务。这时Tomcat会将“Tomcat 5.0/common/lib”文件夹下新增加的包载入到内存中。

1.4.2  编写SOAP程序

编写SOAP程序分三大步：

l           编写server端的程序，此程序和普通程序没有什么差别

l           配置SOAP，将相关请求指向到server端的程序

l           编写client的程序，client的程序带有非常深的SOAP的烙印，里面会用到非常多SOAP包的类和方法。

因为我习惯用Eclipse来敲代码，以后项目也是用Eclipse来开发，所以这里的SOAP程序也是用Eclipse来写的。当然你也能够用记事本＋JDK也编写SOAP程序。

1、配置mysoap项目的库引用。

将下图所看到的的四个JAR包增加到项目的库引用中。关于库引用的设置，这里是用“用户库”的方式，详细操作能够參阅这篇文章：http://blog.csdn.net/glchengang/archive/2005/02/17/291522.aspx  。在完毕库引用之后，Eclipse编写的SOAP程序时才干使用soap相关的类。

2、创建一个新的java项目mysoap，在项目里创建一个包“cn.com.chengang.soap.hello”，然后在包中创建两个Java文件，例如以下图所看到的：

（1）HelloWorldService.java是server端的程序，其代码例如以下。这个程序中仅仅有一个方法，和其它Java程序没有什么区别，该方法也也非常easy就是返回一个HelloWorld字符串

package cn.com.chengang.soap.hello;

public class HelloWorldService {

    public String getMessage() {

        return "Hello World!";

    }

}

 

（2）HelloWorldClient.java是client的訪问程序，其代码例如以下：

package cn.com.chengang.soap.hello;

import java.net.URL;

 

import org.apache.soap.Constants;

import org.apache.soap.Fault;

import org.apache.soap.rpc.Call;

import org.apache.soap.rpc.Parameter;

import org.apache.soap.rpc.Response;

 

public class HelloWorldClient {

 

    public static void main(String args[]) throws Exception {

 

        String endPoint = "http://localhost:8080/soap/servlet/rpcrouter";

 

        Call call = new Call();//创建一个RPC Call

        call.setTargetObjectURI("urn:HelloWorldService");//远程的服务名

        call.setMethodName("getMessage");//訪问方法

        call.setEncodingStyleURI(Constants.NS_URI_SOAP_ENC); //设置编码风格

   

        URL url = new URL(endPoint); //SOAP服务的网址

         //開始发送RPC请求，并返回server端的应答

        Response resp = call.invoke(url, "");

 

        //检查应答报文中是否有错

//有错就打印出错信息，没错就打印到正确的返回值HelloWorld

        if (resp.generatedFault()) {

            Fault fault = resp.getFault();

            System.out.println("The Following Error Occured: ");

            System.out.println("  Fault Code = " + fault.getFaultCode());

            System.out.println("  Fault String =" + fault.getFaultString());

        } else {

            Parameter result = resp.getReturnValue();

            System.out.println(result.getValue());

        }

    }

}

这个程序的用到了非常多SOAP的类。注意：假设是两台电脑的话，那么HelloWorldService.java和HelloWorldClient.java是分别独立安装在两台电脑上的，HelloWorldClient中的程序代码就是通过SOAP服务来调用HelloWorldService中的getMessage方法。

4、将HelloWorldService.java的编译文件HelloWorldService.class拷贝到Tomcat中，操作过程例如以下：

（1）在“导航器”视图的bin文件夹下找到HelloWorldService.class文件。

（2）在“Tomcat 5.0/common/classes/”路径下新建一个“cn/com/chengang/soap/hello”文件夹结构，这个文件夹结构要和HelloWorldService.class的所在包名一样的。然后将HelloWorldService.class文件拷贝到此文件夹下，例如以下图所看到的。

注：另一种方法是比較普遍使用的，就是将全部server端的class文件打成一个JAR包，然后将这个JAR包放在“Tomcat 5.0/common/lib”文件夹下。

5、重新启动Tomcat。

这一步不要忘记了，仅仅有重新启动Tomcat才干将common下新增加的JAR包或class文件载入到内存中。

1.4.3  公布SOAPserver端的程序：HelloWorldService.java

有多种方法可让HelloWorldService这个程序注冊到SOAP服务中，本文介绍的是编写XML文件来注冊SOAP服务的方法

（1）HelleWorld.xml文件。此文件能够放置到不论什么地方，它和HelloWorldService.java的位置没有必定的关系。

<?xml version="1.0"?>

<isd:service xmlns:isd="http://xml.apache.org/xml-soap/deployment" id="urn:HelloWorldService">

    <isd:provider type="java" scope="Request" methods="getMessage">

        <isd:java class="cn.com.chengang.soap.hello.HelloWorldService" static="false"/>

    </isd:provider>

</isd:service>

代码说明：

l           urn:HelloWorldService是服务名，它要求系统唯一。这里是取成和类名同样，你也能够取其它名称。

l           getMessage是提供的服务方法，也就是类HelloWorldService的方法名

l           <isd:java class=要求填入全类名（包名＋类名）

（2）设置两个环境变量。之所以要设置这两个变量是由于接下来的公布命令的须要。

TOMCAT_HOME  ＝  E:/Program Files/Apache Software Foundation/Tomcat 5.0

classpath  ＝  %TOMCAT_HOME%/common/lib/soap.jar;%TOMCAT_HOME%/common/lib
/mail.jar;%TOMCAT_HOME%/common/lib/activation.jar;%TOMCAT_HOME%/common/lib/xerces.jar

（3）进入DOS窗体，并定位到HelloWorld.xml所在的文件夹，然后执行例如以下命令（一行）。假设执行正确，则应该没有不论什么显示；假设命令错误则会输出错误信息。

java  org.apache.soap.server.ServiceManagerClient http://127.0.0.1:8080/soap/servlet/rpcrouter  deploy  HelloWorld.xml

另外，再介绍其它两个经常使用的命令：

显示已经注冊的SOAP服务：

java org.apache.soap.server.ServiceManagerClient http://127.0.0.1:8080/soap/servlet/rpcrouter list

 

取消公布：

java org.apache.soap.server.ServiceManagerClient http://127.0.0.1:8080/soap/servlet/rpcrouter undelpoy "urn:HelloWorldService"

 

 命令的运行步骤例如以下：（我把xml文件放在e:/soaptest文件夹下，该文件夹就这一个文件）

 

你也能够进入SOAP站点的去看看是否注冊成功了。

1.4.4  执行client

在Eclipse中，将HelloWorldClient.java象一个普通Java应用程序那样执行，得到例如以下结果：

可见client程序HelloWorldClient通过SOAP服务调用了HelloWorldService的getMessage方法，并得到了一个返回结果。

在这里我们并没有编写传输的XML文件（前面的XML是注冊服务用的，不是一回事），这是由于SOAP包已经为我们自己主动完毕了生成XML并传输到server的过程。

1.5  带參数的方法调用（CVS：V0002版）

上面的HelloWorld的实例中，getMessage方法是没有參数的，这一节我们来加一个參数。

（1）将HelloWorldService.java改动例如以下：

package cn.com.chengang.soap.hello;

 

public class HelloWorldService {

    public String getMessage() {

        return "Hello World!";

    }

 

    public String getMessage(String str) {

        return "Hello World! " + str;

    }

 

    public String getMessage(String str1, String str2) {

        return "Hello World! " + str1 + "&" + str2;

    }

}

 

（2）将HelloWorldService.class拷贝到Tomcat的“Tomcat 5.0/common/classes/cn/com/chengang/soap/hello”文件夹下，覆盖原来的HelloWorldService.class。

（3）重新启动Tomcat服务。

（4）改动HelloWorldClient程序例如以下（红字部份是新加的）：

package cn.com.chengang.soap.hello;

 

import java.net.URL;

import java.util.Vector;

 

import org.apache.soap.Constants;

import org.apache.soap.Fault;

import org.apache.soap.rpc.Call;

import org.apache.soap.rpc.Parameter;

import org.apache.soap.rpc.Response;

 

public class HelloWorldClient {

 

    public static void main(String args[]) throws Exception {

 

        String endPoint = "http://localhost:8080/soap/servlet/rpcrouter";

 

        Call call = new Call();//创建一个RPC Call

        call.setTargetObjectURI("urn:HelloWorldService");//远程的服务名

        call.setMethodName("getMessage");//訪问方法

        call.setEncodingStyleURI(Constants.NS_URI_SOAP_ENC); //设置编码风格

 

        Vector params = new Vector();

        Parameter p1 = new Parameter("name", String.class, "陈刚", null);

        Parameter p2 = new Parameter("name2", String.class, "陈勇", null);

        params.addElement(p1);

        params.addElement(p2);

        call.setParams(params);

 

        URL url = new URL(endPoint); //SOAP服务的网址

        //開始发送RPC请求，并返回server端的应答

        Response resp = call.invoke(url, "");

 

        //检查应答报文中是否有错

        //有错就打印出错信息，没错就打印到正确的返回值HelloWorld

        if (resp.generatedFault()) {

            Fault fault = resp.getFault();

            System.out.println("The Following Error Occured: ");

            System.out.println("  Fault Code = " + fault.getFaultCode());

            System.out.println("  Fault String =" + fault.getFaultString());

        } else {

            Parameter result = resp.getReturnValue();

            System.out.println(result.getValue());

        }

    }

}

（6）在Eclipse中执行HelloWorldClient，得到例如以下效果

 

參考资料

http://blog.csdn.net/caiyi0903/archive/2004/01/20/18036.aspx

http://blog.csdn.net/caiyi0903/archive/2004/01/20/18036.aspx

http://blog.csdn.net/caiyi0903/archive/2004/01/20/18037.aspx

http://blog.csdn.net/madfool/archive/2002/08/17/11309.aspx