SOAP协议

1​、            什么是SOAP？​

1)        SOAP 指简易对象访问协议

2)        SOAP 是一种通信协议

3)        SOAP 用于应用程序之间的通信

4)        SOAP 是一种用于发送消息的格式

5)        SOAP 被设计用来通过因特网进行通信

6)        SOAP 独立于平台

7)        SOAP 独立于语言

8)        SOAP 基于 XML

9)        SOAP 很简单并可扩展

10)    SOAP 允许您绕过防火墙

11)    SOAP 将被作为 W3C标准来发展

​2、            为什么选择SOAP？​

         对于应用程序开发来说，使程序之间进行因特网通信是很重要的。

目前的应用程序通过使用远程过程调用（RPC）在诸如 DCOM 与 CORBA 等对象之间进行通信，但是 HTTP 不是为此设计的。RPC 会产生兼容性以及安全问题；防火墙和代理服务器通常会阻止此类流量。

通过 HTTP 在应用程序间通信是更好的方法，因为 HTTP 得到了所有的因特网浏览器及服务器的支持。SOAP 就是被创造出来完成这个任务的。

SOAP 提供了一种标准的方法，使得运行在不同的操作系统并使用不同的技术和编程语言的应用程序可以互相进行通信。

​3、            Microsoft 和 SOAP之间的关系？​

SOAP 是微软 .net 架构的关键元素，用于未来的因特网应用程序开发。

​4、            定义​

简单对象访问协议（SimpleObject Access Protocol，SOAP），是一种轻量的、简单的、基于XML的协议，它被设计成在WEB上交换结构化的和固化的信息。 SOAP 可以和现存的许多​​因特网协议​​​和格式结合使用，包括​​超文本​​​​传输协议​​​（HTTP），​​简单邮件传输协议​​​（SMTP），​​多用途网际邮件扩充协议​​​（MIME）。它还支持从​​消息​​​系统到​​远程过程调用​​​（RPC）等大量的​​应用程序​​​。SOAP使用基于XML的​​数据结构​​​和超文本传输协议(HTTP)的组合定义了一个标准的方法来使用Internet上各种不同操作环境中的​​分布式对象​​。

​5、            特点​

Ø  可扩展性

Ø  可以在几乎所有的协议上使用

Ø  独立于平台、独立于语言、允许任何编程模型，并且不依赖与RPC

Ø  是基于XML技术，所以它遵循XML标准，一个SOAP包就是一个XML文档

​6、            SOAP结构​

一条 SOAP 消息就是一个普通的 XML 文档

​语法规则​

1)        SOAP 消息必须用 XML 来编码

2)        SOAP 消息必须使用 SOAPEnvelope 命名空间

3)        SOAP 消息必须使用 SOAPEncoding 命名空间

4)        SOAP 消息不能包含 DTD 引用

5)        SOAP 消息不能包含 XML 处理指令


下面看一个简单的SOAP结构


<?xmlversion=​"1.0"​encoding=​"UTF-8"​?>

<soap:Envelopexmlns:soap=​"http://www.w3.org/2001/12/soap-envelope"​soap:encodingStyle=​"http://www.w3.org/2001/12/soap-encoding"​>

    <soap:Header>

       <tm:Infoxmlns:tm=​"http://www.bccd.com/php/"​soap:mustUnderstand=​"1"​>Tsoft</tm:Info>

    </soap:Header>

    <soap:Bodyxmlns:tm=​"http://bccd.com/PHP"​>

       <tm:PHP_book>

           <tm:Name>PHP</tm:Name>

       </tm:PHP_book>

       <soap:Fault>

           ...

       </soap:Fault>

    </soap:Body>

</soap:Envelope>



这个文档主要由3部分组成：SOAPEnvelope、SOAP Header和SOAP Body。


SOAP Envelope（必须）：可把此 XML文档标识为一条 SOAP消息

                  Envelop（信封、封套），就是说Envelope在SOAP中的最外层，也就是根元素，是SOAP中必须有的元素。

         元素Envelope的命名空间的值必须是​"http://www.w3.org/2001/12/soap-envelope"​否则此SOAP无效。

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

SOAP Header（可选）：包含头部信息

可选的 SOAPHeader 元素可包含有关 SOAP 消息的应用程序专用信息（比如认证、支付等）。如果 Header 元素被提供，则它必须是 Envelope 元素的第一个子元素。


<?xmlversion=​"1.0"​?>

<soap:Envelopexmlns:soap=​"http://www.w3.org/2001/12/soap-envelope"​soap:encodingStyle=​"http://www.w3.org/2001/12/soap-encoding"​>

    <soap:Header>

       <m:Transxmlns:m=​"http://www.w3school.com.cn/transaction/"​

           soap:mustUnderstand=​"1"​>234</m:Trans>

    </soap:Header>

    ...

</soap:Envelope>


上面的例子包含了一个带有一个"Trans" 元素的头部，它的值是 234

mustUnderstand是Header中的一个属性，用于标识标题项对于要进行处理的接收者来说是否必须处理。值等于1表示必须处理；值等于0表示可选。

SOAP 在默认的命名空间中 ("http://www.w3.org/2001/12/soap-envelope") 定义了三个属性。

actor 属性

通过沿着消息路径经过不同的端点，SOAP 消息可从某个发送者传播到某个接收者。并非 SOAP 消息的所有部分均打算传送到 SOAP 消息的最终端点，不过，另一个方面，也许打算传送给消息路径上的一个或多个端点。

SOAP 的 actor 属性可被用于将Header 元素寻址到一个特定的端点。


soap:actor="URI"            // 语法


