Spring MVC 中提供了 AOP 风格 拦截器,拥有更加精细的拦截处理能力。Spring Boot中拦截器的注册更加方便,步骤如下:
- 创建一个 Spring Boot 项目,添加 spring-boot-starter-web 依赖。
- 创建拦截器实现 HandlerInterceptor 接口, 如下:
public class MyInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("MyInterceptor>>>>>>>>>preHandle");
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("MyInterceptor>>>>>>>>>postHandle");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("MyInterceptor>>>>>>>>>afterCompletion");
}
}
拦截器中的方法将按 preHandle 一> Controller 一> postHandle 一> afterCompletion 的顺序执行。注意,只有 preHandle 方法返回 true 时后面的方法才会执行。当拦截器链内存在多个拦截器时, postHandler 在拦截器链内的所有拦截器返回成功时才会调用,而 afterCompletion 只有 preHandle 返回 true 才调用,但若拦截器链内的第一个拦截器 preHandle 方法返回 false,则后面的方法都不会执行。
- 配置拦截器。定义配置类进行拦截器的配置,代码如下:
@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new MyInterceptor())
.addPathPatterns("/**")
.excludePathPatterns("/hello");
}
}
自定义类实现 WebMvcConfigurer 接口,实现接口中的 addlnterceptors 方法。其中,addPathPattems 表示拦截路径, excludePathPattems 表示排除的路径。
- 测试,在浏览器中提供 /hello2 和 /hello 接口分别进行访问,当访问 /hello2 接口时,打印日志如下: