Galileo Computing :: Java 7 - Mehr als eine Insel - 14 JavaServer Pages und Servlets

14.10 Servlets

Wir kommen nun noch einmal auf unser Eingangsbeispiel für ein Servlet zurück, das eine einfache Ausgabe erzeugt:

Listing 14.18: com/tutego/web/servlet/SchnarchServlet.java

package com.tutego.web.servlet;

import java.io.IOException;
import javax.servlet.http.*;

public class SchnarchServlet extends HttpServlet
{
  @Override
  protected void doGet( HttpServletRequest req, HttpServletResponse res )
      throws IOException
  {
    res.getWriter().println( "'Chr! Schnarch! Razong! Chr! Chr! Rapüh!'" );
    res.getWriter().println( "(Disneys beste Comics, Band 5, S.  218)" );
  }
}

Alle Servlets implementieren die Schnittstelle javax.servlet.Servlet beziehungsweise erweitern die Klasse GenericServlet oder HttpServlet. Ein HttpServlet enthält wichtige Arbeitsmethoden für das Protokoll HTTP. Eine Erweiterung von GenericServlet ist eher unüblich, es sei denn, Nicht-HTTP-Protokolle wie FTP werden angeboten:

abstrat class javax.servlet.http.HttpServlet
extends GenericServlet
implements Serializable

protected void service(HttpServletRequest req, HttpServletResponse resp)
Empfängt alle HTTP-Requests und leitet sie aufgrund der unterschiedlichen HTTP-Methoden auf die jeweiligen doXXX()-Methoden weiter.
protected void doDelete(HttpServletRequest req, HttpServletResponse resp)
Wird von der service()-Methode aufgerufen, wenn ein HTTP-DELETE kommt.
protected void doGet(HttpServletRequest req, HttpServletResponse resp)
Wird von der service()-Methode aufgerufen, wenn ein HTTP-GET kommt.
protected void doOptions(HttpServletRequest req, HttpServletResponse resp)
Wird von der service()-Methode aufgerufen, wenn ein HTTP-OPTIONS kommt.
protected void doPost(HttpServletRequest req, HttpServletResponse resp)
Wird von der service()-Methode aufgerufen, wenn ein HTTP-POST kommt.
Protected void doPut(HttpServletRequest req, HttpServletResponse resp)
Wird von der service()-Methode aufgerufen, wenn ein HTTP-PUT kommt.
protected void doTrace(HttpServletRequest req, HttpServletResponse resp)
Wird von der service()-Methode aufgerufen, wenn ein HTTP-TRACE kommt.

Lebenszyklus

Spricht der Client am Webserver ein Servlet an, so bildet der Servlet-Container ein Exemplar der Servlet-Klasse (in unserem Fall SchnarchServlet) und ruft nach der Initialisierung auf dem Objekt die Methode service() auf. Die service()-Methode delegiert beim HttpServlet je nach HTTP-Methode zu den doXXX()-Methoden, also etwa doGet() bei einer GET-Anfrage.

Alle doXXX()-Methoden haben zwei Parameter:

HttpServletRequest: Repräsentiert die Anfrage. Es lassen sich zum Beispiel Parameter oder Header erfragen, die der Client zum Server schickt.
HttpServletResponse: Repräsentiert das Ergebnis. Es lassen sich zum Beispiel Daten zurück zum Client schicken, genauso Antwort-Header (etwa Content-Type) setzen. Am wichtigsten ist die Methode getWriter(), die uns eine Referenz auf ein Writer-Objekt liefert, damit wir die HTML-Elemente für die Seite abschicken. Für Binärdaten können wir uns auch einen normalen OutputStream besorgen, damit wir zum Beispiel Bilder schicken können.

Header und Content-Typ

Mit setHeader() lassen sich weitere Header setzen.

response.setHeader( "Content-Type", "text/html");

Die Methode erhält als Argument zwei Zeichenketten: den Header und den dazugehörigen Wert. Da der Header Content-Type jedoch so häufig benötigt wird, bietet die Schnittstelle HttpServletResponse dafür die eigene Methode setContentType() an:

response.setContentType( "text/html" );

Um reine (Nur-)Textausgaben zu erzeugen, setzen wir den Content-Header mit text/plain.

Zentrale Methoden von HttpServletRequest

Die interessanteren Methoden der Schnittstelle HttpServletRequest sind:

interface javax.servlet.http.HttpServletRequest
extends ServletRequest

String getHeader(String name)
Enumeration<String> getHeaderNames()
Enumeration<String> getHeaders(String name)
int getIntHeader(String name)
long getDateHeader(String name)
String getPathInfo()
String getPathTranslated()
String getQueryString()
String getRequestURI()
String getServletPath()
HttpSession getSession()
HttpSession getSession(boolean create)
Cookie[] getCookies()

Die pfadorientierten Methoden sind am besten an einem Beispiel erklärt:

**Tabelle 14.9:** Pfad-Methoden und was sie liefern
Anfrage auf /geo/new/welcome.jsp/update bei dem Kontextpfad geo
getRequestURI()	/geo/new/welcome.jsp/udate
getContextPath()	/geo
getServletPath()	/new/welcome.jsp
getPathInfo()	/update

Das HttpServletRequest von ServletRequest ist zentral, denn bei ServletRequest sind die wichtigen Methoden zur Erfragen der Parameter:

interface javax.servlet.ServletRequest

String getParameter(String name)
Map<String,String[]> getParameterMap()
Enumeration<String> getParameterNames()
String[] getParameterValues(String name)

Zentrale Methoden bei HttpServletResponse

Daten, die vom Servlet zurück zum Client gehen, werden über das HttpServletResponse-Objekt gesetzt. Die interessanten Methoden sind:

interface javax.servlet.http.HttpServletResponse
extends ServletResponse

void addHeader(String name, String value)
void addDateHeader(String name, long date)
void addIntHeader(String name, int value)
void addCookie(Cookie cookie)
String encodeRedirectURL(String name)
void sendError(int sc)
void sendError(int sc, String msg)
void sendRedirect(String location)
void setDateHeader(String name, long date)
void setHeader(String name, String value)
void setIntHeader(String name, int value)
void setStatus(int sc)

Die zentrale Methode, um an den Ausgabestrom zu kommen, stammt aus dem Basistyp ServletResponse. Die wichtigen Methoden sind:

interface javax.servlet.ServletResponse

ServletOutputStream getOutputStream()
PrintWriter getWriter()
void setCharacterEncoding(String charset)
void setContentLength(int len)
void setContentType(String type)
void setLocale(Locale locale)
void flushBuffer()
void reset()

14.10.1 Servlets compilieren

Um Servlets zu übersetzen, muss das Jar-Archiv servlet.jar im Pfad sein. Dazu können wir entweder den CLASSPATH anpassen oder das Archiv einfach in das jre/lib/ext-Verzeichnis der Java SE kopieren; das Archiv liegt Tomcat im Ordner lib bei. Bei der Enterprise-Version von Java (Java EE) ist die Bibliothek schon im Pfad eingebunden.

Wir erinnern uns: Eine Webapplikation besteht aus einem Verzeichnis WEB-INF mit den optionalen Verzeichnissen classes und lib. Die übersetzten Klassen müssen in das Verzeichnis classes. Falls das Servlet in einem Paket liegt, muss diese Paketstruktur natürlich auch auf die Verzeichnisstruktur abgebildet werden.

Die Java EE Version von Eclipse bindet das Archiv selbstständig ein und übersetzt die Klasse automatisch im richtigen Verzeichnis. Wir legen einfach das Servlet im Quellcodeordner ab, und es wird somit automatisch unter WEB-INF/classes compiliert.

14.10.2 Servlet-Mapping

Um nun den Server zur Ausführung unserer Servlets zu bewegen, gibt es zwei Möglichkeiten:

Deployment-Descriptor web.xml im Verzeichnis WEB-INF jeder Webapplikation
Standard-Servlet-Mapping unter /servlet/

Für ein Servlet, das über File • New • Other... • Web • Servlet angelegt wird, stehen die Einträge automatisch im Deployment-Descriptor web.xml.

Der Deployment-Descriptor web.xml

