Webové služby

Každá SOAP zpráva je jednoduchý XML dokument. Tento XML dokument má kořenový element obálku (envelope). Obálka obsahuje další dva elementy, nepovinnou hlavičku (header) a tělo (body), jak ukazuje obrázek 2.3 – „Struktura SOAP zprávy“.

Obrázek 2.3. Struktura SOAP zprávy

Význam těchto elementů je následující:

Nyní si ukážeme příklad klasické SOAP zprávy zaslané webové službě. Ptáme se na hodnotu akcií s kódem DIS. V těle zprávy je požadavek na volání vzdálené funkce GetLastTradePrice, která zjistí poslední známou cenu akcií s kódem DIS.

<soapenv:Envelope 
  xmlns:soapenv=
        "http://schemas.xmlsoap.org/soap/envelope/">
  soapenv:encodingStyle=
        "http://schemas.xmlsoap.org/soap/encoding/"/>
    <soapenv:Body>
        <m:GetLastTradePrice xmlns:m="Some-URI">
            <m:tickerSymbol>DIS</m:tickerSymbol>
        </m:GetLastTradePrice>
    </soapenv:Body>
</soapenv:Envelope>
     

Jak by mohla vypadat odpověď webové služby na tuto SOAP zprávu vidíme níže.

<soapenv:Envelope 
  xmlns:soapenv=
         "http://schemas.xmlsoap.org/soap/envelope/">
  soapenv:encodingStyle=
        "http://schemas.xmlsoap.org/soap/encoding/"/>
    <soapenv:Body>
        <m:GetLastTradePriceResponse xmlns:m="Some-URI">
            <m:price>34.5</m:price>
        </m:GetLastTradePriceResponse>
    </soapenv:Body>
</soapenv:Envelope>

Element price obsahuje hodnotu akcií s kódem DIS. Jméno elementu, GetLastTradePriceResponse, není důležité a specifikace SOAP jej nedefinuje. Je však konvencí uvádět jej jako jméno metody s připojeným řetězcem „Response“ na konci.

V předchozím příkladu SOAP zpráv nebyla pro jednoduchost zanesena žádná SOAP hlavička. Pokud ovšem přítomna je, musí se objevit jako první element elementu Envelope. Hlavička může obsahovat několik tzv. bloků hlaviček. Každý blok hlavičky musí patřit do nějakého jmenného prostoru (namespace). Každý blok může obsahovat atribut mustUnderstand. Pokud příjemce zprávy nerozumí některému bloku, kde atribut mustUnderstand má hodnotu true, musí celou zprávu odmítnout.

V následujícím příkladě hlavička s atributem mustUnderstand nastaveným na hodnotu true říká, že pokud příjemce zprávy nerozumí transakcím, musí zprávu odmítnout.

<env:Header>
<t:transaction
    xmlns:t=http://thirdparty.example.org/transaction
    env:encodingStyle=http://example.com/encoding
    env:mustUnderstand="true" >5</t:transaction>
</env:Header>

Pokud by byla hodnota atributu mustUnderstand false, znamenalo by to, že příjemce nemusí tomuto bloku hlavičky rozumět, přesto by měl být schopen zprávu úspěšně zpracovat.

SOAP používá pro identifikování jednotlivých částí XML zprávy jmenné prostory. V příkladu SOAP zprávy uvedené v kapitole „Struktura SOAP zprávy“ jsou tři uvedeny různé jmenné prostory. První z nich, http://schemas.xmlsoap.org/soap/envelope/, určuje jmenný prostor, do kterého patří obálka, hlavičky a tělo zprávy. Druhý jmenný prostor, http://schemas.xmlsoap.org/soap/encoding/, identifikuje způsob kódování přenášených dat do XML. SOAP vyžaduje, aby každá funkce byla v určitém jmenném prostoru. Funkcím GetLastTradePrice a GetLastTradePriceResponse je tedy potřeba přiřadit nějaký jmenný prostor. Jeho hodnotou musí být nějaké URI. Protože na hodnotě URI nezáleží, je zvolen řetězec „Some-URI“. Prefixy jmenných prostorů, v tomto případě soapenv a m, nejsou důležité. Mohou být nahrazeny libovolnými jinými řetězci.

