jsp-develop.de presents:

Filter Services
von shark,  13.03.2002 19:54:55
Ab der Servlet 2.3 Spezifikation ist das Servlet Filter Modell verfügbar. Servlet Filter basieren auf dem J2EE Design Pattern Decorating Filter. Filter werden als Objekte implementiert die HTTP-Requests bzw. Responses modifizieren. Filter kann man sich als Präprozessor eines HTTP-Requests bzw. im Fall der HTTP-Response als Postprozessor vorstellen.

Filter werden demnach vor einem HTTP-Request bzw. nach einer HTTP-Response ausgeführt.

Der wesentliche Vorteil von Servlet Filtern ist, dass Services, die Servlets betreffen, außerhalb des Servlet Source Codes definiert werden können.

Filter implizieren wiederverwendbare Software Services, die man zwischen Anwendungen austauscht. Im Internet gibt es mittlerweile interessante Filter für eine Vielzahl von Anwendungsfällen.

Technologisch gesehen implementieren Filter die javax.servlet.Filter Schnittstelle.

Folgende Filter-Methoden sind für eigene Gehversuche zu implementieren:

void init(FilterConfig poConfig) throws ServletException
void destroy()
void doFilter(ServletRequest poRequest, ServletResponse poResponse, FilterChain poChain) throws IOException, ServletException

Die init-Methode wird aufgerufen, um den Filter zu initialisieren, destroy hingegen wenn der Filterservice beendet wird. Die Methode doFilter ist Kern eines Filters, der für jeden HTTP-Request ausgeführt wird.

Folgendes Beispiel veranschaulicht, wie Filter implementiert und konfiguriert werden können:

//-- filter implementierung
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;

public class SimpleFilter implements Filter
{
  private FilterConfig m_oConfig = null;

  public void init(FilterConfig poConfig) throws ServletException
  {
    this.m_oConfig = poConfig;
  }

  public void destroy()
  {
    m_oConfig = null;
  }

  public void doFilter(ServletRequest poRequest, ServletResponse poResponse,
                    FilterChain poChain) throws IOException, ServletException
  {
   
    poChain.doFilter(poRequest, poResponse);
 
    m_oConfig.getServletContext().log("SimpleFilter: Log-Message...");
  }
}

<!-- filter konfiguration in der web.xml -->
<?xml version="1.0" encoding="ISO-8859-1"?>

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

<web-app>

    <filter>
        <filter-name>simpleFilter</filter-name>
        <filter-class>SimpleFilter</filter-class>
    </filter>

    <filter-mapping>
        <filter-name>simpleFilter</filter-name>
   <url-pattern>/*</url-pattern>
    </filter-mapping>

</web-app>

Die Datei web.xml kopiert man in das "Web-inf" Verzeichnis und die Klasse "SimpleFilter.class" liegt für unser Beispiel im Verzeichnis "\Web-inf\classes" vor. Es macht Sinn eine einfache index.html zu schreiben, um diese in das Verzeichnis "\develop\simple" zu legen.

Nachfolgend die Verzeichnisstruktur im Überblick:

develop
  -- simple
      -- Web-inf
            -- classes 

Im Verzeichnis "\develop\simple" führt man in iner Dos-Shell das Kommando "jar cvf simple.war index.html Web-inf" aus, um die Anwendung in ein Web-Archiv zu packen. Das Web-Archiv kopiert man in das "\webapps" Verzeichnis der ServletEngine bzw. des Application Servers, falls Hot-Deployment unterstützt wird. Unterstützt der Servlet Container kein Hot-Deployment, deployed man die Anwendung mit einer entsprechenden Administrationskonsole.

Fazit: Filter sind ein gutes Mittel für die Steuerung von HTTP-Requests/-Responses. Neue Services und Funktionalitäten lassen sich in Filtern kapseln und sind lose mit einer Web-Anwendung verbunden. Die Austausch- und Wiederverwendbarkeit von Servlet Filtern ist konform dem komponentenorientierten Gedanken.
URL dieses Beitrags:
http://www.jsp-develop.de/forumbeitrag/view/1488/