Soll der Invoker nicht zum Einsatz kommen, müssen wir für jede Webapplikation eine Datei web.xml im Verzeichnis WEB-INF anlegen. Sie dient dazu, die Webapplikation zu vervollständigen. Der Deployment-Descriptor zählt die Servlets auf und weist ihnen Pfade zu. web.xml ist eine klassische XML-Datei, die validiert wird. Im Wurzelelement <web-app> finden sich jetzt die spannenden Einträge, wie für unser SchnarchServlet:

Listing 14.19: WEB-INF/web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://java.sun.com/xml/ns/javaee"
   xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
   xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/
   javaee/web-app_2_5.xsd"
   id="WebApp_ID" version="2.5">
   <servlet>
      <servlet-name>SchnarchServlet</servlet-name>
      <servlet-class>com.tutego.web.servlet.SchnarchServlet</servlet-class>
   </servlet>
   <servlet-mapping>
      <servlet-name>SchnarchServlet</servlet-name>
      <url-pattern>/SchnarchServlet</url-pattern>
   </servlet-mapping>
   <welcome-file-list>
      <welcome-file>index.html</welcome-file>
      <welcome-file>index.jsp</welcome-file>
   </welcome-file-list>
</web-app>

Damit ist alles komplett. Die Angabe von http://localhost:8080/web/SchnarchServlet präsentiert unser Servlet und seine Ausgabe.

Standard-Servlet-Mapping

Im Fall des Standard-Servlet-Mappings wird ein Servlet unter der URI servlet/SERVLETNAME zugänglich. Um diese Möglichkeit einzuschalten, müssen wir die globale Konfigurationsdatei conf/web.xml modifizieren und an zwei Stellen das sogenannte Invoker-Servlet aktivieren.

14.10.3 Der Lebenszyklus eines Servlets

Der Container für Servlets registriert eine Anfrage durch den Client und lädt das Servlet in den Speicher. Da Servlets normale Klassen sind, übernimmt ein spezieller Klassenlader diese Aufgabe. Die Abarbeitung findet anschließend in einem Thread statt, der die Methoden des Servlet-Objekts aufruft.

Über die Schnittstelle Servlet werden drei elementare Methoden für die Initialisierung, die Abarbeitung der Anfragen und die Beendigung vorgeschrieben. Der Ablauf dieser Methoden heißt Lebenszyklus eines Servlets.

Die folgende Aufzählung zeigt alle Methoden, die die Schnittstelle Servlet für alle Java-Servlets vorschreibt.

interface javax.servlet.Servlet

void init(ServletConfig config)
Wird zu Beginn eines Dienstes aufgerufen.
void service(ServletRequest req, ServletResponse res)
Der Container leitet die Anfrage an das Servlet an diese Stelle.
void destroy()
Wird am Ende eines Servlets vom Container genau einmal aufgerufen.
ServletConfig getServletConfig()
Liefert ein ServletConfig-Objekt, das Initialisierungs- und Startparameter kapselt.
String getServletInfo()
Liefert Informationen über das Servlet, wie Autor, Version und Copyright.

Ein HttpServlet ist eine besondere Implementierung der Servlet-Schnittstelle. Die Klasse implementiert service(ServletRequest req, ServletResponse res), doch leitet es dann an service(HttpServletRequest req, HttpServletResponse resp) weiter, was wiederum zu den doXXX()-Methoden geht.

14.10.4 Mehrere Anfragen beim Servlet und die Thread-Sicherheit

In der Regel nutzt der Container pro Anfrage einen Thread, der dann die service()-Methode des Servlet-Objekts betritt und die Anfrage bearbeitet. Es gibt demnach für mehrere Aufträge keine unterschiedlichen Exemplare des Servlets, sondern lediglich unterschiedliche Threads bei einem Servlet-Exemplar. Aus diesem Grund ist zu bedenken, dass die Dienste seiteneffektfrei sein müssen. Es ist unsere Aufgabe, die Methode so weit zu synchronisieren, dass es keine negativen Auswirkungen der Parallelität gibt. Die Synchronisation wirkt sich natürlich auf die Ausführungsgeschwindigkeit nachteilig aus, sodass auf die passende Granularität zu achten ist.

