Interceptor拦截器概述

拦截器概述

        Spring MVC 中的拦截器(Interceptor) 类似于Servlet 中的过滤器(Filter)，它主要用于拦截用户请求并做相应的处理。例如通过拦截器可以进行权限验证、记录请求信息的日志、判断用户是否登录等。

拦截器的定义：

        要使用 Spring MVC 中的拦截器，就需要对拦截器进行定义和配置。通常拦截器类可以通过两种方式来定义。一种是通过实现 HandlerInterceptor 接口，或继承 HandlerInterceptor 接口的实现类 (如HandlerInterceptorAdapter) 来定义；另一种是通过实现 WebRequestHandlerInterceptor 接口，或继承 WebRequestHandlerInterceptor 接口的实现类来定义。

以实现 HandlerInterceptor 接口的定义方式为例，自定义拦截器类的代码如下所示：

从以上代码可以看出，自定义的拦截器类实现了 HandlerInterceptor 接口，并实现了接口中的三个方法。关于者三个方法的具体描述如下。

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

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

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

拦截器的配置：

        要使自定义的拦截器类生效，还需要在Spring MVC 的配置文件中进行配置，配置代码如下所示。

在上述代码中，<mvc:interceptors> 元素用于配置一组拦截器，其子元素 <bean> 中定义的是全局拦截器，它会拦截所有的请求；而 <mvc:interceptor> 元素中定义的是指定路径的拦截器，它会对指定路径下的请求生效。<mvc:interceptor> 元素的子元素 <mvc:mapping> 用于配置拦截器作用的路径，该路径在其属性 path 中定义。如上述代码中 path 的属性值 “/**” 表示拦截所有路径，“/hello” 表示拦截所有以 “/hello” 结尾的路径。如果在请求路径中包含不需要拦截的内容，还可以通过 <mvc:exclude-mapping> 元素进行配置。

需要注意的是，<mvc:interceptor> 中的子元素必须按照上述代码的配置顺序进行编写，即<mvc:mapping .../>  ->  <mvc:exclude-mapping .../>  ->  <bean .../>的顺序，否则文件会报错。

拦截器的执行过程

单个拦截器的执行流程：

        在运行程序时，拦截器的执行是有一定顺序的，该顺序与配置文件中所定义的拦截器的顺序相关。如果在项目中只定义了一个拦截器，那么该拦截器在程序中的执行流程如下。

 

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

多个拦截器的执行流程：

下面通过一张图来描述多个拦截器的执行流程( 假设有两个拦截器 Intercept1 和 Intercept2 ，并且在配置文件中，Intercept1 拦截器配置器在前)，如下图所示。

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