SOAP

SOAP（原为Simple Object Access Protocol的首字母缩写，即简单对象访问协议）是交换数据的一种协议规范。

特点：

  • SOAP 指简易对象访问协议
  • SOAP 是一种通信协议
  • SOAP 用于应用程序之间的通信
  • SOAP 是一种用于发送消息的格式
  • SOAP 被设计用来通过因特网进行通信
  • SOAP 独立于平台
  • SOAP 独立于语言
  • SOAP 基于 XML
  • SOAP 很简单并可扩展
  • SOAP 允许您绕过防火墙

  • SOAP 将被作为 W3C 标准来发展

    相关定义

  • 基于类对象的传输协议。

  • SOAP封装（envelop），它定义了一个框架，描述消息中的内容是什么，是谁发送的，谁应当接受并处理它以及如何处理它们；
  • SOAP编码规则（encoding rules），它定义了一种序列化机制，用于表示应用程序需要使用的数据类型的实例；
  • SOAP RPC表示（RPC representation），它定了一个协定，用于表示远程过程调用和应答；
  • SOAP绑定（binding），它定义了SOAP使用哪种协议交换信息。使用HTTP/TCP/UDP协议都可以。

把SOAP绑定到HTTP提供了同时利用SOAP的样式和分散的灵活性的特点以及HTTP的丰富的特征库的优点。在HTTP上传送SOAP并不是说SOAP会覆盖现有的HTTP语义，而是HTTP上的SOAP语义会自然的映射到HTTP语义。在使用HTTP作为协议绑定的场合中，RPC请求映射到HTTP请求上，而RPC应答映射到HTTP应答。然而，在RPC上使用SOAP并不仅限于HTTP协议绑定。

历史

SOAP是“Simple Object Access Protocol”的缩写。
最新版本SOAP 1.2版在2003年6月24日成为W3C的推荐版本。
SOAP由Dave Winer, Don Box，Bob Atkinson, Mohsen Al-Ghosein于1998年设计，当时只作为一种对象访问协议。SOAP规范由 万维网联盟的 XML工作组维护。

四个部分

1. 封装 envelop

它定义了一个框架 , 该框架描述了消息中的内容是什么，谁应当处理它以及它是可选的还是必须的。

2. 编码规则 encoding rules

它定义了一种序列化的机制，用于交换应用程序所定义的数据类型的实例。

3. RPC表示 RPC representation

它定义了用于表示远程过程调用和应答的协定。

4. 绑定 binding

定义了一种使用底层传输协议来完成在节点间交换SOAP封装的约定。

SOAP消息基本上是从发送端到接收端的单向传输，但它们常常结合起来执行类似于请求 / 应答的模式。所有的 SOAP消息都使用 XML 编码。一条 SOAP消息就是一个包含有一个必需的 SOAP 的封装包，一个可选的 SOAP 标头和一个必需的 SOAP 体块的 XML 文档。把 SOAP 绑定到 HTTP 提供了同时利用 SOAP 的样式和分散的灵活性的特点以及 HTTP 的丰富的特征库的优点。在HTTP上传送 SOAP 并不是说 SOAP 会覆盖现有的 HTTP 语义，而是 HTTP 上的 SOAP 语义会自然的映射到 HTTP 语义。在使用 HTTP 作为协议绑定的场合中， RPC 请求映射到 HTTP 请求上，而 RPC 应答映射到 HTTP 应答。然而，在 RPC 上使用 SOAP 并不仅限于 HTTP 协议绑定。SOAP也可以绑定到TCP和UDP协议上。

语法规则

构建模块

