本文纲要
- 拦截器概念
- 拦截器与过滤器的区别
- 拦截器入门案例
项目结构
第一步:编写拦截器类
第二步:配置拦截器
启动测试与流程分析 - 拦截器方法参数详解
- 拦截器链配置与执行顺序
配置多个拦截器
执行顺序规则
中断场景分析 - 总结
拦截器概念
Spring MVC 拦截器(Interceptor)是一种动态拦截请求调用的机制,它可以在控制器(Controller)方法执行的前后插入自定义逻辑。功能主要包括:
- 在方法执行前后增加通用处理(如日志记录、权限校验、性能监控等)
- 根据条件决定是否放行请求,可以终止原始方法的执行
在传统的 Java Web 架构中,请求首先到达 Tomcat 容器,然后经由过滤器(Filter)链,最终进入 Spring MVC 的中央控制器(DispatcherServlet)分发到具体的 Controller。
拦截器就工作在 Spring MVC 体系内,靠近 Controller 执行的前后位置,因此它可以便捷地使用 Spring 容器中的各种资源。
拦截器与过滤器的区别
| 对比维度 | 过滤器(Filter) | 拦截器(Interceptor) |
|---|---|---|
| 归属技术 | Servlet 规范的一部分 | Spring MVC 提供的组件 |
| 作用范围 | 可拦截所有进入 Web 容器的请求(包括静态资源) | 仅拦截进入 Spring MVC 的请求(由 DispatcherServlet 处理) |
| 配置方式 | 在 web.xml 中配置或通过 @WebFilter 注解 | 在 Spring MVC 配置类中注册 |
| 生命周期 | 由 Servlet 容器管理 | 由 Spring 容器管理,可以注入其他 Bean |
| 执行顺序 | 基于配置顺序,执行链可以包装请求/响应 | 通过配置顺序形成拦截器链,前置顺序依次执行,后置和完成顺序反向 |
拦截器入门案例
1 )项目结构
springmvc_12_interceptor
├── pom.xml
└── src
└── main
└── java
└── com.wb
├── config
│ ├── ServletContainersInitConfig.java
│ ├── SpringMvcConfig.java
│ └── SpringMvcSupport.java
├── controller
│ ├── BookController.java
│ └── interceptor
│ ├── ProjectInterceptor.java
│ └── ProjectInterceptor2.java
└── domain
└── Book.java
2 ) 第一步:编写拦截器类
实现 HandlerInterceptor 接口,并覆盖其三个方法。该类需受 Spring 容器管理,通常使用 @Component 注解。
package com.wb.controller.interceptor;
import org.springframework.stereotype.Component;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@Component
public class ProjectInterceptor implements HandlerInterceptor {
@Override
// 原始方法调用前执行,返回值决定是否放行
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
String contentType = request.getHeader("Content-Type");
HandlerMethod hm = (HandlerMethod) handler;
System.out.println("preHandle..." + contentType);
return true; // 返回 true 放行,false 则终止后续操作
}
@Override
// 原始方法调用后执行(在视图渲染之前)
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("postHandle...");
}
@Override
// 原始方法调用完成后执行(视图渲染之后)
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("afterCompletion...");
}
}
3 ) 第二步:配置拦截器
有两种常见配置方式:
方式一:实现 WebMvcConfigurer 接口(推荐,代码侵入性较强但简洁)
package com.wb.config;
import com.wb.controller.interceptor.ProjectInterceptor;
import com.wb.controller.interceptor.ProjectInterceptor2;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
@Configuration
@ComponentScan({"com.wb.controller"})
@EnableWebMvc
public class SpringMvcConfig implements WebMvcConfigurer {
@Autowired
private ProjectInterceptor projectInterceptor;
@Autowired
private ProjectInterceptor2 projectInterceptor2;
@Override
public void addInterceptors(InterceptorRegistry registry) {
// 配置拦截器并指定拦截路径
registry.addInterceptor(projectInterceptor).addPathPatterns("/books", "/books/*");
registry.addInterceptor(projectInterceptor2).addPathPatterns("/books", "/books/*");
}
}
方式二:继承 WebMvcConfigurationSupport(可自定义更多底层配置)
package com.wb.config;
import com.wb.controller.interceptor.ProjectInterceptor;
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.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {
@Autowired
private ProjectInterceptor projectInterceptor;
@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/pages/").addResourceLocations("/pages/");
}
@Override
protected void addInterceptors(InterceptorRegistry registry) {
// 配置拦截器并指定拦截路径
registry.addInterceptor(projectInterceptor).addPathPatterns("/books", "/books/*");
}
}
如果采用方式二,主配置类 SpringMvcConfig 就不需要实现 WebMvcConfigurer 接口,但要确保该类被 Spring 容器加载(例如在 ComponentScan 范围内或手动注册)。
核心配置说明
addInterceptor(xxx):注册拦截器实例。addPathPatterns("/books", "/books/"):指定要拦截的请求路径,支持通配符 (单级)和 (多级)。
4 ) 启动测试与流程分析
启动后发起请求 POST /books,控制台输出:
preHandle...application/json
book save...Book{书名='...', 价格=...}
postHandle...
afterCompletion...
单个拦截器的执行流程如下:
preHandle返回true:放行,正常执行后续步骤。preHandle返回false:终止请求,不会调用postHandle和afterCompletion(但会执行已经触发的拦截器的afterCompletion,详见拦截器链部分)
拦截器方法参数详解
| 方法 | 参数 | 说明 |
|---|---|---|
preHandle | request, response, handler | handler 是 HandlerMethod 类型,封装了被拦截的 Controller 方法信息,可通过 (HandlerMethod) handler 获取方法名、参数等。 |
postHandle | request, response, handler, modelAndView | modelAndView 在前后端分离架构中很少使用(主要用于页面跳转)。 |
afterCompletion | request, response, handler, ex | ex 是控制器方法抛出的异常对象,可用于统一日志记录(但更推荐使用全局异常处理器)。 |
典型用法示例:
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
// 获取请求头信息
String contentType = request.getHeader("Content-Type");
// 获取方法信息
HandlerMethod hm = (HandlerMethod) handler;
System.out.println("即将执行:" + hm.getMethod().getName());
// 权限校验伪代码
if (/ 无权限 /) {
return false; // 终止请求
}
return true;
}
拦截器链配置与执行顺序
1 ) 配置多个拦截器
在配置类中继续调用 registry.addInterceptor() 即可添加多个拦截器:
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(projectInterceptor).addPathPatterns("/books", "/books/*");
registry.addInterceptor(projectInterceptor2).addPathPatterns("/books", "/books/*");
}
Interceptor2 示例:
package com.wb.controller.interceptor;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@Component
public class ProjectInterceptor2 implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
System.out.println("preHandle...222");
return false; // 测试终止情况
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) {
System.out.println("postHandle...222");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
System.out.println("afterCompletion...222");
}
}
执行顺序规则
- 前置(
preHandle):按照配置的先后顺序,依次执行。 - 后置(
postHandle):与前置顺序相反,即先配置的后执行。 - 完成(
afterCompletion):同样与前置顺序相反。
中断场景分析
如果在某个拦截器的 preHandle 中返回 false,则:
- **随后所有拦截器的
preHandle均不执行。 - **所有拦截器的
postHandle均不执行。 - 只有在返回
false的拦截器之前已经执行过preHandle的拦截器,其afterCompletion会执行(顺序依然反向)。
以拦截器1(true)、拦截器2(return false)为例:
从控制台输出会看到:
preHandle... (拦截器1)
preHandle...222 (拦截器2)
afterCompletion... (拦截器1)
afterCompletion...222 没有出现,因为拦截器2的 preHandle 返回 false 后,它自身的完成回调不会触发
总结
- 拦截器是 Spring MVC 中用于增强 Controller 的组件,归属于 Spring 技术栈
- 开发步骤:实现
HandlerInterceptor接口 → 注册为 Spring Bean → 在配置类中注册并指定拦截路径 - 单个拦截器的生命周期:
preHandle→Controller→postHandle→afterCompletion preHandle的返回值控制请求是否继续;返回false会直接终止后续所有处理- 多拦截器形成“拦截器链”,执行顺序遵循“前置正序,后置和完成逆序”的栈式结构
- 合理使用拦截器可以实现权限校验、日志记录、性能监控等切面功能,是面向切面编程在 Spring MVC 中的典型实践
2237



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



