Vlastův blog

DWR - AJAX knihovna pro remotování Java objektů

7. September 2007

S knihovnou DWR (Direct Web Remoting) jsem se setkal před několika měsíci při brouzdání internetem. Tehdy jsem si vyzkoušel příklad ze stránky Getting Started with DWR a nepracoval jsem s ní až do doby před dvěma týdny, kdy jsme začali pracovat na zakázce, která si o její použití přímo říkala.

K čemu knihovna DWR slouží

Pomocí DWR můžete volat Javovský kód přímo z Javascriptu z prostředí internetového prohlížeče na klientském počítači. DWR se samo postará o vykonání asynchronního požadavku na server a převod objektů z javovského světa do javascriptového.

Kromě toho má DWR sadu Utilit, které pomáhají v manipulaci s odesíláním a zpracováním příjímaných dat – plnění selektu daty, přidávání řádků do tabulky atd. V této části knihovny ovšem nespatřuji její těžiště, a tak se o ní více zmiňovat nebudu. Osobně k práci se stránkou používáním knihovnu jQuery.

Nastavení na straně serveru

DWR je nyní nachází ve verzi 2.0 a kromě kromě samostatného použití nabízí integraci do některých populárních frameworků – například Spring Framework, JSF, Struts. Základem je definování DWR servletu v deployment deskriptoru:

<servlet>
  <servlet-name>dwr-invoker</servlet-name>
  <display-name>DWR Servlet</display-name>
  <servlet-class>uk.ltd.getahead.dwr.DWRServlet</servlet-class>
  <init-param>
     <param-name>debug</param-name>
     <param-value>true</param-value>
  </init-param>
</servlet>

<servlet-mapping>
  <servlet-name>dwr-invoker</servlet-name>
  <url-pattern>/dwr/*</url-pattern>
</servlet-mapping>

Pro integraci se Spring Frameworkem toto není potřeba. Stačí do aplikačního kontextu přidat nové mapování a kontroler:

<bean id="dwrUrlMapping" class="org.springframework.web.servlet.handler.SimpleUrlHandlerMapping">
        <property name="alwaysUseFullPath" value="true" />
        <property name="mappings">
        <props>
                <prop key="/dwr/**/*">dwrController</prop>
        </props>
        </property>
</bean>
<bean id="dwrController" class="org.springframework.web.servlet.mvc.ServletWrappingController">
        <property name="servletClass">
                <value>uk.ltd.getahead.dwr.DWRServlet</value>
        </property>
</bean>

Tím máme zajištěno, že požadavku začínající na /dwr/ obslouží DWR engine. Dále musíme specifikovat remotnuté objekty. Jsou to business metody našich servisních tříd a dále samotné doménové objekty. Možnosti konfigurace máme tři:

• pomocí souboru dwr.xml
• přímo ve aplikačním kontextu springu pomocí přidání dwr namespacu
• programově (návod)

O možnoststech nastavení remotnutých objektů přímo v aplikačním kontextu springu se lze více dočíst v článku Spring & DWR – Ajax made Easy. Já používám Spring Framework 1.2.8, takže jsem byl nucen použít soubor dwr.xml. Ten jednododuše umístíte do stejného adresáře jako web.xml a DWR si jej při startu aplikace samo najde.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dwr PUBLIC "-//GetAhead Limited//DTD Direct Web Remoting 2.0//EN" "http://getahead.org/dwr/dwr20.dtd">
<dwr>
        <allow>
                <create creator="spring" javascript="BusinessService">
                        <param name="beanName" value="businessService" />
                        <include method="method1" />
                        <include method="method2" />
                </create>
                <convert converter="bean" match="cz.vavru.samples.dto.*" />

                <convert converter="hibernate2" match="cz.vavru.samples.business.vo.Article">
                        <param name="include" value="id,title,content" />
                </convert>
        </allow>
</dwr>

Tag create

Pomocí tagu create se definují remotnuté třídy a jejich metody. Pokud tyto metody vrací nějaké nestandardní objekty (například naše vlastní třídy nebo jejich kolekce) je nutné mít k nim nadefinovaný Conventor – jak název napovídá dělá se to pomocí tagu convert.

Pomocí atributu creator defunujeme kdo je zodpovědný za získání (vytvoření) instance volané třídy. Možnosti jsou následující:

new

Je vytvořen vždy nový objekt. Objekt musí mít bezpearametrický konstruktor.

none

Nevytváří se žádný nový objekt. Toto se používá buď při volání statických metod nebo při volání nestatických metod při jiném kontextu než page.

