設(shè)計(jì)合同

申請(qǐng)免費(fèi)試用、咨詢電話：400-8352-114

設(shè)計(jì)合同

Scott Seely

Microsoft Corporation

2001年6月6日

簡(jiǎn)介

我們已經(jīng)很長(zhǎng)時(shí)間沒有在 At Your Service 專欄中與您進(jìn)行交流了。為了扭轉(zhuǎn)這一局面，我們專門成立了一個(gè)小組來從事這方面的工作，小組成員包括 Matt Powell 和 Scott Seely。我是 Scott，先由我和大家來探討有關(guān)問題。不久前，Mary Kirtland 在讓我們認(rèn)識(shí)一下（英文）一文中對(duì)我們進(jìn)行了介紹。不過，既然以后由我們主持本專欄的工作，我們想更為詳細(xì)地介紹一下自己。

Matt 在 Microsoft 工作了 10 年以上，大部分時(shí)間是在 Microsoft 的開發(fā)人員支持機(jī)構(gòu)中工作。他堅(jiān)持認(rèn)為自己是一個(gè)網(wǎng)絡(luò)協(xié)議專家，因?yàn)樗偸怯袡C(jī)會(huì)對(duì)涉及 DLC、NetBIOS、Winsock、RPC、SNMP、WinInet 和 ISAPI 中的一切提供支持。相對(duì)于 Windows? 資源管理器來說，Matt 更喜歡使用 MS-DOS 提示符；在緊急情況下，甚至?xí)褂?EDLIN 來編輯文本文件。業(yè)余時(shí)間，Matt 喜歡帶著他的一家九口去觀看西雅圖水手隊(duì)的比賽。他總是坐在第一排，就在 Ichiro 的身后觀看比賽，不停揮舞著白毛巾，瘋狂地為西雅圖水手隊(duì)吶喊助威。

如果您閱讀過本專欄以前發(fā)布的文章，您可能會(huì)注意到 James Francisco（他以前是我們小組的成員之一）曾經(jīng)提到我們已經(jīng)落后于進(jìn)度表，因?yàn)橐话腴_發(fā)人員（指我）休假回家去照顧孩子了。3 月 15 日，我去看望了我的女兒 Angeline。她的母親、哥哥和我都花了四周時(shí)間來了解我們這個(gè)新家庭成員。在那段時(shí)間中，我還為 Prentice Hall 撰寫完有關(guān) SOAP 的一書《SOAP：使用 XML 開發(fā)跨平臺(tái) Web 服務(wù)》（英文）。它將在 2001 年 7 月底與讀者見面。除了著書之外，我還從事跨平臺(tái)開發(fā)工作。這是因?yàn)閷?shí)際上，我使用過三個(gè)非 Microsoft 的 SOAP 工具包：我自己的 SimpleSOAP（英文）、Apache SOAP（英文）和 SOAP::Lite（英文）。

概述

在本專欄中，我們將討論為 Web 服務(wù)設(shè)計(jì)合同時(shí)，需要考慮哪些因素。希望您在提到 Web 服務(wù)時(shí)，不要再聯(lián)想到諸如檢索股票價(jià)格或是查看您所在城市當(dāng)前的氣溫這樣的事情了。相反，您應(yīng)該將 Web 服務(wù)看作具有相當(dāng)完善功能的 API 的組件。在本專欄中，我們將討論如何設(shè)計(jì) Web 服務(wù)的接口以及滿足全球化要求。

定義 Web 服務(wù)的接口

現(xiàn)在，通過 Web 服務(wù)說明語言 (WSDL) 文件可以告知他人如何訪問和使用 Web 服務(wù)。最初引入 SOAP 時(shí)，曾出現(xiàn)過多種基于 XML 的接口說明語言 (IDL)。所有這些 IDL 識(shí)別不同的描述服務(wù)方式，并且包含一些特定于它們所依附的 SOAP 實(shí)現(xiàn)方案的項(xiàng)目。業(yè)界很快意識(shí)到必須進(jìn)行標(biāo)準(zhǔn)化，這樣就產(chǎn)生了 WSDL。WSDL 說明了以下項(xiàng)目：

