架構(gòu)Web Service:描述與注冊，發(fā)布Web服務(wù)

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

架構(gòu)Web Service:描述與注冊，發(fā)布Web服務(wù)  

  
 柴曉路 (fennivel@uddi-china.org)

Chief System Architect

2001年9月20日

本文是架構(gòu)Web服務(wù)的系列文章的第六篇，也是最后一篇，文本以前文為基礎(chǔ)，在前文的應(yīng)用實(shí)例的基礎(chǔ)上，考察了發(fā)布Web服務(wù)界面的整個(gè)過程：XML Schema建模、WSDL發(fā)布和UDDI注冊。通過本文，大家可以詳細(xì)具體地了解各個(gè)XML和Web Service的系列規(guī)范在Web Service的發(fā)布時(shí)所起的左右，對Web Service技術(shù)也將有一個(gè)深入的理解。

在前文中，我已經(jīng)介紹過，Web服務(wù)是通過SOAP消息調(diào)用的，通過WSDL進(jìn)行界面描述的，以及通過UDDI進(jìn)行公共注冊發(fā)布的。在前一篇文章中，我已經(jīng)介紹了如何進(jìn)行SOAP API的消息定義，那么在本文中，我將單把save_category提出來，看看在具體的實(shí)現(xiàn)上，應(yīng)當(dāng)如何對這個(gè)消息使用W3C XML Schema進(jìn)行建模，如果使用WSDL將基于該消息調(diào)用的Web服務(wù)進(jìn)行規(guī)范描述并交付調(diào)用者，以及如何將這個(gè)Web服務(wù)連同它的WSDL規(guī)范化描述文件一起發(fā)布到UDDI注冊中心中去。希望大家能通過本文的實(shí)例講解，在本系列的最后完整地了解Web服務(wù)的工作原理和相關(guān)技術(shù)規(guī)范的作用。

本文所引用的資源主要包括兩類，一類是Web服務(wù)的技術(shù)資源網(wǎng)站，包含了大量Web服務(wù)的技術(shù)信息，另一類是Web服務(wù)“stack"系列技術(shù)規(guī)范，他們是一個(gè)整體的技術(shù)體系，包括UDDI、SOAP、WSDL、XML Schema, XML等。本文的最后給出了這些資源的鏈接，有興趣的讀者可以通過這些資源鏈接找到所需的內(nèi)容。

SOAP消息示例

以下是一個(gè)save_category的調(diào)用例子，在例子中使用了SOAP HTTP Binding(使用的SOAP規(guī)范的版本是1.2)，假設(shè)目標(biāo)Web服務(wù)被部署在www.sagitta.com，而調(diào)用的Web服務(wù)的入口位置將是http://www.sagitta.com/catalog/。

在這個(gè)消息中，將在一個(gè)現(xiàn)有的category中添加一個(gè)新的category和一個(gè)新的product。

POST /catalog HTTP/1.1
Content-Type: text/xml; charset="utf-8"
Content-Length: nnnn
SOAPAction: "http://www.sagitta.com/catalog/"
Host: www.sagitta.com

<?xml version="1.0" encoding="UTF-8" ?>
<env:Envelope xmlns:env="http://www.w3.org/2001/06/soap-envelope">
  <env:Body>
    <save_category xmlns="http://www.sagitta.com/schema/">
      <authInfo>5Az784kJceHCE982eB</authInfo>
      <category categoryKey="cb4e17d1-6100-47f6-a532-cd9cbd30c073" parentCategoryKey="ab4e3de1-7865-f2c1-b49a-beccbd21c072">
        <name>Consumer Electronics</name>
        <description>Product Category for Consumer Electronics </description>
        <category categoryKey="" parentCategoryKey="cb4e17d1-6100-47f6-a532-cd9cbd30c073">
          <name>SONY Consumer Electronics</name>
          <description>Sony's Product Category for Consumer Electronics</description>
        </category>
        <product productKey="" parentCategoryKey=" cb4e17d1-6100-47f6-a532-cd9cbd30c073">
          <name>DSC-S75 Digital Camera</name>
          <description>Sony's Brand-New Professional Digital Camera</description>
          <compliantSpecBag>
            <specification specificationKey="Key[USB1.1]" />
          </compliantSpecBag>
          <featureBag>
            <feature>……</feature>
            <feature>……</feature>
          </featureBag>
          <parameterBag>
            ……
          </parameterBag>
        </product>
      </category>
    </save_category>
  </env:Body>
