SpringBoot拦截器 上手指南

前言

首先说说拦截器与过滤器不同,不要搞混淆
它们的区别如下：

1. 拦截器是居于java的反射机制，而过滤器是基于函数回调
2. 拦截器不依赖与servlet容器，而过滤器依赖于service容器
3. 拦截器只能对action请求奏效，而过滤器可以对几乎所有的请求起作用
4. 拦截器可以访问action上下文、值栈里的对象，而过滤器不能访问
5. 在action的生命周期中，拦截器可以多次被调用，而过滤器只能在容器初始化时被调用一次

action请求： “action 就是一次请求，在程序中 初学者可以把它理解为一个后缀名为.action的请求路径”

开始

1. 创建一个控制层代码

@RequestMapping("/customer")
public class CustomerController {
    /**
     * 创建一个控制层代码
     * @return
     */
    @GetMapping("/test")
    public R queryPage() {
    	System.out.println("这是控制层代码1");
    }
}

2. 自定义拦截器

• 创建自定义类
• 实现接口HandlerInterceptor
• 重写HandlerInterceptor中的方法(三个)
  • preHandle：在业务处理器处理请求之前被调用，可以进行编码、安全控制、权限校验等处理
  • postHandle：在业务处理器处理请求执行完成后，生成视图之前执行
  • 在DispatcherServlet完全处理完请求后被调用，可用于清理资源等
• 注册拦截器，配置拦截规则

/**
 * 客户拦截器
 */
@Component
@Slf4j
public class CustomerInterceptor implements HandlerInterceptor {
 	@Autowired
    private RedisUtil redisUtil;
    /**
     * 在请求到达Controller控制器之前 通过拦截器执行一段代码
     * 如果方法返回true,继续执行后续操作
     * 如果返回false，执行中断请求处理，请求不会发送到Controller
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
   		log.info("----------进入拦截器----------");
    	log.infon("这是拦截器preHandle()方法");
    	//👇下面我将随便举例 使用
    	String token = request.getHeader("token");//从请求头中获取token
        if (token == null || !redisUtil.hasKey(token)) {
            response.setStatus(500);//可改变返回status
            log.info("==token不存在或已过期==");
            log.info("----------拦截器结束-------------");
            return false;
        }
        log.info("==token存在，结果true==");
        log.info("------------拦截器结束-------------");
        //👆仅供参考 根据业务自定义
        return true;
    }

    /**
     * 控制器之后，跳转前
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
    }

    /**
     * 跳转之后执行
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
    }
}

注册拦截器

import ...

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Autowired
    private CustomerInterceptor customerInterceptor;//注入自定义拦截器

    /**
     * 注册拦截器
     *
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        /**
         * addInterceptor 注册拦截器
         * addPathPatterns 配置拦截规则
         * excludePathPatterns 排除拦截路径
         */
        registry.addInterceptor(customerInterceptor)
                .addPathPatterns("/customer/test");
                //.excludePathPatterns("/customer/test2")
                //.addPathPatterns("/**");                
    }
}

也可以自定义多个拦截器，根据自己的实际情况决策·····