scripted

Nový objekt je vytvořen pomocí BSF skriptu.

spring

Získá instanci objektu z aplikačního kontextu Springu.

jsf

Získá instanci objektu z kontextu JSF.

struts

Získá instanci objektu z kontextu Struts.

pageflow

Zístká instanci objektu z PageFlow kontextu na serverech Weblogic nebo Beeehive.

ejb3

Dle dokumentace experimentální creator, která dokáže zpřístupnit EJB.

Pomocí atributu javascript definujeme pod jakým názvem budeme k vystavenému objektu přistupovat z javascriptu.

Atribut scope nastavuje kontext objektu – možnosti jsou „application“, „session“, „request“ a „page“. Defaultní hodnota je page. V dokumentaci se sice dočtete, že scope session funguje pouze při fungujících cookies, ale na jiném místě dokumentace naopak zjistíte, že funguje i bez nich a je nahrazen URL rewritingem.

Tag create může obsahovat další tagy:

param

Slouží pro nastavení prametrů pro vytvářený objekt. Pokud je atribut creator nastaven na hodnotu spring tak se následujícím zápisem nastavím k danému creatoru beana businessService – <param name=„beanName“ value=„busines­sService“ />

include

Slouží pro explicitní povolení metody specifikované v atributu method.

exclude

Opak tagu include – slouží k explicitnímu zakázání metody specifikované v atributu method. DWR umožňuje použití pouze tagů typu include (neuvedené metody jsou zakázané) nebo exclude(neuvedené metody jsou povoleny).

auth

Slouží pro definování rolí, které musí mít autentifikovaný uživatel pro invoknutí dané metody.

filter

Umožňuje definovat filtry – např. pro účely logování, autentizace atd. Více na stránce AjaxFilter.

Tag convert

Konventory jsou druhou důležitou skupinou v souboru dwr.xml. Pomocí nich se definuje jakým způsobem jsou převedený objekty z javovského do javascriptového světa. Konventory pro základní typy objektů jsou zaregistrovány automaticky:

• primitivní typy a jejich objektové wrappery (včetně java.lang.String, java.util.Date)
• pole a kolekce výše uvedených typů
• DOM objekty

Pro ostatní typy objektů je nutné explicitně definovat converter (možno používat i wildcardy). Například zápisem <convert converter=„bean“ match=„cz.vavru­.samples.dto.*“ /> nadefinujete, že se všechny třídy z uvedeného balíčku mají převádět pomocí bean convertoru. Ten pracuje tak, že projde všechny gettery a settery objektu a převede jej do javascriptu ve formě asociativního pole. Object convertor pracuje tak, že prochází přímo třídní proměnné.

Zmíním bych ještě konventory pro hibernate 2 a 3. Pokud jej používáme se Springem nesmíme zapomenou zkontrolovat zda máme nastaveno mapování OpenSessionInView filtru i pro DWR. Samozřejmě pouze v případě, že je to potřeba – například pokud jste mezi vlastnostmi, které se mají převést, uvedli lazy kolekci.

<filter>
        <filter-name>Hibernate OpenSessionInView</filter-name>
        <filter-class>org.springframework.orm.hibernate.support.OpenSessionInViewFilter</filter-class>
</filter>
<filter-mapping>
        <filter-name>Hibernate OpenSessionInView</filter-name>
        <url-pattern>*.htm</url-pattern>
