JSP 和 Servlet 中的过滤器都是 Ja va 类。

过滤器可以动态地拦截请求和响应。

它能够变换或使用包含在请求或响应中的信息。

可以将一个或多个过滤器附加到一个 Servlet 或一组 Servlet。

过滤器也可以附加到 Ja vaServer Pages (JSP) 文件和 HTML 页面。

过滤器的作用

过滤器是可用于 Servlet 编程的 Ja va 类，可以实现以下目的：

• 在客户端的请求访问后端资源之前，拦截这些请求。
• 在服务器的响应发送回客户端之前，处理这些响应。

过滤器的常见类型

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

• 身份验证过滤器（Authentication Filters）。
• 数据压缩过滤器（Data compression Filters）。
• 加密过滤器（Encryption Filters）。
• 触发资源访问事件过滤器。
• 图像转换过滤器（Image Conversion Filters）。
• 日志记录和审核过滤器（Logging and Auditing Filters）。
• MIME-TYPE 链过滤器（MIME-TYPE Chain Filters）。
• 标记化过滤器（Tokenizing Filters）。
• XSL/T 过滤器（XSL/T Filters），转换 XML 内容。

过滤器的声明与执行

过滤器通过 Web 部署描述符（web.xml）中的 XML 标签来声明。

然后映射到您的应用程序的部署描述符中的 Servlet 名称或 URL 模式。

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

Filter 的执行顺序与在 web.xml 配置文件中的配置顺序一致。

一般把 Filter 配置在所有的 Servlet 之前。

Servlet 过滤器方法

过滤器是一个实现了 ja vax.servlet.Filter 接口的 Ja va 类。

ja vax.servlet.Filter 接口定义了三个方法：

序号	方法 & 描述
1	public void doFilter (ServletRequest, ServletResponse, FilterChain) 该方法完成实际的过滤操作，当客户端的请求与过滤器设置的 URL 匹配时，Servlet 容器将先调用过滤器的 doFilter 方法。FilterChain 用于访问后续过滤器。
2	public void init(FilterConfig filterConfig) web 应用程序启动时，web 服务器将创建Filter 的实例对象，并调用其init方法，读取web.xml配置，完成对象的初始化功能，从而为后续的用户请求作好拦截的准备工作（filter对象只会创建一次，init方法也只会执行一次）。开发人员通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。
3	public void destroy() Servlet容器在销毁过滤器实例前调用该方法，在该方法中释放Servlet过滤器占用的资源。

FilterConfig 使用

Filter 的 init 方法中提供了一个 FilterConfig 对象。

如 web.xml 文件配置如下：

    LogFilter
    com.runoob.test.LogFilter
    
        Site
        菜鸟教程
    
    

在 init 方法使用 FilterConfig 对象获取参数：

public void  init(FilterConfig config) throws ServletException {
    // 获取初始化参数
    String site = config.getInitParameter("Site"); 
    // 输出初始化参数
    System.out.println("网站名称: " + site); 
}

JSP 过滤器实例

以下是 Servlet 过滤器的实例，将输出网站名称和地址。

本实例让您对 Servlet 过滤器有基本的了解。

您可以使用相同的概念编写更复杂的过滤器应用程序：

//导入必需的 ja va 库
import ja vax.servlet.*;
import ja va.util.*;
//实现 Filter 类
public class LogFilter implements Filter  {
    public void  init(FilterConfig config) throws ServletException {
        // 获取初始化参数
        String site = config.getInitParameter("Site"); 
        // 输出初始化参数
        System.out.println("网站名称: " + site); 
    }
    public void  doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws ja va.io.IOException, ServletException {
        // 输出站点名称
        System.out.println("站点网址：http://www.runoob.com");
        // 把请求传回过滤链
        chain.doFilter(request,response);
    }
    public void destroy( ){
        /* 在 Filter 实例被 Web 容器从服务移除之前调用 */
    }
}

DisplayHeader.ja va 文件代码如下：

//导入必需的 ja va 库
import ja va.io.IOException;
import ja va.io.PrintWriter;
import ja va.util.Enumeration;
import ja vax.servlet.ServletException;
import ja vax.servlet.annotation.WebServlet;
import ja vax.servlet.http.HttpServlet;
import ja vax.servlet.http.HttpServletRequest;
import ja vax.servlet.http.HttpServletResponse;
@WebServlet("/DisplayHeader")
//扩展 HttpServlet 类
public class DisplayHeader extends HttpServlet {
    // 处理 GET 方法请求的方法
    public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
    {
        // 设置响应内容类型
        response.setContentType("text/html;charset=UTF-8");
        PrintWriter out = response.getWriter();
        String title = "HTTP Header 请求实例 - 菜鸟教程实例";
        String docType =
            " n";
            out.println(docType +
            "n" +
            "n"+
            "n" +
            "
" + title + "
n" +
            "n" +
            "n" +
            "n"+
            "n");
        Enumeration headerNames = request.getHeaderNames();
        while(headerNames.hasMoreElements()) {
            String paramName = (String)headerNames.nextElement();
            out.print("n");
            String paramValue = request.getHeader(paramName);
            out.println("n");
        }
        out.println("
Header 名称
Header 值
" + paramName + "
 " + paramValue + "
n");
    }
    // 处理 POST 方法请求的方法
    public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
        doGet(request, response);
    }
}

