Soap基础 - littleboy12580/learning_python GitHub Wiki

概念

SOAP 是基于 XML 的简易协议，可使应用程序在 HTTP 之上进行信息交换，即SOAP 是用于访问网络服务的协议

结构

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

  1. 必需的 Envelope 元素，可把此 XML 文档标识为一条 SOAP 消息
  2. 可选的 Header 元素，包含头部信息
  3. 必需的 Body 元素，包含所有的调用和响应信息
  4. 可选的 Fault 元素，提供有关在处理此消息所发生错误的信息

语法

下面是SOAP一些重要的语法规则：

  1. SOAP 消息必须用 XML 来编码
  2. SOAP 消息必须使用 SOAP Envelope 命名空间
  3. SOAP 消息必须使用 SOAP Encoding 命名空间
  4. SOAP 消息不能包含 DTD 引用
  5. SOAP 消息不能包含 XML 处理指令

一个SOAP 消息的实例基本结构如下代码所示：

<?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">

<soap:Header>
  ...
  ...
</soap:Header>

<soap:Body>
  ...
  ...
  <soap:Fault>
    ...
    ...
  </soap:Fault>
</soap:Body>

</soap:Envelope>

Envelope 元素

Envelope 元素是 SOAP 消息的根元素，它可把 XML 文档定义为 SOAP 消息；与此对应的SOAP消息中需要有xmlns:soap 命名空间，其值为xmlns:soap="http://www.w3.org/2001/12/soap-envelope；
SOAP 的 encodingStyle 属性用于定义在文档中使用的数据类型。此属性可出现在任何 SOAP 元素中，并会被应用到元素的内容及元素的所有子元素上。SOAP 消息没有默认的编码方式

Header元素

可选的 SOAP Header 元素可包含有关 SOAP 消息的应用程序专用信息（比如认证、支付等）。如果 Header 元素被提供，则它必须是 Envelope 元素的第一个子元素；所有 Header 元素的直接子元素必须是合格的命名空间；
SOAP 在默认的命名空间中 ("http://www.w3.org/2001/12/soap-envelope") 定义了三个属性。这三个属性是：actor、 mustUnderstand 以及 encodingStyle。这些被定义在 SOAP 头部的属性可定义容器如何对 SOAP 消息进行处理。

actor 属性

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

<?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">

<soap:Header>
<m:Trans
xmlns:m="http://www.w3school.com.cn/transaction/"
soap:actor="http://www.w3school.com.cn/appml/">
234
</m:Trans>
</soap:Header>

...
...

</soap:Envelope>

mustUnderstand 属性

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

<?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">

<soap:Header>
<m:Trans
xmlns:m="http://www.w3school.com.cn/transaction/"
soap:mustUnderstand="1">
234
</m:Trans>
</soap:Header>

...
...

</soap:Envelope>

Body 元素

SOAP Body 元素可包含打算传送到消息最终端点的实际 SOAP 消息；SOAP Body 元素的直接子元素可以是合格的命名空间
一个SOAP请求如下所示

<?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">

<soap:Body>
   <m:GetPrice xmlns:m="http://www.w3school.com.cn/prices">
      <m:Item>Apples</m:Item>
   </m:GetPrice>
</soap:Body>

</soap:Envelope>

上面的 m:GetPrice 和 Item 元素是应用程序专用的元素，它们并不是 SOAP 标准的一部分
该请求对应的响应类似如下代码

<?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">

<soap:Body>
   <m:GetPriceResponse xmlns:m="http://www.w3school.com.cn/prices">
      <m:Price>1.90</m:Price>
   </m:GetPriceResponse>
</soap:Body>

</soap:Envelope>

Fault元素

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

SOAP 的 Fault 元素拥有下列子元素：

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

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

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

SOAP HTTP Binding

SOAP 方法指的是遵守 SOAP 编码规则的 HTTP 请求/响应。
HTTP + XML = SOAP
SOAP 请求可能是 HTTP POST 或 HTTP GET 请求。
HTTP POST 请求规定至少两个 HTTP 头：Content-Type 和 Content-Length
SOAP 的请求和响应的 Content-Type 头可定义消息的 MIME 类型，以及用于请求或响应的 XML 主体的字符编码（可选）； Content-Length 头规定请求或响应主体的字节数

POST /item HTTP/1.1
Content-Type: application/soap+xml; charset=utf-8
Content-Length: 250
⚠️ **GitHub.com Fallback** ⚠️