一、简介

• Filter也称为过滤器，它是Servlet技术中最激动人心的技术，web开发人员通过Filter技术，对web服务器管理的所有web资源：例如JSP，Servlet，静态图片文件或静态html文件等进行拦截，从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。

• ServletAPI中提供了一个Filter接口，开发web应用时，如果编写的java类实现了这个接口，则把这个java类称之为过滤器Filter。通过Filter技术，开发人员可以实现用于在访问某个目标资源之前，对访问的请求和响应进行拦截。

二、Filter是如何实现拦截的

• Filter接口中有一个doFilter方法，当开发人员编写好Filter，并配置对哪个web资源进行拦截后，web服务器每次在调用web资源的service方法之前，都会先调用一下Filter的doFilter方法，因此，在该方法内编写代码可达到如下目的：
  • 调用目标资源之前，让一段代码执行
  • 是否调用目标资源（即是否让用户访问web资源）。Web服务器在调用doFilter方法时，会传递一个filterChain对象进来，filterChain对象是filter接口中最重要的一个对象，它也提供了一个doFilter方法，开发人员可以根据需求决定是否调用此方法，调用该方法，则web服务器就会调用web资源的service方法，即web资源就会被访问，否则web资源不会被访问。
  • 调用目标资源之后，让一段代码执行

三、 filter开发入门

3.1 filter开发分为两个步骤

• 编写java类实现filter接口，并实现其doFilter方法。

• 在web.xml文件中使用<filter>和<filter-mapping>元素对编写的filter类进行注册，并设置它所能拦截的资源。

3.2 filter链

• 在一个web应用中，可以开发编写多个filter，这些filter组合起来称之为一个filter链。

• Web服务器根据filter在web.xml文件中的注册顺序，决定先调用哪个filter，当第一个filter的doFilter方法被调用时，web服务器会创建一个代表filter链的FilterChain对象传递给该方法。在doFilter方法中，开发人员如果调用了FilterChain对象中是否还有filter，如果有，则调用第二个filter；如果没有，则调用目标资源。

3.3 示例（工程day18）

FilterDemo1.java

package cn.itcast.web.filter;
import java.io.IOException;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;

public class FilterDemo1 implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        //对request和response进行一些预处理
        /*request.setCharacterEncoding("UTF-8");
        response.setCharacterEncoding("UTF-8");
        response.setContentType("text/html;charset=UTF-8");*/
        
        System.out.println("filter 执行前");
        
        chain.doFilter(request, response);//让目标资源执行，或者叫放行
        
        System.out.println("filter 执行后");
        
    }

    @Override
    public void init(FilterConfig arg0) throws ServletException {
    }
    
    @Override
    public void destroy() {
    }
}

说明：

• 1.filter的三种典型应用：

  • 可以在filter中根据条件决定是否调用chain.doFilter(request, response)方法，即是否防目标资源执行；
  • 在让目标资源执行之前，可以对request和response做一些预处理，如上面预先设置好编码方式，再让目标资源执行；
  • 在目标资源执行之后，可以捕获目标资源的执行结果，从而实现一些特殊的功能。

• 2.目标资源执行之后我们还可以执行其后的代码，比如数据库操作提交、取出目标资源的执行结果进行处理（如压缩）。注意：FilterChain就是很多个filter组成的一个链。

在web.xml文件中对过滤器进行配置

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://xmlns.jcp.org/xml/ns/javaee"
    xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
    id="WebApp_ID" version="3.1">
    <display-name>day18</display-name>

    <filter>
        <filter-name>FilterDemo1</filter-name>
        <filter-class>cn.itcast.web.filter.FilterDemo1</filter-class>
    </filter>

    <filter-mapping>
        <filter-name>FilterDemo1</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

    <welcome-file-list>
        <welcome-file>index.jsp</welcome-file>
    </welcome-file-list>
</web-app>

说明：

• 1.过滤器复合dtd2.3规范，但是不符合dtd2.2及以下的规范
• 2.配置的过程中多个<filter>要放在一起，多个<filter-mapping>要放在一起，不能交叉放置；
• 3.对于过滤器我们需要直接先建class文件，然后继承javax.servlet中的filter接口。

3.4 filter的声明周期

• init(FilterConfig filterConfig)throws ServletException
  和我们编写的Servlet程序一样，Filter的创建和销毁由web服务器负责。Web应用程序启动时，web服务器将创建filter的实例对象，并调用其init方法，完成对象的初始化功能，从而为后续的用户请求做好拦截的准备工作（注：filter对象只会创建一次，init方法也只会执行一次）

• 开发人员通过init方法的参数，可获得代表当前filter配置信息的FilterConfig对象。

• destory()
  在web容器卸载Filter对象之前被调用。该方法在filter的声明周期中仅执行一次。在这个方法中，可以释放过滤器使用的资源。

3.5 FilterConfig接口

用户在配置filter时，可以使用````<init-param>为filter配置一些初始化参数，当web容器实例化filter对象，调用其init方法时，会把封装了filter初始化参数的FilterConfig对象传递进来。因此开发人员在编写filter时，通过filterConfig```对象的方法就可获得：

• String getFilterName()得到filter的名称。

• String getInitParameter(String name) 返回在部署描述中指
  定名称的初始化参数的值。如果不存在返回null。

• Enumeration getInitParameterNames()返回过滤器的所有初始
  化参数的名字的枚举集合。

• public ServletContext getServletContext()返回Servlet上
  下文对象的引用。

示例
FilterDemo3.java

package cn.itcast.web.filter;
import java.io.IOException;
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;

public class FilterDemo3 implements Filter {

    private FilterConfig config = null;//用于记住初始化参数
    
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("filter创建了！！");
        this.config = filterConfig;

    }
    
    public void destroy() {
        System.out.println("filter销毁了！！");
    }

    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException {
        
        //获取配置的初始化参数
        System.out.println(this.config.getInitParameter("xxx"));
    }
}

配置web.xml

   <filter>
    <filter-name>FilterDemo3</filter-name>
    <filter-class>cn.itcast.web.filter.FilterDemo3</filter-class>
    <init-param>
        <param-name>xxx</param-name>
        <param-value>yyy</param-value>
    </init-param>
    
  </filter>
  
  <filter-mapping>
    <filter-name>FilterDemo3</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>

说明：如上，我们就可以获得一些初始化参数值。