简单对象访问协议(SOAP)

转载 2007年09月22日 10:00:00

摘自

http://www-128.ibm.com/developerworks/cn/webservices/ws-intwsdl/part2/index.html

使用 WSDL 部署 Web 服务,第 2 部分: 简单对象访问协议(SOAP)

Web 服务和 WSDL 简介

级别: 初级

Bilal Siddiqui, CEO

2002 年 3 月 01 日

简单对象访问协议(SOAP)提供对远程对象的访问。这些对象的示例是简单的 JavaBeans 组件或是企业 JavaBeans 组件和 COM/COM+ 对象等。这些对象驻留在不同企业内部并且可能存在于因特网的任何位置。因此,SOAP 通过因特网通信并且是一种在不同企业间交换信息的机制。在本文中,Bial 会详细的讨论 SOAP 通信,对象是怎样用 SOAP 公开其功能的,怎样调用 SOAP 对象,怎样在有 SOAP 意识的应用程序间交换信息。他还会展示第 1 部分中提到的 WSDL 应用程序的 SOAP 服务部署,以及远程服务器对它的调用。

SOAP 和 WSDL

我在本系列文章的 第 1 部分介绍了 WSDL。WSDL 描述了 Web 服务的接口。Web 服务所有者将用 SOAP 来实现他们的接口。因此, WSDL 服务实际上作为 SOAP 服务一样存在。一旦 Web 服务用户拥有 WSDL 文件,他或者她就知晓接口的细节。他或者她就会用 SOAP 来与 Web 服务通信。

可以把 Web 服务考虑为对象,可以通过 WSDL 接口公开并且使用 SOAP 通过因特网远程访问。既然服务是对象,那么肯定有每种服务的相关属性和每种服务调用的行为。SOAP 消息是 XML 文档,可通过 HTTP 工作。

为什么用 SOAP?

B2B(Business-to-business)和 A2A(application-to-application )需求表明企业之间为交换信息而相互通信。这种概念被用在 B2B、工作流和跨企业集成中。例如,设想一条垂直供应链,在链上一家企业为了满足它的客户需求而需要调用其提供者的服务。而一些提供者需要沿供应链进一步下行来调用其它企业的服务。

很明显,在此应用程序中互操作性是最为重要的。任何单个企业只能实现 SOAP 通信通道的一端。另一端将是因特网上 任何地方的实体

在最近几年里,企业之间的集成和互操作性已经成为软件工程师和企业的一个挑战性任务。平台相关性也成为取得集成和互操作性的一个大问题。SOAP 依然是在企业间取得集成和互操作性最简单的机制。

 


 

SOAP 体系结构

有了对 SOAP 和它的用途的基本理解,我现在就展开对其体系结构的讨论以了解一些深层知识。请参阅 图 1, 在此图里面您可以识别典型 SOAP 通信体系结构中的一些组件:

  1. SOAP 客户机
  2. SOAP 服务器
  3. 实际服务


图 1. 一个典型 SOAP 通信体系结构的组件
一个典型 SOAP 通信体系结构的组件

让我解释上面所提到的每个实体的体系结构角色。下面的讨论参照 图 1

SOAP 客户机

SOAP 客户机是一台有 SOAP 机制的机器,它可以产生 SOAP 请求并通过 HTTP 发送到服务器。一条 SOAP 请求是一种类型的 SOAP 消息,通常只有两种类型的 SOAP 消息:一条 SOAP 请求就是一台 SOAP 客户机发送给 SOAP 服务器的内容,一条 SOAP 响应就是 SOAP 服务器对 SOAP 客户机响应的内容。 清单 1是典型的 SOAP 请求,请参阅 清单 2来回顾 SOAP 响应。

清单 1:一条简单的 SOAP 请求


SOAP 服务器

SOAP 服务器也是一台有 SOAP 机制的机器,能够接收来自 SOAP 客户机的请求,并对之作出适当的响应。这些编过码的响应会返回发出请求的 SOAP 客户机。在 SOAP 服务器内部有三个实体:

  1. 服务管理器
  2. 被部署服务的列表
  3. XML 转换程序

