Spring Boot中使用拦截器
是 AOP 的一种实现,专门拦截对动态资源的后台请求,即拦截对控制层的请 求。使用场景比较多的是判断用户是否有权限请求后台,更拔高一层的使用场景也有,比如拦截器可以 结合 websocket 一起使用,用来拦截 websocket 请求,然后做相应的处理等等。
1. 拦截器的使用
1.1 定义拦截器
定义拦截器,只需要实现 HandlerInterceptor 接口,HandlerInterceptor 接口是所有自定义拦截 器或者 Spring Boot提供的拦截器的鼻祖,所以,首先来了解下该接口。该接口中有三个方法: preHandle(……) 、 postHandle(……) 和afterCompletion(……) 。
(1)preHandle(……) 方法:该方法的执行时机是,当某个 url 已经匹配到对应的 Controller 中的某个方法,且在这个方法执行之前。所以 preHandle(……) 方法可以决定是否将请求放行,这是通 过返回值来决定的,返回 true则放行,返回 false 则不会向后执行。
(2)postHandle(……) 方法:该方法的执行时机是,当某个 url 已经匹配到对应的Controller 中的某 个方法,且在执行完了该方法,但是在 DispatcherServlet 视图渲染之前。所以在这个方法中有 个ModelAndView 参数,可以在此做一些修改动作。
(3)afterCompletion(……)方法:顾名思义,该方法是在整个请求处理完成后(包括视图渲染)执 行,这时做一些资源的清理工作,这个方法只有在 preHandle(……)被成功执行后并且返回 true 才会被执行。
举例:
自定义一个拦截器:
public class MyInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
HandlerMethod handlerMethod = (HandlerMethod) handler;
Method method = handlerMethod.getMethod();
String methodName = method.getName();
System.out.println("====拦截到了方法:{},在该方法执行之前执行===="+ methodName);
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("执行完方法之后进执行(Controller方法调用之后)..");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("整个请求都处理完了..");
}
}
配置拦截器:
在 Spring Boot 2.0 之前,我们都是直接继承 WebMvcConfigurerAdapter 类,然后重写addInterceptors 方法来实现拦截器的配置。但是在 Spring Boot 2.0 之后,该方法已经被废弃了(当然,也可以继续用),取而代之的是 WebMvcConfigurationSupport 方法,中重写 addInterceptors 方法,将我们上面自定义的拦截器添加进去, addPathPatterns方法是添加要拦截的请求,这里我们拦截所有的请求。这样就配置好拦截器了,如下:
@Configuration
public class MyInterceptorConfig extends WebMvcConfigurationSupport {
@Override
protected void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**");
super.addInterceptors(registry);
}
}
添加测试验证:让其跳转到 hahaha.html 页面
@Controller
@RequestMapping("/interceptor")
public class InterceptorController {
@RequestMapping("/test")
public String test(){
return "hahaha";
}
}
发现无法访问。也就是说,虽然 Spring Boot 2.0 废弃了WebMvcConfigurerAdapter,但是WebMvcConfigurationSupport 又会导致默认的静态资源被拦截,这就需要我们手动将静态资源放开。
除了在 MyInterceptorConfig 配置类中重写 addInterceptors 方法外,还需要再重写一个方法: addResourceHandlers ,将静态资源放开:
@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
super.addResourceHandlers(registry);
}
这样配置好之后,重启项目,静态资源也可以正常访问了。
还有一种方法:
我们不继承 WebMvcConfigurationSupport 类,直接实现 WebMvcConfigurer 接口,然后重写addInterceptors 方法,将自定义的拦截器添加进去即可,如下:
@Override
public void addInterceptors(InterceptorRegistry registry) {
registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**");
}
2. 拦截器使用实例
https://blog.csdn.net/CodersCoder/article/details/106444313
参考:武哥聊编程