1. Principio básico de funcionamiento de Filter

  • 1. Un programa Filter es una clase Java que implementa una interfaz especial; al igual que Servlet, también es invocado y ejecutado por el contenedor de Servlet.
  • 2. Cuando se registra un Filter en web.xml para interceptar un programa Servlet, puede decidir si continuar pasando la solicitud al programa Servlet y si modificar los mensajes de solicitud y respuesta.
  • 3. Cuando el contenedor de Servlet comienza a invocar un programa Servlet, si descubre que ya se ha registrado un programa Filter para interceptar ese Servlet, el contenedor ya no invoca directamente el método service del Servlet, sino que invoca el método doFilter del Filter, y luego el método doFilter decide si activar el método service.
  • 4. Sin embargo, en el método Filter.doFilter no se puede invocar directamente el método service del Servlet; en su lugar, se invoca el método FilterChain.doFilter para activar el método service del Servlet de destino. El objeto FilterChain se pasa a través del parámetro del método Filter.doFilter.
  • 5. Basta con agregar cierto código de programa antes y después de la instrucción que invoca FilterChain.doFilter en el método Filter.doFilter para implementar ciertas funciones especiales antes y después de que el Servlet responda.
  • 6. Si en el método Filter.doFilter no se invoca el método FilterChain.doFilter, el método service del Servlet de destino no se ejecutará; de esta manera, a través de Filter se pueden bloquear ciertas solicitudes de acceso ilegales.

2. Cadena de filtros

  • 1. En una aplicación web se pueden registrar varios programas Filter; cada programa Filter puede interceptar uno o un grupo de programas Servlet. Si hay varios programas Filter que pueden interceptar el proceso de acceso a un programa Servlet, cuando llega la solicitud de acceso para ese Servlet, el contenedor web combina estos múltiples programas Filter en una cadena de filtros (también llamada filter chain).
  • 2. El orden de interceptación de cada Filter en la cadena de filtros es consistente con su orden de mapeo en el archivo web.xml. La invocación del método FilterChain.doFilter en el método Filter.doFilter del Filter anterior activará el método doFilter del siguiente Filter; la invocación del método FilterChain.doFilter en el método Filter.doFilter del último Filter activará el método service del Servlet de destino.
  • 3. Mientras cualquier Filter en la cadena de filtros no invoque el método FilterChain.doFilter, el método service del Servlet de destino no se ejecutará.

3. Interfaz Filter

Un programa Filter es una clase Java que debe implementar la interfaz Filter. La interfaz javax.servlet.Filter define tres métodos: init, doFilter, destroy.

1. Método init

  • (1) Cuando se inicia la aplicación web, el servidor web (contenedor web) creará el objeto de instancia de cada Filter registrado según la información de configuración de su archivo web.xml y lo guardará en la memoria.
  • (2) Después de que el contenedor web crea el objeto de instancia de Filter, inmediatamente llama al método init del objeto Filter. El método init se ejecuta solo una vez en el ciclo de vida del Filter. Cuando el contenedor web invoca el método init, pasa un objeto FilterConfig que contiene la configuración del Filter y la información del entorno de ejecución.

    public voic init(FilterConfig filterConfig) throws ServletException
  • (3) El desarrollador puede realizar en el método init funciones de inicialización similares a las de un constructor. Se debe tener en cuenta que, si el código de inicialización necesita usar el objeto FilterConfig, este código solo puede escribirse en el método init, no en el constructor (ya que el método init todavía no se ha invocado, es decir, el objeto FilterConfig aún no se ha creado, por lo que usarlo sin duda causaría un error).

2. Método doFilter

Cuando un objeto Filter puede interceptar la solicitud de acceso, el contenedor de Servlet invocará el método doFilter del objeto Filter.

public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws java.io.IOException.ServletException

Entre ellos, los parámetros request y response son los objetos de solicitud y respuesta transferidos por el contenedor web o por el Filter anterior en la cadena de filtros; el parámetro chain es el objeto que representa la cadena de filtros actual.

3. Método destroy

Este método se invoca antes de que el contenedor web descargue el objeto Filter, y también se ejecuta solo una vez. Puede realizar la función contraria al método init, liberando los recursos abiertos por ese objeto Filter, por ejemplo: cerrar conexiones de base de datos y flujos de E/S.


4. Interfaz FilterChain

Esta interfaz se utiliza para definir los métodos que un objeto de cadena de filtros debe proporcionar externamente. Esta interfaz solo define un método doFilter.

public void doFilter(ServletRequest request, ServletResponse response) throws java.io.IOException.ServletException

El método doFilter de la interfaz FilterChain se utiliza para notificar al contenedor web que entregue la solicitud al siguiente Filter en la cadena de filtros para que la procese. Si el objeto Filter que actualmente llama a este método es el último Filter de la cadena de filtros, entonces la solicitud se entregará al programa Servlet de destino para su procesamiento.