</env:Envelope>

該調(diào)用消息的返回消息可能是：

 HTTP/1.1 200 OK
Content-Type: text/xml; charset="utf-8"
Content-Length: nnnn

<?xml version="1.0" encoding="UTF-8" ?>
<env:Envelope xmlns:env="http://www.w3.org/2001/06/soap-envelope">
  <env:Body>
    <categoryList xmlns="http://www.sagitta.com/schema/">
      <category categoryKey="cb4e17d1-6100-47f6-a532-cd9cbd30c073" parentCategoryKey="ab4e3de1-7865-f2c1-b49a-beccbd21c072">
        <category categoryKey="8933aa50-3aaf-11d5-80dc-002035229c64" parentCategoryKey="cb4e17d1-6100-47f6-a532-cd9cbd30c073" />
        <product productKey="89307600-3aaf-11d5-80dc-002035229c64" parentCategoryKey="cb4e17d1-6100-47f6-a532-cd9cbd30c073" />
      </category>
    </categoryList>
  </env:Body>
</env:Envelope>

從中我們可以看到在save_category和categoryList兩個(gè)元素后面都帶了一個(gè)xmlns的修飾"http://www.sagitta.com/schema/"。這URI唯一表示了該元素及其所有子元素的的命名空間。同時(shí)通過這個(gè)URL可以獲得這些元素的Schema定義。

使用W3C XML Schema描述的XML文檔的模式定義在整個(gè)Web服務(wù)的技術(shù)系列中處于一個(gè)支持工具的地位。W3C XML Schema是任何類型的XML文檔的建模工具。在Web服務(wù)體系中，無論在SOAP消息的表示上，還是在WSDL的界面描述上，XML Schema都是不可缺少的重要工具和底層支持。

下面我將從XML Schema開始，針對save_category這個(gè)消息(同時(shí)也對應(yīng)一個(gè)服務(wù)入口)逐一介紹如何為我們的XML消息進(jìn)行XML Schema建模，如何使用WSDL將save_category這個(gè)服務(wù)入口進(jìn)行界面描述，然后將這個(gè)入口發(fā)布到UDDI注冊中心中去。

XML Schema建模

XML Schema的文件后綴是.xsd文件，一個(gè)XML Schema中的定義通常分為兩部分，型(Type)定義和元素(Element)定義。下面我們結(jié)合save_category具體的XML Schema定義來說明如何使用XML Schema來實(shí)現(xiàn)模式定義。

在下面的XML Schema文檔中，型定義包括：compliantSpecBag，featureBag，parameter，parameterBag，product和category六個(gè)類型，而元素定義為save_category這一個(gè)元素。

save_category的XML Schema描述定義：(完整的XML Schema文檔是：sagitta.xsd)

<?xml version="1.0" encoding="UTF-8"?>

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">

以上是XML Schema的文件頭。

 <xs:complexType name="compliantSpecBag">
    <xs:sequence>
      <xs:element name="specification" minOccurs="0" maxOccurs="unbounded">
        <xs:complexType>
          <xs:simpleContent>
            <xs:extension base="xs:string">
              <xs:attribute name="specificationKey" type="xs:string" use="required"/>
            </xs:extension>
          </xs:simpleContent>
        </xs:complexType>
      </xs:element>
    </xs:sequence>
  </xs:complexType>

在這段Schema描述中，描述了compliantSpecBag這個(gè)元素類型，任何使用compliantSpecBag類型的元素可以包含的元素是specification，這個(gè)元素可以出現(xiàn)0次到無窮次(無限制，事實(shí)上不可能出現(xiàn)無窮次)，而specification這個(gè)元素中包含一個(gè)屬性specificationKey，該屬性是必須的，同時(shí)類型為字符串(xs:string)。xs這個(gè)命名空間是W3C XML Schema 2001的命名空間(namespace)。

 <xs:complexType name="featureBag">
    <xs:sequence>
      <xs:element name="feature" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>

