Spring MVC 中请求拦截机制的实现与对比
在 Java Web 开发中,对 HTTP 请求进行统一处理的需求普遍存在,例如日志记录、权限校验、性能监控等。Servlet 规范提供了 Filter 接口,而 Spring 框架则进一步封装了更细粒度的 HandlerInterceptor。二者虽目标相似,但在执行时机、作用范围和扩展能力上存在本质差异。
核心区别简析
- Filter:属于 Servlet 容器层级,基于责任链模式,在请求进入 DispatcherServlet 前后执行,可访问原始
ServletRequest/ServletResponse,但无法直接获取 Spring 的 Handler 方法或 Model 数据。 - HandlerInterceptor:运行于 Spring MVC 框架内部,提供
preHandle(控制器方法前)、postHandle(视图渲染前)、afterCompletion(整个流程结束后)三个钩子,天然支持依赖注入与上下文感知。
基于 Spring Boot 的拦截器实战
以下示例构建一个轻量级请求追踪拦截器,用于统计接口响应耗时并打印关键路径信息。
项目结构概览
request-tracing-demo/
├── src/main/java/com/example/tracing/
│ ├── TracingInterceptor.java <!-- 自定义拦截器 -->
│ ├── GreetingController.java <!-- REST 控制器 -->
│ ├── MvcConfig.java <!-- MVC 配置类 -->
│ └── DemoApplication.java <!-- 启动类 -->
└── pom.xml
Maven 依赖配置(精简版)
仅引入 Spring Boot Web Starter,无需额外声明版本管理(由 parent POM 统一控制):
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
自定义拦截器(TracingInterceptor.java)
该拦截器在请求开始时记录时间戳,并在响应完成后计算并输出耗时及 URI 路径:
package com.example.tracing;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
@Component
public class TracingInterceptor implements HandlerInterceptor {
private static final String START_TIME_ATTR = "startTime";
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
long startTime = System.currentTimeMillis();
request.setAttribute(START_TIME_ATTR, startTime);
return true;
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
Object handler, Exception ex) {
Long startTime = (Long) request.getAttribute(START_TIME_ATTR);
if (startTime != null) {
long duration = System.currentTimeMillis() - startTime;
String uri = request.getRequestURI();
int status = response.getStatus();
System.out.printf("[TRACE] %s | %d ms | %d%n", uri, duration, status);
}
}
}
控制器示例(GreetingController.java)
package com.example.tracing;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/api")
public class GreetingController {
@GetMapping("/greet")
public ResponseEntity<String> greet() {
return ResponseEntity.ok("Welcome to Spring MVC!");
}
}
MVC 配置类(MvcConfig.java)
注册拦截器并限定其生效路径为 /api/**:
package com.example.tracing;
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 MvcConfig implements WebMvcConfigurer {
@Autowired
private TracingInterceptor tracingInterceptor;
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(tracingInterceptor)
.excludePathPatterns("/actuator/**") // 忽略健康检查端点
.addPathPatterns("/api/**");
}
}
启动与验证
执行 mvn spring-boot:run 启动应用后,访问 http://localhost:8080/api/greet,控制台将输出类似:
[TRACE] /api/greet | 12 ms | 200
表明拦截器已成功介入请求生命周期。