Web Service基础知识——WSDL文件详解

2024-06-01 06:38
文章标签 详解 web 基础知识 service wsdl

本文主要是介绍Web Service基础知识——WSDL文件详解，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

一个WSDL文档的根元素是definitions元素，WSDL文档包含7个重要的元素：types, import, message, portType, operations, binding和service元素。

WSDL声明部分

WSDL的声明部分包含：XML声明、Definition定义

1、XML声明

[html]  view plain  copy
  1. <?xml version="1.0" encoding="UTF-8"?>  
  WSDL的声明必须定义成使用：UTF-8 或者UTF-16 编码。

2、definition元素

所有WSDL文档的根元素都是definition元素。   

[html]  view plain  copy
  1. <definitions name="BookQuoteWS"  
  2.                       targetNamespace="http://www.Monson-Haefel.com/jwsbook/BookQuote"  
  3.                       xmlns:mh="http://www.Monson-Haefel.com/jwsbook/BookQuote"  
  4.                       xmlns:soapbind="http://schemas.xmlsoap.org/wsdl/soap/"  
  5.                          xmlns:xsd="http://www.w3.org/2001/XMLSchema"  
  6.                      xmlns="http://schemas.xmlsoap.org/wsdl/">  
  7.   
  8. <!-- message elements describe the input and output parameters -->  
  9.   
  10. <message name="GetBookPriceRequest">  
  11.   
  12.       <part name="isbn" type="xsd:string" />  
  13.   
  14. </message>  
  15.   
  16. <message name="GetBookPriceResponse">  
  17.   
  18.      <part name="price" type="xsd:float" />  
  19.   
  20. </message>  
  21.   
  22. <!-- portType element describes the abstract interface of a Web service -->  
  23.   
  24. <portType name="BookQuote">  
  25.   
  26.     <operation name="getBookPrice">  
  27.   
  28.           <input name="isbn" message="mh:GetBookPriceRequest"/>  
  29.   
  30.           <output name="price" message="mh:GetBookPriceResponse"/>  
  31.   
  32.   </operation>  
  33.   
  34. </portType>  
（1） definition元素中一般包括若干个XML命名空间；
 http://schemas.xmlsoap.org/wsdl/是默认的命名空间，这样就可以不用显式地定义每一个WSDL元素的命名空间了，例如：<types> <messages> <portType>…；文档中所有的元素缺省应该属于这个命名空间。
（2）definition元素的的一个属性是name，此属性不重要可以没有；
（3）定义了targetNamespace命名空间，它为在模式中显式创建的所有新类型均声明了XML命名空间，而且上面的例子中赋予了mh前缀。

（4）上面的例子中：message元素利用name属性指定了标签（例如：GetBookPriceRequest），这些标签会自动使用targetNamespace的命名空间，标签了的messages元素通常被称为定义。

（5）文档中的其他元素用标签和命名空间前缀去应用定义，例如上面的例子中：input元素是使用mh:GetBookPriceRequest来引用标签GetBookPriceRequest。

3、Types元素
Types元素用作一个容器，定义了自定义的特殊数据类型，在声明消息部分（有效负载）的时候，messages定义使用了types元素中定义的数据类型与元素。

[html]  view plain  copy
  1. <?xml version="1.0" encoding="UTF-8"?>  
  2.   
  3. <definitions name="BookQuoteWS"  
  4.                       targetNamespace="http://www.Monson-Haefel.com/jwsbook/BookQuote"  
  5.                       xmlns:mh="http://www.Monson-Haefel.com/jwsbook/BookQuote"  
  6.                       xmlns:soapbind="http://schemas.xmlsoap.org/wsdl/soap/"  
  7.                       xmlns:xsd="http://www.w3.org/2001/XMLSchema"  
  8.                      xmlns="http://schemas.xmlsoap.org/wsdl/">  
  9. <types>  
  10.   
  11.     <xsd:schema   targetNamespace="http://www.Monson-Haefel.com/jwsbook/BookQuote">  
  12.   
  13.       <!-- The ISBN simple type -->  
  14.   
  15.       <xsd:simpleType name="ISBN">  
  16.   
  17.         <xsd:restriction base="xsd:string">  
  18.   
  19.           <xsd:pattern value="[0-9]{9}[0-9Xx]" />  
  20.   
  21.         </xsd:restriction>  
  22.   
  23.       </xsd:simpleType>  
  24.   
  25.     </xsd:schema>  
  26.   
  27. </types>  

