拦截器--HandlerInterceptor
拦截器接口
package org.springframework.web.servlet; public interface HandlerInterceptor { boolean preHandle( HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception; void postHandle( HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception; void afterCompletion( HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception; }
preHandle:预处理回调方法,实现处理器的预处理(如登录检查),第三个参数为响应的处理器;
返回值:true表示继续流程(如调用下一个拦截器或处理器);
false表示流程中断(如登录检查失败),不会继续调用其他的拦截器或处理器,此时我们需要通过response来产生响应;
postHandle:后处理回调方法,实现处理器的后处理(但在渲染视图之前),此时我们可以通过modelAndView(模型和视图对象)对模型数据进行处理或对视图进行处理,modelAndView也可能为null。
afterCompletion:整个请求处理完毕回调方法,即在视图渲染完毕时回调,如性能监控中我们可以在此记录结束时间并输出消耗时间,还可以进行一些资源清理,类似于try-catch-finally中的finally,但仅调用处理器执行链中preHandle返回true的拦截器的afterCompletion。
拦截器适配器
有时候我们可能只需要实现三个回调方法中的某一个,如果实现
HandlerInterceptor接口的话,三个方法必须实现,不管你需不需要,此时spring提供了一个HandlerInterceptorAdapter适配器(一种适配器设计模式的实现),允许我们只实现需要的回调方法。
public abstract class HandlerInterceptorAdapter implements HandlerInterceptor { //省略代码 此处所以三个回调方法都是空实现,preHandle返回true。 }
运行流程图
正常流程
中断流程
中断流程中,比如是HandlerInterceptor2中断的流程(preHandle返回false),此处仅调用它之前拦截器的preHandle返回true的afterCompletion方法。
DispatcherServlet内部 工作
//doDispatch方法 //1、处理器拦截器的预处理(正序执行) HandlerInterceptor[] interceptors = mappedHandler.getInterceptors(); if (interceptors != null) { for (int i = 0; i < interceptors.length; i++) { HandlerInterceptor interceptor = interceptors[i]; if (!interceptor.preHandle(processedRequest, response, mappedHandler.getHandler())) { //1.1、失败时触发afterCompletion的调用 triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, null); return; } interceptorIndex = i;//1.2、记录当前预处理成功的索引 } } //2、处理器适配器调用我们的处理器 mv = ha.handle(processedRequest, response, mappedHandler.getHandler()); //当我们返回null或没有返回逻辑视图名时的默认视图名翻译(详解4.15.5 RequestToViewNameTranslator) if (mv != null && !mv.hasView()) { mv.setViewName(getDefaultViewName(request)); } //3、处理器拦截器的后处理(逆序) if (interceptors != null) { for (int i = interceptors.length - 1; i >= 0; i--) { HandlerInterceptor interceptor = interceptors[i]; interceptor.postHandle(processedRequest, response, mappedHandler.getHandler(), mv); } } //4、视图的渲染 if (mv != null && !mv.wasCleared()) { render(mv, processedRequest, response); if (errorView) { WebUtils.clearErrorRequestAttributes(request); } //5、触发整个请求处理完毕回调方法afterCompletion triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, null);
// triggerAfterCompletion方法 private void triggerAfterCompletion(HandlerExecutionChain mappedHandler, int interceptorIndex, HttpServletRequest request, HttpServletResponse response, Exception ex) throws Exception { // 5、触发整个请求处理完毕回调方法afterCompletion (逆序从1.2中的预处理成功的索引处的拦截器执行) if (mappedHandler != null) { HandlerInterceptor[] interceptors = mappedHandler.getInterceptors(); if (interceptors != null) { for (int i = interceptorIndex; i >= 0; i--) { HandlerInterceptor interceptor = interceptors[i]; try { interceptor.afterCompletion(request, response, mappedHandler.getHandler(), ex); } catch (Throwable ex2) { logger.error("HandlerInterceptor.afterCompletion threw exception", ex2); } } } } }
正常流程
(1、拦截器实现
package cn.javass.chapter5.web.interceptor; //省略import public class HandlerInterceptor1 extends HandlerInterceptorAdapter {//此处一般继承HandlerInterceptorAdapter适配器即可 @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println("===========HandlerInterceptor1 preHandle"); return true; } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { System.out.println("===========HandlerInterceptor1 postHandle"); } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { System.out.println("===========HandlerInterceptor1 afterCompletion"); } }
以上是HandlerInterceptor1实现,HandlerInterceptor2同理 只是输出内容为“HandlerInterceptor2”。
(2、控制器
package cn.javass.chapter5.web.controller; //省略import public class TestController implements Controller { @Override public ModelAndView handleRequest(HttpServletRequest req, HttpServletResponse resp) throws Exception { System.out.println("===========TestController"); return new ModelAndView("test"); } }
(3、Spring配置文件chapter5-servlet.xml
<bean name="/test" class="cn.javass.chapter5.web.controller.TestController"/> <bean id="handlerInterceptor1" class="cn.javass.chapter5.web.interceptor.HandlerInterceptor1"/> <bean id="handlerInterceptor2" class="cn.javass.chapter5.web.interceptor.HandlerInterceptor2"/>
<bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">
<property name="interceptors">
<list>
<ref bean="handlerInterceptor1"/>
<ref bean="handlerInterceptor2"/>
</list>
</property>
</bean>
interceptors:指定拦截器链,拦截器的执行顺序就是此处添加拦截器的顺序;
(4、视图页面WEB-INF/jsp/test.jsp
<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<%System.out.println("==========test.jsp");%>
test page
(5、启动服务器测试
输入网址:http://localhost:9080/springmvc-chapter5/test
控制台输出:
===========HandlerInterceptor1 preHandle ===========HandlerInterceptor2 preHandle ===========TestController ===========HandlerInterceptor2 postHandle ===========HandlerInterceptor1 postHandle ==========test.jsp ===========HandlerInterceptor2 afterCompletion ===========HandlerInterceptor1 afterCompletion
到此一个正常流程的演示完毕。和图5-1一样,接下来看一下中断的流程。
中断流程
(1、拦截器
HandlerInterceptor3和HandlerInterceptor4 与 之前的 HandlerInteceptor1和HandlerInterceptor2一样,只是在HandlerInterceptor4的preHandle方法返回false:
@Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println("===========HandlerInterceptor1 preHandle"); onse.getWriter().print("break");//流程中断的话需要我们进行响应的处理 return false;//返回false表示流程中断
(2、控制器
流程中断不会执行到控制器,使用之前的TestController控制器。
(3、Spring配置文件chapter5-servlet.xml
<bean id="handlerInterceptor3" class="cn.javass.chapter5.web.interceptor.HandlerInterceptor3"/> <bean id="handlerInterceptor4" class="cn.javass.chapter5.web.interceptor.HandlerInterceptor4"/>
<bean id="handlerInterceptor3" class="cn.javass.chapter5.web.interceptor.HandlerInterceptor3"/> <bean id="handlerInterceptor4" class="cn.javass.chapter5.web.interceptor.HandlerInterceptor4"/>
<bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping"> <property name="interceptors"> <list> <ref bean="handlerInterceptor3"/> <ref bean="handlerInterceptor4"/> </list> </property> </bean>
interceptors:指定拦截器链,拦截器的执行顺序就是此处添加拦截器的顺序;
(4、视图页面
流程中断,不会执行到视图渲染。
(5、启动服务器测试
输入网址:http://localhost:9080/springmvc-chapter5/test
控制台输出:
===========HandlerInterceptor3 preHandle ===========HandlerInterceptor4 preHandle ===========HandlerInterceptor3 afterCompletion
此处我们可以看到只有HandlerInterceptor3的afterCompletion执行,符合图5-2的中断流程。
而且页面上会显示我们在HandlerInterceptor4 preHandle 直接写出的响应“break”。
提示:推荐能使用servlet规范中的过滤器Filter实现的功能就用Filter实现,因为HandlerInteceptor只有在Spring Web MVC环境下才能使用,因此Filter是最通用的、最先应该使用的。如登录这种拦截器最好使用Filter来实现。