Servlet - 编写过滤器

Servlet 过滤器是可以在 Servlet 编程中用于以下目的的 Java 类：

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

• 在服务器将响应发送回客户端之前操作服务器的响应。

规范建议了各种类型的过滤器：

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

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

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

Servlet 过滤器方法

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

Servlet 过滤器 - 示例

以下是一个 Servlet 过滤器示例，它将打印客户端的 IP 地址和当前日期时间。此示例将为您提供对 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 安装目录>/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，然后将其应用于任何 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>