【JavaWeb】一文搞懂Java过滤器与拦截器的区别

在这里插入图片描述

✅✅作者主页：🔗孙不坚1208的博客
🔥🔥精选专栏：🔗JavaWeb从入门到精通（持续更新中）
📋📋 本文摘要：本篇文章主要分享Java过滤器与拦截器的知识。

💞💞觉得文章还不错的话欢迎大家点赞👍➕收藏⭐️➕评论💬支持博主🤞
👉 👉你的一键三连是我更新的最大动力❤️❤️

一文搞懂Java过滤器与拦截器的区别

- 一、什么是过滤器与拦截器？
- - 1.1 过滤器（Filter）
  - 1.2 拦截器（Interceptor）
- 二、过滤器与拦截器的区别
- - 2.1 实现原理不同
  - 2.2 使用范围不同
  - 2.3 触发时机不同
  - 2.4 执行顺序不同
  - 2.5 控制执行顺序方式不同
- 三、过滤器与拦截器的实现
- - 3.1 过滤器实现
  - 3.2 拦截器实现

一、什么是过滤器与拦截器？

1.1 过滤器（Filter）

java过滤器指的是在java中起到过滤的作用的一个方法。可以在一个请求到达servlet之前，将其截取进行逻辑判断，然后决定是否放行到请求的servlet；也可以在一个response到达客户端之前，截取结果进行逻辑判断，然后决定是否允许返回给客户端。

filter（过滤器） 有如下几个种类（功能）：

用户授权的filter：filter负责判断用户是否有权限请求该页面。
给予过滤判断日志的filter：截取某个用户在本网站上的所有请求。
记录轨迹负责解码的filter：规定处理本次请求的解码方式。

需要注意的是，一个filter过滤器可以加在多个servlet控制器上，当然多个filter过滤器也是可以加在一个servlet控制器上的。

由此也是可以看出来，我们使用filter往往是对一些公共的操作进行处理。例如：判断用户权限，解码本次请求等。还比如，我们的web应用中某些页面是需要用户登录后才能访问的，以往我们都是在每个servlet页面加上判断控制，导致代码冗余。有了filter，我们可以定义一个实现了filter的过滤器，让需要判断是否登录的页面都加上这么一个过滤器，可以大大降低代码的冗余程度

1.2 拦截器（Interceptor）

java里的拦截器是动态拦截Action调用的对象，它提供了一种机制可以使开发者在一个Action执行的前后执行一段代码，也可以在一个Action执行前阻止其执行，同时也提供了一种可以提取Action中可重用部分代码的方式。

作用域：动态拦截Action调用的对象（也就是我们的controller层）

在实现上基于Java的反射机制，属于面向切面编程(AOP)的一种运用，AOP可参考 Spring AOP速查笔记。由于拦截器是基于web框架的调用，因此可以使用Spring的依赖注入(DI)进行一些业务操作，同时一个拦截器实例在一个controller生命周期之内可以多次调用。但是缺点是只能对controller请求进行拦截，对其他的一些比如直接访问静态资源的请求则没办法进行拦截处理。

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

2.1 实现原理不同

过滤器的实现基于回调函数
拦截器基于Java的反射机制【动态代理】实现。

2.2 使用范围不同

过滤器是Servlet的规范，需要实现javax.servlet.Filter接口，Filter使用需要依赖于Tomcat等容器。
拦截器是Spring组件，定义在org.springframework.web.servlet包下，由Spring容器管理【又有更加丰富的生缪那个周期处理方法，细粒度，且能够使用Spring中的资源】，不依赖Tomcat等容器。

2.3 触发时机不同

过滤器：对请求在进入后Servlet之前或之后进行处理。
拦截器：对请求在handler【Controller】前后进行处理。

2.4 执行顺序不同

执行顺序：Filter 处理中 -> Interceptor 前置 -> 我是controller -> Interceptor 处理中 -> Interceptor 处理后

当有两个过滤器或拦截器时：