types元素作为一个容器，用来定义XML模式内置的数据类型（即复杂类型和定制的简单类现，详细见Web Service XML文章）中没有描述的各种数据类型。例如：ISBN。
上面的例子中，types元素中直接嵌套了一个完整的W3C XML模式文档，此文档中targetNamespace必须是一个有效的非空值，而且必须属于由WSDL文档。

4、Import元素
            Import元素可以让当前的文档使用其他WSDL文档中指定命名空间中的定义。 

[html]  view plain  copy
  1. <definitions name="AllMhWebServices"  
  2.          xmlns="http://schemas.xmlsoap.org/wsdl/">  
  3.   
  4.     <import namespace="http://www.Monson-Haefel.com/jwsbook/BookQuote"  
  5.   
  6.      location="http://www.Monson-Haefel.com/jwsbook/BookPrice.wsdl"/>  
  7.   
  8.     <import namespace="http://www.Monson-Haefel.com/jwsbook/po"  
  9.   
  10.      location="http://www.Monson-Haefel.com/jwsbook/wsdl/PurchaseOrder.wsdl"/>  
  11.   
  12.     <import namespace="http://www.Monson-Haefel.com/jwsbook/Shipping"  
  13.   
  14.      location="http://www.Monson-Haefel.com/jwsbook/wsdl/Shipping.wsdl"/>  
  15.   
  16. </definitions >  
WSDL的import元素必须声明两个属性，即namespace属性和location属性。
 namespace属性必须和正导入的WSDL文档中声明的targetNamespace相匹配。
location属性必须指向一个实际的WSDL文档。

WSDL抽象接口

 Message、portType和operation元素用于描述Web服务的抽象接口，相当于JAVA或者C++中编程中的类的接口。其中portType相当于类接口的名称；operation相当于接口中包含的函数，message相当于函数的参数和返回值。

1、Message元素
 Message元素描述了Web服务的有效负载。相当于函数调用中的参数和返回值。

[html]  view plain  copy
  1. <message name="GetBulkBookPriceRequest">  
  2.   
  3.     <part name="isbn" type="xsd:string"/>  
  4.   
  5.     <part name="quantity" type="xsd:int"/>  
  6.   
  7.   </message>  
  8.   
  9.   <message name="GetBulkBookPriceResponse">  
  10.   
  11.     <part name="price" type="mh:prices" />  
  12.   
  13.   </message>  
GetBulkBookPriceRequest表示消息的输入（相当于函数的参数），GetBulkBookPriceResponse表示消息的输出（相当于函数的返回值）。
Web Service的输入和输出参数可以是多个（一个特点），每一个输入或者输出使用part元素定义。

2、portType元素
 PortType元素定义了Web服务的抽象接口，它可以由一个或者多个operation元素，每个operation元素定义了一个RPC样式或者文档样式的Web服务方法。

3、operation元素
Operation元素要用一个或者多个messages消息来定义它的输入、输出以及错误。

[html]  view plain  copy
  1. <message name="GetBulkBookPriceRequest">  
  2.   
  3.   <part name="isbn" type="xsd:string"/>  
  4.   
  5.   <part name="quantity" type="xsd:int"/>  
  6.   
  7. </message>  
  8.   
  9. <message name="GetBulkBookPriceResponse">  
  10.   
  11.   <part name="prices" type="mh:prices" />  
  12.   
  13. </message>  
  14.   
  15. <message name="InvalidArgumentFault">  
  16.   
  17.     <part name="error_message" element="mh:InvalidIsbnFaultDetail" />  
  18.   
  19.   </message>  
  20.   
  21. <portType name="GetBulkBookPrice" >  
  22.   
  23.   <operation name="getBulkBookPrice" parameterOrder="isbn quantity">  
  24.   
  25.      <input name="request" message="mh:GetBulkBookPriceRequest"/>  
  26.   
  27.      <output name="prices" message="mh:GetBulkBookPriceResponse"/>  
  28.   
  29. <fault name="InvalidArgumentFault" message="mh:InvalidArgumentFault"/>  
  30.   
  31.   </operation>  
  32.   
  33. </portType>  

Input表示传递到Web服务的有效负载；output表示返回给客户的有效负载；可以不包括，也可以包括一个或者多个fault错误消息。

parameterOrder定义了input和output消息采用的正确的顺序

