5.1、处理器拦截器简介
5.1.1、常见应用场景
5.1.2、拦截器接口
java代码:
- 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;
- }
5.1.3、拦截器适配器
java代码:
- public abstract class HandlerInterceptorAdapter implements HandlerInterceptor {
- //省略代码 此处所以三个回调方法都是空实现,preHandle返回true。
- }
5.1.4、运行流程图
java代码:
- //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);
java代码:
- // 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);
- }
- }
- }
- }
- }
5.2
、入门
5.2.1、正常流程
java代码:
- 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");
- }
- }
java代码:
- 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");
- }
- }
java代码:
- <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"/>
java代码:
- <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">
- <property name="interceptors">
- <list>
- <ref bean="handlerInterceptor1"/>
- <ref bean="handlerInterceptor2"/>
- </list>
- </property>
- </bean>
java代码:
- <%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
- <%System.out.println("==========test.jsp");%>
- test page
java代码:
- ===========HandlerInterceptor1 preHandle
- ===========HandlerInterceptor2 preHandle
- ===========TestController
- ===========HandlerInterceptor2 postHandle
- ===========HandlerInterceptor1 postHandle
- ==========test.jsp
- ===========HandlerInterceptor2 afterCompletion
- ===========HandlerInterceptor1 afterCompletion
5.2.2、中断流程
java代码:
- @Override
- public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
- System.out.println("===========HandlerInterceptor1 preHandle");
- onse.getWriter().print("break");//流程中断的话需要我们进行响应的处理
- return false;//返回false表示流程中断
java代码:
- <bean id="handlerInterceptor3"
- class="cn.javass.chapter5.web.interceptor.HandlerInterceptor3"/>
- <bean id="handlerInterceptor4"
- class="cn.javass.chapter5.web.interceptor.HandlerInterceptor4"/>
java代码:
- <bean id="handlerInterceptor3"
- class="cn.javass.chapter5.web.interceptor.HandlerInterceptor3"/>
- <bean id="handlerInterceptor4"
- class="cn.javass.chapter5.web.interceptor.HandlerInterceptor4"/>
java代码:
- <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">
- <property name="interceptors">
- <list>
- <ref bean="handlerInterceptor3"/>
- <ref bean="handlerInterceptor4"/>
- </list>
- </property>
- </bean>
java代码:
- ===========HandlerInterceptor3 preHandle
- ===========HandlerInterceptor4 preHandle
- ===========HandlerInterceptor3 afterCompletion
5.3、应用
5.3.1、性能监控
java代码:
- package cn.javass.chapter5.web.interceptor;
- public class StopWatchHandlerInterceptor extends HandlerInterceptorAdapter {
- private NamedThreadLocal<Long> startTimeThreadLocal =
- new NamedThreadLocal<Long>("StopWatch-StartTime");
- @Override
- public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
- Object handler) throws Exception {
- long beginTime = System.currentTimeMillis();//1、开始时间
- startTimeThreadLocal.set(beginTime);//线程绑定变量(该数据只有当前请求的线程可见)
- return true;//继续流程
- }
- @Override
- public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
- Object handler, Exception ex) throws Exception {
- long endTime = System.currentTimeMillis();//2、结束时间
- long beginTime = startTimeThreadLocal.get();//得到线程绑定的局部变量(开始时间)
- long consumeTime = endTime - beginTime;//3、消耗的时间
- if(consumeTime > 500) {//此处认为处理时间超过500毫秒的请求为慢请求
- //TODO 记录到日志文件
- System.out.println(
- String.format("%s consume %d millis", request.getRequestURI(), consumeTime));
- }
- }
- }
5.3.2、登录检测
java代码:
- @Override
- public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
- Object handler) throws Exception {
- //1、请求到登录页面 放行
- if(request.getServletPath().startsWith(loginUrl)) {
- return true;
- }
- //2、TODO 比如退出、首页等页面无需登录,即此处要放行 允许游客的请求
- //3、如果用户已经登录 放行
- if(request.getSession().getAttribute("username") != null) {
- //更好的实现方式的使用cookie
- return true;
- }
- //4、非法请求 即这些请求需要登录后才能访问
- //重定向到登录页面
- response.sendRedirect(request.getContextPath() + loginUrl);
- return false;
- }