SpringMVC学习笔记（二） 处理器拦截器详解

Spring Web MVC的处理器拦截器类似于Servlet开发中的过滤器Filter，用于对处理器进行预处理和后处理。

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

拦截器接口源码

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 AsyncHandlerInterceptor {

/**
     * This implementation always returns {@code true}.
     */
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
        throws Exception {
        return true;
    }

    /**
     * This implementation is empty.
     */
    public void postHandle(
            HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)
            throws Exception {
    }

    /**
     * This implementation is empty.
     */
    public void afterCompletion(
            HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
    }

    /**
     * This implementation is empty.
     */
    public void afterConcurrentHandlingStarted(
            HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
    }

}

下面写一个拦截器的demo。

1.首先定义三个不同的拦截器
HandlerInterceptor1 拦截器

    public class HandlerInterceptor1 extends HandlerInterceptorAdapter {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        System.out.println("===========HandlerInterceptor1 preHandle");

        return true;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView){
        System.out.println("===========HandlerInterceptor1 postHandle");
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex){
        System.out.println("===========HandlerInterceptor1 afterCompletion");
    }
 }

HandlerInterceptor2拦截器

    public class HandlerInterceptor2 extends HandlerInterceptorAdapter {
    //此处一般继承HandlerInterceptorAdapter适配器即可
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        System.out.println("===========HandlerInterceptor2 preHandle");

        return true;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView){
        System.out.println("===========HandlerInterceptor2 postHandle");
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex){
        System.out.println("===========HandlerInterceptor2 afterCompletion");
    }
}

HandlerInterceptor3拦截器

    public class HandlerInterceptor3 extends HandlerInterceptorAdapter {
    //此处一般继承HandlerInterceptorAdapter适配器即可
    @Override
      public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        System.out.println("===========HandlerInterceptor3 preHandle");

        return true;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView){
        System.out.println("===========HandlerInterceptor3 postHandle");
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex){
        System.out.println("===========HandlerInterceptor3 afterCompletion");
    }
}

2.spring-servlet.xml中添加如下配置：

 <mvc:interceptors>
    <bean id="handlerInterceptor1"
          class="com.spring.interceptor.HandlerInterceptor1"/>
    <bean id="handlerInterceptor2"
          class="com.spring.interceptor.HandlerInterceptor2"/>
    <mvc:interceptor>
        <mvc:mapping path="/view"/>
        <bean id="handlerInterceptor3"
              class="com.spring.interceptor.HandlerInterceptor3"/>
    </mvc:interceptor>
</mvc:interceptors>

拦截器的执行顺序:
preHandle方法按照上述配置文件中的配置顺序执行
postHandle和afterCompletion方法则按照上述顺序的倒序执行

使用<mvc:interceptor>标签配置拦截器，可添加”/view”等路径配置，设置需要拦截的请求路径；默认的<bean>标签配置的拦截器可拦截所有的请求。

至此：拦截器已配置完成，请求非/view路径和/view路径请求的控制台输出结果分别如下：

===========HandlerInterceptor1 preHandle
===========HandlerInterceptor2 preHandle
===========HandlerInterceptor2 postHandle
===========HandlerInterceptor1 postHandle
===========HandlerInterceptor2 afterCompletion
===========HandlerInterceptor1 afterCompletion

***********************************************************************************

===========HandlerInterceptor1 preHandle
===========HandlerInterceptor2 preHandle
===========HandlerInterceptor3 preHandle
===========HandlerInterceptor3 postHandle
===========HandlerInterceptor2 postHandle
===========HandlerInterceptor1 postHandle
===========HandlerInterceptor3 afterCompletion
===========HandlerInterceptor2 afterCompletion
===========HandlerInterceptor1 afterCompletion