Web Service 學(xué)習(xí)筆記

Web Service 概述

Web Service 的定義

W3C 組織對(duì)其的定義如下，它是一個(gè)軟件系統(tǒng)，為了支持跨網(wǎng)絡(luò)的機(jī)器間相互操作交互而設(shè)計(jì)。Web Service 服務(wù)通常被定義為一組模塊化的 API，它們可以通過(guò)網(wǎng)絡(luò)進(jìn)行調(diào)用，來(lái)執(zhí)行遠(yuǎn)程系統(tǒng)的請(qǐng)求服務(wù)。

這里我們從一個(gè)程序員的視角來(lái)觀察 web service。在傳統(tǒng)的程序編碼中，存在這各種的函數(shù)方法調(diào)用。通常，我們知道一個(gè)程序模塊M中的方法 A，向其發(fā)出調(diào)用請(qǐng)求，并傳入 A 方法需要的參數(shù) P，方法 A 執(zhí)行完畢后，返回處理結(jié)果 R。這種函數(shù)或方法調(diào)用通常發(fā)生在同一臺(tái)機(jī)器上的同一程序語(yǔ)言環(huán)境下?，F(xiàn)在的我們需要一種能夠在不同計(jì)算機(jī)間的不同語(yǔ)言編寫的應(yīng)用程序系統(tǒng)中，通過(guò)網(wǎng)絡(luò)通訊實(shí)現(xiàn)函數(shù)和方法調(diào)用的能力，而 Web service 正是應(yīng)這種需求而誕生的。

最普遍的一種說(shuō)法就是，Web Service = SOAP + HTTP + WSDL。其中，SOAP Simple Object Access Protocol）協(xié)議是 web service 的主體，它通過(guò) HTTP 或者 SMTP 等應(yīng)用層協(xié)議進(jìn)行通訊，自身使用 XML 文件來(lái)描述程序的函數(shù)方法和參數(shù)信息，從而完成不同主機(jī)的異構(gòu)系統(tǒng)間的計(jì)算服務(wù)處理。這里的 WSDL（Web Services Description Language）web 服務(wù)描述語(yǔ)言也是一個(gè) XML 文檔，它通過(guò) HTTP 向公眾發(fā)布，公告客戶端程序關(guān)于某個(gè)具體的 Web service 服務(wù)的 URL 信息、方法的命名，參數(shù)，返回值等。 下面，我們先來(lái)熟悉一下 SOAP 協(xié)議，看看它是如何描述程序中的函數(shù)方法、參數(shù)及結(jié)果對(duì)象的。

SOAP 協(xié)議簡(jiǎn)介

什么是 SOAP

SOAP 指簡(jiǎn)單對(duì)象訪問(wèn)協(xié)議，它是一種基于 XML 的消息通訊格式，用于網(wǎng)絡(luò)上，不同平臺(tái)，不同語(yǔ)言的應(yīng)用程序間的通訊?？勺远x，易于擴(kuò)展。一條 SOAP 消息就是一個(gè)普通的 XML 文檔，包含下列元素：

• Envelope 元素，標(biāo)識(shí) XML 文檔一條 SOAP 消息
• Header 元素，包含頭部信息的 XML 標(biāo)簽
• Body 元素，包含所有的調(diào)用和響應(yīng)的主體信息的標(biāo)簽
• Fault 元素，錯(cuò)誤信息標(biāo)簽。

以上的元素都在 SOAP 的命名空間 http://www.w3.org/2001/12/soap-envelope 中聲明；

SOAP 的語(yǔ)法規(guī)則

• SOAP 消息必須用 XML 來(lái)編碼
• SOAP 消息必須使用 SOAP Envelope 命名空間
• SOAP 消息必須使用 SOAP Encoding 命名空間
• SOAP 消息不能包含 DTD 引用
• SOAP 消息不能包含 XML 處理指令

SOAP 消息的基本結(jié)構(gòu)

<? xml version="1.0"?>
<soap:Envelope
xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
<soap:Header>
  ...
  ...
</soap:Header>
<soap:Body>
  ...
  ...
  <soap:Fault>
    ...
    ...
  </soap:Fault>
</soap:Body>
</soap:Envelope>

SOAP Envelope 元素

Envelope 元素是 SOAP 消息的根元素。它指明 XML 文檔是一個(gè) SOAP 消息。它的屬性 xmlns:soap 的值必須是 http://www.w3.org/2001/12/soap-envelope。

encodingStyle 屬性，語(yǔ)法：soap:encodingStyle="URI"

encodingStyle 屬性用于定義文檔中使用的數(shù)據(jù)類型。此屬性可出現(xiàn)在任何 SOAP 元素中，并會(huì)被應(yīng)用到元素的內(nèi)容及元素的所有子元素上。

<? xml version="1.0"?>
<soap:Envelope
xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
  ...
  Message information goes here
  ...
</soap:Envelope>

SOAP Header 元素

