拦截器概述
对于任何优秀的MVC框架,都会提供一些通用的操作,如请求数据的封装、类型转换、数据校验、解析上传的文件、防止表单的多次提交等。早期的MVC框架将这些操作都写死在核心控制器中,而这些常用的操作又不是所有的请求都需要实现的,这就导致了框架的灵活性不足,可扩展性降低。
Spring MVC提供了Interceptor拦截器机制,类似于Servlet中的Filter过滤器,用于拦截用户的请求并做出相应的处理。比如通过拦截器来进行用户权限验证,或者用来判断用户是否已经登录。Spring MVC拦截器是可插拔式的设计,需要某一功能拦截器,只需在配置文件中应用该拦截器即可;如果不需要这个功能拦截器,只需在配置文件中取消应用该拦截器。
在Spring MVC中定义一个拦截器有两种方法:
- 实现HandlerInterceptor接口
- 实现WebRequestInterceptor接口
1.实现HandlerInterceptor接口
该接口位于org.springframework.web.servlet的包中,定义了三个方法,若要实现该接口,就要实现其三个方法:
- preHandle()方法:在控制器方法之前执行,返回true表示继续执行,false表示拦截请求,不再向下执行。
- postHandle()方法:在控制器方法之后,返回ModelAndView之前执行。
- afterCompletion()方法:在执行完控制器之后执行。
实现了HandlerInterceptor接口之后,需要在Spring的类加载配置文件中配置拦截器实现类,才能使拦截器起到拦截的效果,加载配置有两种方式:
- 针对HandlerMapping配置
- 针对全局配置
针对HandlerMapping配置
针对全局配置
2.实现WebRequestInterceptor接口
WebRequestInterceptor中也定义了三个方法,也是通过这三个方法来实现拦截的。这三个方法都传递了同一个参数WebRequest, WebRequest 是Spring 定义的一个接口,它里面的方法定义都基本跟HttpServletRequest 一样,在WebRequestInterceptor 中对WebRequest 进行的所有操作都将同步到HttpServletRequest 中,然后在当前请求中一直传递。三个方法如下:
-
preHandle(WebRequest request): 返回值为void,在请求处理之前调用。可以使用WebRequest的setAttribute(name, value, scope)方法把参数放到WebRequest属性中。
scope是Integer类型,在WebRequest的父层接口RequestAttributes中定义了三个常量:- SCOPE_REQUEST:值为0,表示只有在request中可以访问
- SCOPE_SESSION:值为1,环境允许的情况下,表示一个隔离的session,普通情况下代表一个普通session,并且在该session范围内可以访问。
- SCOPE_GLOBAL_SESSION:值为2,环境允许的情况下,表示一个全局共享的session,普通情况下代表一个普通session,并且在该session范围内可以访问。
-
postHandle(WebRequest request, ModelMap model): 在Controller方法之后,在视图返回被渲染之前调用,通过改变ModelMap来改变数据的展示。
-
afterCompletion(WebRequest request, Exception ex) : 在视图返回后并被渲染之后执行,如果在Controller中抛出异常,可以在此处理。如果已经被Spring异常处理器处理了,此处为null。
单个拦截器执行顺序