WSDL (Web Services Description Language,Web服務(wù)描述語言)是一種XML
Application,他將Web服務(wù)描述定義為一組服務(wù)訪問點(diǎn),客戶端可以通過這些服務(wù)訪問點(diǎn)對(duì)包含面向文檔信息或面向過程調(diào)用的服務(wù)進(jìn)行訪問(類似
遠(yuǎn)程過程調(diào)用)。WSDL首先對(duì)訪問的操作和訪問時(shí)使用的請(qǐng)求/響應(yīng)消息進(jìn)行抽象描述,然后將其綁定到具體的傳輸協(xié)議和消息格式上以最終定義具體部署的服
務(wù)訪問點(diǎn)。相關(guān)的具體部署的服務(wù)訪問點(diǎn)通過組合就成為抽象的Web服務(wù)。 本文將詳細(xì)講解WSDL文檔的結(jié)構(gòu),并分析每個(gè)元素的作用。
一:WSDL定義
WSDL是一個(gè)用于精確描述Web服務(wù)的文檔,WSDL文檔是一個(gè)遵循WSDL XML模式的XML文檔。WSDL
文檔將Web服務(wù)定義為服務(wù)訪問點(diǎn)或端口的集合。在 WSDL
中,由于服務(wù)訪問點(diǎn)和消息的抽象定義已從具體的服務(wù)部署或數(shù)據(jù)格式綁定中分離出來,因此可以對(duì)抽象定義進(jìn)行再次使用:消息,指對(duì)交換數(shù)據(jù)的抽象描述;而端
口類型,指操作的抽象集合。用于特定端口類型的具體協(xié)議和數(shù)據(jù)格式規(guī)范構(gòu)成了可以再次使用的綁定。將Web訪問地址與可再次使用的綁定相關(guān)聯(lián),可以定義一
個(gè)端口,而端口的集合則定義為服務(wù)。
一個(gè)WSDL文檔通常包含7個(gè)重要的元素,即types、import、message、portType、operation、binding、
service元素。這些元素嵌套在definitions元素中,definitions是WSDL文檔的根元素。文章的下一部分將會(huì)詳細(xì)介紹WSDL
的基本結(jié)構(gòu)。
二:WSDL的基本結(jié)構(gòu)--概述
如第一部分最后描述的那樣,一個(gè)基本的WSDL文檔包含7個(gè)重要的元素。下面將分別介紹這幾個(gè)元素以及他們的作用。
WSDL 文檔在Web服務(wù)的定義中使用下列元素:
- Types - 數(shù)據(jù)類型定義的容器,它使用某種類型系統(tǒng)(一般地使用XML Schema中的類型系統(tǒng))。
- Message - 通信消息的數(shù)據(jù)結(jié)構(gòu)的抽象類型化定義。使用Types所定義的類型來定義整個(gè)消息的數(shù)據(jù)結(jié)構(gòu)。
- Operation - 對(duì)服務(wù)中所支持的操作的抽象描述,一般單個(gè)Operation描述了一個(gè)訪問入口的請(qǐng)求/響應(yīng)消息對(duì)。
- PortType - 對(duì)于某個(gè)訪問入口點(diǎn)類型所支持的操作的抽象集合,這些操作可以由一個(gè)或多個(gè)服務(wù)訪問點(diǎn)來支持。
- Binding - 特定端口類型的具體協(xié)議和數(shù)據(jù)格式規(guī)范的綁定。
- Port - 定義為協(xié)議/數(shù)據(jù)格式綁定與具體Web訪問地址組合的單個(gè)服務(wù)訪問點(diǎn)。
- Service- 相關(guān)服務(wù)訪問點(diǎn)的集合。
可以參考下圖來理解一下WSDL的文檔結(jié)構(gòu)圖:
WSDL的xml schema可以參照如下網(wǎng)址:http://schemas.xmlsoap.org/wsdl/
三:WSDL的基本結(jié)構(gòu)--詳述
本節(jié)將通過一個(gè)例子詳細(xì)描述WSDL文檔每個(gè)元素的作用。下面一個(gè)例子是一個(gè)簡單的WSDL文檔的內(nèi)容,該文檔的產(chǎn)生可以參見我的另外一篇文章:xfire開發(fā)實(shí)例--HelloWorld篇 。
一個(gè)簡單的Web Service的WSDL文檔,該服務(wù)支持名為sayHello的唯一操作,該操作通過在http上運(yùn)行SOAP協(xié)議來實(shí)現(xiàn)的。該請(qǐng)求接受一個(gè)字符串name,經(jīng)過處理后返回一個(gè)簡單的字符串。文檔如下:
♦ types元素使用XML模式語言聲明在WSDL文檔中的其他位置使用的復(fù)雜數(shù)據(jù)類型與元素;
♦ import元素類似于XML模式文檔中的import元素,用于從其他WSDL文檔中導(dǎo)入WSDL定義;
♦ message元素使用在WSDL文檔的type元素中定義或在import元素引用的外部WSDL文檔中定義的XML模式的內(nèi)置類型、復(fù)雜類型或元素描述了消息的有效負(fù)載;
♦ portType元素和operation元素描述了Web服務(wù)的接口并定義了他的方法。portType元素和operation元素類似于
java接口和接口中定義的方法聲明。operation元素使用一個(gè)或者多個(gè)message類型來定義他的輸入和輸出的有效負(fù)載;
♦ Binding元素將portType元素和operation元素賦給一個(gè)特殊的協(xié)議和編碼樣式;
♦ service元素負(fù)責(zé)將Internet地址賦給一個(gè)具體的綁定;
1、definitions元素
所有的WSDL文檔的根元素均是definitions元素。該元素封裝了整個(gè)文檔,同時(shí)通過其name提供了一個(gè)WSDL文檔。除了提供一個(gè)命名空間外,該元素沒有其他作用,故不作詳細(xì)描述。
下面的代碼是一個(gè)definitions元素的結(jié)構(gòu):
2、types元素
WSDL采用了W3C
XML模式內(nèi)置類型作為其基本類型系統(tǒng)。types元素用作一個(gè)容器,用于定義XML模式內(nèi)置類型中沒有描述的各種數(shù)據(jù)類型。當(dāng)聲明消息部分的有效負(fù)載
時(shí),消息定義使用了在types元素中定義的數(shù)據(jù)類型和元素。在本文的WSDL文檔中的types定義:
<wsdl:types>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
attributeFormDefault="qualified" elementFormDefault="qualified"
targetNamespace="http://com.liuxiang.xfireDemo/HelloService">
<xsd:element name="sayHello">
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1"
name="name" nillable="true" type="xsd:string" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="sayHelloResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element maxOccurs="1" minOccurs="1"
name="out" nillable="true" type="xsd:string" />
</xsd:sequence>
</xsd:complexType>
</xsd:element>
</xsd:schema>
</wsdl:types>
上面是數(shù)據(jù)定義部分,該部分定義了兩個(gè)元素,一個(gè)是sayHello,一個(gè)是sayHelloResponse:
sayHello:定義了一個(gè)復(fù)雜類型,僅僅包含一個(gè)簡單的字符串,將來用來描述操作的參入傳入部分;
sayHelloResponse:定義了一個(gè)復(fù)雜類型,僅僅包含一個(gè)簡單的字符串,將來用來描述操作的返回值;
3、import元素
import元素使得可以在當(dāng)前的WSDL文檔中使用其他WSDL文檔中指定的命名空間中的定義元素。本例子中沒有使用import元素。通常在用戶希望模塊化WSDL文檔的時(shí)候,該功能是非常有效果的。
import的格式如下:
必須有namespace屬性和location屬性:
namespace屬性:值必須與正導(dǎo)入的WSDL文檔中聲明的targetNamespace相匹配;
location屬性:必須指向一個(gè)實(shí)際的WSDL文檔,并且該文檔不能為空。
4、message元素
message元素描述了Web服務(wù)使用消息的有效負(fù)載。message元素可以描述輸出或者接受消息的有效負(fù)載;還可以描述SOAP文件頭和錯(cuò)誤detail元素的內(nèi)容。定義message元素的方式取決于使用RPC樣式還是文檔樣式的消息傳遞。在本文中的message元素的定義,本文檔使用了采用文檔樣式的消息傳遞:
<wsdl:message name="sayHelloResponse">
<wsdl:part name="parameters" element="tns:sayHelloResponse" />
</wsdl:message>
<wsdl:message name="sayHelloRequest">
<wsdl:part name="parameters" element="tns:sayHello" />
</wsdl:message>
該部分是消息格式的抽象定義:定義了兩個(gè)消息sayHelloResponse和sayHelloRequest:
sayHelloRequest:sayHello操作的請(qǐng)求消息格式,由一個(gè)消息片斷組成,名字為parameters,元素是我們前面定義的types中的元素;
sayHelloResponse:sayHello操作的響應(yīng)消息格式,由一個(gè)消息片斷組成,名字為parameters,元素是我們前面定義的types中的元素;
如果采用RPC樣式的消息傳遞,只需要將文檔中的element元素應(yīng)以修改為type即可。
5、portType元素
portType元素定義了Web服務(wù)的抽象接口。該接口有點(diǎn)類似Java的接口,都是定義了一個(gè)抽象類型和方法,沒有定義實(shí)現(xiàn)。在WSDL中,
portType元素是由binding和service元素來實(shí)現(xiàn)的,這兩個(gè)元素用來說明Web服務(wù)實(shí)現(xiàn)使用的Internet協(xié)議、編碼方案以及
Internet地址。
一個(gè)portType中可以定義多個(gè)operation,一個(gè)operation可以看作是一個(gè)方法,本文中WSDL文檔的定義:
<wsdl:portType name="HelloServicePortType">
<wsdl:operation name="sayHello">
<wsdl:input name="sayHelloRequest"
message="tns:sayHelloRequest" />
<wsdl:output name="sayHelloResponse"
message="tns:sayHelloResponse" />
</wsdl:operation>
</wsdl:portType>
portType定義了服務(wù)的調(diào)用模式的類型,這里包含一個(gè)操作sayHello方法,同時(shí)包含input和output表明該操作是一個(gè)請(qǐng)求/響
應(yīng)模式,請(qǐng)求消息是前面定義的sayHelloRequest,響應(yīng)消息是前面定義的sayHelloResponse。input表示傳遞到Web服務(wù)
的有效負(fù)載,output消息表示傳遞給客戶的有效負(fù)載。
6、binding
binding元素將一個(gè)抽象portType映射到一組具體協(xié)議(SOAO和HTTP)、消息傳遞樣式、編碼樣式。通常binding元素與協(xié)議專有的元素和在一起使用,本文中的例子:
<wsdl:binding name="HelloServiceHttpBinding"
type="tns:HelloServicePortType">
<wsdlsoap:binding style="document"
transport="http://schemas.xmlsoap.org/soap/http" />
<wsdl:operation name="sayHello">
<wsdlsoap:operation soapAction="" />
<wsdl:input name="sayHelloRequest">
<wsdlsoap:body use="literal" />
</wsdl:input>
<wsdl:output name="sayHelloResponse">
<wsdlsoap:body use="literal" />
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
這部分將服務(wù)訪問點(diǎn)的抽象定義與SOAP HTTP綁定,描述如何通過SOAP/HTTP來訪問按照前面描述的訪問入口點(diǎn)類型部署的訪問入口。其中規(guī)定了在具體
具體的使用需要參考特定協(xié)議定義的元素。
7、service元素和port元素
service元素包含一個(gè)或者多個(gè)port元素,其中每個(gè)port元素表示一個(gè)不同的Web服務(wù)。port元素將URL賦給一個(gè)特定的binding,甚至可以使兩個(gè)或者多個(gè)port元素將不同的URL賦值給相同的binding。文檔中的例子:
這部分是具體的Web服務(wù)的定義,在這個(gè)名為HelloService的Web服務(wù)中,提供了一個(gè)服務(wù)訪問入口,訪問地址是http://localhost:8080/xfire/services/HelloService,使用的消息模式是由前面的binding所定義的。
本文簡單介紹了WSDL規(guī)范的用途,基本結(jié)構(gòu)和使用方法,希望對(duì)大家學(xué)習(xí)WSDL有幫助。