SOAP 规范（1）

SOAP 规范

SOAP:简单对象访问协议

 (2001-1-1)

摘要

SOAP是用在分散或分布的环境中交换信息的简单的协议，它是一个基于XML的协议，包括三个部分：封装定义了一个描述消息中包含什么内容以及如何处理它们的框架，编码规则用于表示应用程序定义的数据类型的实例，另外还有一个表示远程过程调用和应答的协定。SOAP被设计为可以与各种其它协议结合使用；但这篇文章仅描述如何将SOAP和HTTP及HTTP扩展框架相结合。

目录
1. 简介
1.1 设计目标
1.2 符号协定
1.3 SOAP消息举例
2. SOAP消息交换模型
3. 与XML的关系
4. SOAP封装
4.1.1 SOAP encodingStyle属性
4.1.2 封装版本模型
4.2 SOAP头
4.2.1 使用SOAP头属性
4.2.2 SOAP actor属性
4.2.3 SOAP mustUnderstand属性
4.3 SOAP体
4.3.1 SOAP头和体的关系
4.4 SOAP 错误
4.4.1 SOAP错误代码
5. SOAP编码
5.1 XML编码类型规则
5.2 简单类型
5.2.1 字符串
5.2.2 枚举
5.2.3 字符数组
5.3 多态 Accessor
5.4 复合类型
5.4.1 复合值和对值的引用
5.4.2 数组
5.4.2.1 PartiallyTransmitted Arrays
5.4.2.2 稀疏数组
5.4.3 一般复合类型
5.5 缺省值
5.6 SOAP root属性
6. 在HTTP中使用SOAP
6.1 SOAP HTTP请求
6.1.1 HTTP头中的SOAPAction域
6.2 SOAP HTTP应答
6.3 HTTP扩展框架
6.4 SOAP HTTP举例
7. 用SOAP表示RPC
7.1 RPC和SOAP体
7.2 RPC和SOAP头
8. 安全考虑
9. 参考文献
A. SOAP封装举例

A.1 请求编码举例

A.2 应答编码举例

1. 简介

SOAP以XML形式提供了一个简单、轻量的用于在分散或分布环境中交换结构化和类型化信息的机制。SOAP本身并没有定义任何应用程序语义，如编程模型或特定语义的实现；实际上它通过提供一个有标准组件的包模型和在模块中编码数据的机制，定义了一个简单的表示应用程序语义的机制。这使SOAP能够被用于从消息传递到RPC的各种系统。

 

SOAP包括三个部分

 

SOAP封装（见第4节）结构定义了一个整体框架用来表示消息中包含什么内容，谁来处理这些内容以及这些内容是可选的或是必需的。
SOAP编码规则（见第5节）定义了用以交换应用程序定义的数据类型的实例的一系列机制。
SOAP RPC表示（见第7节）定义了一个用来表示远程过程调用和应答的协定。
虽然这三个部分都作为SOAP的一部分一起描述，但它们在功能上是相交的。特别的，封装和编码规则是在不同的名域中定义的，这种模块性的定义方法增加了简单性。

在SOAP封装，SOAP编码规则和SOAP RPC协定之外，这个规范还定义了两个协议的绑定，描述了在有或没有HTTP扩展框架[6]的情况下，SOAP消息如何包含在HTTP消息[5]中被传送。

1.1 设计目标
SOAP的主要设计目标是简单性和可扩展性，这意味着传统的消息系统和分布对象系统的某些性质不是SOAP规范的一部分。这些性质包括：

分布式碎片收集
成批传送消息
对象引用（要求分布式碎片收集）
激活机制（要求对象引用）
1.2 符号约定
这篇文章中的关键字 "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", 和"OPTIONAL"的解释在RFC-2119 [2]中。

这篇文章中用到的名域前缀 "SOAP-ENV" 和 "SOAP-ENC"分别与"http://schemas.xmlsoap.org/soap/envelope/" 和"http://schemas.xmlsoap.org/soap/encoding/"关联。

整篇文档中，名域前缀“xsi”被假定为与URI "http://www.w3.org/1999/XMLSchema-instance“（在XML Schema规范[11]定义）相连。类似的，名域前缀”xsd“被假定为与URI "http://www.w3.org/1999/XMLSchema"（在 [10]中定义）相连。名域前缀”tns“用来表示任意名域。所有其它的名域前缀都只是例子。

名域URI的基本形式”some－URI“表示某些依赖于应用程序或上下文的URI[4]。

这个规范用扩展BNF（在RFC－2616[5] 描述）描述某些结构。

