Spring MVC 拦截器

1. 监听器、过滤器和拦截器对比

• Servlet：处理Request请求和Response响应；
• 过滤器（Filter）：对Request请求起到了过滤的作用，作用在Servlet之前，如果配置为 /* 会对所有的资源访问（Servlet、js/css静态资源等）进行过滤处理；
• 监听器（Listener）：实现了jax.servlet.ServletContextListener接口的服务端组件，它随着Web应用的启动而启动，只初始化一次，然后会一直运行监视，随着Web应用的停止而销毁。
  作用一：做一些初始化工作，web应用中Spring 容器启动ContextLoaderListener；
  作用二：监听web中的特定事件，比如HttpSession，ServletRequest的创建和销毁，变量的创建、销毁和修改等。可以在某些动作前后增加处理，实现监控，比如统计在线人数，利用HttpSessionListener等。
• 拦截器（Interceptor）：是Spring MVC、Struts等表现层自己的，不会拦截jsp/html/css/image等访问，只会拦截访问的控制器方法（Handler）。
  从配置的角度也能总结发现：Servlet、filter、listener是配置在web.xml中的，而Interceptor是配置在表现层框架自己的配置文件中：

1. 在Handler业务逻辑执行之前拦截一次；
2. 在Handler逻辑执行完成但未跳转页面之前拦截一次；

3. 在跳转页面之后拦截一次。

   
   Interceptor拦截器执行流程

2. 拦截器的执行流程

在运行程序时，拦截器的执行是有一定顺序的，该顺序与配置文件中所定义拦截器的顺序相关。单个拦截器，在程序中的执行流程如下图所示：

单个拦截器执行顺序

1. 程序先执行preHandle()方法，如果该方法的返回值为true，则程序会继续向下执行处理器中的方法，否则将不会向下执行；
2. 在业务处理器（即Controller类）处理完请求后，会执行postHandle()方法，然后会通过DispatcherServlet向客户端返回响应；
3. 在DispatcherServlet处理完请求之后，才会执行afterCompletion()方法；

3. 多个拦截器执行流程

多个拦截器（假设有两个拦截器Interceptor1和Interceptor2，并且在配置文件中，Interceptor1拦截器配置在前），在程序中的执行流程如下图所示：

多拦截器执行顺序

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

4. 事例代码

• 自定义Spring MVC拦截器

package com.erxiao.edu.intercepter;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpServletRequest;


/**
 * @Version 1.0
 */
public class MyIntercepter implements HandlerInterceptor {
    /**
     * 会在handler方法业务执行之前执行，往往在这里完成了权限校验
     * @param request
     * @param response
     * @param handler
     * @return 返回值boolean代表是否放行，true代表放行，false代表终止
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("MyIntercepter preHandle ........");
        return true;
    }

    /**
     * 会在handler方法业务逻辑执行之后尚未跳转页面时执行
     * @param request
     * @param response
     * @param handler
     * @param modelAndView 封装了视图数据，此时页面还没有跳转，可以在这里针对返回的数据或视图进行修改
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("MyIntercepter postHandle ........");
    }

    /**
     * 页面已经跳转完成之后执行
     * @param request
     * @param response
     * @param handler
     * @param ex 可以在这里捕获异常
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("MyIntercepter afterCompletion ........");
    }
}

• 注册Spring MVC拦截器
  在springmvc.xml文件加入mvc:interceptors标签，注册Spring MVC拦截器

        <mvc:interceptors>
                <!--拦截所有handler-->
                <!--<bean class="com.lagou.edu.interceptor.MyIntercepter01"/>-->
                <mvc:interceptor>
                        <!--配置当前拦截器的url拦截规则，**代表当前目录下及其子目录下的所有url-->
                        <mvc:mapping path="/**"/>
                        <!--exclude-mapping可以在mapping的基础上排除一些url拦截-->
                        <!--<mvc:exclude-mapping path="/demo/**"/>-->
                        <bean class="com.erxiao.edu.intercepter.MyIntercepter"/>
                </mvc:interceptor>
        </mvc:interceptors>