拦截器Intercepteor

一、拦截器介绍

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

作用：拦截请求，在指定的方法前后，根据业务需要执行预先设定的代码

• preHandler：前置拦截器，会在目标方法之前执行，返回true放行，返回false不放行
• postHandle：后置拦截器，会在目标方法执行完且不抛异常才能正常执行
• afterCompletion：视图渲染完毕后执行，最后执行，无论目标方法是否抛出异常都会执行

二、拦截器的基本使用

1. 创建拦截器，实现HandlerInterceptor接口，重写其所有方法

   public class MyInterceptor implements HandlerInterceptor {
       @Override //目标方法运行之前运行
       public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
           return false;
       }
   
       @Override  //目标方法运行之前运行
       public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
   
       }
   
       @Override  //视图渲染之后运行，最后运行
       public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
   
       }
   }
   

2. 在类上加@Component注解

3. 在配置类中注册这个拦截器，指定拦截路径

   @Configuration
   public class MyConfigration extends WebMvcConfigurationSupport {
   
       @Autowired
       private MyInterceptor myInterceptor;//自定义的拦截器对象
   
       @Override
       protected void addInterceptors(InterceptorRegistry registry) {  //在配置类中注册拦截器
           registry.addInterceptor(myInterceptor)//表示注册拦截器
               .addPathPatterns("/**")// /**表示全部拦截
               //说明：/*只能匹配一级路径，/**可以匹配任意级路径
           	 ..excludePathPatterns("/login");//表示不拦截哪些请求路径
       }
   }
   

4. 在拦截器中设置具体逻辑，进行放行和不放行

三、拦截器的执行流程

四、拦截器的使用案例【JWT校验】

@Component
@Slf4j
public class JwtTokenAdminInterceptor implements HandlerInterceptor {

    @Autowired
    private JwtProperties jwtProperties;
    
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //判断当前拦截到的是Controller的方法还是其他资源
        if (!(handler instanceof HandlerMethod)) {
            //当前拦截到的不是动态方法，直接放行
            return true;
        }

        //1、从请求头中获取令牌
        String token = request.getHeader(jwtProperties.getAdminTokenName());

        //2、校验令牌
        try {
            log.info("jwt校验:{}", token);
            Claims claims = JwtUtil.parseJWT(jwtProperties.getAdminSecretKey(), token);
            Long empId = Long.valueOf(claims.get(JwtClaimsConstant.EMP_ID).toString());
            //将当前管理原id放到threadlocal中，存、改员工信息的时候用
            BaseContext.setCurrentId(empId);
            log.info("当前员工id：", empId);
            //3、通过，放行
            return true;
        } catch (Exception ex) {
            //4、不通过，响应401状态码
            response.setStatus(401);
            return false;
        }
    }
}