WSDL詳解 WebService中的WSDL詳解

WebService中的WSDL詳解

       有人在WebService開發的時候，特別是和第三方有接口的時候，走的是SOAP協議，然後用戶（或後臺）給你一個WSDL文件（或網址），說按照上面的進行適配， 這時就要對WebService的WSDL有一定的理解，本文將對WSDL（WebService描述語言）進行詳細總結。
       WSDL (Web Services Description Language,Web服務描述語言)是一種XML Application，他將Web服務描述定義爲一組服務訪問點，客戶端可以通過這些服務訪問點對包含面向文檔信息或面向過程調用的服務進行訪問(類似遠程過程調用)。WSDL首先對訪問的操作和訪問時使用的請求/響應消息進行抽象描述，然後將其綁定到具體的傳輸協議和消息格式上以最終定義具體部署的服務訪問點。相關的具體部署的服務訪問點通過組合就成爲抽象的Web服務。

一．WSDL的基本概念

       WSDL是一個用於精確描述Web服務的文檔，WSDL文檔是一個遵循WSDL-XML模式的XML文檔。WSDL 文檔將Web服務定義爲服務訪問點或端口的集合。在 WSDL 中，由於服務訪問點和消息的抽象定義已從具體的服務部署或數據格式綁定中分離出來，因此可以對抽象定義進行再次使用。消息，指對交換數據的抽象描述；而端口類型，指操作的抽象集合。用於特定端口類型的具體協議和數據格式規範構成了可以再次使用的綁定。將Web訪問地址與可再次使用的綁定相關聯，可以定義一個端口，而端口的集合則定義爲服務。
       一個WSDL文檔通常包含8個重要的元素，即definitions、types、import、message、portType、operation、binding、service元素。這些元素嵌套在definitions元素中，definitions是WSDL文檔的根元素。
WSDL文檔外層結構圖示：

WSDL 服務進行交互的基本元素：
Types（消息類型）：數據類型定義的容器，它使用某種類型系統（如 XSD）。
Message（消息）：通信數據的抽象類型化定義，它由一個或者多個 part 組成。
Part：消息參數
PortType（端口類型）：特定端口類型的具體協議和數據格式規範。，它由一個或者多個 Operation組成。
Operation（操作）：對服務所支持的操作進行抽象描述，WSDL定義了四種操作：
1.單向（one-way）：端點接受信息；
3.要求-響應（solicit-response）：端點發送消息，然後接受相關消息；
4.通知（notification[2] ）：端點發送消息。

Binding：特定端口類型的具體協議和數據格式規範。
Port：定義爲綁定和網絡地址組合的單個端點。
Service：相關端口的集合，包括其關聯的接口、操作、消息等。
外層結構裏面也可能有多層結構。

二．WSDL的基本結構詳解

下面通過一份wsdl文檔，來詳細解讀WSDL結構：

<?xml version="1.0" encoding="UTF-8" ?>
<wsdl:definitions
    targetNamespace="http://com.liuxiang.xfireDemo/HelloService"
    xmlns:tns="http://com.liuxiang.xfireDemo/HelloService"
    xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/"
    xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns:soapenc11="http://schemas.xmlsoap.org/soap/encoding/"
    xmlns:soapenc12="http://www.w3.org/2003/05/soap-encoding"
    xmlns:soap11="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
    <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="0"
                            name="return" nillable="true" type="xsd:string" />
                    </xsd:sequence>
                </xsd:complexType>
            </xsd:element>
        </xsd:schema>
    </wsdl:types>
    <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>
    <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>
    <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>
    <wsdl:service name="HelloService">
        <wsdl:port name="HelloServiceHttpPort"
            binding="tns:HelloServiceHttpBinding">
            <wsdlsoap:address
                location="http://localhost:8080/xfire/services/HelloService" />
        </wsdl:port>
    </wsdl:service>
</wsdl:definitions>

（一） definitions元素

       所有的WSDL文檔的根元素均是definitions元素。該元素封裝了整個文檔，同時通過其name提供了一個WSDL文檔。除了提供一個命名空間（targetNamespace）外，該元素沒有其他作用，故不作詳細描述。