在這里，描述了featureBag這個(gè)元素類型，任何使用featureBag類型的文檔元素可以包含的子元素是feature，而feature元素能夠出現(xiàn)0次到無窮次(無限制，事實(shí)上不可能出現(xiàn)無窮次)。該元素的內(nèi)容的類型是字符串(xs:string)。

 <xs:complexType name="parameter">
    <xs:sequence>
      <xs:element name="keyName" type="xs:string"/>
      <xs:element name="keyValue" type="xs:string"/>
    </xs:sequence>
  </xs:complexType>

  <xs:complexType name="parameterBag">
    <xs:sequence>
      <xs:element name="parameter" type="parameter" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>

這里首先描述了parameter這個(gè)元素類型，任何使用parameter類型的文檔元素可以包含的子元素有兩個(gè)keyName和keyValue，它們都是必須出現(xiàn)的子元素，同時(shí)僅可出現(xiàn)一次。他們的類型也都是字符串(xs:string)。然后描述的是parameterBag元素類型，任何使用parameterBag類型的文檔元素可以包含的子元素是parameter，而這個(gè)子元素的類型是先前定義的parameter(在XML Schema中，類型名和元素名的域空間是正交的，不需要考慮任何的名字重復(fù)問題)，parameter元素出現(xiàn)的次數(shù)可以是從0次到無窮次。

 <xs:complexType name="product">
    <xs:sequence>
      <xs:element name="name" type="xs:string"/>
      <xs:element name="description" type="xs:string"/>
      <xs:element name="compliantSpecBag" type="compliantSpecBag"/>
      <xs:element name="featureBag" type="featureBag"/>
      <xs:element name="parameterBag" type="parameterBag"/>
    </xs:sequence>
    <xs:attribute name="productKey" type="xs:string" use="required"/>
        <xs:attribute name="parentCategoryKey" type="xs:string" use="required"/>
  </xs:complexType>

這里描述了product這個(gè)元素類型，任何使用product類型的文檔元素可以包含的子元素是name、description、compliantSpecBag、featureBag、parameterBag。name和description元素的類型都是xs:string。而compliantSpecBag、featureBag、parameterBag的類型大家通過查看這斷XML Schema定義也可以很清楚地發(fā)現(xiàn)是引用了前面定義的這些類型定義。任何使用product類型的文檔元素還有兩個(gè)必須出現(xiàn)的屬性productKey和parentCategoryKey，這是兩個(gè)字符串(xs:string)類型的屬性值，分別表示了自身元素的鍵值和父輩category的鍵值。

 <xs:complexType name="category">
    <xs:sequence>
      <xs:element name="name" type="xs:string"/>
      <xs:element name="description" type="xs:string"/>
      <xs:element name="category" type="category" minOccurs="0" maxOccurs="unbounded"/>
      <xs:element name="product" type="product" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="categoryKey" type="xs:string" use="required"/>
    <xs:attribute name="parentCategoryKey" type="xs:string" use="required"/>
  </xs:complexType>

這是category元素類型的描述，任何使用product類型的文檔元素可以包含的子元素是name、description、category和product。name和description元素的類型都是簡單類型xs:string。而category是一個(gè)遞歸元素，引用了自身這個(gè)元素類型。而product的元素類型則是前面描述好的product類型。任何使用product類型的文檔元素還有兩個(gè)必須出現(xiàn)的屬性categoryKey和parentCategoryKey，這是兩個(gè)字符串(xs:string)類型的屬性值，分別表示了自身元素的鍵值和父輩category的鍵值。

 <xs:element name="save_category">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="authInfo" type="xs:base64Binary"/>
        <xs:element name="category" type="category" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

