北京 工业网站建设公司价格,wordpress产品模块,做网站备案需要多长时间,手机网站源文件简介
SOAP#xff08;Simple Object Access Protoco#xff09;简单对象访问协议是在分散或分布式的环境中交换信息的简单的协议#xff0c;是一个基于 XML 的协议。此协议规范由 IBM、Microsoft、UserLand 和 DevelopMentor 在1998年共同提出#xff0c;并得到 IBM#…简介
SOAPSimple Object Access Protoco简单对象访问协议是在分散或分布式的环境中交换信息的简单的协议是一个基于 XML 的协议。此协议规范由 IBM、Microsoft、UserLand 和 DevelopMentor 在1998年共同提出并得到 IBM莲花Lotus康柏Compaq等公司的支持于2000年提交给万维网联盟World Wide Web ConsortiumW3C。现在SOAP 协议规范由万维网联盟的 XML工作组维护。SOAP 1.2 版在2003年6月24日成为 W3C 的推荐版本。
SOAP 协议包括以下四个部分的内容 SOAP 封装envelop封装定义了一个描述消息中的内容是什么是谁发送的谁应当接受并处理它以及如何处理它们的框架 SOAP 编码规则encoding rules它定义了不同应用程序间交换信息时需要使用到的数据类型 SOAP RPC 表示RPC representation它定义了一个表示远程过程调用和应答的协定 SOAP 绑定binding它定义 SOAP 使用哪种底层协议交换信息的协定。使用 HTTP/TCP/UDP 协议都可以
四个部分之间的关系
SOAP 消息基本上是从发送端到接收端的单向传输但它们常常结合起来执行类似于请求 / 应答的模式。所有的 SOAP 消息都使用 XML 编码。一条 SOAP 消息就是一个包含有一个必需的 SOAP 的封装包一个可选的 SOAP 标头Header和一个必需的 SOAP 体块Body的 XML 文档。
把 SOAP 绑定到 HTTP 提供了同时利用 SOAP 的样式和分散的灵活性的特点以及 HTTP 的丰富的特征库的优点。在HTTP上传送 SOAP 并不是说 SOAP 会覆盖现有的 HTTP 语义而是 HTTP 上的 SOAP 语义会自然的映射到 HTTP 语义。在使用 HTTP 作为协议绑定的场合中 RPC 请求映射到 HTTP 请求上而 RPC 应答映射到 HTTP 应答。然而在 RPC 上使用 SOAP 并不仅限于 HTTP 协议绑定。SOAP也可以绑定到TCP和UDP协议上。
虽然这四个部分都作为 SOAP 的一部分作为一个整体定义的但他们在功能上是相交的、彼此独立的。特别的信封envelop和编码规则encoding rules是被定义在不同的 XML 命名空间中这样使得定义更加简单。
语法规则 SOAP 消息必须用 XML 来编码 SOAP 消息必须使用 SOAP Envelope 命名空间 SOAP 消息必须使用 SOAP Encoding 命名空间 SOAP 消息不能包含 DTD 引用 SOAP 消息不能包含 XML 处理指令
SOAP 消息格式
SOAP 消息的格式比较简单如下图 下面是一条 SOAP 消息的基本格式
?xml version1.0 encodingutf-8?
soap:Envelopexmlns:soaphttp://www.w3.org/2003/05/soap-envelopesoap:encodingStylehttp://www.w3.org/2003/05/soap-encodingsoap:Header!-- 消息头可选 --/soap:Headersoap:Body!-- 消息内容必需 --soap:Fault!-- 错误信息可选 --/soap:Fault/soap:Body
/soap:Envelope一条 SOAP 消息就是一个普通的 XML 文档包含如下元素 必需的 Envelope 元素据此可把该 XML 文档标识为一条 SOAP 消息 可选的 Header 元素包含头部信息一般用于身份验证 必需的 Body 元素包含所有的调用和响应信息 可选的 Fault 元素提供有关在处理此消息时所发生的错误的描述信息
语法规则详解
SOAP Envelope
Envelope 是 SOAP 消息结构的主要容器也是 SOAP 消息的根元素它必须出现在每个 SOAP 消息中用于把此 XML 文档标示为一条 SOAP 消息。
在 SOAP 中使用命名空间将 SOAP 消息元素与应用程序自定义的元素区分开来将 SOAP 消息元素的作用域限制在一个特定的区域。
soap:Envelopexmlns:soaphttp://schemas.xmlsoap.org/soap/envelope/soap:encodingStylehttp://www.w3.org/2003/05/soap-encoding
/soap:EnvelopeSOAP 的 encodingStyle 属性用于定义在文档中使用的数据类型。此属性可出现在任何 SOAP 元素中并会被应用到元素的内容及元素的所有子元素上。
SOAP Header
这个是可选的如果需要添加 Header 元素那么它必须是 Envelope 的第一个子元素。Header 还可以包含0个或多个可选的子元素这些子元素称为 Header 项所有的 Header 项一般来说是属于某个特定与接口相关的命名空间。
soap:Envelopexmlns:soaphttp://schemas.xmlsoap.org/soap/envelope/soap:encodingStylehttp://www.w3.org/2003/05/soap-encodingsoap:HeaderAuthenHeader xmlnshttp://www.example.comsAuthenticatestring/sAuthenticate/AuthenHeader/soap:Headersoap:Body/soap:Body
/soap:EnvelopeHeader 元素用于与消息一起传输一些附加的消息如身份验证信息等。
SOAP Body
SOAP 消息的 Body 元素可以包含以下任何元素 远程过程调用RPC的方法及其参数 目标应用程序消息接收者即接口调用者所需要的数据 报告故障和状态消息的 SOAP Fault
所有 Body 元素的直接子元素都称为 Body 项所有 Body 项一般是属于某个特点的命名空间的。
SOAP 请求消息例子
soap:Envelopexmlns:soaphttp://www.w3.org/2003/05/soap-envelopesoap:encodingStylehttp://www.w3.org/2003/05/soap-encodingsoap:BodygetMobileCodeInfo xmlnshttp://www.example.commobileCodestring/mobileCodeuserIDstring/userID/getMobileCodeInfo/soap:Body
/soap:EnvelopeSOAP 响应消息例子
soap:Envelopexmlns:soaphttp://www.w3.org/2003/05/soap-envelopesoap:encodingStylehttp://www.w3.org/2003/05/soap-encodingsoap:BodygetMobileCodeInfoResponse xmlnshttp://www.example.comgetMobileCodeInfoResultstring/getMobileCodeInfoResult/getMobileCodeInfoResponse/soap:Body
/soap:Envelope注以上例子表示通过手机号获取手机号归属地等信息。第一个例子是请求消息第二个例子是它的响应消息。
SOAP Fault
Fault 元素用于在 SOAP 消息中传输错误及状态信息。如果 SOAP 消息中包括 Fault 元素它必须作为一个 Body 的子元素出现而且至多出现一次。Fault 元素本身也包含有描述错误详细信息的子元素。它包含以下子元素faultcodefaultstringfaultactordetail。
子元素描述faultcode供识别故障的代码faultstring可供人阅读的有关故障的说明faultactor有关是谁引发故障的信息detail有关涉及 Body 元素的应用程序专用错误信息
其中 faultcode 是每一条错误消息都会提供的元素它的值一般是以下错误代码之一
错误代码描述VersionMismatch无效的 SOAP Envelope 命名空间MustUnderstand无法理解 Header 中拥有属性 mustUnderstand 1 的子元素Client消息结构错误或包含了不正确的信息Server服务器出现错误
注以上关于 SOAP Fault 的描述不完全适用于 SOAP 1.2 版本。因为 SOAP 1.2 版本在返回错误信息时Fault 的子元素及其内容已经有所不同。具体看下面的例子
SOAP v1.1 错误消息例子
soap:Envelopexmlns:soaphttp://schemas.xmlsoap.org/soap/envelope/ soap:encodingStylehttp://www.w3.org/2001/12/soap-encodingsoap:Bodysoap:Faultfaultcodesoap:Client/faultcodefaultstringInput string was not in a correct format./faultstringdetail//soap:Fault
/soap:Body
/soap:EnvelopeSOAP v1.2 错误消息例子
soap:Envelopexmlns:soaphttp://www.w3.org/2003/05/soap-envelopesoap:encodingStylehttp://www.w3.org/2003/05/soap-encodingsoap:Bodysoap:Faultsoap:Codesoap:Valuesoap:Sender/soap:Value/soap:Codesoap:Reasonsoap:Text xml:langenInput string was not in a correct format./soap:Text/soap:Reasonsoap:Detail//soap:Fault/soap:Body
/soap:Envelope从以上返回结果来看其实所返回的错误信息内容并没有太多改变只是 XML 的元素发生了一些变化具体还需要读者自己理解。