（二）types元素

       WSDL採用了W3C XML模式內置類型作爲其基本類型系統。types元素用作一個容器，用於定義XML模式內置類型中沒有描述的各種數據類型（不太明白：XML模式內置類型中沒有描述的各種數據類型）。當聲明消息部分的有效時，消息定義使用了在types元素中定義的數據類型和元素。在本文的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="0"
                            name="return" nillable="true" type="xsd:string" />
                    </xsd:sequence>
                </xsd:complexType>
            </xsd:element>
        </xsd:schema>
    </wsdl:types>

       上面是數據定義部分，該部分定義了兩個元素，一個是sayHello，一個是sayHelloResponse：
       sayHello：定義了一個複雜類型，僅僅包含一個簡單的字符串，將來用來描述操作的參入傳入部分；
       sayHelloResponse：定義了一個複雜類型，僅僅包含一個簡單的字符串，將來用來描述操作的返回值；
       這裏sayHelloResponse是和sayHello相關的，sayHello相對於一個方法，裏面的： type=”xsd:string”，name=”name”，是確定傳入name的參數是String類型的，而sayHelloResponse中的 name=”return” type=”xsd:string” 是確定方法sayHello（String name）返回的類型是String類型的。

（三）import元素

       import元素使得可以在當前的WSDL文檔中使用其他WSDL文檔中指定的命名空間中的定義元素。本例子中沒有使用import元素。通常在用戶希望模塊化WSDL文檔的時候，該功能是非常有效果的。
import的格式如下：

<wsdl:import namespace="http://xxx.xxx.xxx/xxx/xxx" location="http://xxx.xxx.xxx/xxx/xxx.wsdl"/>

必須有namespace屬性和location屬性：
1.namespace屬性：值必須與正導入的WSDL文檔中聲明的targetNamespace相匹配；
2.location屬性：必須指向一個實際的WSDL文檔，並且該文檔不能爲空。

（四）message元素

       message元素描述了Web服務使用消息的有效負載。message元素可以描述輸出或者接受消息的有效負載；還可以描述SOAP文件頭和錯誤detail元素的內容。定義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>

       該部分是消息格式的抽象定義：定義了兩個消息sayHelloResponse和sayHelloRequest：

1.sayHelloRequest：

sayHello操作的請求消息格式，由一個消息片斷組成，名字爲parameters,元素是我們前面定義的types中的元素；

2.sayHelloResponse：

sayHello操作的響應消息格式，由一個消息片斷組成，名字爲parameters,元素是我們前面定義的types中的元素；
        如果採用RPC樣式的消息傳遞，只需要將文檔中的element元素修改爲type即可（？？）。

（五）portType元素

       portType元素定義了Web服務的抽象接口。該接口有點類似Java的接口，都是定義了一個抽象類型和方法，沒有定義實現。在WSDL中，portType元素是由binding和service元素來實現的，這兩個元素用來說明Web服務實現使用的Internet協議、編碼方案以及Internet地址。
一個portType中可以定義多個operation，一個operation可以看作是一個方法，本文中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定義了服務的調用模式的類型，這裏包含一個操作sayHello方法，同時包含input和output表明該操作是一個請求／響應模式，請求消息是前面定義的sayHelloRequest，響應消息是前面定義的sayHelloResponse。input表示傳遞到Web服務的有效負載，output消息表示傳遞給客戶的有效負載。
       這裏相當於抽象類中定義了一個抽象方法sayHello，而方法參數的定義和返回值的定義都是在types中設置的，方法名又是在message中定義有的。

（六）binding

       binding元素將一個抽象portType映射到一組具體協議(SOAO和HTTP)、消息傳遞樣式、編碼樣式。通常binding元素與協議專有的元素和在一起使用，本文中的例子：

<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>

       這部分將服務訪問點的抽象定義與SOAP、HTTP綁定，描述如何通過SOAP/HTTP來訪問按照前面描述的訪問入口點類型部署的訪問入口。
其中規定了在具體SOAP調用時，應當使用的soapAction是”xxx”，這個Action在WebService代碼調用中是很重要的。具體的使用需要參考特定協議定義的元素。

（七）service元素和port元素

       service元素包含一個或者多個port元素，其中每個port元素表示一個不同的Web服務。port元素將URL賦給一個特定的binding，甚至可以使兩個或者多個port元素將不同的URL賦值給相同的binding。文檔中的例子：

    <wsdl:service name="HelloService">
        <wsdl:port name="HelloServiceHttpPort"
            binding="tns:HelloServiceHttpBinding">
            <wsdlsoap:address
                location="http://localhost:8080/xfire/services/HelloService" />
        </wsdl:port>
    </wsdl:service>

       對於這個WSDL文檔的學習，第一次看是感覺非常陌生的，而且裏面元素又多，學習的話先是要了解外層結構代表的意義和作用，然後理解裏面的元素的意義和作用，有些元素作用不大，有些元素又是很關聯的，有些元素是比較重要的。
WSDL圖解：

共勉：沒有絕望的處境,只有對處境絕望的人。

————————————————
版權聲明：本文爲CSDN博主「崢嶸life」的原創文章，遵循CC 4.0 BY-SA版權協議，轉載請附上原文出處鏈接及本聲明。
原文鏈接：https://blog.csdn.net/wenzhi20102321/java/article/details/68486526