5. Interfaz FilterConfig

  • 1. Al igual que un programa Servlet normal, un programa Filter probablemente también necesite acceder al contenedor de Servlet. La especificación de Servlet encapsula el objeto ServletContext y la información de parámetros de configuración del Filter en un objeto llamado FilterConfig.
  • 2. La interfaz FilterConfig se utiliza para definir los métodos que el objeto FilterConfig debe proporcionar externamente, de modo que en el programa Filter se puedan invocar estos métodos para obtener el objeto ServletContext, así como el nombre descriptivo y los parámetros de inicialización establecidos para el Filter en el archivo web.xml.
  • 3. Métodos definidos por la interfaz FilterConfig:

    • El método getFilterName devuelve el valor establecido del elemento <filter-name>.

    • El método getServletContext devuelve una referencia al objeto ServletContext contenido en el objeto FilterConfig.

    • El método getInitParameter se utiliza para devolver el valor del parámetro de inicialización con un determinado nombre establecido para el Filter en el archivo web.xml.

    • El método getInitParameterNames devuelve un objeto de colección Enumeration.


6. Registro y mapeo de Filter

1. Registrar Filter

Un elemento <filter> se utiliza para registrar un Filter. Entre ellos, el elemento <filter-name> es obligatorio, el elemento <filter-class> también es obligatorio, el elemento <init-param> es opcional y puede haber múltiples elementos <init-param>.

<filter>
    <filter-name>FirstFilter</filter-name>
    <filter-class>FirstFilter</filter-class>
    <init-param>
        <param-name>encoding</param-name>
        <param-value>GB2312</param-value>
    </init-param>
</filter>

2. Mapear Filter

El elemento <filter-mapping> se utiliza para configurar los recursos que un Filter se encarga de interceptar. Los recursos que intercepta un Filter se pueden especificar de dos maneras: la ruta de solicitud de acceso del recurso y el nombre del Servlet.

Primera: especificar la ruta de acceso del recurso

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

El método de configuración de la ruta de acceso en el elemento <url-pattern> sigue la especificación de mapeo de URL de Servlet.

  • /*: significa interceptar todas las solicitudes de acceso.
  • /filter/*: Indica interceptar todas las solicitudes de acceso en el directorio filter, por ejemplo: http://localhost:8888/testFilter_001/filter/xxxxxx
  • /test.html: Indica interceptar las solicitudes de acceso con test.html como nombre de recurso en el directorio raíz; la URL de acceso solo será: http://localhost:8888/test.html

Segundo tipo: especificar el nombre del Servlet

<filter-mapping>
    <filter-name>FirstFilter</filter-name>
    <servlet-name>default></servlet-name>
    <dispatcher>INCLUDE</dispatcher>
    <dispatcher>REQUEST</dispatcher>
</filter-mapping>

(1) Los elementos <servlet-name> y <url-pattern> son mutuamente excluyentes; su valor es el nombre registrado de un Servlet en el archivo web.xml.

(2) El elemento <dispatcher> tiene 4 valores posibles: REQUEST, INCLUDE, FORWARD, ERROR, que corresponden a las 4 formas en que el contenedor de Servlet invoca un recurso:

  • Mediante una solicitud de acceso normal;

  • Mediante el método RequestDispatcher.include;

  • Mediante el método RequestDispatcher.forward;

  • Como recurso de respuesta de error.

Si no se establece el elemento hijo <dispatcher>, equivale al caso REQUEST. También se pueden configurar varios elementos hijo <dispatcher> para especificar que el Filter intercepte múltiples formas de invocación del recurso.


7. Ejemplo de programa Filter

FitstFilter.java

import java.io.IOException; import java.io.PrintWriter; import java.util.Enumeration; import javax.servlet.Filter; import javax.servlet.FilterChain; import javax.servlet.FilterConfig; import javax.servlet.ServletException; import javax.servlet.ServletRequest; import javax.servlet.ServletResponse; import javax.servlet.http.HttpServletRequest; public class FirstFilter implements Filter { private FilterConfig filterConfig = null; String paramValue = null; @Override public void init(FilterConfig filterConfig) throws ServletException { this.filterConfig = filterConfig; paramValue = filterConfig.getInitParameter("encoding"); } @Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { System.out.println("begin headers-------------------"); Enumeration<?> headerNames = ((HttpServletRequest)request).getHeaderNames(); while(headerNames.hasMoreElements()) { String headerName = (String)headerNames.nextElement(); System.out.println(headerName + ": " + ((HttpServletRequest)request).getHeader(headerName)); } System.out.println("end headers-------------------"); //Escribir contenido de respuesta antes de llamar al objetivo response.setContentType("text/html; charset=gb2312"); PrintWriter out = response.getWriter(); out.println("La dirección IP es:" + request.getRemoteHost() + "<br>"); chain.doFilter(request, response); //Escribir contenido de respuesta después de que el objetivo retorne out.println("<br>El valor del parámetro de inicialización llamado encoding es:" + paramValue); out.println("<br>La ruta real del programa Web actual es:" + filterConfig.getServletContext().getRealPath("/")); //out.println("<br>¡Se ha modificado el archivo test.html!"); } @Override public void destroy() { this.filterConfig = null; } }

web.xml

<filter> <filter-name>FirstFilter</filter-name> <filter-class>FirstFilter</filter-class> <init-param> <param-name>encoding</param-name> <param-value>GB2312</param-value> </init-param> </filter> <filter-mapping> <filter-name>FirstFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>

test.html (ubicado en el directorio filter de la ruta WebContent)

<html> <head> <meta charset="UTF-8"> <title>Insert title here</title> </head> <body>¡Este es el contenido original de la página test.html!</body> </html>

Acceder:http://localhost:8888/testFilter_001/filter/test.html

Fuente del artículo: https://my.oschina.net/u/1171518/blog/265467