1.3 SOAP消息举例
在这个例子中，GetLastTradePrice SOAP 请求被发往 StockQuote服务。这个请求携带一个字符串参数和ticker符号，在SOAP应答中返回一个浮点数。XML名域用来区分SOAP标志符和应用程序特定的标志符。这个例子说明了在第6节中定义的HTTP绑定。如果SOAP中管理XML负载的规则完全独立于HTTP是没有意义的，因为事实上该负载是由HTTP携带的。

在Appendix A中有更多的例子。

例1 在HTTP请求中嵌入SOAP消息

POST /StockQuote HTTP/1.1
Host:
www.stockquoteserver.com
Content-Type: text/xml;
charset="utf-8"
Content-Length: nnnn
SOAPAction:
"Some-URI"

<SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
 <SOAP-ENV:Body>
 <m:GetLastTradePrice xmlns:m="Some-URI">
 <symbol>DIS</symbol>
 </m:GetLastTradePrice>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

下面是一条应答消息，包括HTTP消息，SOAP消息是其具体内容：

例2 在HTTP应答中嵌入SOAP消息

HTTP/1.1 200 OK
Content-Type: text/xml;
charset="utf-8"
Content-Length:
nnnn

<SOAP-ENV:Envelope
xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"/>
 <SOAP-ENV:Body>
 <m:GetLastTradePriceResponse xmlns:m="Some-URI">
<Price>34.5</Price>
 </m:GetLastTradePriceResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

2. SOAP消息交换模型
SOAP消息从发送方到接收方是单向传送，但正如上面显示的，SOAP消息经常以请求/应答的方式实现。

SOAP实现可以通过开发特定网络系统的特性来优化。例如，HTTP绑定（见第6节）使SOAP应答消息以HTTP应答的方式传输，并使用同一个连接返回请求。

不管SOAP被绑定到哪个协议，SOAP消息采用所谓的”消息路径“发送，这使在终节点之外的中间节点可以处理消息。

一个接收SOAP消息的SOAP应用程序必须按顺序执行以下的动作来处理消息：

识别应用程序想要的SOAP消息的所有部分 （见4.2.2节）
检验应用程序是否支持第一步中识别的消息中所有必需部分并处理它。如果不支持，则丢弃消息（见4.4节）。在不影响处理结果的情况下，处理器可能忽略第一步中识别出的可选部分。
如果这个SOAP应用程序不是这个消息的最终目的地，则在转发消息之前删除第一步中识别出来的所有部分。
为了正确处理一条消息或者消息的一部分，SOAP处理器需要理解：所用的交换方式（单向，请求/应答，多路发送等等），这种方式下接收者的任务，RPC机制（如果有的话）的使用（如第7节中所述），数据的表现方法或编码，还有其它必需的语义。

尽管属性比如SOAP encodingstyle（见4.1.1节）可以用于描述一个消息的某些方面，但这个规范并不强制所有的接收方也必须有同样的属性并取同样的属性值。举个例子，某一特定的应用可能知道一个元素表示一条遵循第7节约定的RPC请求，但是另外一些应用可能认为指向该元素的所有消息都用单向传输，而不是类似第7节的请求应答模式。
（译者注：交互双方的SOAP消息并不一定要遵循同样的格式设定，而只需要以一种双方可理解的格式交换信息就可以了）

3. 与XML的关系
所有的SOAP消息都使用XML形式编码（更多有关XML的信息请见[7]）

一个SOAP应用程序产生的消息中，所有由SOAP定义的元素和属性中必须包括正确的名域。SOAP应用程序必须能够处理它接收到的消息中的SOAP名域（见4.4节），并且它可以处理没有SOAP名域的SOAP消息，就象它们有正确的名域一样。

SOAP定义了两个名域（更多有关XML名域的信息请见[8]）

SOAP封装的名域标志符是"http://schemas.xmlsoap.org/soap/envelope/"
SOAP的编码规则的名域标志符是"http://schemas.xmlsoap.org/soap/encoding/"
SOAP消息中不能包含文档类型声明，也不能包括消息处理指令。[7]

SOAP使用"ID"类型"id"属性来指定一个元素的唯一的标志符，同时该属性是局部的和无需校验的。SOAP使用"uri-reference"类型的"href"属性指定对这个值的引用，同时该属性是局部的和无需校验的。这样就遵从了XML规范[7]，XML Schema规范[11]和XML连接语言规范[9]的风格。

除了SOAP mustUnderstand 属性(见4.2.3节）和SOAP actor属性(见4.2.2节）之外，一般允许属性和它们的值出现在XML文档实例或Schema中（两者效果相同）。也就是说，在DTD或Schema中声明一个缺省值或固定值和在XML文档实例中设置它的值在语义上相同。