Sun J2EE tutorial: http://java.sun.com/j2ee/1.4/docs/tutorial/doc/

Schéma vyhledavacího systému na elektronickýmu zdroji MU

Obrázek 1. vezmu Class Diagram

Servlety jsou reakcí Javy na CGI scripty. Jedná se o programy v Javě, které běží na webovém serveru a odpovídají na požadavky ze stany klientů. Servlety nejsou spjaty z žádným konkrétním client-server protokolem, nicméně nejširší využití servletů je s HTTP protokolem. Slovem „Servlet“ je tedy často míněno „HTTP Servlet“.

Servlety jsou implementací tříd v balíku javax.servlet (základní Servlet framework) a javax.servlet.http (rozšíření Servlet frameworku pro servlety odpovídají na HTTP požadavky). Jelikož jsou servlety napsáný ve vysoce portabilním jazyku a s splňují požadavky na framework, umožňují vytváření sofistikovaných serverových aplikací nezávisle na operačním systému.

Servlety se používají zejména pro:

Tradiční způsob přidávání další funkcionality webovému serveru je pomocí Common Gateway Interface (CGI), jedná se o jazykově nezávislý interface, který umožňuje serveru spouštět externí procesy. Každý požadavek je zodpovězen separátní instancí CGI scriptu.

Servlety mají nad CGI několik výhod:

Na obrázku 1 je zobrazen jeden z nejčastějších využití servletů. Uživatel (1) vyplní formulář, který se odkazuje na servlet a kliknutím na submit tlačítko vyšle požadavek na informaci (2). Server (3) lokalizuje požadovaný servlet (4). A teď vyhodnotí a vrátí požadované informace ve formě web stránky (5). Ta je poté zobrazena v uživatelově prohlížeči (6).

Obrázek 3. Použití servletu

Servlet ve své nejobecnější formě je instance třídy, která implementuje javax.servlet.Servlet interface. Většina servletů je potomkem jednoho ze standardních implementací tohoto interfacu, jmenovitě javax.servlet.GenericServlet a javax.servlet.http.HttpServlet.

Při inicializaci servletu načte server třídu servletu (a ostatní odkazované třídy) a vytvoří instanci voláním bezparametrového konstruktoru. Následně zavolá metodu servletu init(ServletConfig config). Servlet při vykonávání této metody uloží ServletConfig objekt, který bude dostupný metodou getServletConfig(). Toto vše je obstaráno GenericServletem. Servlety, které jsou potomky GenericServletu (nebo jeho podtřídy HttpServlet) by měli volat super.init(config) na začátku metody init. Vzniklý objekt ServletConfig obsahuje parametry servletu a odkaz na ServletContext obsahující runtime environment informace. Metoda init je v životním cyklu servletu volána pouze jednou.

Poté co je servlet inicializován, je jeho metoda service(ServletRequest req, ServletResponse res) volána pro každý požadavek na servlet. Tato metoda je volána souběžně (např. multiple threads mohou volat tuto metodu ve stejný okamžik) a tudíž je nutné, aby byla implementována jako thread-safe.

V případě potřeby odstranění servletu z paměti (např. z důvodu nahrání nové verze nebo vypínaní serveru) je volána metoda destroy().

Obrázek 4. Životní cyklus servletu

Ještě před tím, než se pustíme do psaní našeho prvního servletu, musíme znát několik základních rysů HTTP protokolu.

HTTP je request-response orientovaný protokol. HTTP požadavek se skládá z metody request , URI, hlaviček a těla dotazu. HTTP odpověď obsahuje kód odpovědi, hlavičky a tělo.

