WEBSERVICE入门03：WSDL结构详解

WSDL(Web服务描述语言，WebService Description Language)是为描述Web服务发布的XML格式。WSDL是一种XML Application，它将Web服务描述定义为一组服务访问点，客户端可以通过这些服务访问点对包含面向文档信息或者面向过程调用的服务进行访问(类似远程过程调用)。WSDL首先对访问的操作和访问时使用的请求/响应消息进行抽象描述，然后将其绑定到具体的传输协议和消息格式上以确定最终定义具体部署的服务访问点。相关的具体部署的服务访问点通过组合成为抽象的Web服务。

WSDL文档将web服务定义为服务访问点或端口的集合。在WSDL中，由于访问服务点和消息的抽象定义已从具体的服务部署或数据格式绑定中分离出来，因此可以对抽象定义再次使用：消息，是指对交换数据的抽象描述；端口类型，是指操作的抽象集合。用于特定端口类型的具体协议和数据格式规范构成了可以再次使用的绑定。将Web访问地址与可再次使用的绑定想关联，可以定义一个端口，而端口的集合则定义为服务。

2.WSDL概述

一个WSDL文档通常包含7个重要的元素，即types、import、message、portType、operation、binding、service元素。这些元素嵌套在definitions元素中，definitions是WSDL文档的根元素。

每个元素的基本含义如下：

Types:数据定义的容器，它使用某种系统类型(一般都是XMLSchema中的类型系统)

Message:通信消息的数据结构的抽象化定义。使用Types所定义的类型来定义整个消息的数据结构。

Operation:对服务中所支持的操作的抽象描述，一般单个Operation描述了一个访问入口的请求/响应地址

PortType:对于某个访问入口点类型所支持的操作的抽象集合，这些操作可以有一个或者多个服务访问点来支持。

Binding:特定端口类型的具体协议和数据格式规范的绑定。

Port:定义为协议/数据格式绑定与具体Web访问地址组合的单个服务访问点。

Service:相关服务访问点的集合。

3.WDSL示例详解

输入了http://localhost:6789/ns?wsdl（是基于上一篇发布的服务的url）后，得到的文件如下：

<definitions xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:wsp="http://www.w3.org/ns/ws-policy" xmlns:wsp1_2="http://schemas.xmlsoap.org/ws/2004/09/policy" xmlns:wsam="http://www.w3.org/2007/05/addressing/metadata" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tns="http://service.wyj.com/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.xmlsoap.org/wsdl/" targetNamespace="http://service.wyj.com/" name="MyServiceImplService">
<types>
<xsd:schema>
<xsd:import namespace="http://service.wyj.com/" schemaLocation="http://localhost:6789/ns?xsd=1"/>
</xsd:schema>
</types>
<message name="add">
<part name="parameters" element="tns:add"/>
</message>
<message name="addResponse">
<part name="parameters" element="tns:addResponse"/>
</message>
<message name="sayHi">
<part name="parameters" element="tns:sayHi"/>
</message>
<message name="sayHiResponse">
<part name="parameters" element="tns:sayHiResponse"/>
</message>
<portType name="IMyservice">
<operation name="add">...</operation>
<operation name="sayHi">...</operation>
</portType>
<binding name="MyServiceImplPortBinding" type="tns:IMyservice">...</binding>
<service name="MyServiceImplService">
<port name="MyServiceImplPort" binding="tns:MyServiceImplPortBinding">
<soap:address location="http://localhost:6789/ns"/>
</port>
</service>
</definitions>

这是一个简单的web服务的WSDL文档，该服务支持add和sayHi两个操作，该操作通过在http上运行SOAP协议来实现的。其中add方法接受2个int类型的参数，返回它们的和。而sayHi接受一个字符串，然后返回一个简单的字符串。其中：

types元素使用XML模式语言声明在WSDL文档中的其他位置使用的复杂数据类型与元素；

import元素类似于XML模式文档中的import元素，用于从其他WSDL文档中导入WSDL定义；

在本例中Types中就是引用的外部的schema文件，在浏览器中输入http://localhost:6789/ns?xsd=1，即可以看到定义的数据类型和元素。

• message元素使用在WSDL文档的type元素中定义或在import元素引用的外部WSDL文档中定义的XML模式的内置类型、复杂类型。
• portType元素和operation元素描述了Web服务的接口并定义了他的方法，operation元素类似于java接口和接口中定义的方法声明，operation元素使用一个或者多个message类型来定义他的输入和输出的有效负载；

• Binding元素将portType元素和operation元素赋给一个特殊的协议和编码样式；

• Port描述的是一个服务访问入口的部署细节，包括通过哪个Web地址(URL)来访问，应当使用怎样的消息调用模式来访问等。其中消息调用模式则是使用Binding结构来表示。

• service元素负责将Internet地址赋给一个具体的绑定；

1.definition元素

所有的WSDL文档的根元素都是definition元素。该元素封装了整个文档，同时通过其name提供了一个WSDL文档。除了一个命名空间外，改元素没有其他作用。以下是definition元素的结构:

<definitions xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" 
xmlns:wsp="http://www.w3.org/ns/ws-policy" xmlns:wsp1_2="http://schemas.xmlsoap.org/ws/2004/09/policy" xmlns:wsam="http://www.w3.org/2007/05/addressing/metadata" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tns="http://service.wyj.com/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.xmlsoap.org/wsdl/" targetNamespace="http://service.wyj.com/" 
name="MyServiceImplService">
</definitions>