Web 服務(wù)可以識(shí)別的數(shù)據(jù)類型

消息架構(gòu)

Web 服務(wù)使用的交換方法（請(qǐng)求/響應(yīng)、單向、多播等等）

Web 服務(wù)的位置

錯(cuò)誤信息

標(biāo)頭信息

對(duì) WSDL 的完整說明已超出了本文討論的范圍，不過在本文的末尾，您可以找到一些非常好的 WSDL 背景資料的鏈接?，F(xiàn)在我只想集中討論如何使用以上項(xiàng)目來定義 Web 服務(wù)的接口。

定義接口時(shí)，首先應(yīng)考慮數(shù)據(jù)類型。應(yīng)該始終確保您的類型可以重新映射到 XML 架構(gòu)數(shù)據(jù)類型。例如，對(duì)于字符串，應(yīng)該使用 xsd:string。構(gòu)建復(fù)雜的類型時(shí)，請(qǐng)確保它們最終可以分解為預(yù)定義的 XML 架構(gòu)數(shù)據(jù)類型之一。例如，您可以通過電子郵件地址和業(yè)務(wù)電話號(hào)碼來定義一個(gè)聯(lián)系人。WSDL 文件的類型部分類似于以下內(nèi)容：

<definitions xmlns:s="http://www.w3.org/2001/XMLSchema"
   
xmlns:s0="http://tempuri.org/"
   
targetNamespace="http://tempuri.org/"
   
xmlns="http://schemas.xmlsoap.org/wsdl/">
   
<types>
       
<s:schema attributeFormDefault="qualified"
           
elementFormDefault="qualified"
           
targetNamespace="http://tempuri.org/">
           
<s:element name="ContactInfo">
               
<s:complexType>
                   
<s:sequence>
                       
<s:element minOccurs="1" maxOccurs="1"
                           
name="name" nillable="true"
                           
type="s0:PersonName" />
                       
<s:element minOccurs="1" maxOccurs="1"
                           
name="emailAddress" nillable="true"
                           
type="s0:EmailAddress" />
                       
<s:element minOccurs="0" maxOccurs="unbounded"
                           
name="phoneNumbers" nillable="true"
                           
type="s0:PhoneNumber" />
                   
</s:sequence>
               
</s:complexType>
           
</s:element>
           
<s:complexType name="PersonName">
               
<s:sequence>
                   
<s:element minOccurs="1" maxOccurs="1" name="first"
                       
nillable="false" type="s:string" />
                   
<s:element minOccurs="1" maxOccurs="1"
                       
name="middle" nillable="true"
                       
type="s:string" />
                   
<s:element minOccurs="1" maxOccurs="1" name="last"
                       
nillable="false" type="s:string" />
               
</s:sequence>
           
</s:complexType>
           
<s:complexType name="PhoneNumber">
               
<s:sequence>
                   
<s:element minOccurs="1" maxOccurs="1"
                       
name="areaCode" nillable="false"
                           
type="s:long" />
                   
<s:element minOccurs="1" maxOccurs="1" name="prefix"
                       
nillable="true" type="s:long" />
                   
<s:element minOccurs="1" maxOccurs="1" name="suffix"
                       
nillable="false" type="s:long" />
               
</s:sequence>
           
</s:complexType>
       
</s:schema>
   
</types>
   
...

</definitions>

正如您所看到的，所有的復(fù)雜類型最終都分解為現(xiàn)有的 XML 架構(gòu)數(shù)據(jù)類型。有了這樣的限制，其它 SOAP 實(shí)現(xiàn)方案就更有可能與您的 Web 服務(wù)進(jìn)行交互。這是因?yàn)椴煌钠脚_(tái)存在著不同的 XML 架構(gòu)實(shí)現(xiàn)方案，只要符合標(biāo)準(zhǔn)并盡量避免使用自己偏愛的個(gè)人實(shí)現(xiàn)方案，就可以增加 Web 服務(wù)的可用性。

下一步，應(yīng)考慮如何將 Web 服務(wù)的功能分解成多個(gè)因子。對(duì) Web 服務(wù)進(jìn)行編程時(shí)，應(yīng)該將相關(guān)的操作組合到單個(gè)端口中。對(duì)于收藏服務(wù)，我們?cè)谠O(shè)計(jì)上將其分解為三個(gè)服務(wù)：

