【与众不同】详细讲解过滤器和拦截器

这篇文章详细讲解了过滤器和拦截器的执行过程以及原理，并且有图片和代码进行解释和实现，让你更轻松的掌握这两种技术！！！

制作不易，如果感觉不错的话，点赞加收藏哟！！！

---

目录

1.  Filter过滤器

1.1  什么是Filter？

1.2  Filter快速入门程序掌握过滤器的基本使用操作

1.3  过滤器方法

1.4  注意事项

1.5  过滤器的执行流程(放行前的逻辑-->放行-->Web资源-->放行后的资源)

1.6  过滤路径设置

1.7  过滤器链(Filter1前->Filter2前->web资源->Filter2后->Filter2前->响应数据给浏览器)

1.8  过滤器实现

2.  Interceptor拦截器

2.1  什么是拦截器？

2.2  拦截器的作用

2.3  注意事项

2.4  拦截器的使用步骤和过滤器类似，也分为两步

2.5  拦截路径问题

2.6  拦截路径设置

2.7  执行流程(通过执行流程，大家就能够清晰的知道过滤器与拦截器的执行时机)

3.  过滤器和拦截器之间的区别

---

让你彻底认识Cookie、Session、令牌技术https://blog.csdn.net/2301_77358195/article/details/137049985

麒麟而非淇淋，不是干货不制作https://blog.csdn.net/2301_77358195

1.  Filter过滤器

1.1  什么是Filter？

Filter表示过滤器，是 JavaWeb三大组件(Servlet、Filter、Listener)之一。过滤器可以把对资源的请求拦截下来，从而实现一些特殊的功能使用了过滤器之后，要想访问web服务器上的资源，必须先经过滤器，过滤器处理完毕之后，才可以访问对应的资源。过滤器一般完成一些通用的操作，
比如：登录校验、统一编码处理、敏感字符处理等。

1.2  Filter快速入门程序掌握过滤器的基本使用操作

①.定义过滤器 ：定义一个类，实现 Filter 接口，并重写所有方法.

②.配置过滤器：Filter类上加 @WebFilter 注解，配置拦截资源的路径。引导类上加@ServletComponentScan会自动扫描@WebFilter， 开启Servlet组件支持。

1.3  过滤器方法

①.init方法：过滤器的初始化方法。在web服务器启动的时候会自动的创建Filter过滤器对象，在创建过滤器对象的时候会自动调用init初始化方法，这个方法只会被调用一次。

②.doFilter方法：这个方法是在每一次拦截到请求之后都会被调用，所以这个方法是会被调用多次的，每拦截到一次请求就会调用一次doFilter()方法。

③.destroy方法： 是销毁的方法。当我们关闭服务器的时候，它会自动的调用销毁方法destroy，而这个销毁方法也只会被调用一次。

1.4  注意事项

①.在过滤器Filter中，如果不执行放行操作，将无法访问后面的资源。 放行操作：chain.doFilter(request, response);

②.需要注意的是如果放行了，就直接return; 不需要继续执行下面的代码

1.5  过滤器的执行流程(放行前的逻辑-->放行-->Web资源-->放行后的资源)

①.过滤器当中我们拦截到了请求之后，如果希望继续访问后面的web资源，就要执行放行操作，放行就是调用 FilterChain对象当中的doFilter()方法，在调用doFilter()这个方法之前所编写的代码属于放行之前的逻辑。

②.在放行后访问完 web 资源之后还会回到过滤器当中，回到过滤器之后如有需求还可以执行放行之后的逻辑，放行之后的逻辑我们写在doFilter()这行代码之后

1.6  过滤路径设置

拦截具体路径：/login ，只有访问 /login 路径时，才会被拦截
目录拦截：/emps/* ， 访问/emps下的所有资源，都会被拦截
拦截所有：/* ，访问所有资源，都会被拦截

1.7  过滤器链(Filter1前->Filter2前->web资源->Filter2后->Filter2前->响应数据给浏览器)

①.所谓过滤器链指的是在一个web应用程序当中，可以配置多个过滤器，多个过滤器就形成了一个过滤器链。
比如：在我们web服务器当中，定义了两个过滤器，这两个过滤器就形成了一个过滤器链。而这个链上的过滤器在执行的时候会一个一个的执行，会先执行第一个Filter，放行之后再来执行第二个Filter，如果执行到了最后一个过滤器放行之后，才会访问对应的web资源。访问完web资源之后，就会执行第二个Filter放行后的逻辑，然后再到第一个Filter放行后的逻辑，最后在给浏览器响应数据

②.过滤器顺序问题
大家发现AbcFilter先执行DemoFilter后执行，这是为什么呢？
其实是和过滤器的类名有关系。以注解方式配置的Filter过滤器，它的执行优先级是按时过滤器类名的，自动排序确定的，类名排名越靠前，优先级越高。
假如我们想让DemoFilter先执行，怎么办呢？答案就是修改类名。修改AbcFilter类名为XbcFilter

1.8  过滤器实现

/**
*1. 获取请求url
*2. 判断请求url中是否包含login，如果包含，说明是登录操作，放行，才能去访问web资源查找数据库
*3. 获取请求头中的令牌（token）
*4. 判断令牌是否存在，如果不存在，返回错误结果（未登录）
*5. 解析token，如果解析失败，返回错误结果（未登录）
*6. 放行
*/

//从发送过来的请求，在根据username和password查询对应的用户信息，登录成功就给令牌设置校验信息，然后下发令牌
    if(emp1 != null){
            Map<String, Object> claims = new HashMap<>();
            claims.put("id",emp1.getId());
            claims.put("name",emp1.getName());
            claims.put("username",emp1.getUsername());
            //下发令牌
            String jwt = JwtUtils.generateJwt(claims);//包含登录的信息
            return Result.success(jwt);
        }


然后在过滤器
//3.获取请求头令牌(token)
        String jwt = req.getHeader("token");

//4.判断令牌是否存在，如果不存在，返回错误结果（未登录）
            if(!StringUtils.hasLength(jwt)){//StringUtils.hasLength(jwt)判断是否为'',或者null
            log.info("请求头token为null或者'',返回未登录的信息");
            Result error = Result.error("NOT_LOGIN");
            //手动转换 对象--json ---->阿里巴巴（fastjson）
            String notlogin = JSONObject.toJSONString(error);
            resp.getWriter().write(notlogin);
            return;
        }

//5.解析令牌token,如果解析失败，返回错误结果（未登录）
        try {
            //只要有报错就是解析异常
            JwtUtils.parseJWT(jwt);
        }  catch (Exception e) {
            e.printStackTrace();
            log.info("解析登录信息失败,返回错误登录信息");
            Result error = Result.error("NOT_LOGIN");
            //手动转换 对象--json ---->阿里巴巴（fastjson）
            String notlogin = JSONObject.toJSONString(error);
            resp.getWriter().write(notlogin);
            return;
        }

//6.放行
        log.info("令牌合法，放行");
        filterChain.doFilter(servletRequest,servletResponse);

      
                                

2.  Interceptor拦截器

2.1  什么是拦截器？

是一种动态拦截方法调用的机制，类似于过滤器。拦截器是Spring框架中提供的，用来动态拦截控制器方法的执行。

2.2  拦截器的作用

拦截请求，在指定方法调用前后，根据业务需要执行预先设定的代码。
在拦截器当中，我们通常也是做一些通用性的操作，比如：我们可以通过拦截器来拦截前端发起的请求，将登录校验的逻辑全部编写在拦截器当中。在校验的过程当中，如发现用户登录了(携带JWT令牌且是合法令牌)，就可以直接放行，去访问spring当中的资源。如果校验时发现并没有登录或是非法令牌，就可以直接给前端响应未登录的错误信息。

2.3  注意事项

①.preHandle方法：目标资源方法执行前执行。 返回true：放行， 返回false：不放行
②.postHandle方法：目标资源方法执行后执行
③.afterCompletion方法：视图渲染完毕后执行，最后执行

2.4  拦截器的使用步骤和过滤器类似，也分为两步

①. 定义拦截器(自定义拦截器：实现HandlerInterceptor接口，并重写其所有方法，该类需要加@Component注解)

②. 注册配置拦截器(实现WebMvcConfigurer接口，并重写addInterceptors方法)

@Configuration
public class WebConfig implements WebMvcConfigurer {
    //自定义的拦截器对象
    @Autowired
    private LoginCheckInterceptor loginCheckInterceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
    //注册自定义拦截器对象
    registry.addInterceptor(loginCheckInterceptor).addPathPatterns("/**");//设置拦截器拦截的请求路径（ /** 表示拦截所有请求）
     }
}

2.5  拦截路径问题

①.在注册配置拦截器的时候，通过 addPathPatterns("要拦截路径") 方法，就可以指定要拦截哪些资源。

②.还可以指定不拦截哪些资源，只需要调用 excludePathPatterns("不拦截路径") 方法，指定哪些资源不需要拦截。

2.6  拦截路径设置

①./*            表示一级路径           能匹配/depts，/emps，/login，不能匹配/depts/1
②./**            任意级路径            能匹配/depts，/depts/1，/depts/1/2
③./depts/*         /depts下的一级路径        能匹配/depts/1，不能匹配/depts/1/2，/depts
④./depts/**        /depts下的任意级路径    能匹配/depts，/depts/1，/depts/1/2，不能匹配/emps/1

2.7  执行流程(通过执行流程，大家就能够清晰的知道过滤器与拦截器的执行时机)

①.打开浏览器来访问在web服务器的web资源时，此时我们所定义的过滤器会拦截到这次请求。拦截到这次请求之后，它会先执行放行前的逻辑，然后再执行放行操作该程序基于springboot开发的，所以放行之后是进入到了spring的环境当中，也就是要来访问我们所定义的controller当中的接口方法。

②.Tomcat并不识别所编写的Controller程序，但是它识别Servlet程序，所以在Spring的Web环境中提供了一个非常核心的Servlet：DispatcherServlet（前端控制器），所有请求都会先进行到DispatcherServlet，再将请求转给Controller 

③.当我们定义了拦截器后，会在执行Controller的方法之前，请求被拦截器拦截住。执行preHandle() 方法，这个方法执行完成后需要返回一个布尔类型的值，如果返回true，就表示放行本次操作，才会继续访问controller中的方法；如果返回false，则不会放行（controller中的方法也不会执行）。

④.在controller当中的方法执行完毕之后，再回过来执行 postHandle() 这个方法以及afterCompletion() 方法，然后再返回给DispatcherServlet，最终再来执行过滤器当中放行后的这一部分逻辑的逻辑。执行完毕之后，最终给浏览器响应数据。

3.  过滤器和拦截器之间的区别

其实它们之间的区别主要是两点：
①.口规范不同：过滤器需要实现Filter接口，而拦截器需要实现HandlerInterceptor接口。

②.截范围不同：过滤器Filter会拦截所有的资源，而Interceptor只会拦截Spring环境中的资
源。