使用parameterOrder的时候，必须包含所有输入参数部分；并且只包含不是返回类型的输出部分，如果output只有一个part（上例），会假设返回值，所以不包括在parameterOrder中

如果parameterOrder列出output中的part部分，那么这个将被作为OUT参数，如果input元素和output元素使用相同的名称声明了一个部分的时候，此部分为INOUT参数.

WSDL实现部分

1、binding元素

Binding元素将一个抽象的portType映射到一组具体的协议（SOAP或者HTTP）、消息传递样式（RPC或者document）以及编码样式（literal或者SOAP encoding）。

binding 元素有两个属性 - name 属性和 type 属性。name 属性定义 binding 的名称，而 type 属性指向用于 binding 的端口

1.1 soap:binding元素

[html]  view plain  copy
  1. <binding name="BookPrice_Binding" type="mh:BookQuote">  
  2.   
  3.   <soap:binding style="rpc" transport="http://schemas.xmlsoap.org/soap/http"/>  
  4.   
  5.   <operation name="getBookPrice">  
soap:binding元素指定了用于传输SOAP消息的Internet协议以及operation缺省的消息类型（RPC还是文档类型）

http://schemas.xmlsoap.org/soap/http表示采用的是HTTP的传输方式，当然也可以用HTTPS,用户具体使用HTTP还是HTTPS取决于Port元素中定义的location属性声明中的模式。

上面的rpc表示缺省状态下：operation将采用RPC的方式传递消息负载。

1.2 soap:operation元素

[html]  view plain  copy
  1. <operation name="getBookPrice">  
  2.   
  3.     <soapbind:operation style="rpc" soapAction="http://www.Monson-Haefel.com/jwsbook/BookQuote/GetBookPrice"/>  
  4.   
  5. POST 1ed/BookQuote HTTP/1.1  
  6.   
  7. Host: www.Monson-Haefel.com  
  8.   
  9. Content-Type: text/xml; charset="utf-8"  
  10.   
  11. Content-Length: nnnn  
  12.   
  13. SOAPAction="http://www.Monson-Haefel.com/jwsbook/BookQuote/GetBookPrice"  
soap:operation元素指定了消息传递样式（RPC或者document），并且指定了SOAPAction字段的值。上面的例子显示在HTTP消息中的SOAPAction中对应的值
1.3soap:body元素

[html]  view plain  copy
  1. <operation name="getBookPrice">  
  2.   
  3. <soap:operation style="rpc"/>  
  4.   
  5.       <input>  
  6.   
  7.           <soapbind:body use="literal"  
  8.   
  9.           namespace="http://www.Monson-Haefel.com/jwsbook/BookQuote" />  
  10.   
  11.        </input>  
  12.   
  13.        <output>  
  14.   
  15.           <soapbind:body use="literal"  
  16.   
  17.           namespace="http://www.Monson-Haefel.com/jwsbook/BookQuote" />  
  18.   
  19.        </output>  
  20.   
  21. <operation name="submit">  
  22.   
  23.   <soapbind:operation style="document"/>  
  24.   
  25.       <input>  
  26.   
  27.         <soapbind:body use="literal" />  
  28.   
  29.       </input>  
  30.   
  31.       <output>  
  32.   
  33.         <soapbind:body use="literal" />  
  34.   
  35.       </output>  
  36.   
  37. </operation>  
soapbind:body元素有四个属性use、namespace、part和encodingStyle

对于WS-I use的属性值必须是literal，意味这不是用编码的方式，所以永远不会用到encodingStyle属性

在RPC样式中，必须用一个有效的URI指定的namespace属性。此URI可以于WSDL文档的targetNampspce相同；而在document样式中不能使用namespace，XML文档样式的命名空间派生于它的XML文档。

1.4 soap:fault元素

[html]  view plain  copy
  1. <fault name="InvalidArgumentFault">  
  2.   
  3.      <soapbind:fault name="InvalidArgumentFault" use="literal" />  
  4.   
  5. </fault>  
  6.   
  7. <portType name="BookQuote">  
  8.   
  9.   <operation name="getBookPrice">  
  10.   
  11.      <input name="isbn" message="mh:GetBookPriceRequest"/>  
  12.   
  13.      <output name="price" message="mh:GetBookPriceResponse"/>  
  14.   
  15.      <fault name="InvalidArgumentFault" message="mh:InvalidArgumentFault"/>  
  16.   
  17.   </operation>  
  18.   
  19. </portType>  