服务管理器负责根据请求管理服务。请参阅 清单 1 的服务请求,在这里元素 <m:getListOfModels xmlns:m="urn:MobilePhoneservice" > 包含了服务的名称。服务管理器会读取 SOAP 客户机想调用的 SOAP 服务的名称并检查所需的服务实际上是否驻留于这台 SOAP 服务器上。此后,它会查询被部署服务的列表(SOAP 服务器所托管的所有服务的列表)。若存在,服务管理器将把 SOAP 请求传送给 XML 转换程序。XML 转换程序就负责将 SOAP 请求的 XML 结构转换成程序员用来实现实际服务的编程语言(例如,Java 编程语言)的结构。还要负责将来自实际服务的响应转换回 SOAP 响应的 XML 结构。请参阅 清单 2获得 SOAP 响应的说明。

清单 2:一条简单的 SOAP 响应


实际服务

图 1中标有 actual service的框就是实际服务驻留的位置。服务实现可以是:例如,COM 组件或 JavaBeans 组件的形式。XML 转换程序负责将 XML 结构转换成合适的方法调用。当 XML 转换程序调用了实际服务实现的某个方法时,这个方法就会完成它的工作并且将结果信息返回 XML 转换程序。

请看一看 图 1中连接 XML translator 和 actual service 的箭头。箭头的两端同在一个企业内,这意味着同一个组织控制着通信两端的接口。与穿过企业边界的在 SOAP 客户机和 SOAP 服务器之间的箭头相比,这正是 SOAP 的目的所在。

 


 

SOAP 请求响应机制

当 SOAP 客户机向 SOAP 服务器发送 SOAP 消息时,用 HTTP 协议传输。这就叫做 SOAP 与 HTTP 绑定。当 SOAP 服务器收到消息时,将消息交给服务管理器。服务管理器检查被部署服务的列表,查找在 SOAP 消息中所需的服务。若没有查找到所请求的服务,它将请求失败返回给 SOAP 客户机。但是若此项服务可以提供,控制权由服务管理器转移给 XML 转换程序(转换程序完成合适语言的转换并访问实际服务实现)。服务实现会处理请求并将结果返回给 XML 转换程序。XML 转换程序将结果转换成 SOAP 客户机能够理解的 SOAP 响应(XML 文档)。然后又一次用 HTTP 绑定来传输 SOAP 响应。现在让我们看一下 SOAP 与 HTTP 的绑定细节。

 


 

SOAP 与 HTTP 绑定

当您将 SOAP 和 HTTP 绑定在一起或在 HTTP 上操作 SOAP 时,您实际上将 HTTP 报头加到了 SOAP 请求和响应上了。 清单 1是典型 SOAP 请求的结构,而清单 3456都是完整的 HTTP 请求,用来演示如何将 HTTP 报头添加到 清单 1上。相似地, 清单 7是一条完整的 HTTP 响应,针对于来自 清单 2的 SOAP 响应。

无论您何时在 HTTP 上使用 SOAP,Content-Type 字段必须是 text/xml。现在您可以察看 清单 3清单 7的详情。

使用 HTTP 的 SOAP 请求

您可以将 SOAP 和 HTTP 的 POST请求方法连用。为了发送一条 SOAP HTTP 请求,您需要在 HTTP 中提供一个  SOAPAction 报头字段。 SOAPAction 指定了 SOAP 请求的目的。服务器(例如过滤 HTTP 中 SOAP 请求消息的防火墙)可以用字段 SOAPAction 的值来做决定。

HTTP 客户机在发送一条 SOAP HTTP 请求时必须用此报头字段。SOAPAction 可以有如下几种值:SOAPAction:"URI-Reference"
SOAPAction:"filename"
SOAPAction:""
SOAPAction:


清单 3:演示 SOAPAction 报头字段中的 URI 引用


清单 3 在 SOAPAction 中包括如下 URI 引用: www.mobilephoneservice.com/Vendors/MobilePhoneservice#getListOfModels

这个 SOAPAction 展示了两部分内容。第一部分是一个特别 SOAP 部署的地址: www.mobilephoneservice.com/Vendors/MobilePhoneservice

