【SpringBoot 2.x】开发实战day6，Filter过滤器和Interceptor拦截器配置和生命周期

一、什么是Filter 过滤器 和 Interceptor 拦截器？

用户认证授权、日志记录 MDC、编码解码、UA 检查、多端对应等都需要通过 拦截请求 来进行处理。这时就需要
Servlet、Filter、Listener（监听）、Interceptor 这几种组件。而把非 Spring Boot 项目转换成
Spring Boot 项目，需要沿用以前的这些代码，所以有必要了解这它们的 用法 和 生命周期。

1. Listener 监听
   Listener 可以监听 web 服务器中某一个事件操作，并触发注册的回调函数。通俗的语言就是在 application，session，request 三个对象创建/消亡或者增删改属性时，自动执行代码的功能组件。

2. Servlet
   Servlet 是一种运行服务器端的 java 应用程序，具有 独立于平台和协议的特性，并且可以动态的生成 web 页面，它工作在 客户端请求与服务器响应 的中间层。

3. 过滤器 Filter
   Filter对用户请求进行预处理，接着将请求交给 Servlet 进行处理并生成响应，最后 Filter 再对服务器响应进行后处理。Filter 是可以复用的代码片段，常用来转换 HTTP 请求、响应和头信息。Filter 不像 Servlet，它不能产生响应，而是只修改对某一资源的请求或者响应。

4. 拦截器 Interceptor
   类似面向切面编程（AOP）中的切面和通知，我们通过动态代理对一个 service() 方法添加通知进行功能增强。比如说在方法执行前进行初始化处理，在方法执行后进行后置处理。拦截器的思想和AOP 类似，区别就是拦截器只能对 Controller 的 HTTP 请求进行拦截。

---

二、Filter 与 Interceptor 区别

google和百度上很多说明，随便拿来一个。

1. Filter 是基于函数回调的，而 Interceptor 则是基于 Java 反射 和 动态代理。
2. Filter 依赖于 Servlet 容器，遵循Servlet规范，而 Interceptor 依赖于spring容器，遵循Spring规范。
3. Filter 对几乎 所有的请求 起作用，但过滤器的控制比较粗，只能在请求进来时进行处理，对请求和响应进行包装，而 Interceptor 只对 Controller 对请求起作用，但更精细的控制，可以在controller对请求处理之前或之后被调用，也可以在渲染视图呈现给用户之后调用

---

三、执行顺序

1. Filter 过滤请求处理
2. Interceptor 拦截请求处理
3. Aspect（切面） 拦截处理请求（这里不赘述）
4. 对应的 HandlerAdapter 处理请求
5. Aspect（切面） 拦截响应请求（这里不赘述）
6. Interceptor 拦截响应处理
7. Interceptor 的最终处理
8. Filter 过滤响应处理

图解：如下如

---

四、过滤器Filter实现及剖析 Filter 接口

1. 剖析 Filter 接口以及接口方法
   首先创建过滤器会实现 javax.servlet.Filter 接口

   public interface Filter {
        
   
       public default void init(FilterConfig filterConfig) throws ServletException {
        }
      
       public void doFilter(ServletRequest request, ServletResponse response,
               FilterChain chain) throws IOException, ServletException;
   
       public default void destroy() {
        }
   }
   

   对上面三个接口方法进行分析：

   ① init(FilterConfig)： 初始化接口，在用户自定义的Filter初始化时被调用，它与Servlet的
   init方法的作用是一样的。
   ② doFilter(ServletRequest,ServletResponse,FilterChain)： 在每个用户的请求进来时这个方法都会被调用，并在Servlet的service方法之前调用(如果我们是开发Servlet项目)，而FilterChain就代表当前的整个请求链，通过调用FilterChain.doFilter可以将请求继续传递下去，如果想拦截这个请求，可以不调用FilterChain.doFilter，那么这个请求就直接返回了，所以Filter是一种责任链设计模式，在springsecurity就大量使用了过滤器，有一条过滤器链。
   ③ destroy()： 当Filter对象被销毁时，这个方法被调用，注意，当Web容器调用这个方法之后，容器会再调用一次doFilter方法，这也就是为什么在查看栈信息的时候，最后都会多一次调用doFilter方法

2. 自定义Filter
   在springboot中Filter有两种实现，一个 Servlet 请求可以经由多个 Filter 进行过滤，最终由 Servlet 处理并响应客户端。这里配置两个过滤器示例：
   ①、通过@WebFilter 注解来配置

   /**
    * 通过 @WebFilter 注解来配置
    * @author gcheng.L
    * @create 2019-09-16 11:14
    */
   @Configuration //将该类标记为配置类
   // filterName 过滤器名字，urlPatterns 过滤的url
   @WebFilter(filterName = "fistFilter", urlPatterns = "/*")
   // @Order 该注解设置过滤器执行顺序，越小越先执行
   @Order(value = 2)
   public class FirstIndexFilter implements Filter {
        
       private Logger logger = LoggerFactory.getLogger(FirstIndexFilter.class);
   
       @Override
       public void init(FilterConfig filterConfig) {
        
           logger.info("{} is init.", logger.getName());
       }
   
       /**
        *
        * @param servletRequest
        * @param servletResponse
        * @param filterChain
        * @throws IOException
        * @throws ServletException
        */
       @Override
       public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        
           logger.info("{} is doFilter.", logger.getName());
           //  http请求中添加个filter参数，否则会被过滤掉。
           String filter = servletRequest.getParameter("filter");
           if (isEmpty(filter)) {
        
               servletResponse.getWriter().println("Filtered by firstIndexFilter, " +
                       "please set request parameter \"filter\"");
               return;
           }
           filterChain.doFilter(servletRequest, servletResponse);
           logger.info("{} post filter the response", logger.getName());
   
       }
   
       @Override
       public void destroy() {
        
           logger.info("{} is destroy", logger.getName());
       }
   }
   

   ②、通过 @Bean 注解来配置，注意这种方式需要添加一个配置类，将该Filter注入到spring容器中

   /**
    * 通过 @Bean 注解来配置，这里不需要@Configuration 注解
    * @author gcheng.L
    * @create 2019-09-16 11:14
    */
   public class SecendIndexFilter implements Filter {
        
       private Logger logger = LoggerFactory.getLogger(SecendIndexFilter.class);
   
       @Override
       public void init(FilterConfig filterConfig) {
        
           logger.info("{} is init.", logger.getName());
       }
   
       @Override
       public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        
           logger.info("{} is doFilter.", logger.getName());
           //  http请求中添加个filter参数，否则会被过滤掉。
           String filter = servletRequest.getParameter("filter");
           if (isEmpty(filter)) {
        
               servletResponse.getWriter().println("Filtered by SecondIndexFilter, " +
                       "please set request parameter \"filter\"");
               return;
           }
           filterChain.doFilter(servletRequest, servletResponse);
           logger.info("{} post filter the response", logger.getName());
       }
   
       @Override
       public void destroy() {
        
           logger.info("{} is destroy", logger.getName());
       }
   }
   

   /**
    * filter 过滤器配置类
    * @author gcheng.L
    * @create 2019-09-24