Metoda service HttpServletu rozděluje požadavek vstupním metodám servletu podle typu HTTP požadavku. Jsou rozeznávaný standardní HTTP/1.1 metody: GET, HEAD, PUT, POST, DELETE, OPTIONS a TRACE. Ostatní metody jsou vráceny jako: Bad Request HTTP error. HTTP metoda XXX je přiřazena metoda servletu doXxx, (GET -> doGet()). Všechny tyto metody očekávají parametry „(HttpServletRequest req, HttpServletResponse res)“. Metody doOptions() a doTrace() mají dostatečnou defaultní implementaci a obvykle je nepředefinovávají. Metoda HEAD (která vrací pouze hlavičky) je řešena voláním doGet() a ignorací výstupu této metody. Tím nám zůstávají metody doGet, doPut, doPost a doDelete, jejich výchozí implementace v HttpServletu vrací: Bad Request HTTP error. Podtřída HttpServletu předefinovává jednu či více těchto metod smysluplnou implementací.

Data požadavku vstupují do servletu přes první argument typu HttpServletRequest (který je podtřídou obecnější třídy ServletRequest). Odpověď může být vytvořena skrz druhou proměnou, která je typu HttpServletResponse (podtřída ServletResponse).

V okamžiku, kdy v našem prohlížeči zadáme požadavek na URL, je použita metoda GET. Odpověď se bude skládat z těla odpovědi a hlaviček popisující tělo (obzvláště Content-Type a Content-Encoding). Pokud posíláme HTML formulář, můžeme použít metodu GET nebo POST. S GET požadavkem jsou parametry zakódovaný v URL a s POST požadavkem jsou přeneseny v těle požadavku.

Začneme obvyklým „Hello World“ příkladem

 1:  import java.io.*;
 2:  import javax.servlet.*;
 3:  import javax.servlet.http.*;
 4:
 5:  public class HelloClientServlet extends HttpServlet
 6:  {
 7:    protected void doGet(HttpServletRequest req,
 8:                         HttpServletResponse res)
 9:              throws ServletException, IOException
10:    {
11:      res.setContentType("text/html");
12:      PrintWriter out = res.getWriter();
13:      out.println("<HTML><HEAD><TITLE>Hello Client!</TITLE>"+
14:                  "</HEAD><BODY>Hello Client!</BODY></HTML>");
15:      out.close();
16:    }
17:  }

Podívejme se jak daný servlet funguje.

Řádky 1 až 3 importují balíky potřebné pro běh servletu.

 1:  import java.io.*;
 2:  import javax.servlet.*;
 3:  import javax.servlet.http.*;

Třída servletu je deklarovaná na řádku 5. Servlet dědí třídu javax.servlet.http.HttpServlet, standardní třída pro HTTP servlety.

 5:  public class HelloClientServlet extends HttpServlet

Na řádcích 7 až 16 je předefinovaná metoda doGet() HttpServletu.

 7:    protected void doGet(HttpServletRequest req,
 8:                         HttpServletResponse res)
 9:              throws ServletException, IOException
10:    {
         ...
16:    }

Na řádku 11 je pro nastavení content type odpovědi použita metoda třídy HttpServletResponse. Všechny hlavičky odpovědi musí být nastaveny před tím než je zavolán PrintWriter nebo ServletOutputStream pro výpis dat.

11:      res.setContentType("text/html");

Řádek 12: pomocí třídy PrintWriter je zapsán text do odpovědi.

12:      PrintWriter out = res.getWriter();

13 až 14 no comment ...

13:      out.println("<HTML><HEAD><TITLE>Hello Client!</TITLE>"+
14:                  "</HEAD><BODY>Hello Client!</BODY></HTML>");

Po ukončení zápisu zavíráme na řádku 15 PrintWriter.

15:      out.close();

Tento řádek je uveden pro úplnost. Není striktně vyžadován. Web server zavírá PrintWriter nebo ServletOutputStream automaticky po návratu metody service.

Ant je multyplatformní sestavovací nástroj napsaný kompletně v Javě. Umožňuje nám automaticky sestavovat aplikace a spoustu jiných činností. Ant je UNIXovou analogií Makefilu.

Domovská stránka: http://ant.apache.org/

Konfiguraci Ant zapisuje implicitnně do souboru build.xml.

Kořenový element project - definuje projekt jako takový. Má atributy:

Jeden nebo více elementů target - cíl, co chci s projektem udělat. Pokud nechci použít defaultní, musí se při spuštění antu zadat jeho jméno (příklad: target init): ant -buildfile build.xml init Atributy:

<target name="A">
<target name="B" depends="A">

Nula nebo více elementů task - úkol; spustitelná část kódu. Z build-souboru se vyvolává

<task atribut1="hodnota1" atribut2="hodnota2"... >

Buď můžeme využít množství zabudovaných tasků, například:

property - Určuje nějakou hodnotu, se kterou v build-souboru pracujeme (vlastně definice proměnné/konstanty). Může být definována buď uvnitř souboru (task property)

<property name="prsi" value="ne"/>

Location znaci absolutni cestu k souboru nebo relativni cestu k adresari

<property name="src" location="zdrojovy_adresar"/>

nebo mimo Ant (ten se pak spustí s parametry)

-D[property]=[hodnota]

nebo celým souborem tvaru property=hodnota (primo zadane property maji prednost)

-propertyfile [jmeno]

Jejich hodnotu můžeme využívat v ostatních tascích jako hotnotu atributů. V předchozích textech např. zdrojový, cílový adresář a podobně.

${[property]}

Jedním z nejpoužívanějších Servlet kontejnerů je Apache Tomcat. http://jakarta.apache.org/tomcat

Tomcat verze 5.5 implementuje Servlet 2.4 a JavaServer Pages 2.0 specifikaci a obsahuje mnoho dalších vlastností, které z něj činní vhodnou platformu pro vývoj a provoz webových aplikací a webových služeb.

Tomcat se spouští pomocí příkazu startup.sh, poté je server dostupný na posru 8080 na daném serveru http://localhost:8080

Ukončení běhu serveru se provádí příkazem shutdown.sh

Top-level adresář ve struktuře aplikací je i kořenovým adresářem naší aplikace. Po nahrání aplikace na server bude dostupná právě pod jménem aplikace: např soubor index.html v aplikaci catalog, bude odkazovaná jako http://server/catalog/index.html

Vnitřní strukrura aplikace odpovídá formátu WAR souboru

Základní myšlenka strukturu naší aplikace je oddělení zdrojových kodů od binárních. Takovéto rodělení přináší následující výhhody:

Pozdějí uvidíme, že vytváření hierarchické struktury adresářů za pomocí antu je velmi snadné.

Doporučená struktura adresářu:

V průběhu kompilace dojde k vytvoření dvou adresářů:

Není vhodné do aplikace začlenévat JAR soubory běžných aplikací. Ty je vhodnější umístit na server do sdílených ložek common nebo shared.

Taktéž není příliš vhodné umístovat přiložené třídy do SVN repozitory.

V souboru web.xml je uveden popis aplikace, použití různých filtrů, taglibs, servletů atd. V následují ukázce je uvedeno na jaký odkaz má Tomcat přemapovat servlet HelloWorldExampleServlet, který je spouštěn třídou mypackage.HelloWorldExample.

<!DOCTYPE web-app 
  PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN" 
  "http://java.sun.com/dtd/web-app_2_3.dtd">

<web-app>
  <display-name>Hello, World Application</display-name>
  <description>
    This is a simple web application with a source code organization
    based on the recommendations of the Application Developer's Guide.
  </description>

  <servlet>
    <servlet-name>HelloWorldExampleServlet</servlet-name>
    <servlet-class>mypackage.HelloWorldExample</servlet-class>
  </servlet>

  <servlet-mapping>
    <servlet-name>HelloWorldExampleServlet</servlet-name>
    <url-pattern>/HelloWorldExample</url-pattern>
  </servlet-mapping>
</web-app>

Existují dva hlavní způsoby jak svou aplikaci do Tomcatu nainstalovat:

Použití Antu je snadná věc, kterou zvládne opravdu každý a ušetří si tak spoustu práce. Pro instalaci do tomcat manageru je potřeba nakopírovat soubor catalina-ant.jar z tomcatu do $ANT_HOME/lib.

Ant používá jako konfigurační Makefile soubor buil.xml v kterém jsou uvedeny jednotlivé targets a parametry. Pro základní použití není potřeba konfiguračnímu souboru příliš rozumět, navíc je možné parametry includovat z externího souboru většinou nazvaném buil.properties, takže když potřebujeme něco změnit v konfiguraci stačí změnit několik údajů v tomto souboru a do buil.xml vůbec nezasahovat.