• actor 屬性，語(yǔ)法 soap:actor="URI"

通過(guò)沿著消息路徑經(jīng)過(guò)不同的端點(diǎn)，SOAP 消息可從某個(gè)發(fā)送者傳播到某個(gè)接收者。并非 SOAP 消息的所有部分均打算傳送到 SOAP 消息的最終端點(diǎn)，不過(guò)，另一個(gè)方面，也許打算傳送給消息路徑上的一個(gè)或多個(gè)端點(diǎn)。SOAP 的 actor 屬性可被用于將 Header 元素尋址到一個(gè)特定的端點(diǎn)。

• mustUnderstand 屬性 ，語(yǔ)法 soap:mustUnderstand="0|1"

SOAP 的 mustUnderstand 屬性可用于標(biāo)識(shí)標(biāo)題項(xiàng)對(duì)于要對(duì)其進(jìn)行處理的接收者來(lái)說(shuō)是強(qiáng)制的還是可選的。假如您向 Header 元素的某個(gè)子元素添加了 "mustUnderstand="1"，則要求處理此頭部的接收者必須認(rèn)可此元素。

<? xml version="1.0"?>
<soap:Envelope
xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
<soap:Header>
<m:Trans
xmlns:m="http://www.jsoso.net/transaction/" 
soap:mustUnderstand="1" 
soap:actor="http://www.w3schools.com/appml/ “  >234</m:Trans>
</soap:Header>
...
...
</soap:Envelope>

SOAP Body 元素

必需的 SOAP Body 元素可包含打算傳送到消息最終端點(diǎn)的實(shí)際 SOAP 消息。Body 元素中既可以包含 SOAP 定義的命名空間中的元素，如 Fault，也可以是用戶的應(yīng)用程序自定義的元素。以下是一個(gè)用戶定義的請(qǐng)求：

<? xml version="1.0"?>
<soap:Envelope
xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
<soap:Body>
   <m:GetPrice xmlns:m="http://www.jsoso.net/prices">
      <m:Item>Apples</m:Item>
   </m:GetPrice>
</soap:Body>
</soap:Envelope>

上面的例子請(qǐng)求蘋果的價(jià)格。請(qǐng)注意，上面的 m:GetPrice 和 Item 元素是應(yīng)用程序?qū)Ｓ玫脑亍Ｋ鼈儾⒉皇?SOAP 標(biāo)準(zhǔn)的一部分。而對(duì)應(yīng)的 SOAP 響應(yīng)應(yīng)該類似這樣：

<?xml version="1.0"?>
<soap:Envelope
xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
<soap:Body>
   <m:GetPriceResponse xmlns:m="http://www.jsoso.net/prices">
      <m:Price>1.90</m:Price>
   </m:GetPriceResponse>
</soap:Body>
</soap:Envelope>

SOAP Fault 元素

Fault 元素表示 SOAP 的錯(cuò)誤消息。它必須是 Body 元素的子元素，且在一條 SOAP 消息中，F(xiàn)ault 元素只能出現(xiàn)一次。Fault 元素?fù)碛邢铝凶釉兀?

http://wiki.jikexueyuan.com/project/java-special-topic/images/1.gif" alt="" />

常用的 SOAP Fault Codes

http://wiki.jikexueyuan.com/project/java-special-topic/images/2.gif" alt="" />

HTTP 協(xié)議中的 SOAP 實(shí)例

下面的例子中，一個(gè) GetStockPrice 請(qǐng)求被發(fā)送到了服務(wù)器。此請(qǐng)求有一個(gè) StockName 參數(shù)，而在響應(yīng)中則會(huì)返回一個(gè) Price 參數(shù)。此功能的命名空間被定義在此地址中： "http://www.jsoso.net/stock"

• SOAP 請(qǐng)求：(注意 HTTP 的 Head 屬性)

POST /InStock HTTP/1.1
Host: www.jsoso.net
Content-Type: application/soap+xml; charset=utf-8
Content-Length: XXX

<? xml version="1.0"?>
<soap:Envelope
xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
  <soap:Body xmlns:m="http://www.jsoso.net/stock">
    <m:GetStockPrice>
      <m:StockName>IBM</m:StockName>
    </m:GetStockPrice>
  </soap:Body>  
</soap:Envelope>

• SOAP 響應(yīng)：(注意 HTTP 的 Head 屬性)

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: XXX

<? xml version="1.0"?>
<soap:Envelope
xmlns:soap="http://www.w3.org/2001/12/soap-envelope"
soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">
  <soap:Body xmlns:m="http://www.jsoso.net/stock">
    <m:GetStockPriceResponse>
      <m:Price>34.5</m:Price>
    </m:GetStockPriceResponse>
  </soap:Body>  
</soap:Envelope>

HTTP 協(xié)議中的 SOAP RPC 工作流程

http://wiki.jikexueyuan.com/project/java-special-topic/images/3.gif" alt="" />

WSDL 簡(jiǎn)介