登錄：對(duì)被授權(quán)者進(jìn)行身份驗(yàn)證并授予他們一個(gè)訪問服務(wù)時(shí)使用的密鑰

帳戶：處理最終用戶的創(chuàng)建和收藏?cái)?shù)據(jù)的維護(hù)事項(xiàng)

報(bào)表：處理報(bào)表

將功能分成相關(guān)的功能塊后，在構(gòu)建特定的功能時(shí)，Web 服務(wù)的用戶就可以很輕松地找到他們所需的功能。編程人員可以了解與特定端口有關(guān)的功能，從而使他們的工作變得更為輕松。

這些端口的實(shí)現(xiàn)一般駐留在一個(gè)對(duì)象中。在內(nèi)部，對(duì)象可以共享公共的 Helper 函數(shù)。在外部，這些對(duì)象不應(yīng)該依賴于內(nèi)部狀態(tài)。我曾觀察過新聞組，發(fā)現(xiàn)許多人在試圖傳送 SOAP 對(duì)象的指針或引用時(shí)都遭遇了失敗。為什么他們會(huì)失敗呢？因?yàn)樗麄冊(cè)O(shè)計(jì)的東西要求引用指針，但很快他們就會(huì)意識(shí)到 SOAP 不允許這樣做。

如果您陷入了困境，我們向您介紹一個(gè)很好的解決方法：使用 in/out 參數(shù)。無論對(duì)象是 in、out 還是 in/out 參數(shù)，它必須能將自己的狀態(tài)寫入 XML。當(dāng)您指定所需的對(duì)象部分時(shí)，請(qǐng)分析一下功能真正需要什么數(shù)據(jù)，并且只需要該信息。這可能會(huì)產(chǎn)生巨大的差異，因?yàn)樵诰W(wǎng)絡(luò)上傳輸數(shù)據(jù)可能比整個(gè)串行化過程花費(fèi)的時(shí)間更多。消息越小，到達(dá)目的地所需的時(shí)間也就越少。

您可能還希望確保能夠監(jiān)視來回傳送的參數(shù)。如果使用可以生成 WSDL 的工具（例如 .NET 運(yùn)行時(shí)或 SOAP Toolkit v2 WSDLGEN.EXE 工具），您可能不會(huì)意識(shí)到自己正在浪費(fèi)帶寬。在構(gòu)建解決方案時(shí)，請(qǐng)花一些時(shí)間來了解生成的 WSDL 看起來像什么。看看是否可以找到減少消息往返次數(shù)的位置。例如，Visual Basic? COM 對(duì)象中作為 ByRef 發(fā)送的任何參數(shù)（如果您不指定，它們將都是 ByRef）都是一個(gè) in/out 參數(shù)。如果使用該對(duì)象，但在返回之前不對(duì)它進(jìn)行修改，則應(yīng)該將該參數(shù)更改為 ByVal。同樣地，請(qǐng)檢查 C++ 對(duì)象的 IDL 文件，并確保參數(shù)進(jìn)行了相應(yīng)的限定。

大多數(shù)情況下，Web 服務(wù)使用了請(qǐng)求/響應(yīng)（即傳統(tǒng)的 RPC）。可以通過忽略 operation 的 output 元素來指定單向。

請(qǐng)求/響應(yīng)：

<operation name='DeleteFavorite' parameterOrder='key Username FavID'>
   
<input message='wsdlns:Account.DeleteFavorite' />
   
<output message='wsdlns:Account.DeleteFavoriteResponse' />

</operation>

單向：

<operation name='DeleteFavorite' parameterOrder='key Username FavID'>
   
<input message='wsdlns:Account.DeleteFavorite' />

</operation>

單向消息只是忽略了輸出消息。如果有必要，請(qǐng)忽略“輸出消息”。這樣做可以減少等待的時(shí)間，并且可以使服務(wù)運(yùn)行得更快一些，因?yàn)榭蛻舫绦虿辉俚却祷氐南ⅰ?/FONT>