這是在這個(gè)Schema文檔中唯一的一個(gè)元素定義，元素save_category是一個(gè)復(fù)合類型，它的元素可以有authInfo和category。其中authInfo是一個(gè)base64編碼的字符串，而category則是一個(gè)可以出現(xiàn)0次到無限次的類型為category的子元素。我們不難發(fā)現(xiàn)元素定義和類型定義的基本機(jī)制是一樣的，事實(shí)上，我們完全可以將這段定義拆分成兩段，一段為類型定義，一段為元素定義，下面給出這個(gè)等價(jià)實(shí)例，希望有助于對Schema的理解。

 <xs:complexType name="save_category">
    <xs:sequence>
      <xs:element name="authInfo" type="xs:base64Binary"/>
      <xs:element name="category" type="category" minOccurs="0" maxOccurs="unbounded"/>
    </xs:sequence>
  </xs:complexType>

  <xs:element name="save_category" type="save_category" />

那為什么要采用第一種方法，而不使用第二種方法呢，原因也很簡單，由于整個(gè)Web服務(wù)相關(guān)的消息Schema中，諸如category、product、featureBag、compliantSpecBag、parameterBag這些元素都可能被復(fù)用，因此定義成類型比較合適，而save_category是一個(gè)單一的消息，不可能被其他元素復(fù)用，因此就直接定義成了元素。

</xs:schema>

最后，我給出對應(yīng)本節(jié)描述的save_category元素的Schema定義的Schema圖示來結(jié)束本小節(jié)。

Figure 1. SOAP API Schema圖示

WSDL服務(wù)描述

對SOAP API消息完成Schema建模之后，一方面這個(gè)數(shù)據(jù)模型可以由SOAP Interface來使用，當(dāng)發(fā)生具體調(diào)用時(shí)可以使用這個(gè)數(shù)據(jù)模型來除了傳入的參數(shù)并生成傳出的參數(shù)。同時(shí)，利用這個(gè)數(shù)據(jù)模型，我們可以生成相應(yīng)的WSDL描述，從而將這個(gè)Web服務(wù)的接口文檔發(fā)布給使用者，該接口文檔是具備被程序自動(dòng)處理的能力的。

以下是WSDL文檔詳細(xì)的定義：(完整的WSDL文檔是: sagitta.wsdl)

<?xml version="1.0"?>
<definitions name="catalogService"
             targetNamespace="http://www.sagitta.com/wsdl/savecategory.wsdl"
             xmlns:tns="http://www.sagitta.com/wsdl/savecategory.wsdl"
             xmlns:myxs="http://www.sagitta.com/schema/"
             xmlns:soap="http://www.w3.org/2001/06/soap-envelope"
             xmlns="http://schemas.xmlsoap.org/wsdl/">

  <import namespace="http://www.sagitta.com/schema/" location=" http://www.sagitta.com/schema/save_category.xsd" />

這是WSDL文件的文件頭，其中的import元素指明在這個(gè)WSDL文件中，types系統(tǒng)是由http://www.sagitta.com/schema/save_category.xsd文件具體描述，在這里僅僅是將其導(dǎo)入。

 <message name="save_category">
    <part name="body" element="myxs:save_category"/>
  </message>
 
  <message name="categoryList">
    <part name="body" element="myxs:categoryList"/>
  </message>

這里定義了兩條消息：save_category消息，在前面的Schema建模中已經(jīng)完整地創(chuàng)建了根元素的結(jié)構(gòu)定義。其中myxs是這里使用的命名空間(namespace)，命名空間的具體定義在文件頭上出現(xiàn)。而categoryList將會對應(yīng)save_category消息的返回消息，在Schema建模中沒有表現(xiàn)，在這里我也僅列出一個(gè)元素名，相信大家在看了本文的前半部分以及本系列的前一篇文章之后，會很清楚如何來定義。

 <portType name="save_category_portType">
    <operation name="save_category_operation">
      <input message="tns:save_category"/>
      <output message="tns:categoryList"/>
    </operation>
  </portType>

