目录
拦截器概述
没有拦截器之前
有了拦截器之后
拦截器与过滤器的关系
拦截器的定义与使用
方式一:实现HandlerInterceptor接口
当需要对请求进行一些通用的操作,如请求数据的封装、类型转换、数据校验、解析上传的文件、防止表单的多次提交等。早期的MVC框架将这些操作都写死在核心控制器中,而这些常用的操作又不是所有的请求都需要实现的,这就导致了框架的灵活性不足,可扩展性降低
SpringMVC提供了Interceptor拦截器机制,类似于Servlet中的Filter过滤器,用于拦截用户的请求并做出相应的处理。比如通过拦截器来进行用户权限验证,或者用来判断用户是否已经登录。Spring MVC拦截器是可插拔式的设计,需要某一功能拦截器,只需在配置文件中应用该拦截器即可;如果不需要这个功能拦截器,只需在配置文件中取消应用该拦截器。
在Spring MVC中定义一个拦截器有两种方法:实现HandlerInterceptor接口,实现WebRequestInterceptor接口。(本文主要基于HandlerInterceptor)
1)定义一个类实现HandlerInterCeptor接口
2)分别重载preHandle、postHandle、afterCompletion方法
preHandle(req,resp):在controller的方法被调用之前执行该方法,返回boolean类型的值,可以使用该方法中断或继续处理执行链。
1)如果返回true,拦截器链将继续执行后续拦截器的preHandle方法;
2)如果返回false,DispatchServlet会假定烂机器本身已经处理完毕请求,此时将直接倒序执行此前已经方形的拦截器链的afterCompletion方法,随后return结束处理
postHandle(req, resp):在方法被调用视图解析之前调用。对于采用了@ResponseBody注解或者返回ResponseEntity的方法,postHandle后处理不太有效,因为在Handler执行成功时响应的数据(比如JSON数据)已经被写入response并且已被提交,并且是在postHandle方法被执行之前进行的!此时对于response的任何修改(比如添加额外的头部信息)都为时已晚。对于这种情况,我们可以实现ResponseBodyAdvice接口并且声明为ControllerAdvice,或者直接在RequestMappingHandlerAdapter中配置。
afterCompletion(req, resp):在请求处理完毕之后执行,无论是否有响应视图,无论有没有通过preHandle,无论有没有抛出异常。只会对此前放行成功(preHandle返回true)的拦截器进行倒序调用。
代码如下:
package ...;import ...;/*** 自定义请求头拦截器,将Header数据封装到线程变量中方便获取* 注意:此拦截器会同时验证当前用户有效期自动刷新有效期** @author liulianglin*/
public class HeaderInterceptor implements AsyncHandlerInterceptor
{@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception{// 这里做一些事情,return true or return false}@Overridepublic void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,ModelAndView modelAndView) {// 这里做一些事情}@Overridepublic void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)throws Exception{// 这里做一些事情}
}
3)配置拦截器
3.1)传统spring mvc项目
在spring-mvc的配置文件中配置拦截器,可以配置多个拦截器,哪个在上边,最先执行哪个拦截器。
3.2)SpringBoot项目
自定义配器实现WebMvcConfigurer配置器接口。
package ...;import ...;/*** 拦截器配置** @author bonc*/
public class WebMvcConfig implements WebMvcConfigurer{/** 不需要拦截地址 */public static final String[] excludeUrls = { "/login", "/logout", "/refresh" };@Overridepublic void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(getHeaderInterceptor()).addPathPatterns("/**").excludePathPatterns(excludeUrls).order(-10);}/*** 自定义请求头拦截器*/public HeaderInterceptor getHeaderInterceptor(){return new HeaderInterceptor();}
}