soap:fault元素和fault元素包含一个强制性的name属性，表示要引用声明于对应portType中的专有错误消息。

1.5 soap:header元素

[html]  view plain  copy
  1. <types>  
  2.   
  3. <xsd:schema   
  4.   
  5. targetNamespace="http://www.Monson-Haefel.com/jwsbook/BookQuote"  
  6.   
  7.      xmlns="http://www.w3.org/2001/XMLSchema">  
  8.   
  9.         <xsd:element name="message-id" type="string" />  
  10.   
  11.     </xsd:schema>  
  12.   
  13. </types>  
  14.   
  15.    
  16.   
  17. <!-- message elements describe the input and output parameters -->  
  18.   
  19.   <message name="Headers">  
  20.   
  21.     <part name="message-id" element="mh:message-id" />  
  22.   
  23.   </message>  
  24.   
  25.    
  26.   
  27. <operation name="getBookPrice">  
  28.   
  29.   <input>  
  30.   
  31.      <soapbind:header message="mh:Headers" part="message-id" use="literal" />  
  32.   
  33.      <soapbind:body use="literal"  
  34.   
  35.            namespace="http://www.Monson-Haefel.com/jwsbook/BookQuote" />  
  36.   
  37.   </input>  
WSDL在绑定的input元素、output元素中利用soapbind:header元素显式指定了一个SOAP头文件

1.6 soap:headerfault元素  

[html]  view plain  copy
  1. <!-- message elements describe the input and output parameters -->  
  2.   
  3.   <message name="HeaderFault">  
  4.   
  5.     <part name="faultDetail" element="mh:detailMessage" />  
  6.   
  7.   </message>  
  8.   
  9. <input>  
  10.   
  11.       <soapbind:header message="mh:Header" use="literal">  
  12.   
  13.          <soapbind:headerfault message="mh:Headers" use="literal" />  
  14.   
  15.       </soapbind:header>  
  16.   
  17.       <soapbind:body use="literal"  
  18.   
  19.            namespace="http://www.Monson-Haefel.com/jwsbook/BookQuote" />  
  20.   
  21. </input>  

soap:headerfault元素表述了Header专用的错误消息，如果有一个响应消息，必须在消息的Header元素中返回各种header的专用错误。

SOAP没有就如何提供Header错误方面给出详细说明，只是要求必须在Header元素中包含detail元素。有些SOAP工具箱将SOAP的fault放在header元素中。

2、Service和Port元素

[html]  view plain  copy
  1. <service name="BookPriceService">  
  2.   
  3.   <port name="BookPrice_Port" binding="mh:BookPrice_Binding">  
  4.   
  5.     <soapbind:address location=  
  6.   
  7.      "http://www.Monson-Haefel.com/jwsbook/BookQuote" />  
  8.   
  9.   </port>  
  10.   
  11.   <port name="BookPrice_Failover_Port" binding="mh:BookPrice_Binding">  
  12.   
  13.     <soapbind:address location=  
  14.   
  15.      "http://www.monson-haefel.org/jwsbook/BookPrice" />  
  16.   
  17.   </port>  
  18.   
  19.   <port name="SubmitPurchaseOrder_Port"  
  20.   
  21.    binding="mh:SubmitPurchaseOrder_Binding">  
  22.   
  23.     <soapbind:address location=  
  24.   
  25.      "https://www.monson-haefel.org/jwsbook/po" />  
  26.   
  27.   </port>  
  28.   
  29. </service>  
Service元素包含一个或者多个Port元素

每一个Port元素对应一个不同的Web服务，port将一个URL赋予一个特定的binding，通过location实现

可以使两个或者多个port元素将不同的URL赋给相同的binding，例如负载平衡和容错的时候，使用这种方法。

soapbind:address：将Internet地址通过location属性赋予一个SOAP绑定。

这篇关于Web Service基础知识——WSDL文件详解的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1020253。

相关文章

Mysql 中的多表连接和连接类型详解

Mysql 中的多表连接和连接类型详解

《Mysql中的多表连接和连接类型详解》这篇文章详细介绍了MySQL中的多表连接及其各种类型,包括内连接、左连接、右连接、全外连接、自连接和交叉连接,通过这些连接方式,可以将分散在不同表中的相关数据... 目录什么是多表连接？1. 内连接（INNER JOIN）2. 左连接（LEFT JOIN 或 LEFT
阅读更多...
Java中switch-case结构的使用方法举例详解