<soap:Header>

       <m:Transxmlns:m=​"http://www.w3school.com.cn/transaction/"​soap:actor=​"http://www.w3school.com.cn/appml/"​>

           234

       </m:Trans>

    </soap:Header>


mustUnderstand 属性

SOAP 的mustUnderstand 属性可用于标识标题项对于要对其进行处理的接收者来说是强制的还是可选的。

假如您向 Header 元素的某个子元素添加了 "mustUnderstand="1"，则它可指示处理此头部的接收者必须认可此元素。假如此接收者无法认可此元素，则在处理此头部时必须失效。    


soap:mustUnderstand="0|1"     // 语法


<soap:Header>

       <m:Transxmlns:m=​"http://www.w3school.com.cn/transaction/"​soap:mustUnderstand=​"1"​>

           234

       </m:Trans>

    </soap:Header>


encodingStyle 属性

         在SOAPEnvelope中已经解释过了

SOAP Body（必须）：包含所有的调用和响应信息

SOAP Body是Envelope根元素中必要元素，用于错误处理的Fault元素就是属于Body的子元素，它包含了SOAP的消息内容，如果有Header元素，那么Body必须跟在Header元素的后面，如果没有，则Body为Envelope的第一个子元素。


<?xmlversion=​"1.0"​?>

<soap:Envelopexmlns:soap=​"http://www.w3.org/2001/12/soap-envelope"​

    soap:encodingStyle=​"http://www.w3.org/2001/12/soap-encoding"​>


    <soap:Body>

       <m:GetPricexmlns:m=​"http://www.w3school.com.cn/prices"​>

           <m:Item>Apples</m:Item>

       </m:GetPrice>

    </soap:Body>


</soap:Envelope>



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

而一个 SOAP 响应应该类似这样：   


<?xmlversion=​"1.0"​?>

<soap:Envelopexmlns:soap=​"http://www.w3.org/2001/12/soap-envelope"​

    soap:encodingStyle=​"http://www.w3.org/2001/12/soap-encoding"​>


    <soap:Body>

       <m:GetPriceResponsexmlns:m=​"http://www.w3school.com.cn/prices"​>

           <m:Price>1.90</m:Price>

       </m:GetPriceResponse>

    </soap:Body>


</soap:Envelope>



SOAP Fault（可选）：提供有关在处理此消息所发生错误的信息

         Fault元素用于保存SOAP中的错误消息及状态信息，如果有Fault元素，它必须是Body的子元素，并且最多出现一次，Fault元素定义了以下4个子元素。


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


子元素



描述



<faultcode>



供识别故障的代码



<faultstring>



可供人阅读的有关故障的说明



<faultactor>



有关是谁引发故障的信息



<detail>



存留涉及 Body 元素的应用程序专用错误信息，如果Body元素的内容不能被成功解析，则必须包含detail子元素，detail有一条编码规则，一个detail由它的元素全名（包括命名空间）确定



其中faultcode元素提供的故障代码主要有4种。


错误



描述



VersionMismatch



SOAP Envelope 元素的无效命名空间被发现



MustUnderstand



Header 元素的一个直接子元素（带有设置为 "1" 的 mustUnderstand 属性）无法被理解。



Client



消息被不正确地构成，或包含了不正确的信息。



Server



服务器有问题，因此无法处理进行下去。



​7、          SOAP HTTP Binding​


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



POST /item HTTP/1.1

Host: 189.123.345.239

Content-Type: text/plain

Content-Length: 200


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



200 OK

Content-Type: text/plain

Content-Length: 200


在上面的例子中，服务器返回了一个 200 的状态代码。这是 HTTP的标准成功代码。

假如服务器无法对请求进行解码，它可能会返回类似这样的信息：



400 Bad Request
Content-Length: 0


SOAP HTTPBinding

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

HTTP + XML =SOAP

SOAP 请求可能是 HTTPPOST 或 HTTP GET 请求。

HTTP POST 请求规定至少两个 HTTP头：Content-Type 和 Content-Length。

Content-Type

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

语法

Content-Type: MIMEType; charset=character-encoding

例子

POST /item HTTP/1.1

Content-Type: application/soap+xml; charset=utf-8

Content-Length

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

语法

Content-Length: bytes

例子

POST /item HTTP/1.1

Content-Type: application/soap+xml; charset=utf-8

Content-Length: 250


​8、          SOAP 实例​

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

SOAP请求：


POST /InStock HTTP/1.1

Host: www.example.org

Content-Type:

application/soap+xml; charset=utf-8

Content-Length: nnn


<?xmlversion=​"1.0"​?>

<soap:Envelopexmlns:soap=​"http://www.w3.org/2001/12/soap-envelope"​

    soap:encodingStyle=​"http://www.w3.org/2001/12/soap-encoding"​>


    <soap:Bodyxmlns:m=​"http://www.example.org/stock"​>

       <m:GetStockPrice>

           <m:StockName>IBM</m:StockName>

       </m:GetStockPrice>

    </soap:Body>


</soap:Envelope>


SOAP相应：



HTTP/1.1 200 OK

Content-Type: application/soap+xml; charset=utf-8

Content-Length: nnn


<?xmlversion=​"1.0"​?>

<soap:Envelopexmlns:soap=​"http://www.w3.org/2001/12/soap-envelope"​

    soap:encodingStyle=​"http://www.w3.org/2001/12/soap-encoding"​>


    <soap:Bodyxmlns:m=​"http://www.example.org/stock"​>

       <m:GetStockPriceResponse>

           <m:Price>34.5</m:Price>

       </m:GetStockPriceResponse>

    </soap:Body>


</soap:Envelope>