Webové služby v Java EE (JAX-WS)

Webové služby v Java EE (JAX-WS) Marek Rychlý Vysoké uˇcení technické v Brneˇ Fakulta informaˇcních technologií Ústav informaˇcních systému˚

Pˇrednáška pro PDI 7. listopadu 2014

Marek Rychlý

Webové služby v Java EE (JAX-WS) — Pˇrednáška pro PDI, 7. listopadu 2014

1 / 51

Obsah 1

Úvod k SOA a webovým službám Architektura orientovaná na služby (SOA) Struktura, chování a vlastnosti služeb v SOA Webové služby (Web Services) Technologie webových služeb (XSD, WSDL a SOAP)

2

Java API for XML Web Services (JAX-WS) Poskytovatel webové služby pomocí JAX-WS Spotˇrebitel webové služby pomocí JAX-WS Použití JAX-WS v aplikaˇcním serveru a podpora v IDE

3

Java API for RESTful Web Services (JAX-RS) Representational State Transfer (REST) architektura Webové služby pomocí JAX-RS

4

ˇ Shrnutí a záver Marek Rychlý


2 / 51

Úvod k SOA a webovým službám Java API for XML Web Services (JAX-WS) Java API for RESTful Web Services (JAX-RS) ˇ Shrnutí a záver

Architektura orientovaná na služby (SOA) Struktura, chování a vlastnosti služeb v SOA Webové služby (Web Services) Technologie webových služeb (XSD, WSDL a SOAP)

Obsah 1


2


3


4



3 / 51



Servisneˇ orientovaná architektura (SOA) Definice (Service-Oriented Architecture, OASIS SOA RefModel) SOA je paradigma pˇredepisující zpusob ˚ uspoˇrádání a použití distribuovaných služeb, které mohou být spravovány ruznými ˚ vlastníky. Definuje jednotný zpusob ˚ inzerce, hledání, vzájemné komunikace a spotˇreby služeb s cílem ˇ ritelnými pˇredpoklady a dosáhnout požadovaných výsledku˚ v souladu s meˇ oˇcekáváním.

SOA je paradigma – kompozice služeb SOA je distribuovaná – autonomní, ale spolupracující služby SOA je heterogenní prostˇredí – služba pˇrístupná pˇres své rozhraní SOA je standardizovaná – popis rozhraní a zpusob ˚ komunikace služeb SOA podporuje business – služby realizují konkrétní business procesy

Marek Rychlý


4 / 51




SOA je paradigma – kompozice služeb (architektonický styl a zpusob ˚ analýzy, návrhu, integrace a údržby systému) ˚

SOA je distribuovaná – autonomní, ale spolupracující služby SOA je heterogenní prostˇredí – služba pˇrístupná pˇres své rozhraní SOA je standardizovaná – popis rozhraní a zpusob ˚ komunikace služeb SOA podporuje business – služby realizují konkrétní business procesy Marek Rychlý


4 / 51




SOA je paradigma – kompozice služeb SOA je distribuovaná – autonomní, ale spolupracující služby (systém realizován jako kompozice úˇcelové spolupracujících služeb)

SOA je heterogenní prostˇredí – služba pˇrístupná pˇres své rozhraní SOA je standardizovaná – popis rozhraní a zpusob ˚ komunikace služeb SOA podporuje business – služby realizují konkrétní business procesy Marek Rychlý


4 / 51




SOA je paradigma – kompozice služeb SOA je distribuovaná – autonomní, ale spolupracující služby SOA je heterogenní prostˇredí – služba pˇrístupná pˇres své rozhraní (služby mohou mít ruzné ˚ životní cykly, vlastníky, implementaˇcní technologie, atd.)

SOA je standardizovaná – popis rozhraní a zpusob ˚ komunikace služeb SOA podporuje business – služby realizují konkrétní business procesy Marek Rychlý


4 / 51




SOA je paradigma – kompozice služeb SOA je distribuovaná – autonomní, ale spolupracující služby SOA je heterogenní prostˇredí – služba pˇrístupná pˇres své rozhraní SOA je standardizovaná – popis rozhraní a zpusob ˚ komunikace služeb (ˇrešení nezávislé na dodavateli, možnost náhrady služby, její outsourcing, atp.)

SOA podporuje business – služby realizují konkrétní business procesy Marek Rychlý


4 / 51




SOA je paradigma – kompozice služeb SOA je distribuovaná – autonomní, ale spolupracující služby SOA je heterogenní prostˇredí – služba pˇrístupná pˇres své rozhraní SOA je standardizovaná – popis rozhraní a zpusob ˚ komunikace služeb SOA podporuje business – služby realizují konkrétní business procesy (služby zpracovávají a produkují dokumenty, spravují zdroje, atd.)

Marek Rychlý


4 / 51



Architektura orientovaná na služby (SOA) SOA: architektura orientovaná na služby (Service-Oriented Architecture), obecný koncept spolupracujících služeb, WS: webové služby (Web Services), technologie pro implementaci SOA, spravuje W3C skupina Web Services Architectures. Role komunikujících stran: poskytovatel služeb implementuje a nabízí služby (service provider), služba je specifikovaná svým popisem (URI, rozhraním a protokolem), spotˇrebitel služeb na základeˇ popisu vyhledá službu v registru služeb a použije ji (service consumer).

Marek Rychlý


5 / 51



Konceptuální model SOA

model interakce mezi poskytovatelem služeb a spotˇrebitelem služeb

Marek Rychlý


6 / 51



Struktura SOA SOA je cˇ ásteˇcneˇ vrstevnatá architektura (vrstva = úrovenˇ abstrakce) 1