一条 SOAP 消息就是一个普通的 XML 文档，包含下列元素：

  • 必需的 Envelope 元素，可把此 XML 文档标识为一条 SOAP 消息
  • 可选的 Header 元素，包含头部信息
  • 必需的 Body 元素，包含所有的调用和响应信息

  • 可选的 Fault 元素，提供有关在处理此消息所发生错误的信息

    语法规则

    这里是一些重要的语法规则：

  • SOAP 消息必须用 XML 来编码

  • SOAP 消息必须使用 SOAP Envelope 命名空间
  • SOAP 消息必须使用 SOAP Encoding 命名空间
  • SOAP 消息不能包含 DTD 引用
  • SOAP 消息不能包含 XML 处理指令

    消息基本结构

    ```xml <?xml version=”1.0”?>soap:Envelope xmlns:soap="http://www.w3.org/2001/12/soap-envelope" soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding"

…

… … 

  1. <a name="utiv5"></a>
  2. ## 核心技术
  3. SOAP采用了已经广泛使用的两个协议:HTTP 和XML（标准通用标记语言下的一个子集）。HTTP用于实现 SOAP 的RPC 风格的传输, 而XML 是它的编码模式。采用几行代码和一个XML 解析器, HTTP 服务器( MS 的 IIS 或 Apache) 立刻成为SOAP 的 ORBS。SOAP 通讯协议使用 HTTP 来发送XML 格式的信息。HTTP与RPC 的协议很相似,它简单、 配置广泛,并且对防火墙比其它协议更容易发挥作用。HTTP 请求一般由 Web 服务器软件(如 IIS 和Apache)来处理, 但越来越多的应用服务器产品正在支持HTTP。XML 作为一个更好的网络数据表达方式( NDR)。SOAP 把 XML 的使用代码化为请求和响应参数编码模式, 并用HTTP 作传输。具体地讲, 一个SOAP 方法可以简单地看作遵循SOAP编码规则的HTTP请求和响应, 一个 SOAP终端则可以看作一个基于HTTP 的URL, 它用来识别方法调用的目标。像CORBA/ IIOP一样, SOAP不需要具体的对象绑定到一个给定的终端, 而是由具体实现程序来决定怎样把对象终端标识符映像到服务器端的对象。
  5. <a name="e1e9e8d8"></a>
  6. # SOAP Envelope 元素
  8. ---
  10. 强制使用的 SOAP 的 Envelope 元素是 SOAP 消息的根元素。
  12. ---
  14. <a name="e1e9e8d8-1"></a>
  15. ## SOAP Envelope 元素
  16. 必需的 SOAP 的 Envelope 元素是 SOAP 消息的根元素。它可把 XML 文档定义为 SOAP 消息。
  17. <a name="480c216f"></a>
  18. ### 实例
  19. ```xml
  20. <?xml version="1.0"?>
  21. <soap:Envelope
  22. xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
  23. soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
  24.   ...
  25.   Message information goes here
  26.   ...
  27. </soap:Envelope>

xmlns:soap 命名空间

SOAP 消息必须拥有与命名空间 “http://www.w3.org/2001/12/soap-envelope“ 相关联的一个 Envelope 元素。
如果使用了不同的命名空间，应用程序会发生错误，并抛弃此消息。

encodingStyle 属性

SOAP 的 encodingStyle 属性用于定义在文档中使用的数据类型。此属性可出现在任何 SOAP 元素中，并会被应用到元素的内容及元素的所有子元素上。
SOAP 消息没有默认的编码方式。

语法

  1. soap:encodingStyle="URI"

实例

  1. <?xml version="1.0"?>
  2. <soap:Envelope
  3. xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
  4. soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
  5.   ...
  6.   Message information goes here
  7.   ...
  8. </soap:Envelope>

SOAP Header 元素

可选的 SOAP Header 元素包含头部信息。

SOAP Header 元素

可选的 SOAP Header 元素可包含有关 SOAP 消息的应用程序专用信息（比如认证、支付等）。
如果 Header 元素被提供，则它必须是 Envelope 元素的第一个子元素。
注意： 所有 Header 元素的直接子元素必须是合格的命名空间。

  1. <?xml version="1.0"?>
  2. <soap:Envelope
  3. xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
  4. soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
  5. <soap:Header>
  6.   <m:Trans xmlns:m="http://www.w3schools.com/transaction/" soap:mustUnderstand="1">
  7.     234
  8.   </m:Trans>
  9. </soap:Header>
  10. ...
  11. ...
  12. </soap:Envelope>