這部分定義了服務(wù)訪問點(diǎn)的調(diào)用模式的類型，表明這個(gè)入口類型是請求/響應(yīng)模式，請求消息是save_category，而響應(yīng)消息是categoryList。

 <binding name="save_category_soapBinding" type=" save_category_portType ">
    <soap:binding style="document" transport=" http://www.w3.org/2001/06/soap-envelope/http">
      <operation name="save_category_operation">
        <soap:operation soapAction=" http://www.sagitta.com/catalog/">
          <input>
            <soap:body use="literal" namespace=" http://www.sagitta.com/schema/"
                       encodingStyle=" http://www.w3.org/2001/06/soap-encoding"/>
          </input>
          <output>
            <soap:body use="literal" namespace=" http://www.sagitta.com/schema/"
                       encodingStyle=" http://www.w3.org/2001/06/soap-encoding"/>
          </output>
        </soap:operation>
      </operation>
    </soap:binding>
  </binding>

這部分將服務(wù)訪問點(diǎn)的抽象定義與SOAP HTTP綁定，描述如何通過SOAP/HTTP來訪問按照前面描述的訪問入口點(diǎn)類型部署的訪問入口。其中規(guī)定了在具體SOAP調(diào)用時(shí)，應(yīng)當(dāng)使用的soapAction是"http://www.sagitta.com/catalog/"，而請求/響應(yīng)消息的編碼風(fēng)格都應(yīng)當(dāng)采用SOAP規(guī)范默認(rèn)定義的編碼風(fēng)格" http://www.w3.org/2001/06/soap-encoding "。

<service name="catalogService">
    <documentation>Online Web Service for Catalog</documentation>
    <port name="save_category_port" binding="tns:save_category_soapBinding">
    <soap:address location="http://www.sagitta.com/catalog/"/>
    </port>
  </service>
 
</definitions>

這部分是具體的Web服務(wù)的定義，在這個(gè)名為catalogService的Web服務(wù)中，提供了一個(gè)服務(wù)訪問入口(其實(shí)還有很多，不過在這里因?yàn)檠菔镜脑?，僅僅介紹了一個(gè))，訪問地址是"http://www.sagitta.com/catalog/"，使用的消息模式是由前面的binding所定義的。

UDDI服務(wù)發(fā)布

在前一節(jié)中，我們已經(jīng)通過使用WSDL這個(gè)工具將Catalog Service這個(gè)Web服務(wù)進(jìn)行了結(jié)構(gòu)化地描述。為了使更多的潛在用戶能夠發(fā)現(xiàn)這個(gè)Web服務(wù)，同時(shí)也為了加強(qiáng)這個(gè)Web服務(wù)的互操作能力和災(zāi)難恢復(fù)時(shí)的連接保持能力，我們需要使用UDDI SDK將這個(gè)Web服務(wù)注冊到UDDI注冊中心中去。

假設(shè)我們之前已經(jīng)注冊了一個(gè)businessEntity，叫做www.sagitta.com，一個(gè)在線服務(wù)提供商，這個(gè)businessEntity的鍵值是"434554F4-6E17-1342-EA41-36E642531DA1"，那么我們要在這個(gè)businessEntity下注冊一個(gè)businessService，以用于描述前面的Catalog Service。同時(shí)需要成立的假設(shè)是我們也預(yù)先注冊了一個(gè)Service Type(tModel)，這個(gè)tModel描述了我們這個(gè)需要發(fā)布的Web服務(wù)的調(diào)用規(guī)范，具體內(nèi)容是前面我定義的這個(gè)WSDL文檔，在UDDI中，注冊的是描述的鏈接。

businessService注冊的SOAP消息如下，其中使用了Microsoft的test.uddi.microsoft.com站點(diǎn)，因此authInfo中可以填入測試用的udditest。

