01 什么是过滤器Filter

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

简单说，过滤器实际上就是对web资源进行拦截，做一些处理后再交给下一个过滤器或servlet处理。通常都是用来拦截request进行处理的，也可以对返回的response进行拦截处理。

02 过滤器Filter的具体流程图

具体流程图如下：

03 过滤器的应用场景

自动登录统一设置编码格式访问权限控制敏感字符过滤等

04 如何创建过滤器Filter

创建一个普通类实现Filter接口，注意是 javax.servlet包下的

两种方法：

第一种：在web.xml里面配置：略

<!--
       配置filter
        <filter-name>别名</filter-name>
        <filter-class>配置过滤器的全路径
        <filter-mapping>映射配置
       <filter-name>别名</filter-name>
       <url-pattern>filter的拦截路径</url-pattern>
   -->

<filter>
    <filter-name>HelloFilter</filter-name>
    <filter-class>com.hjxr.filter.HelloFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>HelloFilter</filter-name>
<url-pattern>/demo</url-pattern>
</filter-mapping>

第二种 注解的方式

@WebFilter(filterName = "CharsetFilter",
        urlPatterns = "/*",/*通配符（*）表示对所有的web资源进行拦截*/
        initParams = {
                @WebInitParam(name = "charset", value = "utf-8")/*这里可以放一些初始化的参数*/
        })
public class CharsetFilter implements Filter {

    private String charset;

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        /*初始化方法  接收一个FilterConfig类型的参数 该参数是对Filter的一些配置*/
        charset = filterConfig.getInitParameter("charset");
        String filterName = filterConfig.getFilterName();
        System.out.println("我被初始化了！");
        System.out.println("初始化过滤器名称：" + filterName);
        System.out.println("初始化Param：" + charset);
    }

    @Override
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws IOException, ServletException {
        /*过滤方法 主要是对request和response进行一些处理，然后交给下一个过滤器或Servlet处理*/
        System.out.println("我在工作ing");
        req.setCharacterEncoding(charset);
        resp.setCharacterEncoding(charset);
        chain.doFilter(req, resp);//交给下一个过滤器或servlet处理
    }

    @Override
    public void destroy() {
        /*销毁时调用*/
        System.out.println("我被销毁了！");
    }
}

关于注解@WebFilter：

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface WebFilter {
    String description() default ""; //添加描述信息
    String displayName() default "";
    WebInitParam[] initParams() default {}; // 配置初始化参数，跟Servlet配置一样
    String filterName() default ""; // 定义Filter名字
    String smallIcon() default "";
    String largeIcon() default "";
    String[] servletNames() default {};
    String[] value() default {};
    String[] urlPatterns() default {}; // 配置要拦截的资源
    DispatcherType[] dispatcherTypes() default {DispatcherType.REQUEST}; // 配置拦截的类型，可配置多个。默认为DispatcherType.REQUEST
    boolean asyncSupported() default false;
}

// DispatcherType是个枚举类型，有下面几个值
FORWARD,// 转发
INCLUDE,// 包含在页面
REQUEST,// 请求
ASYNC,  // 异步
ERROR;  // 出错

过滤器是在服务器启动时就会创建的，只会创建一个实例，常驻内存，也就是说服务器一启动就会执行Filter的init(FilterConfig config)方法。当Filter被移除或服务器正常关闭时，会执行destroy方法

05 拦截路径配置

一个路径只能有一个servlet执行,但是一个路径可以有多个filter执行.且filter中不存在路径优先级问题

精准匹配 完全匹配 : /a/b/c/aaServlet目录匹配 : /a/b/c/*后缀名匹配 : *.jsp *.abc

在filter中一般使用的模糊路径匹配和后缀名匹配

06 生命周期(了解)

注意:始终请保持整个项目中有且只有一个Filter,filter允许配置多个

void init(FilterConfig config):初始化方法,在项目启动的时候就会执行,只执行一次

void doFilter(request,response,FilterChain chain):执行过滤方法,当请求匹配上的时候就会执行

void destroy():销毁,在项目被移除的时候或者服务器关闭的时候就会执行,只执行一次

Servlet和filter的对比

Servlet:默认第一次被访问初始化 每一次执行Servlet执行service方法 服务器停止 执行destroy方法

filter是一个单实例的线程不安全的对象(不要给成员变量)
服务器启动的时候,服务器会创建filter对象,且调用filter的init方法,实现初始化操作
当请求来的时候,若filter能匹配到此路径,服务器就会从线程池中获取一个线程,在线程中调用filter的doFilter方法,当dofilter方法执行了放行操作的时候才会到达下一个地方.
当服务器正常关闭的时候,服务器会调用filter的destroy方法,实现销毁操作.

和servlet不一样的地方:servlet默认第一次访问的时候才会进行初始化,当然也可以通过load-on-startup标签修改servlet的初始化时机.

07 过滤器链

当我们访问一个请求的时候,若匹配到了多个filter,多个filter都会执行,执行流程就像一个链子把这些过滤器都串起来了.

FilterChain:只有一个放行方法 doFilter(req,resp).当chain的放行方法执行之后,就会将执行流程移交下一个过滤器上,若当前的过滤器是最后一个话,就会执行对应的servle或者jsp.然后在逆着返回.

08 Filter执行顺序问题

过滤器链中的过滤器的执行顺序为:

在web.xml中，filter执行顺序跟的顺序有关，(自上而下的顺序)使用注解配置的话，filter的执行顺序跟名称的字母顺序有关，例如AFilter会比BFilter先执行如果既有在web.xml中声明的Filter，也有通过注解配置的Filter，那么会优先执行web.xml中配置的Filter

09 Filter案例-- 解决全站乱码

每一个Servlet的第一步 都是处理请求和响应的编码

需求

浏览器发出的任何请求，通过过滤器统一处理中文乱码 。

tomcat8.5处理了get请求的中文乱码,但是post的没有处理,对于post请求来说,我们之前的操作,是在获取参数之前执行 request.setCharacterEncoding("utf-8");

分析得出:

可以将post请求的中文乱码问题抽取到过滤器中过滤器的路径 /*

步骤分析

编写一个过滤器配置过滤器的路径为 /*编写过滤请求的逻辑若是post请求,就执行request.setCharacterEncoding("utf-8");其他方式请求,不用管理别忘记放行

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

/**
 * 字符过滤器
 *
 * @author common
 */
@WebFilter(filterName = "EncodingFilter", urlPatterns = "/*")
public class EncodingFilter implements Filter {

    @Override
    public void init(FilterConfig config) {

    }

    @Override
    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
        if (req instanceof HttpServletRequest) {
            HttpServletRequest request = (HttpServletRequest) req;
            if ("POST".equals(request.getMethod())) {
                //统一处理编码
                req.setCharacterEncoding("utf-8");
                resp.setContentType("text/html;charset=utf-8");
            }

        }
        //放行代码
        chain.doFilter(req, resp);

    }

    @Override
    public void destroy() {
    }
    
}