vrstva business procesu˚ – BP je posloupnost kroku˚ respektující business pravidla a vedoucí k zisku (hmotnému i nehmotnému), ˇ reprezentován sekvencí provedení nekolika služeb (choreografie služeb),

2

vrstva služeb – rozhraní jednotlivých komponent sjednocena do ˇ služeb, služba za behu sestavuje komponenty a pˇreposílá jim ˇ požadavky, služba na rozhraní zpˇrístupnuje své funkce (popis služby),

3

vrstva komponent – základní stavební kameny služeb, realizace ˇ požadované kvality služeb (QoS), funkˇcnosti služeb a zajištení ˇ a jejich funkce jsou pˇrístupné komponenty jsou cˇ erné skˇrínky pouze pˇres rozhraní.

Marek Rychlý


7 / 51



Informaˇcní systém – bez architektury SOA podsystémy jsou monolitické (komplikovaný pˇrístup k jednotlivým funkcím, nejasné rozhraní, obtížná integrace celých podsystému) ˚

podsystémy jsou striktneˇ ˇ oddelené, každý má samostatný životní cyklus (implementací, správou, možností modifikace, atd.)

komunikace podsystému˚ pˇres spoleˇcné úložišteˇ dat (problematická návaznost procesu, ˚ napˇr. „Order Status“, ˇ nejasná zodpovednost za data) (diagram pˇrevzat z „Sun: Service-Oriented Architecture – Overview“)

Marek Rychlý


8 / 51



Informaˇcní systém – s architekturou SOA dekompozice na úrovenˇ jednotlivých služeb (jasneˇ definovaná rozhraní služeb, podsystémy vznikají kompozicí)

podsystémy se prolínají sdílenými službami, každá má samostatný životní cyklus (sdílení spoleˇcných cˇ ástí podsystému, ˚ napˇr. „Check Order Status“)

pˇrímá komunikace služeb, úložišteˇ dat pro dokumenty

(diagram pˇrevzat z „Sun: Service-Oriented Architecture – Overview“)

Marek Rychlý

(služby komunikují napˇríˇc podsystémy, s daty manipuluje služba reprezentující k datum ˚ pˇríslušný business proces)


9 / 51



Spolupráce mezi službami v SOA služby poskytují své prostˇredky bud’ pˇrímo cílovému spotˇrebiteli anebo jiným službám, služby mezi sebou spolupracují (komunikují) zasíláním zpráv. Spolupráce mezi službami: kooperace – služba využívá prostˇredky jiné (rovnocenné) služby pro realizaci nabízených funkcí, agregace – služba sestavená ze dvou (nebo více, podˇrízených) služeb nabízí kombinaci funkcí dílˇcích služeb, choreografie – služby potom spolupracují za úˇcelem provedení konkrétního business procesu, orchestrace – služba ˇrídí souˇcinost ostatních služeb za úˇcelem provedení své cˇ ásti business procesu.

Marek Rychlý


10 / 51



Principy SOA

standardizace

→

kompatibilita, nezávislost

→ → → → → → →

ˇ údržba služeb snadnejší jednoznaˇcný zpusob ˚ použití ˇ zisk vývoj služby pˇrinese vetší ˇ ritelnost funkˇcnosti oveˇ pˇredvídatelnost chování implementaˇcní nezávislost ˇ tvorba složitejších služeb

(jednotný zpusob ˚ popisu služeb)

volné vázání abstrakce znovupoužitelnost nezávislost bezstavovost dohledatelnost kompozice

Marek Rychlý


11 / 51



Principy SOA

standardizace volné vázání

→ →

kompatibilita, nezávislost ˇ údržba služeb snadnejší

(minimum závislostí mezi službami, okolí služby závisí pouze na jejím rozhraní)

abstrakce znovupoužitelnost nezávislost bezstavovost dohledatelnost kompozice

Marek Rychlý

→ → → → → →

jednoznaˇcný zpusob ˚ použití ˇ zisk vývoj služby pˇrinese vetší ˇ ritelnost funkˇcnosti oveˇ pˇredvídatelnost chování implementaˇcní nezávislost ˇ tvorba složitejších služeb


11 / 51



Principy SOA

standardizace volné vázání abstrakce

→ → →

kompatibilita, nezávislost ˇ údržba služeb snadnejší jednoznaˇcný zpusob ˚ použití

(služby pˇrístupné pouze pˇres rozhraní, zbytek zapouzdˇren)

znovupoužitelnost nezávislost bezstavovost dohledatelnost kompozice

Marek Rychlý

→ → → → →

ˇ zisk vývoj služby pˇrinese vetší ˇ ritelnost funkˇcnosti oveˇ pˇredvídatelnost chování implementaˇcní nezávislost ˇ tvorba složitejších služeb


11 / 51



Principy SOA

standardizace volné vázání abstrakce znovupoužitelnost

→ → → →

kompatibilita, nezávislost ˇ údržba služeb snadnejší jednoznaˇcný zpusob ˚ použití ˇ zisk vývoj služby pˇrinese vetší

(služba použitelná v ruzných ˚ kontextech/systémech)

nezávislost bezstavovost dohledatelnost kompozice

Marek Rychlý

→ → → →

ˇ ritelnost funkˇcnosti oveˇ pˇredvídatelnost chování implementaˇcní nezávislost ˇ tvorba složitejších služeb


11 / 51



Principy SOA

standardizace volné vázání abstrakce znovupoužitelnost nezávislost

→ → → → →

kompatibilita, nezávislost ˇ údržba služeb snadnejší jednoznaˇcný zpusob ˚ použití ˇ zisk vývoj služby pˇrinese vetší ˇ ritelnost funkˇcnosti oveˇ

(služby autonomní jednotky, nezávisí skryteˇ na svém okolí)

