干货，一文带你超详细了解 Filter 的原理及应用

提出问题

1、我们在访问后台很多页面时都需要登录，只有登录的用户才能查看这些页面，我们需要   在每次请求的时候都检查用户是否登陆，这样做很麻烦，有没有一种方法可以在我们请求之   前就帮我们做这些事情。有！

2、我们 web 应用经常会接收中文字符，由于可能导致中文乱码，我们每次都需要在方法的开始使用 request.setCharacterEncoding(“utf-8”)；能不能在我们要获取参数值直接就可以自己设置好编码呀。能！

这种问题的解决方法我们想到了一种办法。那就是在每次请求之前我们先将它拦截起来，当   我们设置好一切东西的时候，再将请求放行。类似与我们地铁站的检票系统。每个人进站的   时候必须刷卡，扣完钱后才可以进站坐车。

web 中也有这个机制，我们叫做过滤器。就是我们接下来学习的 filter

Filter 简介

什么是 filter

1） Filter（过滤器） 的基本功能是对 Servlet 容器调用 Servlet (JSP)的过程进行拦截， 从而在 Servlet 处理请求前和 Servlet 响应请求后实现一些特殊的功能。

2） 在 Servlet API 中定义了三个接口类来开供开发人员编写 Filter 程序： Filter,FilterChain, FilterConfig

3） Filter 程序是一个实现了 Filter 接口的 Java 类，与 Servlet 程序相似，它由 Servlet容器进行调用和执行

4） Filter 程序需要在 web.xml 文件中进行注册和设置它所能拦截的资源：Filter 程序可以拦截 Jsp, Servlet, 静态图片文件和静态 html 文件

filter 的运行原理是什么

这个 Servlet 过滤器就是我们的 filter

1）当在 web.xml 中注册了一个 Filter 来对某个 Servlet 程序进行拦截处理时，这个Filter 就成了 Tomcat 与该 Servlet 程序的通信线路上的一道关卡，该 Filter 可以对Servlet 容器发送给 Servlet 程序的请求和 Servlet 程序回送给 Servlet 容器的响应进行拦截，可以决定是否将请求继续传递给 Servlet 程序，以及对请求和相应信息是否进行修改

2）在一个 web 应用程序中可以注册多个 Filter 程序，每个 Filter 程序都可以对一个或一组 Servlet 程序进行拦截。

3）若有多个 Filter 程序对某个 Servlet 程序的访问过程进行拦截，当针对该 Servlet 的访问请求到达时，web 容器将把这多个 Filter 程序组合成一个 Filter 链(过滤器链)。Filter 链中各个 Filter 的拦截顺序与它们在应用程序的 web.xml 中映射的顺序一致

Filter-helloword

Hello-World

filter 编写三步骤：

1、创建 filter 实现类，实现 filter 接口

2、编写 web.xml 配置文件，配置 filter 的信息

3、运行项目，可以看到 filter 起作用了

代码：

//1、filter 实现类
public class MyFirstFilter implements Filter{ 

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("初始化方法");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response,FilterChain chain) throws
    IOException, ServletException {
        System.out.println("dofilter方法");
    }

    @Override
    public void destroy() {
        System.out.println("销毁方法...");
    }

}

//2、web.xml 配置
<filter>
    <filter-name>MyFirstFilter</filter-name>
    <filter-class>com.atguigu.filter.MyFirstFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>MyFirstFilter</filter-name>
    <url-pattern>/index.jsp</url-pattern>
</filter-mapping>

//3、运行程序，发现 index.jsp 页面不显示了，后台输出“dofilter 方法”，说明我们写的 filter 执行了。

filter 的生命周期

1）在服务器启动时，filter 被创建并初始化，执行 init()方法。

2）请求通过 filter 时执行 doFilter 方法。

3）服务器停止时，调用 destroy 方法。

filter 放行请求

我们发现，刚才的 filter 配置好后，index.jsp 页面没法访问了，访问这个页面的时候 filter的 dofilter 方法被调用了。说明 dofilter 这个方法拦截了我们的请求。

我们如何显示页面呢。也就是如何将请求放行呢。我们观察发现有个 filterChain 被传入到这个方法里面了。filterChain 里面有个 doFilter()方法。放行请求只需要调用 filterChain 的 dofilter 方法。

