15.1拦截器概述
Spring MVC中的拦截器(Interceptor):类似于Servlet中的过略器(Filter),它主要用于拦截用户请求并做出相应的处理。例如通过拦截器可以进行权限验证,记录请求信息的日志,判断用户是否登录等
15.1.1拦截器的定义
使用Spring MVC中的拦截器,需要对拦截器类进行定义和配置
通常拦截器类可以通过两种方式来定义:
(1)通过实现HandlerInterceptor接口,或继承HandlerInterceptor接口的实现类(如HandlerInterceptorAdapter)来定义
(2)通过实现WebRequestInterceptor接口,或继承WebRequestInterceptor接口的实现类来定义
以实现HandlerInterceptor接口的定义方式为例,自定义拦截器类的代码如下所示:
public class CustomInterceptor implements HandlerInterceptor{
@Override
public boolean preHandle(HttpServletRequest request,
HttpServletResponse response, Object handler)throws Exception {
return false;
}
@Override
public void postHandle(HttpServletRequest request,
HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
}
@Override
public void afterCompletion(HttpServletRequest request,
HttpServletResponse response, Object handler,
Exception ex) throws Exception {
}
}
从上述代码可以看出,自定义的拦截器类实现了HandlerInterceptor接口,并实现了接口中的三个方法
关于这三个方法的具体描述如下:
(1)preHandle()方法: 该方法会在控制器方法前执行,其返回值表示是否中断后续操作。当其返回值为true时,表示继续向下执行;当其返回值为false时,会中断后续的所有操作(包括调用下一个拦截器和控制类中的方法执行等)
(2)postHandle()方法: 该方法会在控制器方法调用之后,且解析视图之前执行。可以通过此方法对请求域中的模型和视图做出进一步的修改
(3)afterCompletion()方法: 该方法会在整个请求完成,即视图渲染结束之后执行。可以通过此方法实现一些资源清理,记录日志信息等工作
15.1.2拦截器的配置
要使用自定义的拦截器类生效,还需要在Spring MVC的配置文件中进行配置,配置代码如下:
<!-- 配置拦截器 -->
<mvc:interceptors>
<!--使用bean直接定义在<mvc:interceptors>下面的拦截器将拦截所有请求-->
<!-- <bean class="com.itheima.interceptor.CustomInterceptor"/> -->
<!-- 拦截器1 -->
<mvc:interceptor>
<!-- 配置拦截器作用的路径 -->
<mvc:mapping path="/**" />
<!-- 定义在<mvc:interceptor>下面的表示匹配指定路径的请求才进行拦截的 -->
<bean class="com.itheima.interceptor.Interceptor1" />
</mvc:interceptor>
<!-- 拦截器2 -->
<mvc:interceptor>
<mvc:mapping path="/hello" />
<bean class="com.itheima.interceptor.Interceptor2" />
</mvc:interceptor>
...
</mvc:interceptors>
<mvc:interceptors>
元素: 用于配置一组拦截器,其子元素中定义的是全局拦截器,它会拦截所有的请求
<mvc:interceptor>
元素: 用于定义指定路径的拦截器,它会对指定路径下的请求生效
<mvc:interceptor>
元素的子元素<mvc:mapping>
: 用于配置拦截器作用的路径,该路径在其属性path中定义。如上述代码中path的属性值"/**“表示拦截所有路径,”/hello"表示拦截所有以"/hello"结尾的路径
<mvc:exclude-mapping>
元素: 用于请求路径包含不需要拦截的内容
注意:<mvc:interceptors>
元素中的子元素必须按照上述代码的配置顺序进行编写,否则文件会报错
15.2拦截器的执行流程
15.2.1单个拦截器的执行流程
在运行程序时,拦截器的执行是有一定顺序的,该顺序与配置文件中所定义的拦截器的顺序相关
单个拦截器的执行流程如下:
(1)程序首先会执行拦截器类中的preHandle()方法,如果该方法的返回值为true则程序会继续向下执行处理器中的方法,否则将不会向下执行
(2)在业务处理器(即控制器Controller类)处理玩请求后,会执行postHandle()方法,然后回通过DispatcherServlet向客户端返回响应
(3)在DispatcherServl处理完请求后,才会执行afterCompletion()方法
15.2.2多个拦截器的执行流程
多个拦截器的执行流程(假设有两个拦截器Interceptor1和Interceptor2,并且在配置文件中,Interceptor1拦截器配置在前):
当有多个拦截器同时工作时,它们的preHandle()方法会按照配置文件中拦截器的配置顺序执行;而它们的postHandle()方法和afterCompletion()方法则会按照配置顺序的反序执行