`

WebService CXF学习(进阶篇1):SOAP讲解

 
阅读更多

SOAP 是基于 XML 的简易协议,可使应用程序在 HTTP 之上进行信息交换。或者更简单地说:SOAP 是用于访问网络服务的协议。 
    您应当具备的基础知识 
    在继续学习之前,您需要对下面的知识有基本的了解: 
        * XML 
        * XML 命名空间 
    
Why SOAP? 
    对于应用程序开发来说,使程序之间进行因特网通信是很重要的。 
    目前的应用程序通过使用远程过程调用(RPC)在诸如 DCOM 与 CORBA 等对象之间进行通信,但是 HTTP 不是为此设计的。RPC 会产生兼容性以及安全问题;防火墙和代理服务器通常会阻止此类流量。 
    通过 HTTP 在应用程序间通信是更好的方法,因为 HTTP 得到了所有的因特网浏览器及服务器的支持。SOAP 就是被创造出来完成这个任务的。 
    SOAP 提供了一种标准的方法,使得运行在不同的操作系统并使用不同的技术和编程语言的应用程序可以互相进行通信。 
    
Microsoft 和 SOAP 
    SOAP 是微软 .net 架构的关键元素,用于未来的因特网应用程序开发。 
    
SOAP 1.1 被提交到 W3C 
    在 2000 年 5 月,UserLand、Ariba、Commerce One、Compaq、Developmentor、HP、IBM、IONA、Lotus、Microsoft 以及 SAP 向 W3C 提交了 SOAP 因特网协议,这些公司期望此协议能够通过使用因特网标准(HTTP 以及 XML)把图形用户界面桌面应用程序连接到强大的因特网服务器,以此来彻底变革应用程序的开发。 
   
W3C 正在发展 SOAP 1.2 
   首个关于 SOAP 的公共工作草案由 W3C 在 2001 年 12 月发布。如需阅读更多有关在 W3C 的 SOAP 活动的内容,请访问我们的《W3C 教程》。 
   
SOAP 构建模块 
    一条 SOAP 消息就是一个普通的 XML 文档,包含下列元素: 
    * 必需的 Envelope 元素,可把此 XML 文档标识为一条 SOAP 消息 
    * 可选的 Header 元素,包含头部信息 
    * 必需的 Body 元素,包含所有的调用和响应信息 
    * 可选的 Fault 元素,提供有关在处理此消息所发生错误的信息 

    所有以上的元素均被声明于针对 SOAP 封装的默认命名空间中: 
    http://www.w3.org/2001/12/soap-envelope 
    以及针对 SOAP 编码和数据类型的默认命名空间: 
    http://www.w3.org/2001/12/soap-encoding 

语法规则 
    这里是一些重要的语法规则: 
    * SOAP 消息必须用 XML 来编码 
    * SOAP 消息必须使用 SOAP Envelope 命名空间 
    * SOAP 消息必须使用 SOAP Encoding 命名空间 
    * SOAP 消息不能包含 DTD 引用 
    * SOAP 消息不能包含 XML 处理指令 

SOAP 消息的基本结构
 

Java代码  收藏代码
  1. <?xml version="1.0"?>  
  2. <soap:Envelope  
  3. xmlns:soap="http://www.w3.org/2001/12/soap-envelope"  
  4. soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">  
  5.   
  6. <soap:Header>  
  7.   ...  
  8.   ...  
  9. </soap:Header>  
  10.   
  11. <soap:Body>  
  12.   ...  
  13.   ...  
  14.   <soap:Fault>  
  15.     ...  
  16.     ...  
  17.   </soap:Fault>  
  18. </soap:Body>  
  19.   
  20. </soap:Envelope>  



SOAP Envelope 元素 
    必需的 SOAP 的 Envelope 元素是 SOAP 消息的根元素。它可把 XML 文档定义为 SOAP 消息。 
    请注意 xmlns:soap 命名空间的使用。它的值应当始终是: 

Java代码  收藏代码
  1. http://www.w3.org/2001/12/soap-envelope  


    并且它可把封装定义为 SOAP 封装: 

Java代码  收藏代码
  1. <?xml version="1.0"?>  
  2. <soap:Envelope  
  3. xmlns:soap="http://www.w3.org/2001/12/soap-envelope"  
  4. soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">  
  5.   ...  
  6.   Message information goes here  
  7.   ...  
  8. </soap:Envelope>  



xmlns:soap 命名空间 
    SOAP 消息必须拥有与命名空间 "http://www.w3.org/2001/12/soap-envelope" 相关联的一个 Envelope 元素。 
    如果使用了不同的命名空间,应用程序会发生错误,并抛弃此消息。 

encodingStyle 属性 
   SOAP 的 encodingStyle 属性用于定义在文档中使用的数据类型。此属性可出现在任何 SOAP 元素中,并会被应用到元素的内容及元素的所有子元素上。SOAP 消息没有默认的编码方式。 
语法 

Java代码  收藏代码
  1. soap:encodingStyle="URI"  


实例 

Java代码  收藏代码
  1. <?xml version="1.0"?>  
  2. <soap:Envelope  
  3. xmlns:soap="http://www.w3.org/2001/12/soap-envelope"  
  4. soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">  
  5. ...  
  6. Message information goes here  
  7. ...  
  8. </soap:Envelope>  



SOAP Header 元素 
    可选的 SOAP Header 元素可包含有关 SOAP 消息的应用程序专用信息(比如认证、支付等)。如果 Header 元素被提供,则它必须是 Envelope 元素的第一个子元素。 
     注释:所有 Header 元素的直接子元素必须是合格的命名空间。 

Java代码  收藏代码
  1. <?xml version="1.0"?>  
  2. <soap:Envelope  
  3. xmlns:soap="http://www.w3.org/2001/12/soap-envelope"  
  4. soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">  
  5.   
  6. <soap:Header>  
  7. <m:Trans  
  8. xmlns:m="http://www.w3school.com.cn/transaction/"  
  9. soap:mustUnderstand="1">234</m:Trans>  
  10. </soap:Header>  
  11.   
  12. ...  
  13. ...  
  14.   
  15. </soap:Envelope>  



    上面的例子包含了一个带有一个 "Trans" 元素的头部,它的值是 234,此元素的 "mustUnderstand" 属性的值是 "1"。 
    SOAP 在默认的命名空间中 ("http://www.w3.org/2001/12/soap-envelope") 定义了三个属性。这三个属性是:actor、 mustUnderstand 以及 encodingStyle。这些被定义在 SOAP 头部的属性可定义容器如何对 SOAP 消息进行处理。 

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

Java代码  收藏代码
  1. soap:actor="URI"   


实例 

Java代码  收藏代码
  1. <?xml version="1.0"?>  
  2. <soap:Envelope  
  3. xmlns:soap="http://www.w3.org/2001/12/soap-envelope"  
  4. soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">  
  5.   
  6. <soap:Header>  
  7. <m:Trans  
  8. xmlns:m="http://www.w3school.com.cn/transaction/"  
  9. soap:actor="http://www.w3school.com.cn/appml/">  
  10. 234  
  11. </m:Trans>  
  12. </soap:Header>  
  13.   
  14. ...  
  15. ...  
  16.   
  17. </soap:Envelope>  


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

Java代码  收藏代码
  1. soap:mustUnderstand="0|1"  


实例 

Java代码  收藏代码
  1. <?xml version="1.0"?>  
  2. <soap:Envelope  
  3. xmlns:soap="http://www.w3.org/2001/12/soap-envelope"  
  4. soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">  
  5.   
  6. <soap:Header>  
  7. <m:Trans  
  8. xmlns:m="http://www.w3school.com.cn/transaction/"  
  9. soap:mustUnderstand="1">  
  10. 234  
  11. </m:Trans>  
  12. </soap:Header>  
  13.   
  14. ...  
  15. ...  
  16.   
  17. </soap:Envelope>  


encodingStyle 属性 
    SOAP 的 encodingStyle 属性在上一节中已解释过了。 

SOAP Body 元素 
    必需的 SOAP Body 元素可包含打算传送到消息最终端点的实际 SOAP 消息。 
    SOAP Body 元素的直接子元素可以是合格的命名空间。SOAP 在默认的命名空间中("http://www.w3.org/2001/12/soap-envelope")定义了 Body 元素内部的一个元素。即 SOAP 的 Fault 元素,用于指示错误消息。 

Java代码  收藏代码
  1. <?xml version="1.0"?>  
  2. <soap:Envelope  
  3. xmlns:soap="http://www.w3.org/2001/12/soap-envelope"  
  4. soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">  
  5.   
  6. <soap:Body>  
  7.    <m:GetPrice xmlns:m="http://www.w3school.com.cn/prices">  
  8.       <m:Item>Apples</m:Item>  
  9.    </m:GetPrice>  
  10. </soap:Body>  
  11.   
  12. </soap:Envelope>  


    上面的例子请求苹果的价格。请注意,上面的 m:GetPrice 和 Item 元素是应用程序专用的元素。它们并不是 SOAP 标准的一部分。 
    而一个 SOAP 响应应该类似这样: 

Java代码  收藏代码
  1. <?xml version="1.0"?>  
  2. <soap:Envelope  
  3. xmlns:soap="http://www.w3.org/2001/12/soap-envelope"  
  4. soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">  
  5.   
  6. <soap:Body>  
  7.    <m:GetPriceResponse xmlns:m="http://www.w3school.com.cn/prices">  
  8.       <m:Price>1.90</m:Price>  
  9.    </m:GetPriceResponse>  
  10. </soap:Body>  
  11.   
  12. </soap:Envelope>  



SOAP Fault 元素
 
    来自 SOAP 消息的错误消息被携带于 Fault 元素内部。 
    如果已提供了 Fault 元素,则它必须是 Body 元素的子元素。在一条 SOAP 消息中,Fault 元素只能出现一次。 
    SOAP 的 Fault 元素用于下列子元素: 

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




SOAP Fault Codes
 
    在下面定义的 faultcode 值必须用于描述故障时的 faultcode 元素中: 

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



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

Java代码  收藏代码
  1. POST /item HTTP/1.1  
  2. Host: 189.123.345.239  
  3. Content-Type: text/plain  
  4. Content-Length: 200  


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

Java代码  收藏代码
  1. 200 OK  
  2. Content-Type: text/plain  
  3. Content-Length: 200  


   在上面的例子中,服务器返回了一个 200 的状态代码。这是 HTTP 的标准成功代码。 
   假如服务器无法对请求进行解码,它可能会返回类似这样的信息: 

Java代码  收藏代码
  1. 400 Bad Request  
  2. Content-Length: 0  




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

Java代码  收藏代码
  1. Content-Type: MIMEType; charset=character-encoding   


例子 

Java代码  收藏代码
  1. POST /item HTTP/1.1  
  2. Content-Type: application/soap+xml; charset=utf-8  



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

Java代码  收藏代码
  1. Content-Length: bytes  


例子 

Java代码  收藏代码
  1. POST /item HTTP/1.1  
  2. Content-Type: application/soap+xml; charset=utf-8  
  3. Content-Length: 250  



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

Java代码  收藏代码
  1. POST /InStock HTTP/1.1  
  2. Host: www.example.org  
  3. Content-Type: application/soap+xml; charset=utf-8  
  4. Content-Length: nnn  
  5.   
  6. <?xml version="1.0"?>  
  7. <soap:Envelope  
  8. xmlns:soap="http://www.w3.org/2001/12/soap-envelope"  
  9. soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">  
  10.   
  11.   <soap:Body xmlns:m="http://www.example.org/stock">  
  12.     <m:GetStockPrice>  
  13.       <m:StockName>IBM</m:StockName>  
  14.     </m:GetStockPrice>  
  15.   </soap:Body>  
  16.     
  17. </soap:Envelope>  


SOAP 响应: 

Java代码  收藏代码
  1. HTTP/1.1 200 OK  
  2. Content-Type: application/soap+xml; charset=utf-8  
  3. Content-Length: nnn  
  4.   
  5. <?xml version="1.0"?>  
  6. <soap:Envelope  
  7. xmlns:soap="http://www.w3.org/2001/12/soap-envelope"  
  8. soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">  
  9.   
  10.   <soap:Body xmlns:m="http://www.example.org/stock">  
  11.     <m:GetStockPriceResponse>  
  12.       <m:Price>34.5</m:Price>  
  13.     </m:GetStockPriceResponse>  
  14.   </soap:Body>  
  15.     
  16. </soap:Envelope>  
分享到:
评论
发表评论

文章已被作者锁定,不允许评论。

相关推荐

    WebService CXF学习文档

    WebService CXF学习——进阶篇 1.SOAP讲解 2.JAX-WS讲解 3.对象传递 WebService CXF学习——高级篇(一)(二) 1.整合Spring框架 2.CXF+Spring+Hibernate 3.WS-Security WebService CXF学习——JAXB剖析

    CXF打印SOAP报文,记录WebService日志

    1. **CXF Interceptors机制**:CXF采用了一种基于拦截器的架构,允许开发者在消息处理的不同阶段插入自定义的行为。这些拦截器可以被用来执行各种任务,比如安全检查、日志记录等。 2. **Logging Message**:CXF内部...

    WebService CXF 详细教程

    1. **强大的SOAP支持**:CXF支持各种WS-*规范,如WS-Security、WS-Addressing、WS-RM等,提供了一流的SOAP处理能力。 2. **RESTful API支持**:CXF可以轻松地创建和消费RESTful服务,支持JAX-RS标准。 3. **数据绑定...

    webservice cxf_demo

    1. **SOAP和RESTful服务**:CXF允许开发者创建符合WS-*标准的SOAP服务,同时也支持更轻量级的RESTful服务,满足不同应用场景的需求。 2. **强大的绑定和数据转换**:CXF支持多种协议和数据格式,如HTTP、JMS、SMTP...

    WebService CXF学习-入门篇.pdf

    **WebService CXF 学习——入门篇** **一、WebService CXF 由来与目标** Apache CXF 是一个流行的开源框架,它源自 ObjectWeb Celtix 和 CodeHaus XFire 的合并,这两个项目分别由 IONA 公司和业界知名SOAP堆栈...

    webService(基于cxf)的完整例子

    1. **CXF框架介绍**:CXF,全称为"Code first eXtended Framework",最初由XFire项目发展而来,后与Apache Axiom和Neethi等项目合并。CXF提供了一种从代码直接生成Web服务的方式,支持JAX-WS和JAX-RS标准,使得开发...

    webservice cxf.jar 相关包

    1. 服务端开发:CXF允许开发者使用Java编程模型(如JAX-WS或JAX-RS)来定义服务接口,然后自动生成服务实现和WSDL(Web Services Description Language)。 2. 客户端调用:CXF也支持生成客户端代理代码,使得Java...

    webservice cxf集成servlet

    ### WebService CXF与Servlet集成详解 #### 一、项目准备与搭建 ##### 1. 创建Web Project - **项目命名**:首先,在开发环境中创建一个新的Web项目,并将其命名为`cxf_bigdata`。 ##### 2. 目录结构 - 项目的...

    WebService CXF 对象传递 附

    **WebService CXF 对象传递详解** 在Web服务领域,CXF是一个非常重要的开源框架,它允许开发者创建和消费各种Web服务。CXF支持SOAP、RESTful等多种通信模式,并且能够处理复杂的对象传递,使得Web服务的数据交换...

    WebService CXF --- 传输文件MTOM

    WebService CXF,全称Apache CXF,是一款开源的Java框架,用于构建和开发Web服务。它支持多种协议和规范,包括SOAP、RESTful、XML以及Web服务标准如WS-*。在"WebService CXF --- 传输文件MTOM"这个主题中,我们将...

    基于 cxf 2.7.5 开发的 webservice [soap restful]

    【标题】基于CXF 2.7.5开发的WebService:SOAP与RESTful详解 【描述】本项目是使用Apache CXF 2.7.5版本实现的WebService服务,包括了SOAP和RESTful两种常见的Web服务接口。Apache CXF是一个开源的Java框架,它为...

    Webservice-CXF实用手册学习大全

    WebService-CXF实用手册学习大全的知识点涵盖了WebService技术的多个方面,主要分为以下几个部分: 1. WebService基础: - WebService是一种通过网络提供服务的技术,使用HTTP作为传输协议,SOAP作为消息格式,...

    Webservice笔记含使用cxf和jaxws两种方式开发webservice【源代码+笔记】

    Soap(jaxws开发webservice的传输协议)重点掌握 UDDI(了解) Webservice的使用场景分析(掌握) 学会jaxws基本开发方法(重点) Soap1.1和soap1.2区别: 跟踪soap协议 综合案例: 使用webservice传输xml...

    webservice cxf 客户端创建

    1. **引入Webservice库:** 首先,你需要下载Apache CXF的库。例如,你可以获取apache-cxf-2.7.6.zip,并将其解压缩。将解压后的`lib`目录中的所有JAR文件添加到你的项目类路径中。确保包含了CXF的核心库和其他必要...

    Java webservice cxf客户端调用demo和服务端

    1. 生成客户端代理:CXF的WSDL2Java工具可以将服务端的WSDL(Web Service Description Language)文件转换为Java客户端代码,生成服务代理类。 2. 创建服务代理实例:通过代理类,客户端可以创建服务的实例,就像...

    WebService CXF、 Mybatis简单实例

    WebService CXF和Mybatis是两种在Java开发中广泛使用的技术,它们分别用于构建Web服务和数据库操作。让我们深入了解这两个框架以及如何将它们与Spring框架结合使用。 **WebService CXF** CXF是一个开源的Java框架...

    webservice使用cxf的实例

    1. **CXF简介**:CXF是一个开源的Java框架,它支持基于标准的Web服务,包括SOAP 1.1/1.2,RESTful HTTP,以及WS-Security等安全标准。它提供了从Java类直接生成WSDL文档的能力,反之亦然,即Java-to-WSDL(JAX-WS)...

    webservice cxf 整合spring例子源代码

    2. **CXF Bus**:CXF的Bus是整个框架的核心,它可以管理服务的生命周期,处理各种协议和消息格式。在Spring中,可以通过`&lt;cxf:bus&gt;`标签来创建和配置Bus,将它注入到其他需要使用CXF功能的bean中。 3. **服务接口与...

    调用pb开发的webserver(SOAP 1.1)

    调用pb开发的webserver(SOAP 1.1) /* POST /webservice/n_webservice.asmx HTTP/1.1 Host: localhost Content-Type: application/soap+xml; charset=utf-8 Content-Length: length &lt;soap12:Envelope xmlns:xsi=...

Global site tag (gtag.js) - Google Analytics