SpringMVC 提供了拦截器 HandlerInterceptor在请求到达 Controller 之前、Controller 执行之后、视图渲染完成之后各留了一个钩子把通用逻辑挂在这些钩子上就行。一、拦截器是什么拦截器是 SpringMVC 里的组件挂在处理器执行链 HandlerExecutionChain 上。DispatcherServlet 找到 Controller 方法之后会把匹配到的拦截器组成一条链请求沿着链往前走进入 Controller 之前逐个调用 preHandleController 执行完调用 postHandle视图渲染完调用 afterCompletion。拦截器和 Filter 长得像位置不一样对比项FilterInterceptor归属Servlet 规范由容器提供SpringMVC 框架提供位置DispatcherServlet 之外DispatcherServlet 之内能拿到的对象request、responserequest、response、handler、ModelAndView拦截范围url-pattern 匹配的所有请求mvc:mapping匹配到的处理器请求典型用途编码、跨域、请求包装登录校验、权限、日志、耗时统计Filter 在 DispatcherServlet 前面拦的是所有经过容器的请求连静态资源也算在内。拦截器在 DispatcherServlet 里面只有在请求落到 Controller 方法上时才起作用所以能拿到 handler 和 ModelAndView 这些东西做业务层面的判断更方便。二、写一个拦截器并配上先准备一个被拦截的 Controllerpackage cn.tx.controller; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; Controller RequestMapping(/dept) public class DeptController { RequestMapping(/findAll.do) public String findAll() { System.out.println(controller方法执行了...); return suc; } }拦截器实现 HandlerInterceptor 接口。先只写 preHandle看它和 Controller 的先后关系package cn.tx.demo4; import org.springframework.web.servlet.HandlerInterceptor; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; public class MyInterceptor2 implements HandlerInterceptor { Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println(拦截器preHandle方法执行了...); // 手动跳转页面 // request.getRequestDispatcher(/index.jsp).forward(request, response); // 拦截不放行 // return false; // 放行 return true; } }然后在 SpringMVC.xml 里注册!-- 配置拦截器们 -- mvc:interceptors !-- 配置拦截器 -- mvc:interceptor !-- 该拦截器拦截哪些资源 -- mvc:mapping path/dept/**/ !-- 哪些资源不想拦截 mvc:exclude-mapping path / -- !-- 拦截器对象 -- bean classcn.tx.demo4.MyInterceptor2 / /mvc:interceptor /mvc:interceptorsmvc:mapping path/dept/**/表示只拦/dept下面的请求路径按 Ant 风格写/**是所有/dept/**是某个目录下的所有。exclude-mapping用来把其中某几个地址排除掉。拦截器类没有加 Controller也不用被组件扫描到在mvc:interceptor里用bean class.../直接指定就行。Spring 5 的 HandlerInterceptor 里三个方法都带默认实现preHandle 默认返回 truepostHandle 和 afterCompletion 默认是空方法。所以这里只写 preHandle 也能编译用不到的方法不实现即可。访问/dept/findAll.do控制台打印两行拦截器preHandle方法执行了... controller方法执行了...preHandle 先执行返回 trueController 才继续。三、HandlerInterceptor 的三个方法接口里一共三个方法除了 preHandle 有返回值另外两个都是 void方法执行时机参数常见用途preHandleController 方法执行前request、response、handler登录校验、权限判断返回 false 可中断postHandleController 执行完、视图渲染前request、response、handler、ModelAndView补充模型数据、修改视图、手动跳转afterCompletion视图渲染完成后request、response、handler、Exception清理资源、记录耗时3.1 preHandleOverride public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println(拦截器preHandle方法执行了...); // 手动跳转页面 // request.getRequestDispatcher(/index.jsp).forward(request, response); // 拦截不放行 // return false; // 放行 return true; }返回值决定请求走不走返回 true后面的拦截器和 Controller 继续返回 false请求在这里停住Controller 不会执行。handler 是当前请求对应的处理器用 Controller 的时候它是一个 HandlerMethod里面包着 Controller 对象和具体的方法做权限判断时可以拿它取方法上的注解。返回 false 之后页面得自己给出要么直接写响应要么手动转发。登录校验就是按这个思路写的Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { Object user request.getSession().getAttribute(user); if (user null) { // 没登录转到登录页并且不放行 request.getRequestDispatcher(/login.jsp).forward(request, response); return false; } return true; }3.2 postHandleOverride public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { System.out.println(postHandle方法执行了...); // 也是可以进行页面的跳转 request.getRequestDispatcher(/index.jsp).forward(request, response); }这时 Controller 已经执行完ModelAndView 也拿到了但页面还没渲染。参数里的 modelAndView 就是即将交给视图解析器的那个对象可以往里加数据、改视图名modelAndView.addObject(visitTime, new Date());也可以像示例里那样直接转发到另一个页面。Controller 方法如果抛了异常postHandle 不会执行。3.3 afterCompletionOverride public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { System.out.println(afterCompletion方法执行了...); }视图已经渲染完响应也发出去了这一步是整个请求的收尾。参数里的 ex 用来接收异常没有异常时是 null。适合放释放资源、清理 ThreadLocal 这类工作。把这三个方法补回 MyInterceptor2它就覆盖了请求的三个阶段控制台会依次多打印 preHandle、postHandle、afterCompletion 三行。三个方法摆在一起执行顺序是这样的preHandle │ 返回 true ▼ Controller 方法 │ ▼ postHandle │ ▼ 视图渲染 │ ▼ afterCompletionpreHandle 返回 false 时后面的步骤全部跳过这个拦截器自己的 afterCompletion 也不会执行之前已经放行过的拦截器它们的 afterCompletion 仍然会走一遍收尾。四、配置多个拦截器拦截器可以配置多个再写一个拦截器三个方法都实现package cn.tx.demo4; import org.springframework.web.servlet.HandlerInterceptor; import org.springframework.web.servlet.ModelAndView; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; public class MyInterceptor3 implements HandlerInterceptor { Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println(MyInterceptor3的preHandle方法执行了...); // 放行 return true; } Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { System.out.println(MyInterceptor3的postHandle方法执行了...); } Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { System.out.println(MyInterceptor3的afterCompletion方法执行了...); } }配置里再加一段两个拦截器分别管不同的范围mvc:interceptors !-- 只拦 /dept 下面的请求 -- mvc:interceptor mvc:mapping path/dept/**/ bean classcn.tx.demo4.MyInterceptor2 / /mvc:interceptor !-- 拦所有请求 -- mvc:interceptor mvc:mapping path/**/ bean classcn.tx.demo4.MyInterceptor3 / /mvc:interceptor /mvc:interceptors访问/dept/findAll.do时/dept/**和/**都能匹配上两个拦截器都会执行。顺序按配置的先后跟路径的具体程度无关MyInterceptor2 配在前面就排在链的前面MyInterceptor3 配在后面排在后面。一条链的执行方向是进去正序出来逆序请求 │ ├─ MyInterceptor2.preHandle → true ├─ MyInterceptor3.preHandle → true │ ├─ Controller 方法 │ ├─ MyInterceptor3.postHandle ├─ MyInterceptor2.postHandle │ ├─ 视图渲染 │ ├─ MyInterceptor3.afterCompletion └─ MyInterceptor2.afterCompletion │ ▼ 响应preHandle 按配置顺序往里走postHandle 和 afterCompletion 按相反方向回来像方法调用压栈、出栈一样。控制台打印的顺序也是这个拦截器preHandle方法执行了... MyInterceptor3的preHandle方法执行了... controller方法执行了... MyInterceptor3的postHandle方法执行了... postHandle方法执行了... MyInterceptor3的afterCompletion方法执行了... afterCompletion方法执行了...五、小结拦截器要做的就两件事写一个类实现 HandlerInterceptor在 SpringMVC.xml 的mvc:interceptors里用mvc:mapping圈定范围、用bean指定实现类。三个方法对应请求的三个阶段preHandle 在 Controller 之前返回值决定放不放行postHandle 在 Controller 之后、渲染之前可以改 ModelAndViewafterCompletion 在渲染之后负责收尾。配多个拦截器时进去正序、出来逆序范围按 mapping 匹配顺序按配置的先后。
SpringMVC 提供了拦截器 HandlerInterceptor在请求到达 Controller 之前、Controller 执行之后、视图渲染完成之后各留了一个钩子把通用逻辑挂在这些钩子上就行。一、拦截器是什么拦截器是 SpringMVC 里的组件挂在处理器执行链 HandlerExecutionChain 上。DispatcherServlet 找到 Controller 方法之后会把匹配到的拦截器组成一条链请求沿着链往前走进入 Controller 之前逐个调用 preHandleController 执行完调用 postHandle视图渲染完调用 afterCompletion。拦截器和 Filter 长得像位置不一样对比项FilterInterceptor归属Servlet 规范由容器提供SpringMVC 框架提供位置DispatcherServlet 之外DispatcherServlet 之内能拿到的对象request、responserequest、response、handler、ModelAndView拦截范围url-pattern 匹配的所有请求mvc:mapping匹配到的处理器请求典型用途编码、跨域、请求包装登录校验、权限、日志、耗时统计Filter 在 DispatcherServlet 前面拦的是所有经过容器的请求连静态资源也算在内。拦截器在 DispatcherServlet 里面只有在请求落到 Controller 方法上时才起作用所以能拿到 handler 和 ModelAndView 这些东西做业务层面的判断更方便。二、写一个拦截器并配上先准备一个被拦截的 Controllerpackage cn.tx.controller; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.RequestMapping; Controller RequestMapping(/dept) public class DeptController { RequestMapping(/findAll.do) public String findAll() { System.out.println(controller方法执行了...); return suc; } }拦截器实现 HandlerInterceptor 接口。先只写 preHandle看它和 Controller 的先后关系package cn.tx.demo4; import org.springframework.web.servlet.HandlerInterceptor; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; public class MyInterceptor2 implements HandlerInterceptor { Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println(拦截器preHandle方法执行了...); // 手动跳转页面 // request.getRequestDispatcher(/index.jsp).forward(request, response); // 拦截不放行 // return false; // 放行 return true; } }然后在 SpringMVC.xml 里注册!-- 配置拦截器们 -- mvc:interceptors !-- 配置拦截器 -- mvc:interceptor !-- 该拦截器拦截哪些资源 -- mvc:mapping path/dept/**/ !-- 哪些资源不想拦截 mvc:exclude-mapping path / -- !-- 拦截器对象 -- bean classcn.tx.demo4.MyInterceptor2 / /mvc:interceptor /mvc:interceptorsmvc:mapping path/dept/**/表示只拦/dept下面的请求路径按 Ant 风格写/**是所有/dept/**是某个目录下的所有。exclude-mapping用来把其中某几个地址排除掉。拦截器类没有加 Controller也不用被组件扫描到在mvc:interceptor里用bean class.../直接指定就行。Spring 5 的 HandlerInterceptor 里三个方法都带默认实现preHandle 默认返回 truepostHandle 和 afterCompletion 默认是空方法。所以这里只写 preHandle 也能编译用不到的方法不实现即可。访问/dept/findAll.do控制台打印两行拦截器preHandle方法执行了... controller方法执行了...preHandle 先执行返回 trueController 才继续。三、HandlerInterceptor 的三个方法接口里一共三个方法除了 preHandle 有返回值另外两个都是 void方法执行时机参数常见用途preHandleController 方法执行前request、response、handler登录校验、权限判断返回 false 可中断postHandleController 执行完、视图渲染前request、response、handler、ModelAndView补充模型数据、修改视图、手动跳转afterCompletion视图渲染完成后request、response、handler、Exception清理资源、记录耗时3.1 preHandleOverride public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println(拦截器preHandle方法执行了...); // 手动跳转页面 // request.getRequestDispatcher(/index.jsp).forward(request, response); // 拦截不放行 // return false; // 放行 return true; }返回值决定请求走不走返回 true后面的拦截器和 Controller 继续返回 false请求在这里停住Controller 不会执行。handler 是当前请求对应的处理器用 Controller 的时候它是一个 HandlerMethod里面包着 Controller 对象和具体的方法做权限判断时可以拿它取方法上的注解。返回 false 之后页面得自己给出要么直接写响应要么手动转发。登录校验就是按这个思路写的Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { Object user request.getSession().getAttribute(user); if (user null) { // 没登录转到登录页并且不放行 request.getRequestDispatcher(/login.jsp).forward(request, response); return false; } return true; }3.2 postHandleOverride public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { System.out.println(postHandle方法执行了...); // 也是可以进行页面的跳转 request.getRequestDispatcher(/index.jsp).forward(request, response); }这时 Controller 已经执行完ModelAndView 也拿到了但页面还没渲染。参数里的 modelAndView 就是即将交给视图解析器的那个对象可以往里加数据、改视图名modelAndView.addObject(visitTime, new Date());也可以像示例里那样直接转发到另一个页面。Controller 方法如果抛了异常postHandle 不会执行。3.3 afterCompletionOverride public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { System.out.println(afterCompletion方法执行了...); }视图已经渲染完响应也发出去了这一步是整个请求的收尾。参数里的 ex 用来接收异常没有异常时是 null。适合放释放资源、清理 ThreadLocal 这类工作。把这三个方法补回 MyInterceptor2它就覆盖了请求的三个阶段控制台会依次多打印 preHandle、postHandle、afterCompletion 三行。三个方法摆在一起执行顺序是这样的preHandle │ 返回 true ▼ Controller 方法 │ ▼ postHandle │ ▼ 视图渲染 │ ▼ afterCompletionpreHandle 返回 false 时后面的步骤全部跳过这个拦截器自己的 afterCompletion 也不会执行之前已经放行过的拦截器它们的 afterCompletion 仍然会走一遍收尾。四、配置多个拦截器拦截器可以配置多个再写一个拦截器三个方法都实现package cn.tx.demo4; import org.springframework.web.servlet.HandlerInterceptor; import org.springframework.web.servlet.ModelAndView; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; public class MyInterceptor3 implements HandlerInterceptor { Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println(MyInterceptor3的preHandle方法执行了...); // 放行 return true; } Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { System.out.println(MyInterceptor3的postHandle方法执行了...); } Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { System.out.println(MyInterceptor3的afterCompletion方法执行了...); } }配置里再加一段两个拦截器分别管不同的范围mvc:interceptors !-- 只拦 /dept 下面的请求 -- mvc:interceptor mvc:mapping path/dept/**/ bean classcn.tx.demo4.MyInterceptor2 / /mvc:interceptor !-- 拦所有请求 -- mvc:interceptor mvc:mapping path/**/ bean classcn.tx.demo4.MyInterceptor3 / /mvc:interceptor /mvc:interceptors访问/dept/findAll.do时/dept/**和/**都能匹配上两个拦截器都会执行。顺序按配置的先后跟路径的具体程度无关MyInterceptor2 配在前面就排在链的前面MyInterceptor3 配在后面排在后面。一条链的执行方向是进去正序出来逆序请求 │ ├─ MyInterceptor2.preHandle → true ├─ MyInterceptor3.preHandle → true │ ├─ Controller 方法 │ ├─ MyInterceptor3.postHandle ├─ MyInterceptor2.postHandle │ ├─ 视图渲染 │ ├─ MyInterceptor3.afterCompletion └─ MyInterceptor2.afterCompletion │ ▼ 响应preHandle 按配置顺序往里走postHandle 和 afterCompletion 按相反方向回来像方法调用压栈、出栈一样。控制台打印的顺序也是这个拦截器preHandle方法执行了... MyInterceptor3的preHandle方法执行了... controller方法执行了... MyInterceptor3的postHandle方法执行了... postHandle方法执行了... MyInterceptor3的afterCompletion方法执行了... afterCompletion方法执行了...五、小结拦截器要做的就两件事写一个类实现 HandlerInterceptor在 SpringMVC.xml 的mvc:interceptors里用mvc:mapping圈定范围、用bean指定实现类。三个方法对应请求的三个阶段preHandle 在 Controller 之前返回值决定放不放行postHandle 在 Controller 之后、渲染之前可以改 ModelAndViewafterCompletion 在渲染之后负责收尾。配多个拦截器时进去正序、出来逆序范围按 mapping 匹配顺序按配置的先后。
