上一节:
下一节:

  Servlet - 过滤器

  • 简述

    Servlet 过滤器是 Java 类，可在 Servlet 编程中用于以下目的 -
    • 在客户端访问后端资源之前拦截来自客户端的请求。
    • 在将响应发送回客户端之前操作来自服务器的响应。
    规范建议了各种类型的过滤器 -
    • 身份验证过滤器。
    • 数据压缩过滤器。
    • 加密过滤器。
    • 触发资源访问事件的过滤器。
    • 图像转换过滤器。
    • 记录和审计过滤器。
    • MIME-TYPE 链式过滤器。
    • 标记过滤器。
    • 转换 XML 内容的 XSL/T 过滤器。
    过滤器部署在部署描述符文件中 web.xml 然后映射到应用程序部署描述符中的 servlet 名称或 URL 模式。
    当 Web 容器启动您的 Web 应用程序时，它会为您在部署描述符中声明的每个过滤器创建一个实例。过滤器按照它们在部署描述符中声明的顺序执行。

  • Servlet 过滤器方法

    过滤器只是一个实现 javax.servlet.Filter 接口的 Java 类。javax.servlet.Filter 接口定义了三种方法 -
    序号 方法和说明
    1
    public void doFilter (ServletRequest, ServletResponse, FilterChain)
    由于客户端对链末端资源的请求，每次请求/响应对通过链时，容器都会调用此方法。
    2
    public void init(FilterConfig filterConfig)
    该方法由 Web 容器调用，以向过滤器表明它正在投入使用。
    3
    public void destroy()
    该方法由 Web 容器调用，以向过滤器表明它正在停止服务。

  • Servlet 过滤器 - 示例

    以下是将打印客户端 IP 地址和当前日期时间的 Servlet 过滤器示例。这个例子会让你对 Servlet 过滤器有基本的了解，但你可以使用相同的概念编写更复杂的过滤器应用程序 - 
    
// Import required java libraries
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.util.*;
// Implements Filter class
public class LogFilter implements Filter  {
   public void  init(FilterConfig config) throws ServletException {
      
      // Get init parameter 
      String testParam = config.getInitParameter("test-param"); 
      //Print the init parameter 
      System.out.println("Test Param: " + testParam); 
   }
   
   public void  doFilter(ServletRequest request, ServletResponse response,
      FilterChain chain) throws java.io.IOException, ServletException {
      // Get the IP address of client machine.
      String ipAddress = request.getRemoteAddr();
      // Log the IP address and current timestamp.
      System.out.println("IP "+ ipAddress + ", Time " + new Date().toString());
      // Pass request back down the filter chain
      chain.doFilter(request,response);
   }
   public void destroy( ) {
      /* Called before the Filter instance is removed from service by the web container*/
   }
}
    编译 LogFilter.java 以通常的方式将您的类文件放在 <Tomcat-installationdirectory>/webapps/ROOT/WEB-INF/classes

  • Web.xml 中的 Servlet 过滤器映射

    过滤器被定义然后映射到一个 URL 或 Servlet，就像 Servlet 被定义然后映射到一个 URL 模式一样。在部署描述符文件中为过滤器标记创建以下条目web.xml 
    
<filter>
   <filter-name>LogFilter</filter-name>
   <filter-class>LogFilter</filter-class>
   <init-param>
      <param-name>test-param</param-name>
      <param-value>Initialization Paramter</param-value>
   </init-param>
</filter>
<filter-mapping>
   <filter-name>LogFilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>
    上面的过滤器将适用于所有的 servlet，因为我们指定了 /*在我们的配置中。如果您只想在少数 servlet 上应用过滤器，则可以指定特定的 servlet 路径。
    现在尝试以通常的方式调用任何 servlet，您将在 Web 服务器日志中看到生成的日志。您可以使用 Log4J 记录器将上面的日志记录到单独的文件中。

  • 使用多个过滤器

    您的 Web 应用程序可能会定义多个具有特定用途的不同过滤器。考虑一下，您定义了两个过滤器AuthenFilter和LogFilter。除了您需要创建不同的映射，如下所述 - 其余过程将保持如上所述 - 
    
<filter>
   <filter-name>LogFilter</filter-name>
   <filter-class>LogFilter</filter-class>
   <init-param>
      <param-name>test-param</param-name>
      <param-value>Initialization Paramter</param-value>
   </init-param>
</filter>
<filter>
   <filter-name>AuthenFilter</filter-name>
   <filter-class>AuthenFilter</filter-class>
   <init-param>
      <param-name>test-param</param-name>
      <param-value>Initialization Paramter</param-value>
   </init-param>
</filter>
<filter-mapping>
   <filter-name>LogFilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>
<filter-mapping>
   <filter-name>AuthenFilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>

  • 过滤器应用顺序

    web.xml 中过滤器映射元素的顺序决定了 Web 容器将过滤器应用于 servlet 的顺序。要反转过滤器的顺序，您只需反转 web.xml 文件中的过滤器映射元素。
    例如，上面的示例将首先应用 LogFilter，然后将 AuthenFilter 应用于任何 servlet，但以下示例将颠倒顺序 - 
    
<filter-mapping>
   <filter-name>AuthenFilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>
<filter-mapping>
   <filter-name>LogFilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>
上一节:
下一节: