前言

作为一个java，处理独有的业务或者项目设计时候可能会考虑到过滤器，监听器，拦截器这几个东西。有必要单独拿出来讲解一下，区别以及原理和如何整合项目

过滤器
监听器
拦截器

一、通俗理解

过滤器（Filter）：过滤一些你不想要的接口
拦截器（Interceptor）：某一类请求，你可以拦截了他，并且可以在容器生成，发展中和容器结束时候穿插一些你想要做的事情
监听器（Listener）：监听某一个事情发生，并不想干预这个事件本身的进程

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

2. filter：filter是一个可以复用的代码片段，可以用来转换HTTP请求，响应和头信息。它不能产生一个请求或者响应，它只是修改对某一资源的请求或者响应；
 
3. listener：监听器，通过listener可以坚挺web服务器中某一执行动作，并根据其要求作出相应的响应。就是在application，session，request三个对象创建消亡或者往其中添加修改删除属性时自动执行代码的功能组件；
 
4. interceptor：拦截器是对过滤器更加细化的应用，他不仅可以应用在service方法前后还可以应用到其他方法的前后拦截器；
 
5. servlet，filter，listener是配置到web.xml中，interceptor不配置到web.xml中，struts的拦截器配置到struts。xml中。spring的拦截器配置到spring.xml中；

二、过滤器和拦截器的区别

拦截器是基于java的反射机制的，而过滤器是基于函数回调。
拦截器不依赖与servlet容器，过滤器依赖与servlet容器。
拦截器只能对action请求起作用，而过滤器则可以对几乎所有的请求起作用。
拦截器可以访问action上下文、值栈里的对象，而过滤器不能访问。
在action的生命周期中，拦截器可以多次被调用，而过滤器只能在容器初始化时被调用一次。
拦截器可以获取IOC容器中的各个bean，而过滤器就不行，这点很重要，在拦截器里注入一个service，可以调用业务逻辑。

三、触发时机

过滤器是在请求进入容器后，但请求进入servlet之前进行预处理的。请求结束返回也是，是在servlet处理完后，返回给前端之前。

3.1、图例

总结：过滤器包裹住servlet，servlet包裹住拦截器。

3.2、过滤器

过滤器是在请求进入tomcat容器后，但请求进入servlet之前进行预处理和servlet处理完后，返回给前端之前进行，理解上面这句话我们就可以知道，进入servlet之前，主要是两个参数：ServletRequest，ServletResponse

那我们得到这两个测试可以干哪些事呢？

我们可以通过ServletRequest得到HttpServletRequest,此时你就可以对请求或响应(Request、Response)那就可以对对web服务器管理的所有web资源。例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息、字符集统一等一些高级功能。
也可以对HttpServletResponse进行后处理

Filter的完整流程

Filter对用户请求进行预处理，接着将请求交给Servlet进行处理并生成响应，最后Filter再对服务器响应进行后处理。。它是随你的web应用启动而启动的，只初始化一次，以后就可以拦截相关请求，只有当你的web应用停止或重新部署的时候才销毁。（每次热部署后，都会销毁）

3.3、拦截器

拦截器中用于在某个方法或字段被访问之前，进行拦截然后，在之前或之后加入某些操作。比如日志，安全等。
一般拦截器方法都是通过动态代理的方式实现。可以通过它来进行权限验证，或者判断用户是否登陆，或者是像12306 判断当前时间是否是购票时间。

过滤器能做的事拦截器都能做，二拦截器做的事过滤器不一定做的了

3.4、监听器

用于监听servletContext、HttpSession和servletRequest等域对象的创建和销毁事件。监听域对象的属性发生修改的事件。用于在事件发生前、发生后做一些必要的处理。

使用场景

统计在线人数和在线用户
系统启动时加载初始化信息
统计网站访问量
记录用户访问路径。

四、spring boot如何整合使用

4.1、过滤器

启动类里面增加 @ServletComponentScan，进行扫描

@SpringBootApplication
@ServletComponentScan
public class SpringbootstudyApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringbootstudyApplication.class, args);
    }
}

新建一个Filter类，implements Filter，并实现对应的接口
@WebFilter 标记一个类为filter，被spring进行扫描，urlPatterns：拦截规则，支持正则
控制chain.doFilter的方法的调用，来实现是否通过放行不放行，web应用resp.sendRedirect("/index.html");场景：权限控制、用户登录(非前端后端分离场景)等

