SpringMVC自定义处理器拦截器

处理器拦截器简介

Spring Web MVC的处理器拦截器（如无特殊说明，下文所说的拦截器即处理器拦截器）
类似于Servlet开发中的过滤器Filter，用于对处理器进行预处理和后处理。

常见应用场景

• 日志记录：记录请求信息的日志，以便进行信息监控、信息统计、计算PV（Page View）等。
• 权限检查：如登录检测，进入处理器检测检测是否登录，如果没有直接返回到登录页面；
• 性能监控：有时候系统在某段时间莫名其妙的慢，可以通过拦截器在进入处理器之前记录开始时间，在处理完后记录结束时间，从而得到该请求的处理时间（如果有反向代理，如apache可以自动记录）；
• 通用行为：读取cookie得到用户信息并将用户对象放入请求，从而方便后续流程使用，还有如提取Locale、Theme信息等，只要是多个处理器都需要的即可使用拦截器实现。
• OpenSessionInView：如Hibernate，在进入处理器打开Session，在完成后关闭Session。

本质也是AOP（面向切面编程），也就是说符合横切关注点的所有功能都可以放入拦截器实现。

拦截器接口

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：预处理回调方法，实现处理器的预处理（如登录检查），
  第三个参数为响应的处理器（如我们上一章的Controller实现）；

  返回值：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。  } 

另外WebRequestHandlerInterceptorAdapter的实现类似

运行流程图

接下来看一下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);                      }                  }              }          }      }  

正常流程

拦截器实现

package com.lf.web;import org.springframework.web.servlet.ModelAndView;import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;/** * Created by LF on 2017/5/7. */public class MyHandlerInterceptor extends HandlerInterceptorAdapter {    @Override    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {        System.out.println("===========HandlerInterceptor1 preHandle");        return super.preHandle(request, response, handler);    }    @Override    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {        super.postHandle(request, response, handler, modelAndView);        System.out.println("===========HandlerInterceptor1 postHandle");    }    @Override    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {        super.afterCompletion(request, response, handler, ex);        System.out.println("===========HandlerInterceptor1 afterCompletion");    }}

控制器

参考control包

配置到mvc环境中

xml形式

<bean id="handlerInterceptor1"   class="com.lf.web.MyHandlerInterceptor"/>  <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">      <property name="interceptors">          <list>             <ref bean="handlerInterceptor1"/>            <ref bean="handlerInterceptor2"/>          </list>      </property>  </bean>  

java代码形式

package com.lf.web;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.ComponentScan;import org.springframework.context.annotation.Configuration;import org.springframework.web.servlet.ViewResolver;import org.springframework.web.servlet.config.annotation.*;import org.springframework.web.servlet.view.InternalResourceViewResolver;/** * Created by LF on 2017/5/4. */@Configuration@EnableWebMvc@ComponentScan//组件扫描public class WebConfig extends WebMvcConfigurerAdapter {    @Bean    public ViewResolver viewResolver() {        InternalResourceViewResolver resolver = new InternalResourceViewResolver();        resolver.setPrefix("/WEB-INF/");        resolver.setSuffix(".jsp");        return resolver;    }    @Override    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {        configurer.enable();    }    @Override    public void addInterceptors(InterceptorRegistry registry) {        super.addInterceptors(registry);        registry.addInterceptor(new MyHandlerInterceptor());    }}

项目代码

http://git.oschina.net/null_064_8008/SpringLearning/tree/master/MyDispatcherServlet?dir=1&filepath=MyDispatcherServlet&oid=44434ae431786d75ec80c6453c0941dd9962451d&sha=684b9f1bc09736c99cdce214183e06fe3c707c97