SpringBoot之HandlerInterceptor拦截器的使用

定义实现类

定义一个Interceptor非常简单方式也有几种，简单列举两种:

1. 类要实现Spring的HandlerInterceptor接口
2. 类继承实现了HandlerInterceptor接口的类，例如 已经提供的实现了HandlerInterceptor接口的抽象类HandlerInterceptorAdapter

这里使用的是第二种方法继承HandlerInterceptorAdapter

方法介绍

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

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

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

• preHandle： 在业务处理器处理请求之前被调用。预处理，可以进行编码、安全控制、权限校验等处理；
• postHandle: 在业务处理器处理请求执行完成后，生成视图之前执行。后处理（调用Service并返回ModelAndView，但未进行页面渲染）, 有机会修改ModelAndView；
• afterCompletion: 在DispatcherServlet完全处理完请求后被调用，可用于清理资源等。返回处理（已经渲染了页面）

拦截器实现

• TestFilter

package com.kenyang.filter;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * @ClassName TestFiler
 * @Description TODO
 * @Author Ken.Yang
 * @Date 2021/8/16 15:04
 */
public class TestFiler extends HandlerInterceptorAdapter {

    private final Logger logger = LoggerFactory.getLogger(TestFiler.class);
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
       logger.info("request请求地址path[{}] uri[{}]", request.getServletPath(), request.getRequestURI());
       //request.getHeader(String)  从请求头中获取数据
       //从请求头中获取用户token (登录凭证根据业务而定）
        Long userId = getUserId(request.getHeader("H-User-Token"));
        if (userId != null && checkAuth(userId,request.getRequestURI())){
            return true;
        }
        throw new Exception();
    }

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

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

    /**
     * 根据token获取用户ID
     * @param userToken
     * @return
     */
    private Long getUserId(String userToken){
        Long userId = null;
        return userId;
    }

    /**
     * 校验用户访问权限
     * @param userId
     * @param requestURI
     * @return
     */
    private boolean checkAuth(Long userId,String requestURI){
        return true;
    }

}

• 新建WebAppConfigurer实现WebMvcConfigurer接口

其实以前都是继承WebMvcConfiguerAdapter类 不过SpringBoot 2.0 以上

WebMvcConfigurerAdapter方法过时，有两种替代方案：

1. 继承WebMvcConfigurationSupport
2. 实现WebMvcConfigurer

但是继承WebMvcConfigurationSupport会让Spring-boot对mvc的自动配置失效。根据项目情况选择。现在大多数项目是前后端分离的，并没有对静态资源有自动配置的需求，所以继承WebMvcConfigurationSupport也未尝不可

public class WebAppConfigurer implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //可以添加多个
        registry.addInterceptor(new TestFiler()).addPathPatterns("/**");
    }
}

其实下面还有很多方法我这里就省略了，过滤器可以添加多个，可以指定Path，这里的/**是对所有的请求都做拦截