@WebFilter(urlPatterns = "/api/*", filterName = "loginFilter")
public class LoginFilter  implements Filter{
          
     /**
      * 容器加载的时候调用
      */
      @Override
      public void init(FilterConfig filterConfig) throws ServletException {
          System.out.println("拦截器进入========拦截器进入========");
      }
      
      /**
       * 请求被拦截的时候进行调用
       */
      @Override
      public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
          System.out.println("拦截中========拦截中========");

          HttpServletRequest hrequest = (HttpServletRequest)servletRequest;
          HttpServletResponseWrapper wrapper = new HttpServletResponseWrapper((HttpServletResponse) servletResponse);
          if(hrequest.getRequestURI().indexOf("/index") != -1 ||
                  hrequest.getRequestURI().indexOf("/asd") != -1 ||
                  hrequest.getRequestURI().indexOf("/online") != -1 ||
                  hrequest.getRequestURI().indexOf("/login") != -1
                  ) {
              filterChain.doFilter(servletRequest, servletResponse);
          }else {
              wrapper.sendRedirect("/login");
          }
          
      }

      /**
       * 容器被销毁的时候被调用
       */
      @Override
      public void destroy() {
          System.out.println("拦截器销毁========拦截器销毁========");
      }

}

4.2、监听器

@WebListener
public class RequestListener implements ServletRequestListener {

    @Override
    public void requestDestroyed(ServletRequestEvent sre) {
        // TODO Auto-generated method stub
        System.out.println("======销毁监听器========");
    }

    @Override
    public void requestInitialized(ServletRequestEvent sre) 				{
        System.out.println("======进入监听器========");
 }
}

4.3、拦截器

CustomWebMvcConfigurer主拦截器

1：添加@Configuration注解
2：实现WebMvcConfigurer接口

//主拦截器，根据拦截不同路径跳转不同自定义拦截器 （实现WebMvcConfigurer方法）
@Configuration
public class CustomWebMvcConfigurer implements WebMvcConfigurer  {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {

        registry.addInterceptor(new LoginIntercepter()).addPathPatterns("/api1/*/**");
        registry.addInterceptor(new TwoIntercepter()).addPathPatterns("/api2/*/**");
        
        //.excludePathPatterns("/api2/xxx/**"); //拦截全部 /*/*/**
        
        WebMvcConfigurer.super.addInterceptors(registry);
    }

}

LoginIntercepter子拦截器

public class LoginIntercepter implements HandlerInterceptor{

    /**
     * 进入controller方法之前
     */
    @Override
    public boolean preHandle(HttpServletRequest request,
            HttpServletResponse response, Object handler) throws Exception {
        System.out.println("LoginIntercepter------->preHandle");

//        String token = request.getParameter("access_token");
//        
//        response.getWriter().print("fail");
        
        return HandlerInterceptor.super.preHandle(request, response, handler);
    }

    /**
     * 调用完controller之后，视图渲染之前
     */
    @Override
    public void postHandle(HttpServletRequest request,
            HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {
        
        System.out.println("LoginIntercepter------->postHandle");
        
        HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
    }

    /**
     * 整个完成之后，通常用于资源清理
     */
    @Override
    public void afterCompletion(HttpServletRequest request,
            HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        System.out.println("LoginIntercepter------->afterCompletion");
        
        HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
    }
    
    
}

4.4、测试

浏览器访问：http://127.0.0.1:8092/api/hello
会跳转到

控制台启动项目时候会进入拦截器，访问时候会触发拦截器进行中和监听器。停止项目时候会触发拦截器销毁。

当浏览器访问：http://127.0.0.1:8092/api1/hello
或者 http://127.0.0.1:8092/api2/hello 分别会触发LoginIntercepter和TwoIntercepter拦截器

4.5、结论

由上面可得出结论，项目1、先触发拦截器进入，2、拦截器触发中，3、再进入监听器，4、接着触发拦截器，5、再销毁监听器，6、停止项目则停止拦截器

过滤器-->监听器-->拦截器

总结：

过滤器：用于属性甄别，对象收集（不可改变过滤对象的属性和行为）
监听器：用于对象监听，行为记录（不可改变监听对象的属性和行为）
拦截器：用于对象拦截，行为干预（可以改变拦截对象的属性和行为）

纯洁的麦田

SpringBoot实战 (十一) | 过滤器，监听器，拦截器

前言