Servlet的过滤器（Filter）

以下内容引用自http://wiki.jikexueyuan.com/project/servlet/writing-filters.html：

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

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

• 在它们发送回客户端之前，处理这些来自服务器端的响应。

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

• 身份验证过滤器。

• 数据压缩过滤器。

• 加密过滤器。

• 触发访问事件资源的过滤器。

• 图像转换过滤器。

• 日志记录和审核过滤器。

• MIME-类型链过滤器。

• Tokenizing过滤器。

• 转换XML内容的XSL/T过滤器。

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

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

一、Servlet过滤器方法

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

方法	描述
public void doFilter (ServletRequest, ServletResponse, FilterChain)	该方法在每次一个请求/响应对因客户端在链的末端请求资源而通过链传递时由容器调用。
public void init(FilterConfig filterConfig)	该方法由Web容器调用，指示一个过滤器被放入服务。
public void destroy()	该方法由Web容器调用，指示一个过滤器从服务被去除。

二、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并把类文件放入/webapps/ROOT/WEB-INF/classes中。（注意：POM和Eclipse项目忽略这一步）

三、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>

 

测试工程：https://github.com/easonjim/5_java_example/tree/master/servletbasics/test6