介紹過(guò)了 SOAP，讓我們關(guān)注 Web Service 中另外一個(gè)重要的組成 WSDL。

WSDL 的主要文檔元素

http://wiki.jikexueyuan.com/project/java-special-topic/images/4.gif" alt="" />

WSDL 文檔可以分為兩部分。頂部分由抽象定義組成，而底部分則由具體描述組成。抽象部分以獨(dú)立于平臺(tái)和語(yǔ)言的方式定義SOAP消息，它們并不包含任何隨機(jī)器或語(yǔ)言而變的元素。這就定義了一系列服務(wù)，截然不同的應(yīng)用都可以實(shí)現(xiàn)。具體部分，如數(shù)據(jù)的序列化則歸入底部分，因?yàn)樗唧w的定義。在上述的文檔元素中，、、屬于抽象定義層，、屬于具體定義層。所有的抽象可以是單獨(dú)存在于別的文件中，也可以從主文檔中導(dǎo)入。

WSDL 文檔的結(jié)構(gòu)實(shí)例解析

下面我們將通過(guò)一個(gè)實(shí)際的 WSDL 文檔例子來(lái)詳細(xì)說(shuō)明各標(biāo)簽的作用及關(guān)系。

<?xml version="1.0" encoding="UTF-8"?>
<definitions
 xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
 xmlns:tns="http://www.jsoso.com/wstest"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns="http://schemas.xmlsoap.org/wsdl/"
 targetNamespace="http://www.jsoso.com/wstest"
 name="Example">

<types>
  <xsd:schema>
  <xsd:import
   namespace="http://www.jsoso.com/wstest"
   schemaLocation="http://localhost:8080/hello?xsd=1"></xsd:import>
  </xsd:schema>
</types>

<message name="toSayHello">
  <part name="userName" type="xsd:string"></part>
</message>
<message name="toSayHelloResponse">
  <part name="returnWord" type="xsd:string"></part>
</message>

<message name="sayHello">
  <part name="person" type="tns:person"></part>
  <part name="arg1" type="xsd:string"></part>
</message>
<message name="sayHelloResponse">
  <part name="personList" type="tns:personArray"></part>
</message>
<message name="HelloException">
  <part name="fault" element="tns:HelloException"></part>
</message>

<portType name="Example">
  <operation name="toSayHello" parameterOrder="userName">
    <input message="tns:toSayHello"></input>
    <output message="tns:toSayHelloResponse"></output>
  </operation>
  <operation name="sayHello" parameterOrder="person arg1">
    <input message="tns:sayHello"></input>
    <output message="tns:sayHelloResponse"></output>
    <fault message="tns:HelloException" name="HelloException"></fault>
  </operation>
</portType>

<binding name="ExamplePortBinding" type="tns:Example">
  <soap:binding
    transport="http://schemas.xmlsoap.org/soap/http" 
    style="rpc"></soap:binding>
  <operation name="toSayHello">
    <soap:operation soapAction="sayHello"></soap:operation>
    <input>
      <soap:body use="literal"
        namespace="http://www.jsoso.com/wstest"></soap:body>
    </input>
    <output>
      <soap:body use="literal"
         namespace="http://www.jsoso.com/wstest"></soap:body>
    </output>
  </operation>
  <operation name="sayHello">
    <soap:operation soapAction="sayHello"></soap:operation>
    <input>
      <soap:body use="literal"
        namespace="http://www.jsoso.com/wstest"></soap:body>
    </input>
    <output>
      <soap:body use="literal"
        namespace="http://www.jsoso.com/wstest"></soap:body>
    </output>
    <fault name="HelloException">
      <soap:fault name="HelloException" use="literal"></soap:fault>
    </fault>
    </operation>
</binding>

<service name="Example">
  <port name="ExamplePort" binding="tns:ExamplePortBinding">
    <soap:address location="http://localhost:8080/hello"></soap:address>
  </port>
</service>
</definitions>

由于上面的事例 XML 較長(zhǎng)，我們將其逐段分解講解

WSDL 文檔的根元素：＜definitions＞

<definitions
 xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
 xmlns:tns="http://www.jsoso.com/wstest"
 xmlns:xsd="http://www.w3.org/2001/XMLSchema"
 xmlns="http://schemas.xmlsoap.org/wsdl/"
 targetNamespace="http://www.jsoso.com/wstest"
 name="Example">
……
……
</definitions>

＜definitions＞定義了文檔中用到的各個(gè) xml 元素的 namespace 縮寫，也界定了本文檔自己的 targetNamespace=" XML 要引用當(dāng)前 XML 中的元素時(shí)，要聲明這個(gè) namespace。注意 xmlns:tns=" tns 這個(gè)前綴指向自身的命名空間。

<types>
  <xsd:schema>
  <xsd:import
   namespace="http://www.jsoso.com/wstest"
   schemaLocation="http://localhost:8080/hello?xsd=1"></xsd:import>
  </xsd:schema>
</types>