SOAP 是什么东西? 介绍介绍

  若是你的安装路径(installation paths)和上面使用的不一样,你须要更正它们,而后关闭和重启Tomcat以使它们生效。这样,你就有为运行SOAP做好了准备。可是如今,我要忘记有关的技术部分,来学一点理论知识。 java

  SOAP意思是简单对象访问协议(Simple Object Access Protocol)。的确如它的名字同样,SOAP是很简单的。它是一个基于XML的协议,容许程序组件和应用程序彼此使用一种标准的Internet协议--HTTP来通信。SOAP是一种独立的平台,它不依赖程序语言,它是简单的,弹性的,很容易扩展的。目前,应用程序可以彼此使用一种基于DCOMCORBA技术的远程过程调用(RPC)来进行相互通信,但HTTP不被设计为这个目的。RPCInternet上应用是很是困难的,它们会出现许多兼容性和安全性的问题,由于防火墙和代理服务器一般都会阻断(block)这些类型的流量。应用程序之间最好的通信方式是经过HTTP协议,由于HTTP是支持全部Internet浏览器和服务器的。基于这个目的,SOAP协议被建立出来。
那么,它们是如何运做的呢?好比,一个应用程序(A)须要和另外一个应用程序(B)SOAP的帮助下进行彼此通信。它们将使用下面的框架图来完成这个过程:
web

  这个SOAP信封(SOAP envelope)是一个包含如下内容的XML文档:算法

  

  正如你看到的,它是很是简单的。它看起来确实就象一个普通的信封或者你的email。你想看看它们是如何动做的吗?下面跟咱们一块儿来吧。其实咱们有不少方法是不用SOAP来在建立和运行咱们本身的“Hello World”应用程序的,可是由于咱们要保持它的简单性,我会给你一个它运做方式的框架图(scheme)apache

  咱们的“Hello World”范例会包含一个SOAP Service。咱们的SOAP Client将发送它们的名字到该SOAP Service,并试图获得一些答复或响应。这个SOAP Service须要部署到一个SOAP Admin的工具,以致重定位全部请求的SOAP(Proxy) RPC Router可以知道它们应该使用哪一种服务来运做。总而言之,这个是如下面的方式来运做的:浏览器


如今,咱们来一步步的看看到底发生了什么。在Step 1里,HelloWorldClient将链接一个SOAP RPC Router,请求咱们的SOAP Service并将包含咱们名字的一个字符串传递给它。该SOAP RPC Router会检查是否它已经部署了这个SOAP Service。若是它被发现是被部署的,那么它将传递数据到这个SOAP Service并调用特定的方法,这个是Step 2。而后SOAP Service方法会被执行,将返回某个字符串值(该值就是SOAP Client的答复或者响应)(Step 3)。在Step4中,SOAP RPC Router将仅仅只是重定向这个数据到SOAP Client。全部在Step1Step4里传输的数据是经过SOAP Envelope来完成的。正如你所看到的,算法是至关简单的,所以咱们只准备关心实际的代码。安全

  首先,咱们要建立一个SOAP Service。下面是它的代码,请不要忘记将它放入HelloWorld/ 目录中(必须被包含在你的CLASSPATH):服务器

// SOAPService.java 
  package HelloWorld; 
  public class SOAPService 
      public String sayHi(String x) 
      return("Hello my friend, " + x + "! Glad to see you!"); 
  
  }
框架

      添加任何注释也是很容易的。要编译它,只须要用下列命令:javac SOAPService.java

        
第二步,一旦咱们准备好了SOAP Service,咱们须要用SOAP Service Manager来部署它。这个能够经过不少方式来实现,可是为了能让初学SOAP的读者更容易理解SOAP,我提供了一个最容易的方式。咱们假设你的Web Server(Tomcat或其余)已经正常运行,而且你已经正确安装了SOAP。那么当浏览器访问http://localhost:8080/soap/,你会看见Apache SOAP的欢迎页面。点击Run the admin client ,而后 Deploy。你会获得一个屏幕显示,在那里你须要填入IDScopeMethodProvider TypeJAVA Provider的信息到表单域中。你能忽略其余全部的表单域,除非你真的须要它们的信息。咱们的“HelloWorld”例子不须要它们,因此,咱们填的下面的值:
ide

·    ID: urn:HelloWorld_SOAPService 工具

·          Scope: Application

·    Methods: sayHi

·    Provider Type: java

·    Java Provider - Provider Class: HelloWorld.SOAPService

·    Java Provider - Static? No

