全面了解SpringBoot拦截器

Spring Boot 拦截器（Interceptor）是面向切面编程（AOP）的一种实现，用于在 Controller 处理前后进行一些特殊的处理。

创建拦截器需要实现 HandlerInterceptor 接口。

以下是一个简单的 Spring Boot 拦截器的示例：

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

然后需要将拦截器注册到 Spring MVC 框架中：

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
    SimpleInterceptor simpleInterceptor;
 
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 添加拦截器
        registry.addInterceptor(simpleInterceptor)
                .addPathPatterns("/**"); // 拦截所有请求
                //.excludePathPatterns("/login"); // 排除某些请求
    }
}

在这个例子中，我们创建了一个简单的拦截器，它实现了 HandlerInterceptor 接口，并重写了 preHandle、postHandle 和 afterCompletion 方法。然后通过一个配置类将其注册到 Spring MVC 中，并且指定了需要拦截的路径。