Při komunikaci aplikací na různých platformách, které navíc nemusí používat stejné datové typy, je potřeba definovat způsob výměny informací. V příkladech SOAP zpráv z kapitoly „Struktura SOAP zprávy“ je uveden atribut encodingStyle. Ten indikuje, jakým způsobem se mají serializovat data použitá ve zprávě, tj. jak platformě závislá data budou vyjádřena pomocí XML syntaxe. Pro kódování dat v protokolu SOAP lze použít libovolný způsob serializace. Standard SOAP však přímo jeden definuje. Datové typy podporované standardním kódováním protokolu SOAP jsou datovými typy definované specifikací XML schémat.

SOAP definuje tři základní způsoby vyjádření datových typů. Moje jméno by mohlo být zakódováno do XML pro potřeby SOAP protokolu takto:

Jak je vidět na příkladu SOAP zpráv z kapitoly „Struktura SOAP zprávy“, není vždy potřeba pravidla kódování definovat. Pokud příjemce zprávy ví, jak se zprávou naložit, nejsou pravidla kódování nutná. Hlavním cílem SOAP kódování je umožnit aplikacím, které si vyměňují dynamicky dokumenty, aby bez předchozí znalosti dokumentu byly schopny rozhodnout o typech dat, které přijímají.

Přestože SOAP nijak nedefinuje, který protokol má být použit pro přenos SOAP zpráv, nejčastěji se používá protokol HTTP. Důvodem je jeho rozšířenost. Také většina firewallů umožňuje většinou neomezenou komunikaci na portu rezervovaném pro HTTP protokol, takže lze tento protokol použít jako transportní protokol pro SOAP komunikaci. Právě nutnost povolovat další porty pro komunikaci byla hlavní nevýhodou technologií DCOM a CORBA. Při použití protokolu HTTP jako transportního protokolu pro přenos SOAP zpráv jsou SOAP zprávy obsaženy v těle HTTP požadavku či odpovědi. HTTP požadavek pak musí obsahovat hlavičku SOAPAction, která danou SOAP zprávu identifikuje. Protokol HTTP je také jediný transportní protokol, který je zanesen přímo ve specifikaci protokolu SOAP. Následuje příklad SOAP zprávy z příkladu z kapitoly „Struktura SOAP zprávy“, přenášené protokolem HTTP. HTTP požadavek vypadá takto:

POST /StockQuote HTTP/1.1
Host: www.stockquoteserver.com
Content-Type: text/xml; charset="utf-8"
Content-Length: 555
SOAPAction: "urn:StockQuote#GetLastTradePrice"

<soapenv:Envelope 
  xmlns:soapenv=
        "http://schemas.xmlsoap.org/soap/envelope/">
  soapenv:encodingStyle=
        "http://schemas.xmlsoap.org/soap/encoding/"/>
    <soapenv:Body>
        <m:GetLastTradePrice xmlns:m="Some-URI">
            <m:tickerSymbol>DIS</m:tickerSymbol>
        </m:GetLastTradePrice>
    </soapenv:Body>
</soapenv:Envelope>

Obsah odpovědi musí být stejně jako obsah požadavku identifikován jako XML dokument pomocí příslušného MIME typu text/xml v hlavičce Content-Type. Odpověď na tento požadavek vypadá takto:

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

<soapenv:Envelope 
  xmlns:soapenv=
        "http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:encodingStyle=
        "http://schemas.xmlsoap.org/soap/encoding/"/>
    <soapenv:Body>
        <m:GetLastTradePriceResponse xmlns:m="Some-URI">
            <m:price>34.5</m:price>
        </m:GetLastTradePriceResponse>
    </soapenv:Body>
</soapenv:Envelope>

Při použití HTTP jako přenosového protokolu SOAP zpráv jsou používány standardní návratové kódy protokolu HTTP. Pokud se při zpracování SOAP zprávy nevyskytla chyba, vrátí protokol HTTP návratový kód 200, jak vidíme na příkladu HTTP odpovědi výše. Pokud se naopak vyskytla při vyřizování SOAP zprávy jakákoli chyba, vrátí webová služba chybový kód 500, Internal server error. V případě chyby je v těle SOAP zprávy obsažen element Fault, který popisuje danou chybu přesně podle SOAP specifikace.