bezstavovost dohledatelnost kompozice

Marek Rychlý

→ → →

pˇredvídatelnost chování implementaˇcní nezávislost ˇ tvorba složitejších služeb


11 / 51



Principy SOA

standardizace volné vázání abstrakce znovupoužitelnost nezávislost bezstavovost

→ → → → → →

kompatibilita, nezávislost ˇ údržba služeb snadnejší jednoznaˇcný zpusob ˚ použití ˇ zisk vývoj služby pˇrinese vetší ˇ ritelnost funkˇcnosti oveˇ pˇredvídatelnost chování

ˇ uchovávat viditelnou stavovou informaci) (služba by nemela

dohledatelnost kompozice

Marek Rychlý

→ →

implementaˇcní nezávislost ˇ tvorba složitejších služeb


11 / 51



Principy SOA

standardizace volné vázání abstrakce znovupoužitelnost nezávislost bezstavovost dohledatelnost

→ → → → → → →

kompatibilita, nezávislost ˇ údržba služeb snadnejší jednoznaˇcný zpusob ˚ použití ˇ zisk vývoj služby pˇrinese vetší ˇ ritelnost funkˇcnosti oveˇ pˇredvídatelnost chování implementaˇcní nezávislost

(navazovány úˇceloveˇ poskytovatel služby dle potˇreby dohledatelný v adresáˇri)

kompozice

Marek Rychlý

→

ˇ tvorba složitejších služeb


11 / 51



Principy SOA

standardizace volné vázání abstrakce znovupoužitelnost nezávislost bezstavovost dohledatelnost kompozice

→ → → → → → → →

kompatibilita, nezávislost ˇ údržba služeb snadnejší jednoznaˇcný zpusob ˚ použití ˇ zisk vývoj služby pˇrinese vetší ˇ ritelnost funkˇcnosti oveˇ pˇredvídatelnost chování implementaˇcní nezávislost ˇ tvorba složitejších služeb

ˇ (kompozice služeb do vetších funkˇcních celku˚ dle potˇreby)

Marek Rychlý


11 / 51



Porovnání SOA s jinými architekturami a principy SOA vs. klient-server architektura klient–server = rozhraní a apl. logika × apl. logika, stav a sdílené zdroje, spotˇrebitel–poskytovatel = potˇrebuje × nabízí funkˇcnost, ˇ dekompozice (napˇr. menší nároky na zdroje), SOA je jemnejší ˇ výpoˇcetní logiky), SOA je více distribuovaná (rozmístení ˇ služby se snaží být bezstavové z vnejšího pohledu.

SOA vs. objektoveˇ orientovaný pˇrístup SOA pˇrístup preferuje volném provázání entit (služeb) × OO pˇrístup ˇ ejší ˇ vazby entit (objektu), pˇresneˇ vztahy mezi tˇrídami, tesn ˚ ˇ cnost × SOA pˇrístup s dediˇ ˇ cností základní vlastností OO pˇrístupu je dediˇ nepoˇcítá, preferuje delegaci, základní vlastností SOA pˇrístupu je bezstavovost entit × zapouzdˇrení dat do objektu˚ v OO pˇrístupu, ˇ aktivita služeb v SOA pˇrístupu je vyvolána až pˇríchodem nejaké zprávy, podobný pohled na abstrakci entit (rozhraní). Marek Rychlý


12 / 51



Webové služby (Web Services)

ˇ a nejpoužívanejší ˇ technologie pro implementaci SOA Neznámejší Webové služby postaveny na „webových“ standardech: HTTP protokol a SOAP protokol (Simple Object Access Protocol), jazyky XML (eXtensible Markup Language) a XML Schema (XSD), registr UDDI (Universal Description, Discovery and Integration) jazyk WSDL (Web Services Description Language) definice Web Service zahrnuje tvorbu XSD a WSDL dokumentu˚ (tj. popis datových typu, ˚ operací, zpusobu ˚ volání rozhraní služby)

Marek Rychlý


13 / 51




ˇ a nejpoužívanejší ˇ technologie pro implementaci SOA Neznámejší Webové služby postaveny na „webových“ standardech: HTTP protokol a SOAP protokol (Simple Object Access Protocol), (komunikaˇcní spojení, obálku a adresace zpráv pˇri volání konkrétních služeb)

jazyky XML (eXtensible Markup Language) a XML Schema (XSD), registr UDDI (Universal Description, Discovery and Integration) jazyk WSDL (Web Services Description Language) definice Web Service zahrnuje tvorbu XSD a WSDL dokumentu˚ (tj. popis datových typu, ˚ operací, zpusobu ˚ volání rozhraní služby)

Marek Rychlý


13 / 51




ˇ a nejpoužívanejší ˇ technologie pro implementaci SOA Neznámejší Webové služby postaveny na „webových“ standardech: HTTP protokol a SOAP protokol (Simple Object Access Protocol), jazyky XML (eXtensible Markup Language) a XML Schema (XSD), ˇ (popis struktury a vlastní zápis informací behem pˇrenosu pˇri volání služeb)

registr UDDI (Universal Description, Discovery and Integration) jazyk WSDL (Web Services Description Language) definice Web Service zahrnuje tvorbu XSD a WSDL dokumentu˚ (tj. popis datových typu, ˚ operací, zpusobu ˚ volání rozhraní služby)

Marek Rychlý


13 / 51




ˇ a nejpoužívanejší ˇ technologie pro implementaci SOA Neznámejší Webové služby postaveny na „webových“ standardech: HTTP protokol a SOAP protokol (Simple Object Access Protocol), jazyky XML (eXtensible Markup Language) a XML Schema (XSD), registr UDDI (Universal Description, Discovery and Integration) (mechanismus registru˚ pro vyhledávání webových služeb)

jazyk WSDL (Web Services Description Language) definice Web Service zahrnuje tvorbu XSD a WSDL dokumentu˚ (tj. popis datových typu, ˚ operací, zpusobu ˚ volání rozhraní služby)

Marek Rychlý


13 / 51




ˇ a nejpoužívanejší ˇ technologie pro implementaci SOA Neznámejší Webové služby postaveny na „webových“ standardech: HTTP protokol a SOAP protokol (Simple Object Access Protocol), jazyky XML (eXtensible Markup Language) a XML Schema (XSD), registr UDDI (Universal Description, Discovery and Integration) jazyk WSDL (Web Services Description Language) ˇ služeb a zpusobu (popis funkcí a umístení ˚ komunikace v XML)

definice Web Service zahrnuje tvorbu XSD a WSDL dokumentu˚ (tj. popis datových typu, ˚ operací, zpusobu ˚ volání rozhraní služby)

Marek Rychlý


13 / 51




ˇ a nejpoužívanejší ˇ technologie pro implementaci SOA Neznámejší Webové služby postaveny na „webových“ standardech: HTTP protokol a SOAP protokol (Simple Object Access Protocol), jazyky XML (eXtensible Markup Language) a XML Schema (XSD), registr UDDI (Universal Description, Discovery and Integration) jazyk WSDL (Web Services Description Language) definice Web Service zahrnuje tvorbu XSD a WSDL dokumentu˚ (tj. popis datových typu, ˚ operací, zpusobu ˚ volání rozhraní služby)

Marek Rychlý


13 / 51



Další standardy kolem Web Services

Marek Rychlý

(diagram pˇrevzat z „Vinod Krishnan: SOA – a quick view“) Webové služby v Java EE (JAX-WS) — Pˇrednáška pro PDI, 7. listopadu 2014

14 / 51



XML Schema Definition (XSD) Jazyk od W3C pro popis struktury/schéma XML dokumentu. ˚ (dalšími jazyky jsou napˇr. DTD, Relax NG, Schematron, atd.)

„W3C XML Schema Definition Language (XSD) 1.1“ popsaná v Part 1: Structures Part 2: Datatypes

Popis schéma je XML dokument s elementem <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:my="http://mycompany.com/hr/schemas" targetNamespace="http://mycompany.com/hr/schemas" elementFormDefault="qualified"> ...

Obsahuje pˇreddefinované jednoduché typy, další lze zadefinovat. (pˇreddefinované jsou napˇr. string, integer nebo date)

Marek Rychlý


15 / 51







Marek Rychlý


15 / 51







Marek Rychlý


15 / 51







Marek Rychlý


15 / 51



Definice dokumentu˚ v XSD (pˇríklady uvedeny bez prefixu˚ jmených prostoru) ˚

elementy a atributy jednoduchých typu˚ <element name="..." type="..."/>

elementy složených typu˚ nebo samotné složené typy <element name="...">...

ˇ restrikce (omezení, výbery) jako jednoduché typy <simpleType name="..."> <xs:pattern value="[0-9][0-9]"/> <simpleType name="..."> <enumeration value="one"/>...

sekvence elementu˚ jako složené typy (ˇrazené) <sequence><element name="..." type="..."/> <element name="..." type="..."/>

množiny elementu˚ jako složené typy (neˇrazené) <element name="..." type="..."/> <element name="..." type="..."/>

. . . a další (vizte XML Schema Reference) Marek Rychlý


16 / 51











16 / 51











16 / 51











16 / 51











16 / 51











16 / 51



Pˇríklad popisu v XSD <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:my="http://mycompany.com/hr/schemas" targetNamespace="http://mycompany.com/hr/schemas" elementFormDefault="qualified"> <xs:element name="HolidayRequest"> <xs:complexType><xs:all> <xs:element name="Holiday" type="my:HolidayType"/> <xs:element name="Employee" type="my:EmployeeType"/> <xs:complexType name="HolidayType"> <xs:sequence> <xs:element name="StartDate" type="xs:date"/> <xs:element name="EndDate" type="xs:date"/> <xs:complexType name="EmployeeType"> <xs:sequence> <xs:element name="Number" type="xs:integer"/> <xs:element name="FirstName" type="xs:string"/> <xs:element name="LastName" type="xs:string"/> Marek Rychlý


17 / 51



Pˇríklad XML dokumentu podle uvedeného popisu Uvedenému popisu vyhovuje napˇr. následující dokument <StartDate>2006-07-03 <EndDate>2006-07-07 <Employee> 42 Arjen Poutsma

ˇ Holiday a Employee. Libovolné poˇradí elementu˚ umístení (ale pevné poˇradí jejich pod-elementu) ˚

Platné datum formátované jako YYYY-MM-DD. (datový typ definovaný ve specifikace XML Schema)

..................................................................... Pˇríklady XSD a WSDL pˇrevzaty z „Spring Web Services: Reference Documentation“. Marek Rychlý


18 / 51








18 / 51








18 / 51



Web Services Description Language (WSDL) W3C zavedla WSDL jako standard pro XML popis webových služeb. Jaké funkce poskytuje daná služba? Jak muže ˚ být s danou službou navázána komunikace? Kde/kým je daná služba poskytována? Každá služba jako množina koncových bodu˚ (service endpoints). ˇ v techto bodech komunikuje s okolím pomocí zasílání zpráv, (pro jednoduchost si lze koncový bod pˇredstavit jako rozhraní služby)

WSDL poskytuje formální definici koncových bodu: ˚ 1

abstraktní popis koncového bodu, (popis rozhraní služby bez ohledu na konkrétní technologie a protokoly)

2

konkrétního popis koncového bodu. (navázání abstraktního popisu na reálnou implementaci a komunikace na konkrétní protokol)

Marek Rychlý


19 / 51






2


Marek Rychlý


19 / 51






2


Marek Rychlý


19 / 51



Abstraktní a konkrétní popis ve WSDL Abstraktní popis koncového bodu: popis rozhraní služby bez ohledu na konkrétní technologie a protokoly, tˇri základní oddíly: message: popis zpráv, které pˇredstavují operace a jejich parametry. operation: popis operací, jejich vstupní a výstupní parametry, interface: rozhraní služby, tj. poskytované operace, Konkrétní popis koncového bodu: navázání abstraktního popisu na reálnou implementaci a komunikace na konkrétní protokol, tˇrí základních oddíly: binding: formát volání služby, popis protokolu (napˇr. v SOAP) pro jednotlivé operation nebo celé interface, service: popis služby jako seskupení prvku˚ „endpoints“, endpoint: fyzická adresa, na které je služba pˇrístupná. Marek Rychlý


20 / 51



Abstraktní a konkrétní popis ve WSDL Abstraktní popis koncového bodu: popis rozhraní služby bez ohledu na konkrétní technologie a protokoly, tˇri základní oddíly: message: popis zpráv, které pˇredstavují operace a jejich parametry. operation: popis operací, jejich vstupní a výstupní parametry, interface: rozhraní služby, tj. poskytované operace, Konkrétní popis koncového bodu: navázání abstraktního popisu na reálnou implementaci a komunikace na konkrétní protokol, tˇrí základních oddíly: binding: formát volání služby, popis protokolu (napˇr. v SOAP) pro jednotlivé operation nebo celé interface, service: popis služby jako seskupení prvku˚ „endpoints“, endpoint: fyzická adresa, na které je služba pˇrístupná. Marek Rychlý


20 / 51



Ukázka WSDL popisu služby I Definujeme jmenné prostory pro jednotlivé cˇ ásti dokumentu: soap: WSDL popisuje službu pro protokol SOAP, tns: názvy používané v naší aplikaci, xsd: popis protokolu volání služby jako XML dokumentu, <wsdl:definitions xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:schema="http://mycompany.com/hr/schemas" xmlns:tns="http://mycompany.com/hr/definitions" targetNamespace="http://mycompany.com/hr/definitions"> <wsdl:types> <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <xsd:import namespace="http://mycompany.com/hr/schemas" schemaLocation="hr.xsd"/>

Marek Rychlý


21 / 51



Ukázka WSDL popisu služby II

Definujeme zprávy pˇrijímané a navracené danou službou1 : message: definice vlastní zprávy pˇrenášené pˇri komunikaci, operation: pˇriˇrazení zpráv k operacím posytovaným službou. <wsdl:message name="HolidayRequest"> <wsdl:part element="schema:HolidayRequest" name="HolidayRequest"/> <wsdl:portType name="HumanResource"> <wsdl:operation name="Holiday"> <wsdl:input message="tns:HolidayRequest" name="HolidayRequest"/>

Marek Rychlý


22 / 51



Ukázka WSDL popisu služby III ˇ služby2 : Popis formátu volání operací pro SOAP a umístení <wsdl:binding name="HumanResourceBinding" type="tns:HumanResource"> <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/> <wsdl:operation name="Holiday"> <soap:operation soapAction="http://mycompany.com/RequestHoliday"/> <wsdl:input name="HolidayRequest"> <soap:body use="literal"/> <wsdl:service name="HumanResourceService"> <wsdl:port binding="tns:HumanResourceBinding" name="HumanResourcePort"> <soap:address location="http://localhost:8080/holidayService/"/>

1 Elementy 2 Element Marek Rychlý

types, message a portType popisují, co služba poskytuje. binding popisuje, jak služba komunikuje, a service, kde ji kontaktovat. Webové služby v Java EE (JAX-WS) — Pˇrednáška pro PDI, 7. listopadu 2014

23 / 51



Simple Object Access Protocol (SOAP)

ˇ základní vrstva WS technologie, výmena XML zpráv, ˇ patˇrí do aplikaˇcní vrstvy petivrstvého TCP/IP modelu, bezstavový protokol, nezávislé na protokolu a implementaci, (jedním z protokolu˚ komunikace je HTTP/HTTPS protokol)

ˇ podporuje nekolik typu˚ volání funkcí služeb, ˇ je implementované Remote (kde klient posílá XML zprávu na server, nejznámejší Procedure Call (RPC), SOAP vychází ze staršího XML-RPC)

ˇ definuje strukturu zprávy (obálka kolem hlaviˇcky a tela). ˇ (pravdepodobn eˇ vychází ze staršího Web Distributed Data eXchange (WDDX))

Marek Rychlý


24 / 51







Marek Rychlý


24 / 51







Marek Rychlý


24 / 51







Marek Rychlý


24 / 51







Marek Rychlý


24 / 51



Struktura SOAP zprávy

(diagram pˇrevzat z „The Java EE 5 Tutorial“)

zpráva = ˇ obálka s hlaviˇckami (nepovinné) a telem + pˇrílohy (nepovinné) Marek Rychlý


25 / 51



Ukázka struktury SOAP zprávy v HTTP protokolu MIME-Version: 1.0 Content-Type: text/xml; charset=UTF-8 Content-Transfer-Encoding: 8bit <env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"> <env:Header/> <env:Body> 2006-07-03 2006-07-07 42 Arjen Poutsma

Marek Rychlý


26 / 51



Existuje mnoho scénáˇru˚ volání služeb pˇres SOAP Fire-and-forget (one-way) (klient odešle požadavek na službu a déle se neˇceká, nic nevrací)

Request/Response ˇ (odešle požadavek a cˇ eká na odpoved’)

Request with acknowledgement (odešle požadavek a cˇ eká na potvrzení pˇríjmu)

Remote Procedure Call (RPC) (odešle požadavek se serializovanými parametry volané procedury ˚ a cˇ eká na ˇ ˇ ˇ odpoved’ opet v podobe serializovaných návratových hodnot)

. . . a další (vizte „SOAP Version 1.2 Usage Scenarios“) Synchronní/asynchronní komunikace záleží na transportním protokolu. ˇ napˇr. narozdíl od emailových zpráv) (napˇr. HTTP(s) synchronní, umí odpovedi,

Samozˇrejmeˇ je možno implemntovat asynchronicitu na úrovni služby. ˇ adresu vlastní (požadavek pošle klient metodou fire-and-forget, ale pˇriloží v nem ˇ služby, která je pˇripravena pˇrijmout odpoved’) Marek Rychlý


27 / 51










27 / 51










27 / 51










27 / 51










27 / 51










27 / 51


Poskytovatel webové služby pomocí JAX-WS Spotˇrebitel webové služby pomocí JAX-WS Použití JAX-WS v aplikaˇcním serveru a podpora v IDE

Obsah 1


2


3


4



28 / 51



Java API for XML Web Services (JAX-WS) pro realizaci XML webových služeb a jejich klientu˚ v Java EE, (poskytovatelu˚ a spotˇrebitelu˚ služeb dle SOA)

používá pˇrenos XML zpráv SOAP protokolem pˇres HTTP, (pˇres knihovny SOAP with Attachments API for Java, SAAJ)

podporuje ruzné ˚ modely komunikace3 : (implicitneˇ se použije „Document/literal“, nastavitelné pomocí anotace) 1

RPC/encoded ˇ (jednoduché WSDL s názvem operace a typy parametru˚ pˇrímo ve zpráve)

2

RPC/literal ˇ (podobneˇ jako pˇredchozí, ale bez typu˚ ve zpráve)

3

Document/encoded (nepoužívá se, není podporováno „standardy“ organizace WS-I)

4

ˇ používaný Document/literal – nejˇcasteji (WSDL popis obsahuje definici typu˚ v XML Schema, lehce validovatelné)

3 http: //www.ibm.com/developerworks/webservices/library/ws-whichwsdl/ Marek Rychlý


29 / 51



Implementace JAX-WS

webové služby jsou definovány jako Java tˇrídy s poskytovanými metodami oznaˇcenými pomocí anotací, (automatický pˇrevod definice rozhraní tˇrídy do popisu pomocí WSDL)

spotˇrebitel vytvoˇrí pomocí JAX-WS lokální proxy pro vzdálenou webovou službu a tu transparentneˇ používá, (proxy má stejné rozhraní jako tˇrída implementující webovou službu u poskytovatele, pˇrevod volání metod proxy na SOAP zprávy je automatický),

respektuje nezávislost na platformeˇ – lze komunikovat s libovolneˇ implementovanými službami. ˇ pomocí JAX-WS, apod.) (tzn. se službami neimplementovanými v Jave,

Marek Rychlý


30 / 51



Technologie JAX-WS v Java EE podle [Jendrock et al., 2014]

Webové služby v Java EE–(JAX-WS) Pˇrednáška pro PDI, 2014 – databáze tenký/tlustý klient Java—EE aplikaˇ c7.nílistopadu server

Marek Rychlý

31 / 51



Komunikace pˇres JAX-WS podle [Jendrock et al., 2014]

JAX-WS tvoˇrí abstrakci nad SOAP komunikací webových služeb

Marek Rychlý


32 / 51



Implementace poskytovatele WS pomocí JAX-WS Použití anotací @javax.jws.WebService a @javax.jws.WebMethod: webová služba je realizována jako rozhraní/tˇrída s anotací @WebService, (service endpoint interface/service endpoint implementation (SEI)) ˇ implicitní je definice rozhraní služby spoleˇcneˇ s implementací (ve tˇríde), (pˇrímo u implementace metod tˇrídy pomocí anotace @WebMethod)

ˇ ˇ definici rozhraní služby, parametr endpointInterface umožnuje oddelit (rozhraní musí rozšiˇrovat rozhraní Remote a oznaˇcit metody pomocí @WebMethod) tˇrída implementující službu nesmí být final nebo abstract, musí mít implicitní bezparametrický konstruktor, (metody s anotací @PostConstruct a @PreDestroy obslouží vznik a zánik)

metody rozhraní/tˇrídy pro webovou službu (anotace @WebMethod) musí být public a nesmí být static nebo final, typy parametru˚ a návratových hodnot metod rozhraní/tˇrídy pro webovou službu jsou omezeny Java Architecture for XML Data Binding (JAXB), z tˇrídy (tj. z implementace služby) lze generovat popis služby. (wsgen -d -classpath <SEI class>) Marek Rychlý


33 / 51



Ukázka implementace poskytovatele v JAX-WS import javax.jws.* @WebService() public class math { private double memory = 0; private String ver = "Math Service v0.1"; @WebMethod(operationName = "getMemory") public double getMemory() { return this.memory; } @WebMethod(operationName = "setMemory") @Oneway public void setMemory(@WebParam(name = "newValue") double newValue) { this.memory = newValue; } @WebMethod(operationName = "addToMemory") public double addToMemory(@WebParam(name = "addValue") double addValue) { return this.memory = this.memory + addValue; } @WebMethod(operationName = "getVersion") public String getVersion() { return this.ver; } }

Marek Rychlý


34 / 51



ˇ poskytovatele WS pomocí JAX-WS Zprovoznení ˇ poskytovatele webové služby: Postup zprovoznení 1 tvorba kódu tˇrídy s implementací služby, 2 kompilace tˇrídy s implementací služby, 3 použití nástroje wsgen pro generování popisu služby, 4 zabalení zkompilované implementace a popisu do WAR archivu, 5 ˇ WAR archivu na aplikaˇcní server. umístení (apl. server automaticky generuje popis služby vyžadovaný spotˇrebitelem)

ˇ ˇ Vetšina aplikaˇcních serveru˚ umožnuje poskytuje pomocné akce: Tomcat informace o webové službeˇ na adrese http://localhost:8080/ws-demo/math?Tester

a WSDL popis na adrese http://localhost:8080/ws-demo/math?wsdl

SUN testování webové služby na adrese http://localhost:8080/ws-demo/math?Tester Marek Rychlý


35 / 51



Implementace spotˇrebitele WS pomocí JAX-WS Použití anotace @WebServiceRef: klient deklaruje odkaz na webovou službu anotací @WebServiceRef, (parametr wsdlLocation udává URI na WSDL odkazované služby) ˇ anotace se použije s deklarací promenné zastupující objekt poskytovatele proxy, ˇ ˇ (promenná se deklaruje jako static a bez pˇriˇrazení hodnoty, typ promenné, tj. ˇ tˇrída objektu, je tˇrída implementující službu doplnená v názvu slovem „Service“)

objekt poskytovatele proxy se použije k získání proxy (portu služby), (metoda getNamePort, kde slovo „Name“ je název tˇrídy implementující službu)

proxy se používá jako klasický objekt tˇrídy implementující službu. (práce s webovou službou zastupovanou proxy je plneˇ transparentní, jako práce s lokálním objektem tˇrídy implementující webovou službu)

z WSDL lze generovat zdroje pro referenci služby v kódu klienta. (voláním wsimport -d <WSDL file>)

Marek Rychlý


36 / 51



Ukázka implementace spotˇrebitele v JAX-WS import javax.xml.ws.WebServiceRef; import cz.vutbr.fit.rychly.wsDemo.service.MathService; import cz.vutbr.fit.rychly.wsDemo.service.math; public class MathClient { @WebServiceRef(wsdlLocation="http://localhost:8080/ws-demo/math?wsdl") static MathService service; public static void main(String[] args) { try { (new MathClient).doTest(args); } catch(Exception e) { e.printStackTrace(); } } public void doTest(String[] args) { try { System.out.println("retrieving the port from" + service); Math port = service.getMathPort(); System.out.println("invoking the operation on the port"); Sestem.out.println(port.getMemory()); } catch(Exception e) { e.printStackTrace(); } } }

Marek Rychlý


37 / 51



ˇ spotˇrebitele WS pomocí JAX-WS Zprovoznení

ˇ spotˇrebitele webové služby: Postup zprovoznení 1

tvorba kódu tˇríd spotˇrebovávajících webovou službu,

2

použití nástroje wsimport s WSDL pro generování zdroju, ˚

3

kompilace tˇríd s spotˇrebovávajících webovou službu, ˇ spotˇrebitele webové služby. spuštení

4

ˇ vývojovým prostˇredím (IDE). Celý proces muže ˚ být usnadnen

Marek Rychlý


38 / 51



ˇ Kombinace JAX-WS s doplnujícími technologiemi Speciální použití webových služeb: ˇ XML dokumentu Streaming API for XML (StAX) – postupné zpˇrístupnení pomocí webové služby (toto není Document Object Model (DOM)), SOAP with Attachments API for Java (SAAJ) – volání s pˇrílohami.

Autentizace a autorizace: ˇ anotace javax.annotation.security.RolesAllowed umožnuje ˇ nebo jejím specifikovat role, které mohou pˇristupovat ke službeˇ (SEI tˇríde) metodám, ˇ anotace javax.annotation.security.DeclareRoles umožnuje nastavit role, ve kterých bude služba (SEI tˇrída) vystupovat, (užiteˇcné pˇri (oboustranném) použití certifikátu) ˚

apl. server autentizuje uživatele a autorizuje je pro pˇrístup k webovým komponentám s definovanými rolemi, (autentizaˇcní mechanismy Basic, Digest, Form, Client-Cert, a jiné)

webová služba je webová komponenta, pˇrístup k ní lze zabezpeˇcit podobneˇ jako napˇr. k servletu. Marek Rychlý


39 / 51



Zabezpeˇcení webové komponenty [Jendrock et al., 2014]

Marek Rychlý


40 / 51



Použití JAX-WS v aplikaˇcním serveru Tomcat Nebudeme využívat zabudovaný apl. server v IDE, použijeme4 1

Apache Tomcat 6.0 je Servlet-2.5/JSP-2.1 webový kontejner, (nepodporuje JavaBeans, jako napˇr. Sun Java System Application Server),

2

stáhneme z http://tomcat.apache.org/ a nainstalujeme,

3

pˇridáme úˇcet správce serveru do tomcat-users.xml <user username="x" password="y" roles="admin,manager,host-manager"/>

4

spustíme a spravujeme webovým rozhraním na http://x:y@localhost:8080/manager/html

4 nebo

použijeme školní server pcuifs2

Marek Rychlý


41 / 51



Podpora JAX-WS ve vývojovém prostˇredí NetBeans

Marek Rychlý

1

v menu „Tools: Servers“ pˇridáme server Tomcat pˇríslušné verze,

2

založíme nový projekt typu „Web Application“,

3

v „Project Properties: Run“ nastavíme server a ˇ cestu ke komponente,

4

z kontextové nabídky projektu vybereme typ nové komponenty (viz vlevo),

5

po implementaci dáme „Build“ a „Deploy“.


42 / 51



Konfigurace služby ve vývojovém prostˇredí NetBeans

Marek Rychlý


43 / 51


Representational State Transfer (REST) architektura Webové služby pomocí JAX-RS

Obsah 1


2


3


4



44 / 51



Java API for RESTful Web Services (JAX-RS) pro webové služby arch. REST mapující web-resources na Java objekty, (pˇrístup k objektum ˚ spravovaným tˇrídou služby via HTTP)

souˇcást Java EE od verze JAX-RS v1.1 (v Java EE 6).

Representational State Transfer (REST) architektura: vzdálený pˇrístup k datum ˚ (zdrojum, ˚ „resources“), nikoli k procedurám, (ke vzdáleným procedurám pˇristupuje napˇr. XML-RPC nebo SOAP)

každý zdroj má unikátní identifikátor (URL nebo URN), (napˇr. „http://example.com/resources/“ nebo „urn:isbn:0451450523“)

HTTP pˇrístup ke zdrojum ˚ metodami PUT, GET, POST a DELETE, (obecneˇ metody reprezentují cˇ tyˇri operací CRUD: Create, Read, Update, Delete)

Marek Rychlý


45 / 51



Pˇrístupové metody v architektuˇre REST pro kolekci zdroju˚ slouží metoda (napˇr. v pˇrípadeˇ pˇrístupu k „http://example.com/resources/“)

PUT k uložení/nahrazení celé kolekce, GET k výpisu URI a další detailu˚ prvku˚ kolekce, POST k vložení prvku do kolekce, automatické pˇriˇrazení URL ˇ (URL je obvykle vráceno v odpovedi), DELETE ke smazání celé kolekce, pro jednotlivý zdroj (prvek kolekce) slouží metoda (napˇr. v pˇrípadeˇ pˇrístupu k „http://example.com/resources/123“)

PUT k uložení/nahrazení p5istupovaného prvku, GET k získání pˇristupovaného prvku ve formátu dle MIME, POST k reprezentaci pˇristupovaného prvku jako kolekce a vložení jejího vlastního prvku, DELETE ke smazání pˇristupovaného prvku (DELETE). Metody PUT, GET a DELETE jsou idempotentní (stejná volání vracejí stejné výsledky). Metoda GET je navíc bezpeˇcná (tj. „no side-effect“). Marek Rychlý


46 / 51



Implementace poskytovatele a spotˇrebitele v JAX-RS Použití anotací @javax.jws.WebService a @javax.jws.WebMethod: webová služba je realizována jako tˇrída s anotací @Path, (anotace ma jako parametr URI zdroje, pˇresné nebo jako vzor, napˇr. @Path("users/username")) metody reprezentující operace anotovány @GET, @PUT, @POST @DELETE, (typ reprezentující operace je dán anotací, samotná metoda muže ˚ mít libovolný název, narozdíl od napˇr. HTTP servletu) ˚ na tˇrídu a metody platí podobná omezení, jako u JAX-WS, (tˇrída nesmí být final nebo abstract a musí mít implicitní bezparametrický konstruktor, metody musí být public a nesmí být static nebo final)

typy pˇredávaných dat lze specifikovat pomocí @Produces a @Consumes. (podle druhu operace, GET data produkuje a PUT je konzumuje; typ je v MIME) jednotlivé parametry HTTP dotazu lze zpˇrístupnit pomocí @PathParam, @QueryParam, @HeaderParam, @CookieParam, @MatrixParam, @FormParam. (pro URL zdroje, URL v HTTP dotazu, hlaviˇcky a cookies v dotazu, atd.) Marek Rychlý


47 / 51



Ukázka implementace poskytovatele v JAX-RS

import javax.ws.rs.*; @Path("/helloworld") public class HelloWorldResource { @GET @Produces("text/plain") public String getClichedMessage() { return "Hello World"; } }

Více v [Jendrock et al., 2014], cˇ ást 6, kapitola 29 „Building RESTful Web Services with JAX-RS“.

Marek Rychlý


48 / 51


Obsah 1


2


3


4



49 / 51


ˇ Shrnutí a záver ˇ SOA umožnuje dekomponovat a rozmístit informaˇcní systém, webové služby (WS) jsou standardizovanou implementací SOA, ˇ Java EE usnadnuje realizaci WS pomocí JAX-WS a JAX-RS, WS jsou webové komponenty se vším, co k tomu patˇrí.

Pokraˇcování? ˇ pˇrednáška o SOA a Java EE obecnejší ˇ (v AIS, bude 27. listopadu 2014, na stránkách pˇredmetu)

pˇrednáška o návrhu SOA od podnikových procesu˚ k IT službám ˇ (v SRI, byla 15. ˇríjna 2013, na stránkách pˇredmetu)

ˇ „Servisneˇ orientované architektury v prostˇredí Oracle“ pˇredmet (každou stˇredu, sudou v 8.00–9.50, lichou v 10.00–11.50, v G202 + cviˇcení) Marek Rychlý


50 / 51

Literatura

Literatura

Jendrock, E., Cervera-Navarro, R., Evans, I., Haase, K., and Markito, W. (2014). The Java EE 7 Tutorial. Oracle, 500 Oracle Parkway, Redwood City, CA 94065, U.S.A. http://docs.oracle.com/javaee/7/tutorial/doc/. Monson-Haefel, R. (2003). J2EE Web Services: XML SOAP WSDL UDDI WS-I JAX-RPC JAXR SAAJ JAXP. Addison-Wesley Professional. 7th Printing, March 2007.

Marek Rychlý


51 / 51

Webové služby v Java EE (JAX-WS)

Recommend Documents