Java中switch-case结构的使用方法举例详解

《Java中switch-case结构的使用方法举例详解》：本文主要介绍Java中switch-case结构使用的相关资料,switch-case结构是Java中处理多个分支条件的一种有效方式,它... 目录前言一、switch-case结构的基本语法二、使用示例三、注意事项四、总结前言对于Java初学者
阅读更多...
Linux内核之内核裁剪详解

Linux内核之内核裁剪详解

《Linux内核之内核裁剪详解》Linux内核裁剪是通过移除不必要的功能和模块,调整配置参数来优化内核,以满足特定需求,裁剪的方法包括使用配置选项、模块化设计和优化配置参数,图形裁剪工具如makeme... 目录简介一、 裁剪的原因二、裁剪的方法三、图形裁剪工具四、操作说明五、make menuconfig
阅读更多...
详解Java中的敏感信息处理

详解Java中的敏感信息处理

《详解Java中的敏感信息处理》平时开发中常常会遇到像用户的手机号、姓名、身份证等敏感信息需要处理,这篇文章主要为大家整理了一些常用的方法,希望对大家有所帮助... 目录前后端传输AES 对称加密RSA 非对称加密混合加密数据库加密MD5 + Salt/SHA + SaltAES 加密平时开发中遇到像用户的
阅读更多...
Springboot使用RabbitMQ实现关闭超时订单(示例详解)

Springboot使用RabbitMQ实现关闭超时订单(示例详解)

《Springboot使用RabbitMQ实现关闭超时订单(示例详解)》介绍了如何在SpringBoot项目中使用RabbitMQ实现订单的延时处理和超时关闭,通过配置RabbitMQ的交换机、队列和... 目录1.maven中引入rabbitmq的依赖：2.application.yml中进行rabbit
阅读更多...
C语言线程池的常见实现方式详解

C语言线程池的常见实现方式详解

《C语言线程池的常见实现方式详解》本文介绍了如何使用C语言实现一个基本的线程池,线程池的实现包括工作线程、任务队列、任务调度、线程池的初始化、任务添加、销毁等步骤,感兴趣的朋友跟随小编一起看看吧... 目录1. 线程池的基本结构2. 线程池的实现步骤3. 线程池的核心数据结构4. 线程池的详细实现4.1 初
阅读更多...
手把手教你idea中创建一个javaweb(webapp)项目详细图文教程

手把手教你idea中创建一个javaweb(webapp)项目详细图文教程

《手把手教你idea中创建一个javaweb(webapp)项目详细图文教程》：本文主要介绍如何使用IntelliJIDEA创建一个Maven项目,并配置Tomcat服务器进行运行,过程包括创建... 1.启动idea2.创建项目模板点击项目-新建项目-选择maven，显示如下页面输入项目名称，选择
阅读更多...
Python绘制土地利用和土地覆盖类型图示例详解

Python绘制土地利用和土地覆盖类型图示例详解

《Python绘制土地利用和土地覆盖类型图示例详解》本文介绍了如何使用Python绘制土地利用和土地覆盖类型图,并提供了详细的代码示例,通过安装所需的库,准备地理数据,使用geopandas和matp... 目录一、所需库的安装二、数据准备三、绘制土地利用和土地覆盖类型图四、代码解释五、其他可视化形式1.
阅读更多...
SpringBoot使用Apache POI库读取Excel文件的操作详解

SpringBoot使用Apache POI库读取Excel文件的操作详解

《SpringBoot使用ApachePOI库读取Excel文件的操作详解》在日常开发中,我们经常需要处理Excel文件中的数据,无论是从数据库导入数据、处理数据报表,还是批量生成数据,都可能会遇到... 目录项目背景依赖导入读取Excel模板的实现代码实现代码解析ExcelDemoInfoDTO 数据传输
阅读更多...
如何用Java结合经纬度位置计算目标点的日出日落时间详解

如何用Java结合经纬度位置计算目标点的日出日落时间详解

《如何用Java结合经纬度位置计算目标点的日出日落时间详解》这篇文章主详细讲解了如何基于目标点的经纬度计算日出日落时间,提供了在线API和Java库两种计算方法,并通过实际案例展示了其应用,需要的朋友... 目录前言一、应用示例1、天安门升旗时间2、湖南省日出日落信息二、Java日出日落计算1、在线API2
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2