springmvc拦截器（定义、配置以及执行流程）

一、拦截器概念

springmvc中的拦截器（interceptor）类似于Servlet中的过滤器（Filter），它主要用于拦截用户请求并做相应的处理。在实际项目中会经常使用到拦截器，例如在购物网站中通过拦截器可以拦截未登录的用户，禁止其购买商品，或者使用它来验证已登录用户是否有相应的操作权限（即权限验证），记录请求信息的日志等应用。

所谓拦截器，就是能够在进行某个操作之前拦截请求，如果请求符合条件就允许在往下执行。比如说，海关就是一个拦截器，他拦截进出口的货物，如果货物满足进出口条件，则放行，否则就拦截，退回处理。

二、拦截器定义和配置使用

在springmvc中要使用拦截器，就需要对拦截器类进行定义和配置，通常拦截器类可以通过两种方式来定义。

第一种通过实现HandleInterceptor接口，或者继承HandleInterceptor接口的实现类HandleInterceptorAdapter来定义；

第二种通过实现WebRequestInterceptor接口，或继承WebRequestInterceptor接口的实现类来定义。

1、拦截器的定义：以实现HandleInterceptor接口为例

public class LoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //做一些操作 方法返回类型为布尔值
        return false;
    }
 
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
		//做一些操作
    }
 
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
		//做一些操作
    }
}

从以上可以看出，自定义的拦截器类实现了HandlerInterceptor接口，并且实现了接口中的三个方法。对这三个方法解释如下：

（1）、preHandle()方法

该方法会在控制器方法前执行，其返回值表示是否中断后续操作。当返回值为true时，表示继续向下执行；当返回值为false时，会中断后续的所有操作（包括调用下一个拦截器和控制器类中的方法执行等）。

（2）、postHandle()方法

该方法会在控制器方法调用之后，且解析视图之前执行。可以通过此方法对请求域中的模型和视图做出进一步的修改。

（3）、afterCompletion()方法

该方法会在整个请求完成，即视图渲染结束之后执行。可以通过此方法实现一些资源清理、记录日志信息等工作。

---

2、拦截器的配置
要使自定义的拦截器类生效，还需要在springmvc的配置文件中进行配置。配置如下所示：

<!-- 配置拦截器 -->
<mvc:interceptors>
    <!-- 使用bean直接定义在<mvc:interceptors>下面的Interceptor将拦截所有请求 -->
    <bean class="com.config.AllInterceptor"/>
    
    <!-- 拦截器1 -->
    <mvc:interceptor>
        <!-- 配置拦截器作用的路径，/**表示拦截所有路径 -->
        <mvc:mapping path="/**"/>	
        <!-- 配置不需要拦截器作用的路径 /admin表示放行所有以/admin结尾的路径 -->
        <mvc:exclude-mapping path="/admin"/>	
        <!-- 定义在<mvc:interceptor>下面的Interceptor，表示对匹配路径的请求才进行拦截 -->
        <bean class="com.config.AdminInterceptor"/>
    </mvc:interceptor>
    
    <!-- 拦截器2 -->
    <mvc:interceptor>
        <mvc:mapping path="/index/**"/>
        <bean class="com.config.IndexInterceptor"/>
    </mvc:interceptor>
    
     <!-- 后面可以配置多个拦截器-->
    
</mvc:interceptors>

需要注意的是在进行配置拦截器时，必须按照如上的顺序进行配置，否则拦截器将失效。

三、拦截器执行流程

在运行程序时，拦截器的执行是有一定的顺序的，该顺序与配置文件中所定义的拦截器的顺序是相关的。拦截器执行顺序有两种情况，即单个拦截器和多个拦截器的情况，单个拦截器和多个拦截器的执行顺序是不一样的，略有差别。

1、单个拦截器执行流程

当只定义了一个拦截器时，它的执行流程如下图所示：

对单个拦截器执行流程解释如下：
从以上图中可以看出，程序首先会执行拦截器类中的preHandle()方法，如果该方法返回true，则程序会继续向下执行处理器中的方法，否则程序将不再往下继续执行。在业务处理器（即控制器Controller类）处理完请求后，会执行postHandle()方法，然后会通过DispatcherServlet向客户端返回响应，在DispatcherServlet处理完请求后，才会执行afterCompletion()方法。

因此单个拦截器的执行流程：
prehandle()——Handle（也就是控制器里的方法）——postHandle()——afterCompletion()。

---

2、多个拦截器执行流程
在大型的企业级项目中，通常会配置多个拦截器来实现不同的功能。例如在springmvc配置文件中配置了两个拦截器Interceptor1和Interceptor2。配置顺序Interceptor1在Interceptor2的前面。
则它们的执行流程如下图所示：

从以上执行流程图中可以看出，当有多个拦截器同时工作时，它们的preHandle()方法会按照配置文件中拦截器的配置顺序执行，而它们的postHandle()和afterCompletion()方法则会按照配置顺序的反序执行。

因此当多个拦截器工作时，其执行流程：
preHandle1——preHandle2——Handle——postHandle2——postHandle1——afterCompletion2——afterCompletion1··········

多个拦截器存在时，其preHandle方法是按次序执行，其余的则是相反顺序执行。