多个拦截器的执行顺序

本文介绍了Spring Boot中拦截器的概念和作用,包括用于Token验证、请求数据校验和用户权限校验等场景。示例展示了如何编写两个拦截器OneInterceptor和TwoInterceptor,并在Web配置文件中注入,实现对所有接口的拦截。通过测试接口调用,展示拦截器的执行顺序遵循注册时的顺序。最后提供了源代码的GitHub和GitEE地址供参考。

一、拦截器简介

1、拦截器定义

拦截器,请求的接口被访问之前,进行拦截然后在之前或之后加入某些操作。拦截是AOP的一种实现策略。 拦截器主要用来按照指定规则拒绝请求。

2、拦截器中应用

Token令牌验证
请求数据校验
用户权限校验
放行指定接口

二、多个拦截器用法

1、编写两个拦截器

自定义类实现HandlerInterceptor接口
1)OneInterceptor 拦截器

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
 * 拦截器一
 */
public class OneInterceptor implements HandlerInterceptor {
 private static final Logger LOGGER
 = LoggerFactory.getLogger(OneInterceptor.class.getName());
 @Override
 public boolean preHandle(HttpServletRequest request,
 HttpServletResponse response,
 Object o) throws Exception {
 String url =String.valueOf(request.getRequestURL()) ;
 LOGGER.info("1、url=="+url);
 // 放开拦截
 return true;
 }
 @Override
 public void postHandle(HttpServletRequest httpServletRequest,
 HttpServletResponse httpServletResponse,
 Object o, ModelAndView modelAndView) throws Exception {
 LOGGER.info("1、postHandle");
 }
 @Override
 public void afterCompletion(HttpServletRequest httpServletRequest,
 HttpServletResponse httpServletResponse,
 Object o, Exception e) throws Exception {
 LOGGER.info("1、afterCompletion");
 }
}

2)TwoInterceptor 拦截器

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/**
 * 拦截器二
 */
public class TwoInterceptor implements HandlerInterceptor {
 private static final Logger LOGGER
 = LoggerFactory.getLogger(TwoInterceptor.class.getName());
 @Override
 public boolean preHandle(HttpServletRequest request,
 HttpServletResponse response,
 Object o) throws Exception {
 String url =String.valueOf(request.getRequestURL()) ;
 LOGGER.info("2、url=="+url);
 // 放开拦截
 return true;
 }
 @Override
 public void postHandle(HttpServletRequest httpServletRequest,
 HttpServletResponse httpServletResponse,
 Object o, ModelAndView modelAndView) throws Exception {
 LOGGER.info("2、postHandle");
 }
 @Override
 public void afterCompletion(HttpServletRequest httpServletRequest,
 HttpServletResponse httpServletResponse,
 Object o, Exception e) throws Exception {
 LOGGER.info("2、afterCompletion");
 }
}

2、Web配置文件中注入拦截器

import com.boot.intercept.intercept.OneInterceptor;
import com.boot.intercept.intercept.TwoInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
/**
 * Web配置文件
 */
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
 public void addInterceptors(InterceptorRegistry registry) {
 // 拦截所有路径
 // 注册自定义两个拦截器
 registry.addInterceptor(new OneInterceptor()).addPathPatterns("/**");
 registry.addInterceptor(new TwoInterceptor()).addPathPatterns("/**");
 }
}

3、编写测试接口

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class InterceptController {
 @RequestMapping("/reqUrl")
 public String reqUrl (){
 return "success" ;
 }
}

4、访问测试接口

日志输出内容如下

intercept.OneInterceptor : 1、url==http://127.0.0.1:8005/reqUrl
intercept.TwoInterceptor : 2、url==http://127.0.0.1:8005/reqUrl
intercept.TwoInterceptor : 2、postHandle
intercept.OneInterceptor : 1、postHandle
intercept.TwoInterceptor : 2、afterCompletion
intercept.OneInterceptor : 1、afterCompletionla

拦截器的拦截顺序,是按照Web配置文件中注入拦截器的顺序执行的。

三、源代码地址

GitHub·地址
https://github.com/cicadasmile/spring-boot-base
GitEE·地址
https://gitee.com/cicadasmile/spring-boot-base
Spring MVC 中,多个拦截器执行顺序遵循一定的规则,这些规则与拦截器的配置顺序和其内部方法的调用机制密切相关。 当多个拦截器都实现放行操作时,其执行顺序如下: - `preHandle` 方法的执行顺序拦截器的配置顺序一致。例如,在配置文件中,如果第一个拦截器是 `FirstInterceptor`,第二个是 `SecondInterceptor`,则 `preHandle` 的执行顺序为 `FirstInterceptor.preHandle`,然后是 `SecondInterceptor.preHandle` [^2]。 - `postHandle` 方法的执行顺序拦截器的配置顺序相反。这意味着 `SecondInterceptor.postHandle` 会在 `FirstInterceptor.postHandle` 之前执行 [^1]。 - `afterCompletion` 方法的执行顺序也与拦截器的配置顺序相反,即 `SecondInterceptor.afterCompletion` 会在 `FirstInterceptor.afterCompletion` 之前执行 [^1]。 这种执行顺序的设计是为了确保拦截器能够按照预期对请求和响应进行处理。例如,`preHandle` 方法通常用于在请求处理之前进行某些操作,如日志记录或权限检查,而 `postHandle` 和 `afterCompletion` 方法则用于在请求处理之后进行清理或后续处理。 ### 示例代码 以下是一个简单的拦截器实现示例: ```java public class FirstInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println("FirstInterceptor preHandle"); return true; // 返回true表示继续执行下一个拦截器或目标方法 } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { System.out.println("FirstInterceptor postHandle"); } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { System.out.println("FirstInterceptor afterCompletion"); } } ``` ```java public class SecondInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println("SecondInterceptor preHandle"); return true; // 返回true表示继续执行下一个拦截器或目标方法 } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { System.out.println("SecondInterceptor postHandle"); } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { System.out.println("SecondInterceptor afterCompletion"); } } ``` 在配置文件中,这两个拦截器的配置顺序如下: ```xml <mvc:interceptors> <mvc:interceptor> <mvc:mapping path="/**"/> <bean class="com.example.FirstInterceptor"/> </mvc:interceptor> <mvc:interceptor> <mvc:mapping path="/**"/> <bean class="com.example.SecondInterceptor"/> </mvc:interceptor> </mvc:interceptors> ``` 根据上述配置,当请求到达时,控制台将输出以下内容: ``` FirstInterceptor preHandle SecondInterceptor preHandle SecondInterceptor postHandle FirstInterceptor postHandle SecondInterceptor afterCompletion FirstInterceptor afterCompletion ``` ### 总结 拦截器执行顺序Spring MVC 框架设计的一部分,确保了请求和响应的处理能够按照预期进行。理解这些规则对于开发人员来说非常重要,尤其是在需要对请求进行预处理和后处理的情况下。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值