Web Services：WSDL

关于

WSDL（网络服务描述语言，Web Services Description Language）是一门基于 XML 的语言，用于描述 Web Services 以及如何对它们进行访问。

文档

WSDL 文档仅仅是一个简单的 XML 文档，它包含一系列描述某个 web service 的定义。

文档结构

WSDL 文档是利用这些主要的元素来描述某个 web service 的：

元素	定义
<portType>	web service 执行的操作
<message>	web service 使用的消息
<types>	web service 使用的数据类型
<binding>	web service 使用的通信协议

• WSDL 文档可包含其它的元素，比如 extension 元素，以及一个 service 元素，此元素可把若干个 web services 的定义组合在一个单一的 WSDL 文档中。

一个 WSDL 文档的主要结构是类似这样的：

<definitions>
 
  <types>
    data type definitions........
  </types>
 
  <message>
    definition of the data being communicated....
  </message>
 
  <portType>
    set of operations......
  </portType>
 
  <binding>
    protocol and data format specification....
  </binding>
 
</definitions>

其中：

1. <portType>：元素描述一个 web service、可被执行的操作，以及相关的消息。
   • 可以把 <portType> 元素比作传统编程语言中的一个函数库（或一个模块、或一个类）；
   • 最重要的 WSDL 元素；
2. <message>：元素定义一个操作的数据元素。
   • 每个消息均由一个或多个部件组成。
   • 可以把这些部件比作传统编程语言中一个函数调用的参数。
3. <types>：元素定义 web service 使用的数据类型。
   • 为了最大程度的平台中立性，WSDL 使用 XML Schema 语法来定义数据类型。
4. <binding>：元素为每个端口定义消息格式和协议细节。

示例

这是某个 WSDL 文档的简化的片段：

<message name="getTermRequest">
  <part name="term" type="xs:string"/>
</message>
 
<message name="getTermResponse">
  <part name="value" type="xs:string"/>
</message>
 
<portType name="glossaryTerms">
  <operation name="getTerm">
    <input message="getTermRequest"/>
    <output message="getTermResponse"/>
  </operation>
</portType>

如上：

1. <portType> 元素把 "glossaryTerms" 定义为某个端口的名称，把 "getTerm" 定义为某个操作的名称。

   操作 "getTerm" 拥有一个名为 "getTermRequest" 的输入消息，以及一个名为 "getTermResponse" 的输出消息。

2. <message> 元素可定义每个消息的部件，以及相关联的数据类型。

   对比传统的编程，glossaryTerms 是一个函数库，而 "getTerm" 是带有输入参数 "getTermRequest" 和返回参数 getTermResponse 的一个函数。

端口：<portType>

<portType> 元素是最重要的 WSDL 元素：它可描述一个 web service、可被执行的操作，以及相关的消息。

• 可以把 <portType> 元素比作传统编程语言中的一个函数库（或一个模块、或一个类）。

操作类型

请求-响应（Request-response）是最普通的操作类型，不过 WSDL 定义了四种类型：

类型	定义
One-way	此操作可接受消息，但不会返回响应。
Request-response	此操作可接受一个请求并会返回一个响应
Solicit-response	此操作可发送一个请求，并会等待一个响应。
Notification	此操作可发送一条消息，但不会等待响应。

One-Way 操作

一个 one-way 操作的例子：

<message name="newTermValues">
  <part name="term" type="xs:string"/>
  <part name="value" type="xs:string"/>
</message>
 
<portType name="glossaryTerms">
  <operation name="setTerm">
    <input name="newTerm" message="newTermValues"/>
  </operation>
</portType >

如上：端口 "glossaryTerms" 定义了一个名为 "setTerm" 的 one-way 操作：

这个 "setTerm" 操作可接受新术语表项目消息的输入，这些消息使用一条名为 "newTermValues" 的消息，此消息带有输入参数 "term" 和 "value"。不过，没有为这个操作定义任何输出。

Request-Response 操作

一个 request-response 操作的例子：

<message name="getTermRequest">
  <part name="term" type="xs:string"/>
</message>
 
<message name="getTermResponse">
  <part name="value" type="xs:string"/>
</message>
 
<portType name="glossaryTerms">
  <operation name="getTerm">
    <input message="getTermRequest"/>
    <output message="getTermResponse"/>
  </operation>
</portType>

如上：端口 "glossaryTerms" 定义了一个名为 "getTerm" 的 request-response 操作：

1. "getTerm" 操作会请求一个名为 "getTermRequest" 的输入消息，此消息带有一个名为 "term" 的参数，
2. 并将返回一个名为 "getTermResponse" 的输出消息，此消息带有一个名为 "value" 的参数。

绑定：<binding>

WSDL 绑定可为 web service 定义消息格式和协议细节。

binding 元素有两个属性：

1. name 属性：定义 binding 的名称；
2. type 属性：指向用于 binding 的端口；

soap:binding 元素有两个属性：

1. style 属性：可取值 "rpc" 或 "document"；
2. transport 属性：定义了要使用的 SOAP 协议。

soap:operation 元素定义了每个端口提供的操作符。

• 对于每个操作，相应的 SOAP 行为都需要被定义。

示例：

<message name="getTermRequest">
  <part name="term" type="xs:string"/>
</message>
 
<message name="getTermResponse">
  <part name="value" type="xs:string"/>
</message>
 
<portType name="glossaryTerms">
  <operation name="getTerm">
    <input message="getTermRequest"/>
    <output message="getTermResponse"/>
  </operation>
</portType>
 
<binding type="glossaryTerms" name="b1">
   <soap:binding style="document"
   transport="http://schemas.xmlsoap.org/soap/http" />
   <operation>
     <soap:operation soapAction="http://example.com/getTerm"/>
     <input><soap:body use="literal"/></input>
     <output><soap:body use="literal"/></output>
  </operation>
</binding>

参考

1. 菜鸟教程：WSDL 教程