Spring MVC 中的拦截器(Interceptor)是用于拦截处理HTTP请求和响应的对象。
- 它们在请求到达控制器之前或发送响应给客户端之后执行。
- 拦截器主要用于实现横切关注点,如日志记录、权限检查、事务管理等。
基本概念
-
拦截器接口:Spring MVC中定义了
HandlerInterceptor
接口,包含三个方法:-
preHandle()
:在请求处理之前进行调用(Controller方法调用之前)。 -
postHandle()
:在请求处理之后立即调用,但是在视图被渲染之前(Controller方法调用之后)。 -
afterCompletion()
:在整个请求结束之后被调用,也就是在DispatcherServlet
渲染了对应的视图之后执行。
-
-
注册拦截器:通过实现
WebMvcConfigurer
接口的addInterceptors
方法来注册拦截器。 - 拦截器链:如果有多个拦截器,它们会按照注册顺序形成一个拦截器链。
入门案例
【第一步】定义拦截器
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
//定义拦截器类,实现HandlerInterceptor接口
public class MyInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
// 在请求处理之前进行调用(Controller方法调用之前)
return true; // 返回true继续流程(如调用下一个拦截器或处理器),返回false则流程中断
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
// 在请求处理之后立即调用,但是在视图被渲染之前(Controller方法调用之后)
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
// 在整个请求结束之后被调用,也就是在DispatcherServlet渲染了对应的视图之后执行
}
}
【第二步】配置加载拦截器
// 注册拦截器
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 {
@Override
public void addInterceptors(InterceptorRegistry registry) {
//配置拦截器
registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**");
}
}
拦截器链
拦截器链(Interceptor Chain)是一系列拦截器的集合,它们按照一定的顺序对请求进行拦截和处理。当请求进入Spring MVC时,它会依次通过这个链中的每个拦截器,执行各自的拦截逻辑。
基本概念
-
顺序执行:拦截器链中的拦截器会按照注册的顺序执行。
- 第一个注册的拦截器将首先执行其
preHandle
方法,然后是第二个,依此类推。
- 第一个注册的拦截器将首先执行其
-
拦截器决策:每个拦截器都可以决定是否继续执行链中的下一个拦截器或直接跳过后面的拦截器。
- 这是通过
preHandle
方法的返回值来控制的。 - 如果
preHandle
返回true
,则继续执行下一个拦截器; - 如果返回
false
,则不会执行后续的拦截器,并且通常不会调用控制器的方法。
- 这是通过
-
后处理:
- 在所有拦截器的
preHandle
方法执行完毕且控制器方法处理完请求后,会逆序执行拦截器的postHandle
方法。 - 这意味着最后一个注册的拦截器将首先执行其
postHandle
方法。
- 在所有拦截器的
-
完成处理:在整个请求处理完成之后,即视图渲染之后,拦截器链会逆序执行每个拦截器的
afterCompletion
方法。