<?xml version="1.0" encoding="UTF-8"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body>
    <save_service generic="1.0" xmlns="urn:uddi-org:api">
      <authInfo>udditest</authInfo>
      <businessService businessKey="434554F4-6E17-1342-EA41-36E642531DA1" serviceKey="">
        <name>categoryService</name>
        <description xml:lang="en">Online Web Service for Catalog</description>
        <bindingTemplates>
          <bindingTemplate bindingKey="" serviceKey="">
            <description xml:lang="en">categoryService's BindingTemplate3</description>
            <accessPoint URLType="http">http://www.sagitta.com/catalog/</accessPoint>
            <tModelInstanceDetails>
              <tModelInstanceInfo tModelKey="uuid:E31A569A-AEFF-4468-BA4D-2BF22FE4ACEF">
                <description xml:lang="en">Sagitta Web Service Type Description</description>
                <instanceDetails>
                  <description xml:lang="en">Sagitta Web Service Type Description</description>
                  <overviewDoc>
                    <description xml:lang="en">Sagitta Web Service Overview</description>
                    <overviewURL>http://www.sagitta.com/wsdl/savecategory.wsdl</overviewURL>
                  </overviewDoc>
                </instanceDetails>
              </tModelInstanceInfo>
            </tModelInstanceDetails>
          </bindingTemplate>
        </bindingTemplates>
      </businessService>
    </save_service>
  </Body>
</Envelope>

通過上述的API調(diào)用，我們就已經(jīng)把這個(gè)服務(wù)注冊進(jìn)了UDDI注冊中心，其中bindingTemplate的accessPoint是服務(wù)的入口，而overviewDoc中的overviewURL是WSDL文檔的訪問位置。

潛在的使用者可以通過查詢UDDI注冊中心找到這個(gè)Web服務(wù)，通過overviewURL中保存的URL找到服務(wù)的描述，然后通過accessPoint所指定的訪問地址來訪問這個(gè)服務(wù)。

當(dāng)發(fā)生緊急服務(wù)崩潰的時(shí)候，Web服務(wù)可能被遷移到另一臺主機(jī)上，IP地址，甚至是訪問的URL都可能有很大變化，此時(shí)原先的集成的連接將不再工作。但是由于UDDI注冊的存在，我們可以通過自動(dòng)化的程序手段來解決這個(gè)問題，使得類似的服務(wù)災(zāi)難恢復(fù)的過程非常迅速。

具體的流程一般是：

當(dāng)恢復(fù)的服務(wù)啟動(dòng)后，自動(dòng)去更新UDDI注冊中心上的數(shù)據(jù)，將訪問入口修改到新的URL位置;

連入的客戶端系統(tǒng)當(dāng)發(fā)現(xiàn)無法訪問最終服務(wù)的時(shí)候，將會定期去查詢UDDI注冊中心，看看新的BindingTemplate數(shù)據(jù)和本地緩存的有沒有差別，如果有的話，就下載到本地，重新建立服務(wù)綁定，完成服務(wù)連接的遷移。

總結(jié)

到這篇文章為止，如何架構(gòu)Web Service這個(gè)系列就將告一段落，在整個(gè)系列中，從為什么要有Web服務(wù)開始，到什么是Web服務(wù)，Web服務(wù)的開發(fā)工具，對Web服務(wù)作了一個(gè)概念上的全面介紹。然后以一個(gè)具體實(shí)例來介紹Web服務(wù)的構(gòu)建模式和各種Web Service "stack"技術(shù)的具體應(yīng)用。希望這個(gè)系列對大家理解和接受下一代的應(yīng)用包裝模式Web服務(wù)有一個(gè)全面的幫助。

參考資料

 柴曉路: 上海得易電子商務(wù)技術(shù)有限公司(DealEasy)首席系統(tǒng)架構(gòu)師、XML技術(shù)顧問。UDDI-China.org藍(lán)色火焰工作室(Blue Blaze Studio)成員。UDDI Advisor Group成員，WSUI Working Group成員。2000年獲復(fù)旦大學(xué)計(jì)算機(jī)科學(xué)碩士學(xué)位，曾在國際計(jì)算機(jī)科學(xué)學(xué)術(shù)會議(ICSC)、亞太區(qū)XML技術(shù)研討會(XML Asia/Pacific'99)、中國XML技術(shù)研討會(北京)、計(jì)算機(jī)科學(xué)期刊等各類國際、國內(nèi)重要會議與期刊上發(fā)表論文多篇。專長于基于XML的系統(tǒng)集成和數(shù)據(jù)交換的技術(shù)研究，同時(shí)對數(shù)據(jù)庫、面向?qū)ο蠹夹g(shù)及CSCW等技術(shù)比較擅長。