一些注释:ID是咱们要从SOAP Client标识咱们的SOAP Service的惟一名字。Method包含SOAP Service提供的一系列方法。JAVA Provider-Provider ClassSOAP Service Java类的名字。

  如今,点击Deploy 按钮,那么你的服务会被部署。再次强调,请注意正确设置CLASSPATH环境变量。而后,你的HelloWorld.SOAPService类可以被找到,而且全部必需的jar包也能被找到。这是个几乎每一个人都会犯的普通错误。如今,你可以点击 List ,将会看见你的服务已经被部署进来。恭喜!

  最后,让咱们来建立一个SOAP Client。代码看起来有点复杂,可是在现实中不会只有这么点长。

1: // HelloWorldClient.java 
  2: import java.io.*; 
  3: import java.net.*; 
  4: import java.util.*; 
  5: import org.apache.soap.*; 
  6: import org.apache.soap.rpc.*; 
  7: public class HelloWorldClient 
  8: public static void main(String[] arg) throws Exception 
  9: Call c = null
  10: URL url = null
  11: Vector params = null
  12: Response rep = null
  13: String ourName = "Superman"; 
  14: String ourUrn = "urn:HelloWorld_SOAPService"; 
  15: String ourMethod = "sayHi"; 
  16: url = 
new URL("http://localhost:8080/soap/servlet/ 
  rpcrouter"); 
  17: System.out.println("Passing to our deployed "+ourUrn+" 
  our name ("+ourName+"): "); 
  18: c = 
new Call(); 
  19: c.setTargetObjectURI(ourUrn); 
  20: c.setMethodName(ourMethod); 
  21: c.setEncodingStyleURI(Constants.NS_URI_SOAP_ENC); 
  22: params = 
new Vector(); 
  23: params.addElement(new Parameter("ourName", String.class
  ourName, null)); 
  24: c.setParams(params); 
  25: System.out.print("and its answer is: "); 
  26: rep = c.invoke(url, ""); 
  27: 
if (rep.generatedFault()) 
  28: Fault fault = rep.getFault(); 
  29: System.out.println("/nCall failed!"); 
  30: System.out.println("Code = " + fault.getFaultCode()); 
  31: System.out.println("String = " + fault.getFaultString()); 
  32: } 
else 
  33: Parameter result = rep.getReturnValue(); 
  34: System.out.print(result.getValue()); 
  35: System.out.println(); 
  36: } 
  37: } 
  38:}


下面我要作一些解释。在第13行,咱们设置了咱们的名字,这个名字将会传递给SOAP Service。在第14行,咱们设置了咱们将要调用的服务的ID(service ID),和第15行里设置的服务方法(service method)。有了这个ID,服务可以被部署到SOAP服务管理器(SOAP Service Manager)中。咱们没有设置任何其余值,仅仅只用刚才那些基础值就能够正常运做了。你能从SOAP的官方文档上获得相关信息,该文档来自SOAP包中,它们的解释超出了本文的范围。

  用如下方式编译这个SOAP Client:

  javac HelloWorldClient.java

  为了圆满完成它,让咱们检查一下针对咱们的测试,是否全部事情都准备就绪。Tomcat正在运行,全部的环境变量都正确,SOAP Service被编译和部署,SOAP Client被成功编译。OK,让咱们运行它,你将看到这个屏幕:

  正如你所看到的,咱们的SOAP Client使用SOAP协议成功发送它的名字和接收了一个答复。正如前面所说的,SOAP Service发送和接收的是SOAP envelope。这个是SOAP envelope的源代码。

  被发送到SOAP ServiceSOAP Envelope

?xml version=1.0 encoding=UTF-8?
SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/
soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"

SOAP-ENV:Body
ns1:sayHi xmlns:ns1="urn:HelloWorld_SOAPService"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/
soap/encoding/"

ourName xsi:type="xsd:string"Superman/ourName
/ns1:sayHi
/SOAP-ENV:Body
/SOAP-ENV:Envelope


SOAP Service接收的SOAP Envelope

?xml version=1.0 encoding=UTF-8?
SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/
soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"

SOAP-ENV:Body
ns1:sayHiResponse xmlns:ns1="urn:HelloWorld_SOAPService"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.
org/soap/encoding/"

return xsi:type="xsd:string"Hello my friend, Superman!
Glad to see you!
/return
/ns1:sayHiResponse
/SOAP-ENV:Body
/SOAP-ENV:Envelope 

      
      
要理解SOAP Envelope中的全部标签的含义,我建议你花一点时间阅读 http://www.w3.org/2001/06/soap-envelope 命名空间规范。

  我但愿本文可以在你理解SOAP技术上有必定帮助。这个技术是简单的,有趣的,强大的,弹性的。它被用在许多Web应用中,这些应用的数量也在不断增长。学习SOAP是值得的,至少你要知道它是什么和它是怎么运做的。