第二部分是一个片段标识符,它给出了我们感兴趣的方法的名字(#getListOfModels)。


清单 4:演示 SOAPAction 报头字段中的一个文件名


清单 4 在 SOAPAction 中包含一个文件名( MobilePhoneservice#getListOfModels )。 MobilePhoneservice 文件必须出现在主机 URI( www.mobilephoneservice.com/Vendors )中。 这个主机 URI 是在 HTTP 报头中 host 字段( www.mobilephoneservice.com )和文件夹名( /Vendors )的结合。


清单 5:演示 SOAPAction 报头中的空字符串


清单 5 在 SOAPAction 中包含一个空字符串("")。空字符串值表明 SOAP 的目的和 Host URI( www.mobilephoneservice.com/Vendors )的目的是一样的。


清单 6:演示无值 SOAPAction 报头


清单 6没有包含 SOAPAction 值。这表明没有关于消息目的的信息。

用 HTTP 的 SOAP 响应

响应将可能是两种类型的 SOAP 响应中的一种:

  • 一个成功的 SOAP 操作产生 SOAP 结果
  • 一个不成功的 SOAP 操作产生一条 SOAP 错误消息


清单 7:一条带有 HTTP 报头的成功 SOAP 响应


清单 7是第一种情况,在此可以从 SOAP 服务器取得有意义的结果。

清单 8是一条典型的 SOAP 错误消息。SOAP HTTP 响应遵循 HTTP 中通信状态信息的 HTTP 状态码的语义。若在处理一条请求时发生一个 SOAP 错误,SOAP HTTP 服务器必须发出一条 HTTP 500 "Internal Server Error" 响应,同时在响应中包括一条带有 SOAP 出错元素的 SOAP 消息。


清单 8:一条带有 HTTP 报头的典型 SOAP 错误消息



 

使用电子邮件的 SOAP

HTTP 不是唯一绑定 SOAP 消息的解决方案。若 HTTP 不合适,您可以用诸如 SMTP 的其它机制来用于 SOAP 绑定。将 SOAP 和 SMTP 绑定,您可以建立一条单向传输路由。两条单向消息可以用来建立请求/响应通信。 用 SMTP 来发送一条 SOAP 消息,您需要遵从以下步骤:

  • 使用 MIME-Version 报头字段
    MIME-Version用一个版本号来区别不同的 MIME 版本。它应用邮件处理代理(例如一个 POP 服务器)来区别旧版本和新版本所生成的邮件消息。请参阅 清单 9,它使用了一个 MIME-Version 报头字段。

    清单 9:一个使用电子邮件的 SOAP 示例


  • 使用 Content-Type 报头字段:
    Content-Type用来标识消息主体中的数据类型。对于 SOAP 消息 Content-Type 应该有一个值“text/xml”。请参阅 清单 9,它使用了 Content-Type。
  • 使用 Content-Transfer-Encoding 字段:
    Content-Transfer-Encoding 用来指定传输编码的类型,也就是您所要传输的数据是字符格式还是二进制格式。 清单 9使用 Quoted-Printable 编码,这种编码符合依照 ASCII 字符集的可打印字符。这种对数据的编码方式使邮件传输代理不可能修改结果八位元。请参阅 清单 9,它使用了 Content-Transfer-Encoding 。

 


 

SOAP 模式与实现

SOAP 消息

一条 SOAP 消息只是一个 XML 文档,由一个强制性的 SOAP Envelope 组成,SOAP Envelope 有一个可选的 SOAP Header 和一个必须有的 SOAP Body。

SOAP 模式的元素:

  • Envelope
  • Header
  • Body
  • Fault

Envelope:
Envelope 是表示一条 SOAP 消息的顶层元素。为了发送一条 SOAP 消息,必须包括此元素。Envelope 使用必要的 SOAP 名称空间标识符( http://schemas.xmlsoap.org/soap/envelope/ )。若 Envelope 包含了错误的名称空间,会产生一个关于 Envelope 名称空间版本的错误。 清单 10是一个空 Envelope。称其为“空 Envelope”是为了强调在通过“投递”发出它之前,它最终应该包含一封“信”(也许是商业信)。SOAP 模式中的“信”就是指“SOAP Body”,HTTP POST(在 HTTP 与 SOAP 的绑定一部分讨论过)就是传输机制。


清单 10:一个空 SOAP Envelope

Header:
SOAP Header 是可选的。您可以直接将 SOAP Body 放到 SOAP Envelope 中并完全忽略报头。报头提供了一个扩展 SOAP 消息功能的机制。例如,认证就是由 SOAP Header 条目所提供的一种典型扩展。在此情况下,将有一个认证框架,它会使用 SOAP 作为更低级别的传输。请参阅 清单 11来查看在 SOAP 中的报头实现。


清单 11:在一个 SOAP Envelope 中的报头实现

Body:
Body 元素包含您实际要发送的消息。它是一个强制性的元素且其子元素通常属于一个用户定义的名称空间。 清单 12 展示了一条引用一个用户定义的名称空间 “u” 的 SOAP 消息。Body 元素是必要信息的容器。这个元素必须在 SOAP 消息中出现并且必须是 SOAP Envelope 元素的一个直接子元素。它也必须直接跟在 SOAP Header 元素的后面。若没有 Header 元素,那么它应直接跟在 Envelope 元素的后面。主体可以包含子元素并且子元素可能是受限于名称空间的。


清单 12: SOAP Envelope 内有 Header,还有 Body

Fault:
这个元素表明一条错误消息。它应作为一个主体条目出现并且不能在 Body 元素中出现一次以上。通常,Fault 元素会在一条 SOAP 响应消息中出现,以表明在 SOAP 请求中出现错误。

Fault 的子元素:

  • faultcode (错误的标识)
  • faultstring (错误的描述)
  • faultactor (标识由谁导致的错误)
  • detail (错误细节。通常是一个应用程序特定错误,也就是说,它相当于在 SOAP 请求主体中用到地用户定义的名称空间)

清单 13是一条典型的错误消息。


清单 13: 当应用程序出现错误时,SOAP Fault 的使用



 

来自第 1 部分的一条对 WSDL 文件的 SOAP 请求

已经解释了 SOAP 消息(请求和响应)的常规语法,我将展示如何对本系列 第 1 部分中的 MobilePhoneservice 开发一条 SOAP 请求。在第 1 部分中您设计一个完整的 WSDL 接口来解释 MobilPhoneservice。移动公司在 MobilePhoneservice 中提供了两种方法,一种是 getListOfModels() ,另一种是 getPrice(modelNumber)GetListOfModels() 没有参数但是返回手机型号的一张列表,而 getPrice(modelNumber) 有一个参数 modelNumber 并返回需求型号的 price 。您将用 SOAP 请求格式对它作成文档,但是首先让我展示给您一般的 SOAP 请求和响应格式。


清单 14:SOAP 请求的一般格式


一条简单的 SOAP 请求或响应只能表明一种服务的一个方法。包含一条 SOAP 请求的 Envelope 的一般格式遵从 清单 14。将这种一般格式与 清单 16 中的 getListOfModels() 的方法调用请求比较。在清单 16 中,我已经提供了方法和 URI 的名称。既然在 getListOfModels() 中不需要参数,所以 <m:getListOfModels>清单 16中是一个空元素。


清单 15:一条 SOAP 响应的一般格式


清单 15 是一条一般的 SOAP 响应。Apache SOAP 服务器在方法名称的后面增加了"Response"关键字并将返回值封入元素 <return> 中作为一个直接子方法元素。若返回值是复合型结构,那么 <return> 元素包含一个或多个 <item> 元素。将 清单 15清单 17 相比,清单 17 是来自 getListOfModels() 的实际响应。 清单 17包含一系列项目,作为 Vector 数据类型,它是返回参数。 相似地, 清单 1819 展示了针对 MobilePhoneservice 的方法 getPrice() 的 SOAP 请求和响应。


清单 16:调用 getListOfModels() 方法的 SOAP 请求




清单 17:针对于来自清单 16 请求的 SOAP 响应



清单 18:对于 getPrice 方法的 SOAP 请求



清单 19:对于来自清单 18 请求的 SOAP 响应


 

在 SOAP 服务器上部署基于 WSDL 的服务

在此部分您将在 Apache SOAP 服务器上部署来自第 1 部分的 WSDL 服务。Apache SOAP 工具箱将 WSDL 服务信息保存在一个部署描述符文件里面。部署描述符包含了 WSDL 服务的名称和它拥有的所有方法。在运行时部署描述符会将这些名称提供给 SOAP 服务器。同样的部署描述符文件还包含了实现接口的 JavaBean 组件的地址。


清单 20:一个部署描述符的框架


清单 20是一个部署描述符的框架,为了作为基于 WSDL 服务的部署描述符使用,它需要三项信息( URN:SERVICE-URN、EXPOSED-METHODSIMPLEMENTING-CLASS)。 URN:SERVICE-URN 是被部署服务的名称。在此例中它是 “urn:MobilePhoneservice”EXPOSED-METHODS 是一个单空格分隔的由服务提供的方法的列表。 在此部署中它是 getListOfModels getPrice

IMPLEMENTING-CLASS 是带有全路径的 Java 类名称。例如, samples.phonequote.MobilePhoneservice 。 在此例中测试应用程序时,您有如下目录结构:
Apache SOAP 服务器: C:/foo/SOAP-2_2
Mobile phone 服务实现:
C:/foo/SOAP-2_2/samples/phonequote/MobilePhoneservice

因此,IMPLEMENTING-CLASS 路径请参照您安装 SOAP 工具箱的目录。 我没有提供 Java 类的实际实现。 它取决于业务逻辑并且可以是任何东西。


清单 21:MobilePhoneservice 的部署描述符


清单 21是来自第 1 部分对 WSDL 文件的完整部署描述符。



 

SOAP 客户机与 SOAP 服务器的通信

我已经提供过一个应用程序样本来演示一台 SOAP 客户机与一台 SOAP 服务器的通信。 为此我给过三个列表:Startup.html( 清单 22)、Operation.html( 清单 23)和 Execute.jsp( 清单 24)。

StartUp.html( 清单 22)是一个简单的 HTML 文件,提供给用户一个 GUI 并询问他将要调用哪一个 SOAP 方法。用户会选择一个他需要的方法。


清单 22:一个作为前端的简单 HTML 页


Operation.html( 清单 23)将询问客户提供方法调用所需的参数。


清单 23:根据他或她所选择的方法给予客户一个 GUI


Execute.jsp( 清单 24)包含了所有的令人感兴趣的代码。它检测所调用的方法和所传递的参数。然后发送给远程服务器一个方法调用。


清单 24:检测方法并发送给远程服务器一个调用


为了运行此应用程序,您需要两台 Apache SOAP 服务器。 一台服务器将用来与用户通信并托管 清单 222324。 另一台服务器(也称为远程服务器)就是我们需要部署第 1 部分所讲的基于 WSDL 服务的地方(在前一节描述,“ 在 SOAP 服务器上基于 WSDL 服务的部署”)。 仅仅是为了演示,远程服务器的地址 http://localhost:8080/soap/servlet/rpcrouter 已经硬编码在 Execute.jsp( 清单 24)中。在实际操作中您可以从 WSDL 文件中读取它。

 


 

SOAP 中的简单与复合数据类型

在此节中,我将从解释简单与复合数据类型的不同开始。然后展示如何在 SOAP 中对它们编码。

简单类型包括字符串、浮点数、整数、枚举等。 例如一部手机的“name”的数据类型就是 “string” 。 复合类型由简单类型组成但只代表一个实体。例如, “Student” 类型记录可以有不同的属性,如 “studentName” 属于类型 “string”“studentRollNumber” 属于类型 “int” 但都只代表一个实体 “Student”

清单 25 包含了一个名称为 “Mobile” 的复合数据类型。 您会在后面的 SOAP 请求中用到。


清单 25: “Mobile”类型的模式定义结构

清单 25 中的第 5 行展示了我们的类型名称(Mobile),而第 6 行说明它是复合数据类型。因复合数据类型有属性,所以在第 7 行到第 12 行展示了定义为子元素的 “Mobile” 数据类型的属性。

第 7 行声明的元素展示了 “Mobile” 类型有一个名称为 “modelNumber” 的属性且其类型为 “int” (也就是说, “modelNumber” 只能采用整数值)。 类似的,第 9 行和第 10 行声明的元素具有同样的类型但有不同的属性名称。在第 8 行定义的元素具有名称为 “modelName” 的属性且其类型是 “string”

第 11 行的元素因有位于第 12 行的、名称为 “simpleType” 的子元素,所以需要更好的理解。这里您在复合类型 Mobile 中定义了一个简单类型。simpleType 的名称为 “modelColor” 且它的类型是 “enumeration” 。它有一个属性 “base” 具有的值为 "xsd:string" ,这表明简单类型 “modelColor” 具有在 SOAP 模式中定义的类型 “string” 的功能。在第 13 行到第 17 行中的每一个 <enumeration> 标记都具有一个属性: “value”"white" "blue""black""red""pink" )。 枚举类型使我们能够从多项选项中选择一个值。

 


 

在 SOAP 请求中使用复合数据类型

清单 26 演示了在 SOAP 请求中复合类型的使用。 它展示了一个在 Body 元素中的携带请求的 Envelope,在 Body 元素中,您正调用 “m” 名称空间的 addModel 方法。 清单 26 使用数据类型 “Mobile” ,此数据类型在 清单 25中定义。

AddModel 方法携带一个类型为 “Mobile” 的参数。我们以 “msd” 名称空间引用来引用 “Mobile” 结构。请参阅清单 26 的 <SOAP-ENV:Envelope> 元素中的 "xmlns:msd" 声明。 这是一个在 SOAP 请求中使用用户定义数据类型的示例。


清单 26:实现在清单 25 中定义的“Mobile”结构



 

总结

在这一部分中,您已经学习了 SOAP 语法、请求、响应、HTTP 绑定和使用电子邮件的 SOAP 使用。您也了解了服务于 Apache SOAP 客户机的 Apache SOAP 服务器。最后,我简述了用户定义数据类型的主题,它是一个需要我们仔细学习的高级主题。在此系列文章的下一部分,您会学习更多的用户定义数据类型示例。我还会检验 SOAP 的互操作性(也就是说,怎样使来自不同供应商的 SOAP 实现相互协调)。

 


 

参考资料

 


 

关于作者

Bilal Siddiqui 是一位 XML 顾问。自 1995 年毕业于 Lahore 工程技术大学电子工程专业后,他开始为工业控制系统设计软件解决方案。后来他转到了 XML 并用自己 C++ 的编程经验来构建基于 Web 和 WAP 的 XML 处理工具、服务器端的解析解决方案和服务应用程序。您可以通过 wap_monster@yahoo.com发电子邮件给 Bilal 来索取本文中包含的代码文件的拷贝。

  

相关文章推荐

一、SOAP简单对象访问协议讲解

首先,让我来简单一下入门SOAP所需的知识点。   一、基本概念 ⊿SOAP:(Simple Object Access Protocol) 简单对象访问协议。 ⊿SOAP是一...

简单对象访问协议(SOAP)介绍

简单对象访问协议(SOAP)介绍SOAP 摘要简单对象访问协议 (SOAP) 通过一种基于XML的、和平台无关的方法规划网站,从而提高Internet的交互性。绪论 Internet正在从根本上改变着...

简单对象访问协议(SOAP)介绍

简单对象访问协议(SOAP)介绍SOAP 摘要简单对象访问协议 (SOAP) 通过一种基于XML的、和平台无关的方法规划网站,从而提高Internet的交互性。绪论 Internet正在从根本上改变着...

一、SOAP简单对象访问协议讲解

首先,让我来简单一下入门SOAP所需的知识点。   一、基本概念 ⊿SOAP:(Simple Object Access Protocol) 简单对象访问协议。 ⊿SOAP是一...

SOAP简单对象访问协议

同义词 SOAP(简单对象访问协议)一般指简单对象访问协议 本词条由“科普中国”百科科学词条编写与应用工作项目 审核 。 简单对象访问协议是交换数据的一种协议规范,是一种轻量的、简...

SOAP:简单对象访问协议

  • 2008年08月27日 22:27
  • 51KB
  • 下载

简单对象访问协议(SOAP)初级指南

  • 2011年05月13日 21:08
  • 50KB
  • 下载

soap简单对象访问协议

简单对象访问协议是交换数据的一种协议规范,是一种轻量的、简单的、基于XML(标准通用标记语言下的一个子集)的协议,它被设计成在WEB上交换结构化的和固化的信息。 webService三要...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:简单对象访问协议(SOAP)
举报原因:
原因补充:

(最多只允许输入30个字)