Element typy (types) definuje datové typy používané v SOAP zprávách. Přestože WSDL protokol není svázán s žádným typovým systémem, jako výchozí typový systém je používáno XML schéma specifikace. Přestože můžeme použít libovolný jiný typový systém, specifikace XML schéma je nyní nejrozšířenější typový systém. Specifikace XML schéma definuje jednoduché datové typy jako jsou string, integer, float. Pokud hodnoty vstupu a výstupu operací definovaných v popisu webové služby jsou těmito jednoduchými typy, není potřeba element types ve WSDL dokumentu vůbec definovat.

Pokud ovšem parametrem operace webové služby není jednoduchý datový typ, musíme tento datový typ explicitně definovat v elementu types. Pokud by například některá operace vracela pole hodnot, bylo potřeba v elementu types definovat nový datový typ takto:

<complexType name="ArrayOfString">
   <complexContent>
      <restriction base="soapenc:Array">
         <attribute ref="soapenc:arrayType" 
            wsdl:arrayType="string[]"/>
      </restriction>
   </complexContent>
</complexType>

Každý nový datový typ je založen na nějakém existujícím datovém typu. Novému datovému typu můžeme definovat určitá omezení (metoda restriction) či rozšíření (metoda extension). Takto můžeme jednoduše vytvořit vlastní datový typ, který upravuje nějaký jednoduchý typ. Typickým příkladem je datový typ Handle definovaný WSDL dokumentem popisující WSRP služby.

<simpleType name="Handle">
    <restriction base="xsd:string">
      <xsd:minLength value="1"/>
      <xsd:maxLength value="255"/>
    </restriction>
</simpleType>
<element name="Handle" type="types:Handle"/>

Mapování datových typů podle XML schémat na datové typy konkrétního programovacího jazyka provádí nástroje pro webové služby.

Element zpráva (message) definuje formát předávaných zpráv pomocí dříve definovaných datových typů. Zprávy fungují jako vstupní nebo výstupní struktury pro operace. Každá zpráva má své jméno, které je v celém WSDL dokumentu mezi všemi zprávami jedinečné. Zprávu tvoří několik logických částí zprávy (message part). Každá část zprávy definuje jeden vstupní nebo výstupní parametr volané operace. Část zprávy obsahuje atribut name, který musí být v rámci jedné zprávy jedinečný. Dále musí část zprávy obsahovat atribut element nebo atribut type definující datový typ parametru operace. Příklad elementu message z WSDL popisu webové služby zjišťující aktuální hodnotu akcií uvedené v kapitole „Struktura SOAP zprávy“ je uveden níže.

<message name="GetTradePriceInput">
    <part name="tickerSymbol" element="xsd:string"/>
</message>

Element operace (operation) popisuje funkce implementované webovou službou. Tyto oprace abstraktně definuje element PortType. Konkrétní podobu každé operace vyjadřuje až vazba (binding). Vstupní a výstupní parametry operací definuje element message. Operace mohou být dle definice WSDL jedním z následujících typů.

Operace typu Request-response je nejrozšířenějším typem operací mezi webovými službami. Jednotlivé typy operací asi nejlépe vysvětluje následující obrázek.

Obrázek 2.4. Typy operací

Konkrétní aplikace operace GetTradePrice uvedené ve vazbě StockQuoteSoapBinding popisu webové služby:

<operation name="GetTradePrice">
  <soap:operation soapAction=
      "http://example.com/GetTradePrice"/>
  <input>
    <soap:body use="encoded" 
        namespace="http://example.com/stockquote"
        encodingStyle=
	    "http://schemas.xmlsoap.org/soap/encoding/"/>
  </input>
  <output>
    <soap:body use="encoded" 
        namespace="http://example.com/stockquote"
        encodingStyle=
	    "http://schemas.xmlsoap.org/soap/encoding/"/>
  </output>