2、types元素

?WSDL采用了W3C XML模式内置类型作为其基本类型系统。types元素用作一个容器，用于定义XML模式内置类型中没有描述的各种数据类型。当声明消息部分的有效负载时，消息定义使用了在types元素中定义的数据类型和元素。在本文的WSDL文档中的types定义：(由于在服务引用了外部的schema文件，需要在浏览器中输入: http://localhost:6789/ns?xsd=1就可以看到types完整的定义了)

<xs:schema xmlns:tns="http://service.wyj.com/" xmlns:xs="http://www.w3.org/2001/XMLSchema" version="1.0" targetNamespace="http://service.wyj.com/">
<xs:element name="add" type="tns:add"/>
<xs:element name="addResponse" type="tns:addResponse"/>
<xs:element name="sayHi" type="tns:sayHi"/>
<xs:element name="sayHiResponse" type="tns:sayHiResponse"/>
<xs:complexType name="sayHi">
<xs:sequence>
<xs:element name="arg0" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="sayHiResponse">
<xs:sequence>
<xs:element name="return" type="xs:string" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="add">
<xs:sequence>
<xs:element name="arg0" type="xs:int"/>
<xs:element name="arg1" type="xs:int"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="addResponse">
<xs:sequence>
<xs:element name="return" type="xs:int"/>
</xs:sequence>
</xs:complexType>
</xs:schema>

上面就是数据类型的定义，其中

sayHi:定义了一个复杂类型，包含了一个string类型的数据，将来用来描述操作参数传入的部分。

sayHiResponse:定义了一个复杂类型，包含了一个string类型的数据，将来用来描述操作的返回值。

add:定义了一个复杂类型，包含了2个int类型的数据，将来用来描述操作的参数的传入部分。

addResponse:定义了一个负载类型，包含了一个string类型的数据，将来用作操作的返回值。

3、import元素

import元素使得可以在当前的WSDL文档中使用其他WSDL文档中指定的命名空间中的定义元素。如：

<types>
<xsd:schema>
<xsd:import namespace="http://service.wyj.com/" schemaLocation="http://localhost:6789/ns?xsd=1"/>
</xsd:schema>
</types>

必须有namespace属性和location属性：

namespace属性：值必须与正导入的WSDL文档中声明的targetNamespace相匹配；

location属性：必须指向一个实际的WSDL文档，并且该文档不能为空。

4、message元素

message元素描述了Web服务使用消息的有效负载。message元素可以描述输出或者接受消息的有效负载；还可以描述SOAP文件头和错误detail元素的内容。如：

<message name="add">
<part name="parameters" element="tns:add"/>
</message>
<message name="addResponse">
<part name="parameters" element="tns:addResponse"/>
</message>
<message name="sayHi">
<part name="parameters" element="tns:sayHi"/>
</message>
<message name="sayHiResponse">
<part name="parameters" element="tns:sayHiResponse"/>
</message>

该部分是消息格式的抽象定义：定义了四个消息sayHi和sayHiResponse，以及add和addResponse。（以下只对add和addResponse进行说明，其他2个读者可以自行类推）

add:由一个消息片段组成，该消息片段名称是parameters，包含的具体元素类型是add。（前面已经定义过了）

addResponse:由一个消息片段组成，该消息片段名称是parameters，包含的具体元素是addResponse。（前面已经定义过了）

5.portType元素

portType元素定义了Web服务的抽象接口。该接口有点类似Java的接口，都是定义了一个抽象类型和方法，没有定义实现。在WSDL中，portType元素是由binding和service元素来实现的，这两个元素用来说明Web服务实现使用的Internet协议、编码方案以及Internet地址。

一个portType中可以定义多个operation，一个operation可以看作是一个方法，本文中WSDL文档的定义：

<portType name="IMyservice">
<operation name="add">
<input wsam:Action="http://service.wyj.com/IMyservice/addRequest" message="tns:add"/>
<output wsam:Action="http://service.wyj.com/IMyservice/addResponse" message="tns:addResponse"/>
</operation>
<operation name="sayHi">
<input wsam:Action="http://service.wyj.com/IMyservice/sayHiRequest" message="tns:sayHi"/>
<output wsam:Action="http://service.wyj.com/IMyservice/sayHiResponse" message="tns:sayHiResponse"/>
</operation>
</portType>

portType定义了服务的调用模式的类型，这里包含了add操作和sayHi操作，同时包含input和output表明该操作是一个响应操作，其中add操作的请求消息是add，响应消息是addResponse；sayHi操作的请求消息是sayHi，响应消息是sayHiResponse。

6、binding

binding元素将一个抽象portType映射到一组具体协议(SOAP和HTTP)、消息传递样式、编码样式。通常binding元素与协议专有的元素和在一起使用，如：

<binding name="MyServiceImplPortBinding" type="tns:IMyservice">
<soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/>
<operation name="add">
<soap:operation soapAction=""/>
<input>
<soap:body use="literal"/>
</input>
<output>
<soap:body use="literal"/>
</output>
</operation>
<operation name="sayHi">...</operation>
</binding>

<service name="MyServiceImplService">
<port name="MyServiceImplPort" binding="tns:MyServiceImplPortBinding">
<soap:address location="http://localhost:6789/ns"/>
</port>
</service>