编写SOAP程序分三大步:
l 编写服务器端的程序,此程序和普通程序没有什么区别
l 配置SOAP,将相关请求指向到服务器端的程序
l 编写客户端的程序,客户端的程序带有很深的SOAP的烙印,里面会用到很多SOAP包的类和方法。
这里的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是服务器端的程序,其代码如下。这个程序中只有一个方法,和其他Java程序没有什么差别,该方法也也很简单就是返回一个HelloWorld字符串
package cn.com.chengang.soap.hello;
public class HelloWorldService {
public String getMessage() {
return "Hello World!";
}
}
(2)HelloWorldClient.java是客户端的访问程序,其代码如下:
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请求,并返回服务器端的应答
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文件复制到此目录下,如下图所示。
注:还有一种方法是比较普遍使用的,就是将所有服务器端的class文件打成一个JAR包,然后将这个JAR包放在“Tomcat 5.0\common\lib”目录下。
5、重启Tomcat。
这一步不要忘记了,只有重启Tomcat才能将common下新加入的JAR包或class文件加载到内存中。
发布soap服务端程序
发布SOAP服务器端的程序: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网站的去看看是否注册成功了。
运行客户端
在Eclipse中,将HelloWorldClient.java象一个普通Java应用程序那样运行,得到如下结果:
可见客户端程序HelloWorldClient通过SOAP服务调用了HelloWorldService的getMessage方法,并得到了一个返回结果。
在这里我们并没有编写传输的 XML 文件(前面的 XML 是注册服务用的,不是一回事),这是因为 SOAP 包已经为我们自动完成了生成 XML 并传输到服务器的过程。