</operation>

Element PortType tvoří abstraktní rozhraní webové služby. PortType je pojmenovaná sada abstraktních operací (operation) implementovaných danou webovou službou (service). Atribut name elementu PortType jednoznačně určuje daný typu portu.

V příkladu WSDL dokumentu je použita Request-response operace GetLastTradePrice, jejíž vstupní a výstupní parametry jsou definovány zprávami GetLastTradePriceIput (input message) a GetLastTradePriceoutput (output message). Zde je uveden element typ portu StockQuotePortType:

<portType name="StockQuotePortType">
    <operation name="GetLastTradePrice">
      <input message="tns:GetLastTradePriceInput"/>
      <output message="tns:GetLastTradePriceOutput"/>
    </operation>
</portType>

Element vazba (binding) říká jakým způsobem jsou operace daného typu portu volány. Definuje konkrétní přenosový protokol a formát zpráv těchto operací. Vazba je jednoznačně určena atributem name. Atribut type určuje typ portu, který vazba adresuje. Zde je příklad vazby uvedené ve WSDL dokumentu webové služby:

<binding name="StockQuoteSoapBinding"
        type="tns:StockQuotePortType">
    <soap:binding style="rpc" 
    	transport="http://schemas.xmlsoap.org/soap/http"/>
    <operation name="GetTradePrice">
      <soap:operation 
          soapAction="http://example.com/GetTradePrice"/>
      <input>
        .
        .
      </input>
      <output>
        .
        .
      </output>
      </operation>>
</binding>

Vazba se jmenuje StockQuoteSoapBinding a adresuje typ portu StockQuotePortType. Atribut transport říká, že operace uvedené v typu portu StockQuotePortType budou volány protokolem HTTP. Atribut SOAPAction definuje HTTP hlavičku SOAPAction.

Element brána (port) je koncový bod služby (service) definovaný jako kombinace síťové adresy a vazby (binding). Port je ve WSDL dokumentu jednoznačně určen svým atributem name. Atribut binding jednoznačně určuje vazbu, kterou daný port používá. Atribut soap:address určuje adresu služby (service). Existují dvě zásadní pravidla, která musí element port splňovat.

V příkladu WSDL dokumentu je definován port StockQuotePort. Tento port je volán způsobem definovaným vazbou StockQuoteBinding a adresou http://example.com/stockquote. Zde je ukázka elementu port:

<port name="StockQuotePort" 
      binding="tns:StockQuoteBinding">
  <soap:address location="http://example.com/stockquote"/>
</port>

Jedna služba (service) může být zpřístupněna více branami s různými vazbami. Můžeme tedy definovat dvě brány a k nim odpovídající vazby. Jednou branou budeme se službou (service) komunikovat protokolem HTTP, druhou branou protokolem SMTP.

Služba (service) sdružuje několik bran (portů) do jedné služby. Každá služba je jednoznačně určena svým atributem name. Porty mohou v rámci služby (service) sdílet stejný typ portu PortType, musí však mít rozdílné vazby (binding) nebo adresy.

Následuje příklad části WSDL dokumentu definující samotnou službu (service).

<service name="StockQuoteService">
     <documentation>My first service</documentation>
     <port name="StockQuotePort" 
             binding="tns:StockQuoteBinding">
         <soap:address location=
            "http://example.com/stockquote"/>
     </port>
</service>

Služba se jmenuje StockQuoteService, je dostupná na adrese http://example.com/stockquote přes port StockQuotePort.

Máme-li WSDL dokument k dané webové službě, můžeme ji začít používat. SOAP zprávy můžeme psát podle WSDL dokumentu dané webové služby ručně nebo můžeme s výhodou použít tzv. invocation tools, které z daného WSDL souboru dokáží vygenerovat SOAP zprávu.

Samotný WSDL dokument můžeme také napsat ručně nebo nadefinovat pouze rozhraní služby a použít opět některého z automatizovaných nástrojů k vygenerování WSDL dokumentu. Například v .NET vygenerujeme WSDL dokument z rozhraní webové služby zadáním služba.asmx?WSDL v prohlížeči.