过滤器：
每一次都将chain对象传入，达到最后接口回调的效果，类似函数的堆栈调用。

拦截器：
preHandle1 -> preHande2 -> 【Controller】 -> postHandle2 -> postHandle1 -> afterCompletion2 -> afterComplention1

preHandle按照注册顺序，后两个与注册顺序相反。

一个拦截器的preHandle为false，则之后的所有拦截器都不会执行。
一个拦截器的preHandle为true，则这个拦截器的triggerAfterCompletion一定会执行。
只有所有的拦截器preHandler都为true，也就是正常执行，postHandle才会执行。

2.5 控制执行顺序方式不同

实际开发过程中，会出现多个过滤器或拦截器同时存在的情况，不过，有时我们希望某个过滤器或拦截器能优先执行，就涉及到它们的执行顺序。

过滤器用@Order注解控制执行顺序，通过@Order控制过滤器的级别，值越小级别越高越先执行。

@Order(Ordered.HIGHEST_PRECEDENCE)
@Component
public class MyFilter2 implements Filter {}

拦截器默认的执行顺序，就是它的注册顺序，也可以通过Order手动设置控制，值越小越先执行。

@Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor2()).addPathPatterns("/**").order(2);
        registry.addInterceptor(new MyInterceptor1()).addPathPatterns("/**").order(1);
        registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**").order(3);
    }

三、过滤器与拦截器的实现

3.1 过滤器实现

过滤器的配置比较简单，直接实现Filter 接口即可，也可以通过@WebFilter注解实现对特定URL拦截，看到Filter 接口中定义了三个方法。

init() ：该方法在容器启动初始化过滤器时被调用，它在 Filter 的整个生命周期只会被调用一次。注意：这个方法必须执行成功，否则过滤器会不起作用。
doFilter() ：容器中的每一次请求都会调用该方法， FilterChain 用来调用下一个过滤器 Filter。
destroy()：当容器销毁过滤器实例时调用该方法，一般在方法中销毁或关闭资源，在过滤器 Filter 的整个生命周期也只会被调用一次

@Component
public class MyFilter implements Filter {
 
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

        System.out.println("Filter 前置");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {

        System.out.println("Filter 处理中");
        filterChain.doFilter(servletRequest, servletResponse);
    }

    @Override
    public void destroy() {

        System.out.println("Filter 后置");
    }
}

3.2 拦截器实现

拦截器它是链式调用，一个应用中可以同时存在多个拦截器Interceptor，一个请求也可以触发多个拦截器，而每个拦截器的调用会依据它的声明顺序依次执行。首先编写一个简单的拦截器处理类，请求的拦截是通过HandlerInterceptor 来实现，看到HandlerInterceptor 接口中也定义了三个方法。

preHandle() ：这个方法将在请求处理之前进行调用。注意：如果该方法的返回值为false ,将视为当前请求结束，不仅自身的拦截器会失效，还会导致其他的拦截器也不再执行。
postHandle()：只有在 preHandle() 方法返回值为true 时才会执行。会在Controller 中的方法调用之后，DispatcherServlet 返回渲染视图之前被调用。有意思的是：postHandle() 方法被调用的顺序跟 preHandle() 是相反的，先声明的拦截器 preHandle() 方法先执行，而postHandle()方法反而会后执行。
afterCompletion()：只有在 preHandle() 方法返回值为true 时才会执行。在整个请求结束之后， DispatcherServlet 渲染了对应的视图之后执行。

@Component
public class MyInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        System.out.println("Interceptor 前置");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

        System.out.println("Interceptor 处理中");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

        System.out.println("Interceptor 后置");
    }
}

将自定义好的拦截器处理类进行注册，并通过addPathPatterns、excludePathPatterns等属性设置需要拦截或需要排除的 URL。

@Configuration
public class MyMvcConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**");
        registry.addInterceptor(new MyInterceptor1()).addPathPatterns("/**");
    }
}