</filter-mapping>
<filter-mapping>
        <filter-name>Hibernate OpenSessionInView</filter-name>
        <url-pattern>/dwr/*</url-pattern>
</filter-mapping>

V konventoru lze pomocí tagu param (podobně jako u tagu create) explicitně nadefinovat členské proměnné (vlastnosti) objektu, které mají (nemají) být převedeny.

Další tagy

Kromě tagu allow může soubor obsahovat část init (používá se pro definování vlastních Creatorů a Conventorů) a signatures (používají se pro deklaraci typových konverzí z javasriptu do Javy – více o signatures).

Ještě nesmím napomenout upozornit na anotace, které lze používat i souběžně se souborem dwr.xml

Nyní jsme si probrali vše potřebné na straně serveru. Pojďme se podívat na klienta.

Práce s DWR na straně klienta

Pro používání DWR je na klientské straně nutné vložit sript se DWR enginem a spriptem s remotnutnutými metodami. Těch může samozřejmě být více. Pokud se rozhodnete využívat funkni z knihovny utilit musíte vložit i tu.

<script src='/my-application/dwr/interface/BusinessService.js'></script>
<script src='/my-application/dwr/engine.js'></script>
<script src='/my-application/dwr/util.js'></script>

Skript na adrese /my-application/dwr/in­terface/Busines­sService.js vygeneruje za běhu DWR servlet. Samotné volání vzdálených metod může vypadat takto:

<script type="text/javascript">
myImportantUserInput = "Hello World";
BusinessService.method1(myImportantUserInput, callback);

function callback(result) {
        // práce s výsledkem požadavku
}
</script>

Řešení vyjímečných stavů

Vyjímečné stavy lze zachytávat pomocí error a exception handlerů.

<script type="text/javascript">
dwr.engine.setErrorHandler(errorHandler);
dwr.engine.setWarningHandler(warningHandler);

function errorHandler(obj) {}
function warningHandler(obj) {}
</script>

Error a Warning handler se dají nastavit výše uvedeným způsobem na globální úrovni. Exception handlery se nastavují pouze v kontextu dané vzdáleného volání nebo batche.

Batchování

Pokud chceme několik asynchronních volání seskupit do jednoho (což může být mnohem rychlejší) použijeme k tomu právě batch. Malá ukázka:

<script type="text/javascript">
dwr.engine.beginBatch();
BusinessService.method1(variable1, callback1);
BusinessService.method2(variable2, callback2);
dwr.engine.endBatch();
</script>

Reverse AJAX

Pod pojmem Reverse AJAX si lze představit technologie pro posílání dat ze serveru do klienta. DWR podporuje tyto metody:

pollování

Spočívá v poolování (periodického dotazování) serveru (například každých několik sekund).

comet

Ponechá se otevřené spojení server-klient

piggyback

Server shromažďuje data, která chce poslat klientovi. Ty mu doručí při příštím dotazu klienta (přibalí je do odpovědi bez ohledu na volanou funkci).

Více se lze dočíst na stránkách DWR – Reverse Ajax a Configuring Reverse Ajax.

Další zajímavé funkce

Pomocí metody dwr.engine.se­tOrdered(boole­an) lze nastavit, aby se další dotaz na server poslal až ve chvíli kdy se vrátí odpověď dotazu předcházejícího – tedy zaručení jakési synchronnosti pořadí odpovědí.

Pomocí metody dwr.enginesetA­sync(boolean) můžeme vykonávat dotazy na server synchronním resp. asynchroním způsobem.

Dalšími příjemnými funkcemi jsou dwr.engine.set­PreHook(functi­on) a dwr.engine.set­PostHook(functi­on). Jak název napovídá – jedná se o fukce, které jsou invoknuty před vykonáním požadavku resp. po příjetí odpovědi ze serveru – ideální na zobrazování loadovacích hlášek. Pro tento případ má DWR funkci useLoadingMes­sage.

Dostal jsem se do situace, že jsem potřeboval v remotnutých servisních metodách přistupovat k session – řešení je nakonec velmi triviální (dík Honzovi Novotnému za pomoc) – pokud máte v signatuře vaší servisní metody objekt typu HttpServletRequest, HttpServletRes­ponse, HttpSession, ServletContext, ServletConfig tak jej při volání z javaskriptu jednoduše vynecháte a DWR je při volání samo nastaví. Druhou možnosti je zavolání použití třídy WebContextFac­tory.

Pěkné je, že v debug režimu převede DWR chybu na string, který zobrazí v alertu. Podpora browserů se zdá také velmi dobrá – my jsme testovali v Opeře, Firefoxu, IE6 a IE7 a vše bez problémů.

Knihovna DWR se v praxi ukázala jako velmi rychlá. Za předpokladu, že se počet objektů (velikost dat) v jedné odpovědi bude pohybovat v rozumných mezích (řekněme do 300) pohybuje se odezva serveru v řádi stovek milisekund (nedostal jsem se nad 500 ms), což je odpověď de facto okamžitá. Určitě stojí za další prozkoumání reverse ajax funkce – např. pro chat určitě lahůdka.

Závěr

Doufám, že jsem vás článkem dostatečně navnadil a celý nedočkavý chvátáte si DWR vyzkoušet na vlastní kůži.

Odkazy

• DWR homepage
• Spring & DWR – Ajax made Easy
• Není AJAX jako AJAX – GWT vs. DWR
• Developing Applications Using Reverse Ajax
• Integrating DWR & Spring
• Spring and DWR revisited
• DWR, Spring and Captcha

Článek patří do kategorie: Java, Ajax