app.name=pokus12
catalina.home=/packages/share/tomcat
manager.url=http://localhost:8080/manager
manager.username=manager
manager.password=manager

Nyní již stačí aplikaci zkompilovat a nainstalovat.

ant compile aplikaci pouze zkompiluje a výsledný war soubor uloží do adresáře /dist

ant install aplikaci zkompiluje a nainstaluje do adresáře /webapps/${app.name}, která bude dostupná jako http://kore.fi.muni.cz:8080/${app.name}.

ant deploy přenese war soubor aplikace do tomcatu a nainstaluje do adresáře /webapps/${app.name}, aplikace bude dostupná jako http://kore.fi.muni.cz:8080/${app.name}. Ttento cíl umožňuje také použití vlastní konfigurací contextu aplikace, které uvedeme v souboru context.xml. Aplikace bude jednak v tomcatu nainstalována a navíc bude do tomcatu přenesen i distribuční war soubor.

ant undeploy odstraní deploynutou aplikaci i war soubor.

ant stop aplikaci pozastaví (nebude dostupná z webu).

ant start aplikaci spustí pozastavenou aplikaci.

ant reload zastaví aplikaci a provede její znovunačtení.

	Poznámka
	konfigurace aplikace uložená v souboru /WEB-INF/web.xml není při reloadu znovu načtena a je použita konfigura předchozí. Pokud jsme uděli změny konfiguračním souboru je nutné aplikaci nejprve zastavit a opětovně zpustit

Nejlepší je se inspirovat již nějakou hotovou aplikací: http://www.fi.muni.cz/~xpavlov/tomcat/app1.tar.gz. K dispozici je i originální ukázková aplikace z distribuce tomcatu http://jakarta.apache.org/tomcat/tomcat-5.5-doc/appdev/.

V případě, že se do apache zkompiluje mod_jk2, není nutné pro použití JSP/Servlet souboru specifikovat port, na kterém tomcat běží. Apache pak sám pozná, který soubor má předat tomcatu ke zpracování a který soubor má zpracovat sám.

Pomocí modulu mod_jk2 můžeme též jednoduše nakonfigurovat loadbalancing. Pustíme několik instancí tomcatu. Ty mohou běžet jednak na stejném stroji tak i na jiném místě v internetu. Modul sám rozděluje příchozí požadavky na jednotlivé instance tomcatu. Další efekt loadbalancigu je v posílení stability aplikace. V případě, že by nám jedna instance tomcatu spadla, modůl předá požadavek jiné funkční instanci.

Existuje také starší verze mod_jk, která ma poněkud odlišnou konfiguraci. V praxi se ale opět začíná více používat než novější verze mod_jk2. Více na: http://jakarta.apache.org/tomcat/connectors-doc/

Nastavení konfiguračního souboru workers2.properties

[shm:]
info=Scoreboard. Required for reconfiguration and status with multiprocess servers
file=${serverRoot}/logs/jk2.shm
size=1000000
debug=0
disabled=0

[lb:lb]
sticky=1

[status:]
info=Status worker, displays runtime information

[channel.socket:localhost:8009]
info=Ajp13 forwarding over socket
debug=0
port=8009
host=127.0.0.1
tomcatID=localhost:8009

[ajp13:localhost:8009]
channel=channel.socket:localhost:8009
group=lb

[uri:/calculator/*]
info=calculator
group=lb

[uri:/jkstatus/*]
info=Display status information and checks the config file for changes.
group=status:

Hlavní cíle JSTL jsou tyto:

STL obsahuje spoustu různých tagů z několika oblastí. Každá z oblastí reprezentuje určitou funkcionalitu a má svůj prefix. URIs knihoven jsou tyto:

<c:out value="Ahoj!"/>

<sql:query var="books" 
  dataSource="${applicationScope.bookDS}">
  select * from PUBLIC.books where id = ?
  <sql:param value="${bookId}" />
</sql:query>