public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException,ServletException {
    System.out.println("dofilter方法");
    chain.doFilter(request, response);//放行请求
}

filter 拦截原理

我们在 chain.doFilter(request, response);方法后也写一句话，System.out.println

(“doFilter 方法执行后…”)，在 index.jsp 页面也写上 jsp 脚本片段，输出我是 jsp 页面。运行程序发现控制台输出了这几句话：

dofilter 方法… 我是 jsp 页面
dofilter 方法后…
我们不难发现 filter 的运行流程

FilterChain

doFilter(ServletRequest request, ServletResponse response, FilterChain chain)

在 doFilter 执行之前，由容器将 filterChain 对象传入方法。调用此对象的.doFilter()方法可以将请求放行，实际上是执行过滤器链中的下一个 doFilter 方法，但是如果只有一个过滤器，则为放行。

FilterConfig

FilterConfig 类似 ServletConfig，是 filter 的配置信息对象。FilterConfig 对象具有以下方法。

getFilterName():获取当前 filter 的名字。获取的是在 web.xml 中配置的 filter-name 的值

getInitParameter(String name):获取 filter 的初始化参数。在 web.xml 中配置

getInitParameterNames():获取 filter 初始化参数名的集合。

getServletContext():获取当前 web 工程的 ServletContext 对象。

Filter 的 url-pattern

url-pattern 是配置 filter 过滤哪些请求的。主要有以下几种配置：

web.xml 中配置的/都是以当前项目路径为根路径的

1）精确匹配：

/index.jsp/user/login 会在请求/index.jsp、/user/login 的时候执行过滤方法

2）路径匹配：

/user/* /* 凡是路径为/user/下的所有请求都会被拦截，/*表示拦截系统的所有请求，包括静态资源文件。

3）扩展匹配：

*.jsp *.action 凡是后缀名为.jsp .action 的请求都会被拦截。

注意：/login/*.jsp 这种写法是错误的，只能是上述三种的任意一种形式。不能组合新形式。

*jsp 也是错误的，扩展匹配必须是后缀名

4）多重 url-pattern 配置

上面的三种形式比较有局限性，但是 url-pattern 可以配置多个，这样这三种组合基本就能解决所有问题了

多 Filter 执行顺序

如果同一个资源有多个 filter 都对其拦截，则拦截的顺序是按照 web.xml 中配置的顺序进行的

执行流程图如下

请求总是在处理之后再回来执行 doFilter 之后的方法。

HttpServletWrapper 和 HttpServletResponseWrapper

定义

Servlet API 中提供了一个 HttpServletRequestWrapper 类来包装原始的 request 对象,HttpServletRequestWrapper 类实现了 HttpServletRequest 接口中的所有方法, 这些方法的内部实现都是仅仅调用了一下所包装的的 request 对象的对应方法

//包装类实现 ServletRequest 接口.
public class ServletRequestWrapper implements ServletRequest {

    //被包装的那个 ServletRequest 对象
    private ServletRequest request;

    //构造器传入 ServletRequest 实现类对象
    public ServletRequestWrapper(ServletRequest request) {
        if (request == null) {
            throw new IllegalArgumentException("Request cannot be null");
        }
        this.request = request;
    }

    //具体实现 ServletRequest 的方法: 调用被包装的那个成员变量的方法实现。
    public Object getAttribute(String name) {
        return this.request.getAttribute(name);
    }

    public Enumeration getAttributeNames() {
        return this.request.getAttributeNames();
    }    

    //...
}    

相类似 Servlet API 也提供了一个 HttpServletResponseWrapper 类来包装原始的 response 对象

作用

用于对 HttpServletRequest 或 HttpServletResponse 的某一个方法进行修改或增强.

public class MyHttpServletRequest extends HttpServletRequestWrapper{

    public MyHttpServletRequest(HttpServletRequest request) {
        super(request);
    }

    @Override
    public String getParameter(String name) {
        String val = super.getParameter(name);
        if(val != null && val.contains(" fuck ")){
            val = val.replace("fuck", "****");
        }
        return val;
    }
}

使用

在 Filter 中, 利用 MyHttpServletRequest 替换传入的 HttpServletRequest

HttpServletRequest req = new MyHttpServletRequest(request);
filterChain.doFilter(req, response);

此时到达目标 Servlet 或 JSP 的 HttpServletRequest 实际上是 MyHttpServletRequest