Servlet - 编写过滤器

Servlet 过滤器是 Java 类，可用于 Servlet 编程，目的如下 −

• 在客户端访问后端资源之前拦截来自客户端的请求。

• 在服务器响应发送回客户端之前对其进行处理。

规范建议使用各种类型的过滤器 −

• 身份验证过滤器。
• 数据压缩过滤器。
• 加密过滤器。
• 触发资源访问事件的过滤器。
• 图像转换过滤器。
• 日志记录和审计过滤器。
• MIME-TYPE 链过滤器。
• 标记化过滤器。
• 转换 XML 内容的 XSL/T 过滤器。

过滤器部署在部署描述符文件 web.xml 中，然后映射到应用程序部署描述符中的 servlet 名称或 URL 模式。

当 Web 容器启动您的 Web 应用程序时，它会为您在部署描述符中声明的每个过滤器创建一个实例。过滤器按照部署描述符中声明的顺序执行。

Servlet 过滤器方法

过滤器只是一个实现 javax.servlet.Filter 接口的 Java 类。javax.servlet.Filter 接口定义了三种方法 −

Servlet 过滤器 − 示例

以下是 Servlet 过滤器示例，它将打印客户端 IP 地址和当前日期时间。此示例将让您对 Servlet 过滤器有基本的了解，但您可以使用相同的概念编写更复杂的过滤器应用程序 −

// 导入所需的 java 库
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.util.*;

// 实现 Filter 类
public class LogFilter implements Filter  {
   public void  init(FilterConfig config) throws ServletException {
      
    // 获取初始化参数
    String testParam = config.getInitParameter("test-param");
    
    //打印初始化参数
    System.out.println("Test Param: " + testParam); 
   }
   
   public void  doFilter(ServletRequest request, ServletResponse response,
      FilterChain chain) throws java.io.IOException, ServletException {

        // 获取客户端计算机的 IP 地址。
        String ipAddress = request.getRemoteAddr();
        
        // 记录 IP 地址和当前时间戳。
        System.out.println("IP "+ ipAddress + ", Time " + new Date().toString());
        
        // 将请求传递回过滤器链
        chain.doFilter(request,response);
   }

   public void destroy( ) {
      /* 在 Web 容器从服务中删除 Filter 实例之前调用*/
   }
}

以通常的方式编译 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 中的 filter-mapping 元素顺序决定了 Web 容器将过滤器应用于 servlet 的顺序。要反转过滤器的顺序，只需反转 web.xml 文件中的 filter-mapping 元素即可。

例如，上面的示例将首先应用 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>