详解Spring 拦截器流程及多个拦截器的执行顺序

更新时间：2021年05月06日 11:10:46 作者：码农UP2U

这篇文章主要介绍了Spring 拦截器流程及多个拦截器的执行顺序的相关资料，帮助大家更好的理解和学习使用Spring框架，感兴趣的朋友可以了解下

拦截器的定义

SpringMVC 的拦截器只需要实现 HandlerInterceptor 接口，并进行配置即可。HandlerInterceptor 接口的定义如下：

public interface HandlerInterceptor {
    default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        return true;
    }

    default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
    }

    default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
    }
}

在 HandlerInterceptor 中共有三个方法，每个方法的含义如下：

preHandler：进入请求方法之前执行；

postHandler：请求方法执行完成之后执行；

afterCompletion：视图渲染后执行。

拦截器的执行流程

在 preHandle 方法中，它的返回值是 boolean 类型的，它的返回值影响着请求方法，以及 postHandle 和 afterCompletion 的执行。具体如下。

也就是说，在 preHandle 中如果返回 false，那么后续的流程将不被执行，这可能也是拦截器命名的由来。

测试拦截器

写一个简单拦截器，代码如下：

@Slf4j
public class TestInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        log.info("preHandler");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("postHandler");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.info("afterCompletion");
    }
}

创建了一个 TestInterceptor 的监听器类，它实现了 HandlerInterceptor 的所有接口。写完 TestInterceptor 还需要进行注册。代码如下：

@Configuration
public class InterceptorConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(testInterceptor());
    }

再来写一个简单的请求方法，代码如下：

@GetMapping("test")
public String test()
{
    return "test";
}

来启动我们的项目，并进行访问，控制台的输出如下：

2021-05-05 16:02:08.110  INFO 88509 --- [nio-8081-exec-6] com.example.demo.TestInterceptor         : preHandler
2021-05-05 16:02:08.111  INFO 88509 --- [nio-8081-exec-6] com.example.demo.TestInterceptor         : postHandler
2021-05-05 16:02:08.111  INFO 88509 --- [nio-8081-exec-6] com.example.demo.TestInterceptor         : afterCompletion

多个拦截器的执行顺序

我们来写多个相同的监听器，分别是 TestInterceptor、TestInterceptor2 和 TestInterceptor3。然后我们进行注册，注册代码如下：

@Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(testInterceptor());
    registry.addInterceptor(testInterceptor2());
    registry.addInterceptor(testInterceptor3());
}

请求我们的方法，输出如下：

2021-05-05 16:09:57.735  INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor         : preHandler
2021-05-05 16:09:57.736  INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor2        : preHandler2
2021-05-05 16:09:57.736  INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor3        : preHandler3
2021-05-05 16:09:57.755  INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor3        : postHandler3
2021-05-05 16:09:57.755  INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor2        : postHandler2
2021-05-05 16:09:57.755  INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor         : postHandler
2021-05-05 16:09:57.755  INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor3        : afterCompletion3
2021-05-05 16:09:57.755  INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor2        : afterCompletion2
2021-05-05 16:09:57.755  INFO 88572 --- [nio-8081-exec-1] com.example.demo.TestInterceptor         : afterCompletion

注意观察输出的顺序，preHandle 方法是按注册顺序进行执行的，而 postHandle 和 afterCompletion 跟注册顺序是相反的。

让 preHandle 进行拦截

我们让 TestInterceptor2 的 preHandle 返回值为 false，然后查看一下输出内容。

2021-05-05 16:14:00.997  INFO 88582 --- [nio-8081-exec-1] com.example.demo.TestInterceptor         : preHandler
2021-05-05 16:14:00.998  INFO 88582 --- [nio-8081-exec-1] com.example.demo.TestInterceptor2        : preHandler2
2021-05-05 16:14:00.998  INFO 88582 --- [nio-8081-exec-1] com.example.demo.TestInterceptor         : afterCompletion

可以看到，TestInterceptor2 的 preHandle 的返回值为 false 以后，相当于在 TestInterceptor2 的 preHandle 后续流程则不再继续执行了。

我们调整一下注册的顺序，代码如下：

@Override
public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(testInterceptor2());
    registry.addInterceptor(testInterceptor());
    registry.addInterceptor(testInterceptor3());
}

修改顺序后的输出如下：

2021-05-05 16:17:23.956  INFO 88589 --- [nio-8081-exec-1] com.example.demo.TestInterceptor2        : preHandler2

可以看到它后面的流程都被拦截了，没有机会执行了。

总结

拦截器是使用一个 List 进行保存，我们可以在项目中添加多个拦截器来完成不同的功能，比如可以进行 Token 的验证，权限的获取等。我们可以放到不同的拦截器中来进行相关的操作。

以上就是详解Spring 拦截器流程及多个拦截器的执行顺序的详细内容，更多关于Spring 拦截器的资料请关注脚本之家其它相关文章！

您可能感兴趣的文章:

JAVA开发环境Vs code配置步骤详解
这篇文章主要为大家介绍了JAVA开发环境Vs code配置步骤详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-04-04
IDEA里找不到Maven的有效解决办法(小白超详细)
这篇文章主要给大家介绍了关于IDEA里找不到Maven的有效解决办法,文中通过图文将解决的办法介绍的非常详细,对大家的学习或者工作具有一定的参考借鉴价值,需要的朋友可以参考下
2023-07-07
java及C++中传值传递、引用传递和指针方式的理解
为什么 Java 只有值传递，但 C++ 既有值传递，又有引用传递呢？今天我们就来探讨下这个问题，有需要的朋友可以参考下
2014-09-09
详解springboot的三种启动方式
这篇文章主要介绍了详解springboot的三种启动方式，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-06-06
SpringBoot实现上传文件到AWS S3的代码
这篇文章主要介绍了SpringBoot实现上传文件到AWS S3的代码，帮助大家更好的理解和使用springboot框架，感兴趣的朋友可以了解下
2020-10-10
Java处理不可见特殊字符要点解析
这篇文章主要介绍了Java处理不可见特殊字符要点解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-11-11
SpringBoot+Redis+Lua分布式限流的实现
本文主要介绍了SpringBoot+Redis+Lua分布式限流的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2022-08-08
Java中RabbitMQ的几种消息确认机制
RabbitMQ消息确认机制指的是在消息传递过程中,发送方发送消息后,接收方需要对消息进行确认,以确保消息被正确地接收和处理,本文主要介绍了Java中RabbitMQ的几种消息确认机制,具有一定的参考价值,感兴趣的可以了解一下
2023-12-12
Spring Boot2发布调用REST服务实现方法
这篇文章主要介绍了Spring Boot2发布调用REST服务实现方法,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-04-04
详解spring boot使用@Retryable来进行重处理
本篇文章主要介绍了详解spring boot使用@Retryable来进行重处理，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-06-06