目录
这次的笔记使用的模块是 SpringMVC-demo5
1、拦截器的配置
SpringMVC中的拦截器用于拦截控制器方法的执行
SpringMVC中的拦截器需要 实现HandlerInterceptor 或 继承
① 创建首页
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>首页</title>
</head>
<body>
<h1>首页</h1>
<!-- 测试创建拦截器 -->
<a th:href="@{/testInterceptor}">测试拦截器</a><br>
</body>
</html>
② 创建拦截器类 FirstInterceptor
@Component //标记为普通组件,在配置拦截器时使用ref拦截时起作用,注意修改此时springMVC.xml中扫描组件的范围
//public class FirstInterceptor extends HandlerInterceptorAdapter { //HandlerInterceptorAdapter的实现类继承了HandlerInterceptor,但已经过时
public class FirstInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("FirstInterceptor --> preHandle");
return HandlerInterceptor.super.preHandle(request, response, handler);
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("FirstInterceptor --> postHandle");
HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("FirstInterceptor --> afterCompletion");
HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
}
}
③ 在 springMVC.xml 中配置拦截器
<!-- 配置拦截器 -->
<mvc:interceptors>
<bean class="com.zyj.mvc.interceptors.FirstInterceptor"></bean><!-- 这种写法会对所有方法进行拦截 -->
<ref bean="firstInterceptor"></ref><!-- 这种写法对 firstInterceptor 类中所有的请求进行拦截 -->
<mvc:interceptor>
<mvc:mapping path="/*"/> <!-- 拦截的路径(/* 表示上下文路径下的一层目录,/** 表示拦截所有路径) -->
<mvc:exclude-mapping path="/"/> <!-- 不拦截 -->
<ref bean="firstInterceptor"></ref>
</mvc:interceptor>
</mvc:interceptors>
2、拦截器的三个抽象方法
SpringMVC中的拦截器有三个抽象方法:
preHandle:控制器方法执行之前执行preHandle(),其boolean类型的返回值表示是否拦截或放行,返回true为放行,即调用控制器方法;返回false表示拦截,即不调用控制器方法
postHandle:控制器方法执行之后执行postHandle()
afterComplation:处理完视图和模型数据,渲染视图完毕之后执行afterComplation()
3、多个拦截器的执行顺序
a>若每个拦截器的preHandle()都返回true
此时多个拦截器的执行顺序和拦截器在SpringMVC的配置文件的配置顺序有关:
preHandle()会按照配置的顺序执行,而postHandle()和afterComplation()会按照配置的反序执行
b>若某个拦截器的preHandle()返回了false
preHandle()返回false和它之前的拦截器的preHandle()都会执行,postHandle()都不执行,返回false的拦截器之前的拦截器的afterComplation()会执行
① 再创建一个拦截器 SecondInterceptor
@Component //标记为普通组件,在配置拦截器时使用ref拦截时起作用,注意修改此时springMVC.xml中扫描组件的范围
//public class FirstInterceptor extends HandlerInterceptorAdapter { //HandlerInterceptorAdapter的实现类继承了HandlerInterceptor,但已经过时
public class SecondInterceptor implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("SecondInterceptor --> preHandle");
return HandlerInterceptor.super.preHandle(request, response, handler);
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("SecondInterceptor --> postHandle");
HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("SecondInterceptor --> afterCompletion");
HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
}
}
② 再 springMVC.xml 中配置拦截器
<mvc:interceptors>
<ref bean="firstInterceptor"></ref>
<ref bean="secondInterceptor"></ref>
</mvc:interceptors>
③ 访问首页,由于firstInterceptor在secondInterceptor之前配置,控制台输出如下
分析:
① 在 testInterceptor 方法的返回语句打上断点,运行测试,点击首页的测试链接
② 在 帧 处点击 doDispatch:1061, DispatcherServlet ,在下面各行打上断点
③ 跳过所有断点,刷新页面,先跳转到1056行的 applyPreHandle 方法,如下图,可以返现 mappedHandler 存放当前的控制器方法以及处理当前方法的拦截器,三个拦截器中,两个是我们自己创建的(first 和 second),一个是 SpringMVC 创建的
接着步入该方法,发现该方法是按照 SpringMVC创建的拦截器,然后是 自己配置的拦截器顺序 遍历的,并按顺序为其 interceptorIndex 赋值,如下图 。当有一个拦截器的 preHandle 返回 false 时,就会进入 if 语句,执行第⑥步的 triggerAfterCompletion 方法,interceptorIndex 是上一个返回true的preHandle的索引
④ 执行完该方法后,会跳到一下方法,跳过后跳转到 return 语句,继续跳过会跳到 applyPostHandle 方法,且仍然是之前的 mappedHandle
⑤ 步入该方法,可以发现该方法是倒序遍历 interceptorList 的
⑥ 恢复程序到下一个断点,当 mappedHandler 不为空时会执行 triggerAfterCompletion 方法
步入该方法,可以发现它是通过 interceptorIndex 的值倒序遍历的,而 interceptorIndex 的值正是 preHandle 中返回true的拦截器的个数