SpringMVC 中的Interceptor 拦截器

一. 使用场景

　　　　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

HttpServletRequest request, HttpServletResponse response, Object handle

预处理回调方法，实现处理器的预处理（如登录检查），第三个参数为响应的处理器；

该方法将在请求处理之前进行调用。SpringMVC 中的Interceptor 是链式的调用的，在一个应用中或者说是在一个请求中可以同时存在多个Interceptor 。每个Interceptor 的调用会依据它的声明顺序依次执行，而且最先执行的都是Interceptor 中的preHandle 方法，所以可以在这个方法中进行一些前置初始化操作或者是对当前请求的一个预处理，也可以在这个方法中进行一些判断来决定请求是否要继续进行下去。

该方法的返回值是布尔值Boolean 类型的，

当返回值为false 时，表示请求结束，后续的Interceptor 和Controller 都不会再执行，此时我们需要通过response来产生响应；

当返回值为true 时就会继续调用下一个Interceptor 的preHandle 方法，如果已经是最后一个Interceptor 的时候就会是调用当前请求的Controller 方法。

postHandle

HttpServletRequest request, HttpServletResponse response, Object handle, ModelAndView modelAndView

后处理回调方法，实现处理器的后处理（但在渲染视图之前），此时我们可以通过modelAndView（模型和视图对象）对模型数据进行处理或对视图进行处理，modelAndView也可能为null。顾名思义就是在当前请求进行处理之后，也就是Controller 方法调用之后执行，但是它会在DispatcherServlet 进行视图返回渲染之前被调用，所以我们可以在这个方法中对Controller 处理之后的ModelAndView 对象进行操作。postHandle 方法被调用的方向跟preHandle 是相反的，也就是说先声明的Interceptor 的postHandle 方法反而会后执行，这和Struts2 里面的Interceptor 的执行过程有点类型。Struts2 里面的Interceptor 的执行过程也是链式的，只是在Struts2 里面需要手动调用ActionInvocation 的invoke 方法来触发对下一个Interceptor 或者是Action 的调用，然后每一个Interceptor 中在invoke 方法调用之前的内容都是按照声明顺序执行的，而invoke 方法之后的内容就是反向的。

afterCompletion

HttpServletRequest request, HttpServletResponse response, Object handle, Exception ex

整个请求处理完毕回调方法，即在视图渲染完毕时回调，如性能监控中我们可以在此记录结束时间并输出消耗时间，还可以进行一些资源清理，类似于try-catch-finally中的finally，但仅调用处理器执行链中preHandle返回true的拦截器的afterCompletion。该方法也是需要当前对应的Interceptor 的preHandle 方法的返回值为true 时才会执行。该方法将在整个请求结束之后，也就是在DispatcherServlet 渲染了对应的视图之后执行。这个方法的主要作用是用于进行资源清理工作的。

三. 自定义拦截器模拟一个用户是否登录实例。

1. 在beans.xml中加入

 <!-- 自定义拦截器 -->    <mvc:interceptors>        <mvc:interceptor>            <mvc:mapping path="/**">            <bean class="com.haut.phonemanage.interceptor.LoginInterceptor"></bean>        </mvc:mapping></mvc:interceptor>    </mvc:interceptors>

2、LoginInterceptor

 public class LoginInterceptor implements HandlerInterceptor {    @Override    public void afterCompletion(HttpServletRequest request,            HttpServletResponse response, Object handler, Exception exception)            throws Exception {    }    @Override    public void postHandle(HttpServletRequest request, HttpServletResponse response,            Object handler, ModelAndView view) throws Exception {    }    @Override    public boolean preHandle(HttpServletRequest request, HttpServletResponse response,            Object handler) throws Exception {        final String ENC = "UTF-8";        String fullPath = request.getRequestURI();        String queryString = request.getQueryString();        String contextPath = request.getContextPath();        String controllerPath = fullPath.replace(contextPath, "");                HttpSession session = request.getSession();        Object account = session.getAttribute("account");                if(queryString != null && !queryString.trim().equals("")) {            queryString = "?" + queryString;        }                if(!controllerPath.startsWith("/passport") && account == null) {            response.sendRedirect(contextPath + "/passport?path=" + URLEncoder.encode(contextPath + controllerPath + queryString, ENC));        }        return true;    }}