上面的例子包含了一个带有一个 “Trans” 元素的头部，它的值是 234，此元素的 “mustUnderstand” 属性的值是 “1”。
SOAP 在默认的命名空间中 (“http://www.w3.org/2001/12/soap-envelope“) 定义了三个属性。
这三个属性是：actor、 mustUnderstand 以及 encodingStyle。这些被定义在 SOAP 头部的属性可定义容器如何对 SOAP 消息进行处理。

mustUnderstand 属性

SOAP 的 mustUnderstand 属性可用于标识标题项对于要对其进行处理的接收者来说是强制的还是可选的。
假如您向 Header 元素的某个子元素添加了 “mustUnderstand=”1”，则它可指示处理此头部的接收者必须认可此元素。假如此接收者无法认可此元素，则在处理此头部时必须失效。

语法

  1. soap:mustUnderstand="0|1"

实例

  1. <?xml version="1.0"?>
  2. <soap:Envelope
  3. xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
  4. soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
  5. <soap:Header>
  6.   <m:Trans xmlns:m="http://www.w3schools.com/transaction/"
  7.   soap:mustUnderstand="1">234
  8.   </m:Trans>
  9. </soap:Header>
  10. ...
  11. ...
  12. </soap:Envelope>

actor 属性

通过沿着消息路径经过不同的端点，SOAP 消息可从某个发送者传播到某个接收者。并非 SOAP 消息的所有部分均打算传送到 SOAP 消息的最终端点，不过，另一个方面，也许打算传送给消息路径上的一个或多个端点。
SOAP 的 actor 属性可被用于将 Header 元素寻址到一个特定的端点。

语法

  1. soap:actor="URI"

实例

  1. <?xml version="1.0"?>
  2. <soap:Envelope
  3. xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
  4. soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
  5. <soap:Header>
  6.   <m:Trans xmlns:m="http://www.w3schools.com/transaction/"
  7.   soap:actor="http://www.w3schools.com/appml/">234
  8.   </m:Trans>
  9. </soap:Header>
  10. ...
  11. ...
  12. </soap:Envelope>

encodingStyle 属性

SOAP 的 encodingStyle 属性用于定义在文档中使用的数据类型。此属性可出现在任何 SOAP 元素中，并会被应用到元素的内容及元素的所有子元素上。
SOAP 消息没有默认的编码方式。

语法

  1. soap:encodingStyle="URI"

SOAP Body 元素

强制使用的 SOAP Body 元素包含实际的 SOAP 消息。

SOAP Body 元素

必需的 SOAP Body 元素可包含打算传送到消息最终端点的实际 SOAP 消息。
SOAP Body 元素的直接子元素可以是合格的命名空间。

实例

  1. <?xml version="1.0"?>
  2. <soap:Envelope
  3. xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
  4. soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
  5. <soap:Body>
  6.   <m:GetPrice xmlns:m="http://www.w3schools.com/prices">
  7.     <m:Item>Apples</m:Item>
  8.   </m:GetPrice>
  9. </soap:Body>
  10. </soap:Envelope>

上面的例子请求苹果的价格。请注意，上面的 m:GetPrice 和 Item 元素是应用程序专用的元素。它们并不是 SOAP 标准的一部分。
而一个 SOAP 响应应该类似这样：

  1. <?xml version="1.0"?>
  2. <soap:Envelope
  3. xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
  4. soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
  5. <soap:Body>
  6.   <m:GetPriceResponse xmlns:m="http://www.w3schools.com/prices">
  7.     <m:Price>1.90</m:Price>
  8.   </m:GetPriceResponse>
  9. </soap:Body>
  10. </soap:Envelope>

SOAP Fault 元素

SOAP Fault 元素用于存留 SOAP 消息的错误和状态信息。

SOAP Fault 元素

可选的 SOAP Fault 元素用于指示错误消息。
如果已提供了 Fault 元素，则它必须是 Body 元素的子元素。在一条 SOAP 消息中，Fault 元素只能出现一次。
SOAP 的 Fault 元素拥有下列子元素：

子元素 描述
供识别故障的代码
可供人阅读的有关故障的说明
有关是谁引发故障的信息
存留涉及 Body 元素的应用程序专用错误信息

SOAP Fault 代码

在下面定义的 faultcode 值必须用于描述错误时的 faultcode 元素中：

错误 描述
VersionMismatch SOAP Envelope 元素的无效命名空间被发现
MustUnderstand Header 元素的一个直接子元素（带有设置为 “1” 的 mustUnderstand 属性）无法被理解。
Client 消息被不正确地构成，或包含了不正确的信息。
Server 服务器有问题，因此无法处理进行下去。

SOAP HTTP 协议

HTTP 协议

HTTP 在 TCP/IP 之上进行通信。HTTP 客户机使用 TCP 连接到 HTTP 服务器。在建立连接之后，客户机可向服务器发送 HTTP 请求消息：

  1. POST /item HTTP/1.1
  2. Host: 189.123.255.239
  3. Content-Type: text/plain
  4. Content-Length: 200

随后服务器会处理此请求，然后向客户机发送一个 HTTP 响应。此响应包含了可指示请求状态的状态代码：

  1. 200 OK
  2. Content-Type: text/plain
  3. Content-Length: 200

在上面的例子中，服务器返回了一个 200 的状态代码。这是 HTTP 的标准成功代码。
假如服务器无法对请求进行解码，它可能会返回类似这样的信息：

  1. 400 Bad Request
  2. Content-Length: 0

SOAP HTTP Binding

SOAP 方法指的是遵守 SOAP 编码规则的 HTTP 请求/响应。

HTTP + XML = SOAP

SOAP 请求可能是 HTTP POST 或 HTTP GET 请求。
HTTP POST 请求规定至少两个 HTTP 头：Content-Type 和 Content-Length。

Content-Type

SOAP 的请求和响应的 Content-Type 头可定义消息的 MIME 类型，以及用于请求或响应的 XML 主体的字符编码（可选）。

语法

  1. Content-Type: MIMEType; charset=character-encoding

实例

  1. POST /item HTTP/1.1
  2. Content-Type: application/soap+xml; charset=utf-8

Content-Length

SOAP 的请求和响应的 Content-Length 头规定请求或响应主体的字节数。

语法

  1. Content-Length: bytes

实例

  1. POST /item HTTP/1.1
  2. Content-Type: application/soap+xml; charset=utf-8
  3. Content-Length: 250

SOAP 实例

一个 SOAP 实例

在下面的例子中，一个 GetStockPrice 请求被发送到了服务器。此请求有一个 StockName 参数，而在响应中则会返回一个 Price 参数。此功能的命名空间被定义在此地址中： “http://www.example.org/stock“

SOAP 请求：

  1. POST /InStock HTTP/1.1
  2. Host: www.example.org
  3. Content-Type: application/soap+xml; charset=utf-8
  4. Content-Length: nnn
  5. <?xml version="1.0"?>
  6. <soap:Envelope
  7. xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
  8. soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
  9. <soap:Body xmlns:m="http://www.example.org/stock">
  10.   <m:GetStockPrice>
  11.     <m:StockName>IBM</m:StockName>
  12.   </m:GetStockPrice>
  13. </soap:Body>
  14. </soap:Envelope>

SOAP 响应：

  1. HTTP/1.1 200 OK
  2. Content-Type: application/soap+xml; charset=utf-8
  3. Content-Length: nnn
  4. <?xml version="1.0"?>
  5. <soap:Envelope
  6. xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
  7. soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
  8. <soap:Body xmlns:m="http://www.example.org/stock">
  9.   <m:GetStockPriceResponse>
  10.     <m:Price>34.5</m:Price>
  11.   </m:GetStockPriceResponse>
  12. </soap:Body>
  13. </soap:Envelope>

优点

  1. 可扩展的。SOAP 无需中断已有的应用程序, SOAP 客户端、 服务器和协议自身都能发展。而且SOAP 能极好地支持中间介质和层次化的体系结构。
  2. 简单的。客户端发送一个请求,调用相应的对象, 然后服务器返回结果。这些消息是XML 格式的,并且封装成符合HTTP 协议的消息。因此,它符合任何路由器、 防火墙或代理服务器的要求。
  3. 完全和厂商无关。SOAP可以相对于平台、 操作系统、 目标模型和编程语言独立实现。另外,传输和语言绑定以及数据编码的参数选择都是由具体的实现决定的。
  4. 与编程语言无关。SOAP 可以使用任何语言来完成，只要客户端发送正确SOAP 请求( 也就是说, 传递一个合适的参数给一个实际的远端服务器)。SOAP 没有对象模型,应用程序可以捆绑在任何对象模型中。
  5. 与平台无关。SOAP 可以在任何操作系统中无需改动正常运行。