Spring Boot 拦截器 HandlerInterceptor的使用以及WebMvcConfigurer简单介绍

Spring Boot中的HandlerInterceptor可以用来在控制器方法执行前后进行一些操作，比如权限校验、日志记录等。

以下是一个简单的HandlerInterceptor实现示例：

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
 
@Component
public class CustomInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        // 在请求处理之前进行调用（Controller方法调用之前）
        System.out.println("Pre Handle");
        return true; // 如果返回false，则停止流程，api不会被调用
    }
 
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
        // 请求处理之后进行调用，但是在视图被渲染之前（Controller方法调用之后）
        System.out.println("Post Handle");
    }
 
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        // 在整个请求结束之后调用，也就是在DispatcherServlet渲染了视图执行
        System.out.println("After Completion");
    }
}

为了让Spring Boot识别并应用这个拦截器，你需要定义一个WebMvcConfigurer并添加这个拦截器：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
 
@Configuration
public class WebConfig implements WebMvcConfigurer {
 
    @Autowired
    private CustomInterceptor customInterceptor;
 
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 添加拦截器，并设置拦截路径
        registry.addInterceptor(customInterceptor)
                .addPathPatterns("/**"); // 所有路径都被拦截
                //.excludePathPatterns("/login", "/error"); // 排除某些路径
    }
}

这样配置后，每次请求都会经过CustomInterceptor中定义的方法，你可以在preHandle方法中进行权限校验