WebService学习笔记之SOAP

语法规则

必须用 XML 来编码
必须使用 SOAP Envelope 命名空间
必须使用 SOAP Encoding 命名空间
不能包含 DTD 引用
不能包含 XML 处理指令

Envelope 元素

SOAP 消息的根元素，前4行应当始终是：

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

Header 元素

包含有关 SOAP 消息的应用程序专用信息（比如认证、支付等）。
Header 元素出现的场合必须是 Envelope 元素的第一个子元素。
Header 元素的直接子元素必须是合格的命名空间。

actor 属性

被用于将 Header 元素寻址到一个特定的端点。

mustUnderstand 属性

标识标题项对于要对其进行处理的接收者来说是强制的还是可选的。
如果Header 元素的某个子元素含有”mustUnderstand=”1”，则处理此头部的接收者必须认可此元素。假如此接收者无法认可此元素，则在处理此头部时必须失效。

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>

p.s.上面的 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 在默认的命名空间中定义了 Body 元素内部的元素-Fault 元素，
用于存留 SOAP 消息的错误和状态信息。
在一条 SOAP 消息中，Fault 元素只能出现一次。

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

Fault 代码

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

SOAP实例

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

请求：

POST /InStock HTTP/1.1
Host: www.example.org
Content-Type: application/soap+xml; charset=utf-8
Content-Length: nnn

<?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 xmlns:m="http://www.example.org/stock">
    <m:GetStockPrice>
      <m:StockName>IBM</m:StockName>
    </m:GetStockPrice>
  </soap:Body>

</soap:Envelope>

响应：

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: nnn

<?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 xmlns:m="http://www.example.org/stock">
    <m:GetStockPriceResponse>
      <m:Price>34.5</m:Price>
    </m:GetStockPriceResponse>
  </soap:Body>

</soap:Envelope>