在 Spring Boot 中,拦截器(Interceptor)是一种强大的组件,用于在请求处理的前后执行特定逻辑,例如日志记录、权限校验、性能监控等。它与 AOP 类似,但更专注于 Web 请求的拦截,且属于 Servlet 层的处理机制。
一、拦截器的核心概念与应用场景
核心概念:
- HandlerInterceptor:Spring 提供的拦截器接口,包含三个核心方法:
preHandle():请求处理前执行(控制器方法调用前)。postHandle():请求处理后执行(控制器方法调用后,但视图渲染前)。afterCompletion():整个请求完成后执行(视图渲染完成后)。
- 执行顺序:多个拦截器按注册顺序依次执行
preHandle(),逆序执行postHandle()和afterCompletion()。
典型应用场景:
- 日志记录:记录请求信息、执行时间。
- 权限校验:验证用户权限,拒绝未授权请求。
- 性能监控:统计接口响应时间。
- 参数预处理:统一处理请求参数(如编码转换)。
- 请求限流:限制请求频率,防止恶意攻击。
二、拦截器的实现步骤
1. 创建拦截器类,实现 HandlerInterceptor 接口
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
@Component
public class LogInterceptor implements HandlerInterceptor {
// 请求处理前执行
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
System.out.println("PreHandle: 请求路径=" + request.getRequestURI());
// 返回 true 表示继续执行后续流程,返回 false 则中断请求
return true;
}
// 请求处理后执行(视图渲染前)
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
ModelAndView modelAndView) {
System.out.println("PostHandle: 请求处理完成");
}
// 整个请求完成后执行(视图渲染后)
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
Object handler, Exception ex) {
System.out.println("AfterCompletion: 请求流程完全结束");
}
}
2. 注册拦截器,配置拦截路径
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 {
private final LogInterceptor logInterceptor;
public WebConfig(LogInterceptor logInterceptor) {
this.logInterceptor = logInterceptor;
}
@Override
public void addInterceptors(InterceptorRegistry registry) {
// 注册日志拦截器,拦截所有请求
registry.addInterceptor(logInterceptor)
.addPathPatterns("/**") // 拦截所有路径
.excludePathPatterns("/static/**", "/error"); // 排除静态资源和错误路径
}
}
三、拦截器的进阶用法
1. 权限校验拦截器
@Component
public class AuthInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
// 从请求头或 Session 中获取用户信息
String token = request.getHeader("Authorization");
// 校验 token 有效性(示例逻辑,实际需结合 JWT 或 Session)
if (token == null || !isValidToken(token)) {
response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
return false; // 拒绝请求
}
// 将用户信息存入请求属性,供后续流程使用
request.setAttribute("user", parseUserFromToken(token));
return true;
}
private boolean isValidToken(String token) {
// 实际项目中需验证 token 签名、过期时间等
return token.startsWith("Bearer ");
}
private User parseUserFromToken(String token) {
// 解析 token 中的用户信息
return new User("testUser");
}
}
注册配置:
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(authInterceptor)
.addPathPatterns("/api/**") // 拦截 API 路径
.excludePathPatterns("/api/login", "/api/register"); // 排除登录注册接口
}
2. 性能监控拦截器
@Component
public class PerformanceInterceptor implements HandlerInterceptor {
private final ThreadLocal<Long> startTime = new ThreadLocal<>();
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
startTime.set(System.currentTimeMillis());
return true;
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
Object handler, Exception ex) {
long elapsedTime = System.currentTimeMillis() - startTime.get();
startTime.remove(); // 防止内存泄漏
// 记录耗时超过 500ms 的请求
if (elapsedTime > 500) {
System.out.println("Slow request: " + request.getRequestURI() +
", time=" + elapsedTime + "ms");
}
}
}
3. 多拦截器执行顺序
@Override
public void addInterceptors(InterceptorRegistry registry) {
// 先注册的拦截器 preHandle 先执行,postHandle 后执行
registry.addInterceptor(new FirstInterceptor()).addPathPatterns("/**");
registry.addInterceptor(new SecondInterceptor()).addPathPatterns("/**");
}
// 执行顺序示例:
// FirstInterceptor.preHandle() → SecondInterceptor.preHandle()
// → Controller → SecondInterceptor.postHandle() → FirstInterceptor.postHandle()
// → SecondInterceptor.afterCompletion() → FirstInterceptor.afterCompletion()
四、拦截器与过滤器(Filter)的对比
| 特性 | 拦截器(Interceptor) | 过滤器(Filter) |
|---|---|---|
| 所属框架 | Spring MVC | Servlet 规范 |
| 执行时机 | 在 DispatcherServlet 之后,Controller 之前 / 之后 | 在 Servlet 容器接收请求后立即执行 |
| 使用场景 | 权限校验、日志记录、性能监控 | 字符编码处理、跨域设置、请求过滤 |
| 访问 Spring Bean | 可以(实现 Spring 接口) | 不可以(Servlet 规范组件) |
| 拦截范围 | 仅拦截 Spring 管理的请求(如 Controller) | 拦截所有请求(包括静态资源) |
| 接口类型 | HandlerInterceptor | javax.servlet.Filter |
五、注意事项与最佳实践
1. 线程安全问题
- 拦截器是单例(Singleton),避免在拦截器中使用实例变量存储请求相关数据。
- 使用
ThreadLocal存储线程私有数据(如上文的startTime),并在afterCompletion()中清理。
2. 异常处理
- 在
preHandle()中抛出异常会中断请求流程,需通过response设置错误响应。 - 建议统一异常处理,结合 Spring 的
@ControllerAdvice和@ExceptionHandler。
3. 性能优化
- 避免在拦截器中执行耗时操作,尤其是
preHandle(),可能阻塞请求处理。 - 对静态资源(如 CSS、JS)配置
excludePathPatterns,减少不必要的拦截。
4. 路径匹配规则
/**:匹配所有路径(包括子路径)。/*:匹配一级路径(如/user,但不匹配/user/1)。*.html:匹配扩展名(如/index.html)。
总结
Spring Boot 拦截器是处理 Web 请求的强大工具,通过实现 HandlerInterceptor 接口并注册到 WebMvcConfigurer,可以在请求处理的不同阶段插入自定义逻辑。其核心优势在于:
- 非侵入式增强:不修改原有代码即可添加功能。
- 细粒度控制:通过路径匹配精准拦截特定请求。
- 多拦截器协作:支持按顺序执行多个拦截器,实现复杂流程。
2583



被折叠的 条评论
为什么被折叠?