14.10.5 Servlets und Sessions

JSP gehören ganz automatisch zu einer Sitzung. Bei Servlets ist dies nicht der Fall. Wir benötigen also eine Möglichkeit, die uns Zugriff auf die Sitzung gibt. Das ist die Methode getSession() in dem aktuellen HttpServletRequest-Objekt. Sie liefert null, wenn noch keine Sitzung verwaltet wird, da der Client zum ersten Mal auf ein Servlet zugreift. Wenn der Client zum ersten Mal zugreift, müssen wir dies erkennen und automatisch ein Sitzungsobjekt initiieren. Für diese Aufgabe gibt es eine Abkürzung, die wie folgt aussieht:

public void doGet( HttpServletRequest request,
                   HttpServletResponse response )
  throws ServletException, IOException
{
  HttpSession session = request.getSession( true );
  ...
  out = response.getWriter();
  ...
}

Wir müssen also nicht request.getSession() != null überprüfen und dann manuell ein Sitzungsobjekt aufbauen, sondern können getSession(true) nutzen, das automatisch eine HttpSession anlegt.

interface javax.servlet.http.HttpServletRequest
extends ServletRequest

HttpSession getSession()
Liefert die aktuelle Session, die mit der Anfrage assoziiert ist. Wenn es keine Session gab, wird automatisch eine angelegt.
HttpSession getSession(boolean create)
Wie getSession(), nur dass getSession(false) nicht automatisch eine neue Session anlegt, wenn es keine mit der Sitzung assoziierte gibt.

14.10.6 Weiterleiten und Einbinden von Servlet-Inhalten

Mit einem RequestDispatcher-Objekt kann sich ein Servlet zu einem anderen Servlet verbinden, oder es können Ausgaben von anderen Servlets in den aktuellen Datenstrom mit eingebunden werden. Die angebotenen Methoden vom Dispatcher sind include() und forward(). Um an den aktuellen RequestDispatcher zu gelangen, wird die Methode getServletDispatcher() aufgerufen, die eine Methode der Klasse ServletContext ist. Die Webseite, die eingebunden ist oder an die weitergeleitet wird, ist durch eine URL spezifiziert, die die Methode getServletDispatcher() als Argument bekommt. Den Methoden forward() und include() werden dann request und response übergeben.

Ein Servlet soll eine einfache Fußzeile generieren, die ein anderes Servlet einbindet:

public class FooterServlet extends HttpServlet
{
  public void service( HttpServletRequest request, HttpServletResponse response )
    throws ServletException, IOException
  {
    response.setContentType( "text/html" );
    PrintWriter out = response.getWriter();
    out.println( "<hr/><center>Copyright &copy 2012</center>" );
  }
}

Damit ein zweites Servlet die Ausgabe einbinden kann, inkludieren wir seine Ausgabe. Konzentrieren wir uns auf die service()-Methode:

public void service( HttpServletRequest request,
                     HttpServletResponse response )
  throws ServletException, IOException
{
    response.setContentType( "text/html" );
    PrintWriter out = response.getWriter();
    ServletContext con = getServletContext();
    out.println( "Der Telefonmann meldet sich wieder" );
    RequestDispatcher  rq = con.getRequestDispatcher( "FooterServlet" );
    rq.include( request, response );
}

interface javax.servlet.RequestDispatcher

void forward(ServletRequest request,ServletResponse response)
throws ServletException, IOException
Die Anfrage wird an ein anderes Servlet, eine andere JSP oder eine andere HTML-Seite weitergeleitet. Eine ServletException kann auftreten, wenn das Ziel eine Ausnahme auslöst.
void include(ServletRequest request,ServletResponse response)
throws ServletException, IOException
Bindet den Inhalt eines Servlets, einer JSP oder einer Webseite in den aktuellen Datenstrom (»response«) ein. Das ServletResponse-Objekt kann keinen Header setzen (um zum Beispiel den Statuscode zu ändern). Änderungen werden ignoriert.

Ihr Kommentar

Wie hat Ihnen das <openbook> gefallen? Wir freuen uns immer über Ihre freundlichen und kritischen Rückmeldungen.

Name
E-Mail
Ihr Kommentar