Web.xml 中的 Servlet 过滤器映射（Servlet Filter Mapping）

定义过滤器，然后映射到一个 URL 或 Servlet。

这与定义 Servlet，然后映射到一个 URL 模式方式大致相同。

在部署描述符文件 web.xml 中为 filter 标签创建下面的条目：

  
  

  LogFilter
  com.runoob.test.LogFilter
  
    Site
    菜鸟教程
  


  LogFilter
  /*

  
    
  DisplayHeader  
    
  com.runoob.test.DisplayHeader  
  
  
  DisplayHeader  
    
  /TomcatTest/DisplayHeader  
  
  

上述过滤器适用于所有的 Servlet，因为我们在配置中指定 /*。

如果您只想在少数的 Servlet 上应用过滤器，您可以指定一个特定的 Servlet 路径。

现在试着以常用的方式调用任何 Servlet，您将会看到在 Web 服务器中生成的日志。

您也可以使用 Log4J 记录器来把上面的日志记录到一个单独的文件中。

接下来我们访问这个实例地址 http://localhost:8080/TomcatTest/DisplayHeader，然后在控制台看下输出内容，如下所示：

使用多个过滤器

在一个 Web 应用里，完全可以围绕不同目标配置多个过滤器。

比如说，这里假设定义了两个过滤器 AuthenFilter 和 LogFilter。

接下来要做的，就是像下面描述的那样分别建立对应的映射。

至于剩下的处理流程，和前面讲到的基本是一回事。

   LogFilter
   com.runoob.test.LogFilter
   
      test-param
      Initialization Paramter
   


   AuthenFilter
   com.runoob.test.AuthenFilter
   
      test-param
      Initialization Paramter
   


   LogFilter
   /*


   AuthenFilter
   /*

过滤器的应用顺序

在 web.xml 里，filter-mapping 元素的排列顺序，实际上就决定了 Web 容器把过滤器依次应用到 Servlet 时的执行先后。

想把过滤器顺序倒过来，做法也很直接：把 web.xml 文件中的 filter-mapping 元素顺序反过来即可。

例如，上面的实例将先应用 LogFilter，然后再应用 AuthenFilter。

但是下面的实例将颠倒这个顺序：

   AuthenFilter
   /*


   LogFilter
   /*

web.xml配置各节点说明

• 指定一个过滤器。

  • 用于为过滤器指定一个名字，该元素的内容不能为空。
  • 元素用于指定过滤器的完整的限定类名。
  • 元素用于为过滤器指定初始化参数，它的子元素指定参数的名字，指定参数的值。
  • 在过滤器中，可以使用FilterConfig接口对象来访问初始化参数。

• 元素用于设置一个 Filter 所负责拦截的资源。

  一个Filter拦截的资源可通过两种方式来指定：Servlet 名称和资源访问的请求路径

  • 子元素用于设置filter的注册名称。该值必须是在元素中声明过的过滤器的名字
  • 设置 filter 所拦截的请求路径(过滤器关联的URL样式)

• 指定过滤器所拦截的Servlet名称。

• 指定过滤器所拦截的资源被 Servlet 容器调用的方式，可以是REQUEST,INCLUDE,FORWARD和ERROR之一，默认REQUEST。

  用户可以设置多个子元素用来指定 Filter 对资源的多种调用方式进行拦截。

• 子元素可以设置的值及其意义

  • REQUEST：当用户直接访问页面时，Web容器将会调用过滤器。如果目标资源是通过RequestDispatcher的include()或forward()方法访问时，那么该过滤器就不会被调用。
  • INCLUDE：如果目标资源是通过RequestDispatcher的include()方法访问时，那么该过滤器将被调用。除此之外，该过滤器不会被调用。
  • FORWARD：如果目标资源是通过RequestDispatcher的forward()方法访问时，那么该过滤器将被调用，除此之外，该过滤器不会被调用。
  • ERROR：如果目标资源是通过声明式异常处理机制调用时，那么该过滤器将被调用。除此之外，过滤器不会被调用。