Spring MVC之拦截器(Inteceptor)的使⽤

一. 监听器、过滤器和拦截器对⽐

（1）Servlet：处理Request请求和Response响应

（2）过滤器（Filter）：对Request请求起到过滤的作⽤，作⽤在Servlet之前，如果配置为/*可以对所 有的资源访问（servlet、js/css静态资源等）进⾏过滤处理

（3）监听器（ Listener ）：实现了 javax.servlet.ServletContextListener 接⼝的服务器端组件，它随 Web 应⽤的启动⽽启动，只初始化⼀次，然后会⼀直运⾏监视，随 Web 应⽤的停⽌⽽销毁

作⽤⼀： 做⼀些初始化⼯作， web 应⽤中 spring 容器启动 ContextLoaderListener

作⽤⼆： 监听 web 中的特定事件，⽐如 HttpSession,ServletRequest 的创建和销毁；变量的创建、

销毁和修改等。可以在某些动作前后增加处理，实现监控，⽐如统计在线⼈数，利⽤

HttpSessionLisener 等。

（4）拦截器（ Interceptor ）：是 SpringMVC 、 Struts 等表现层框架⾃⼰的，不会拦截

jsp/html/css/image 的访问等，只会拦截访问的控制器⽅法（ Handler ）。

从配置的⻆度也能够总结发现： serlvet 、 fifilter 、 listener 是配置在 web.xml 中的，⽽ interceptor 是

配置在表现层框架⾃⼰的配置⽂件中的

• 在Handler业务逻辑执⾏之前拦截⼀次
• 在Handler逻辑执⾏完毕但未跳转⻚⾯之前拦截⼀次
• 在跳转⻚⾯之后拦截⼀次

二. 拦截器的执⾏流程

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

 

1 ）程序先执⾏ preHandle() ⽅法，如果该⽅法的返回值为 true ，则程序会继续向下执⾏处理器中的⽅法，否则将不再向下执⾏。

2 ）在业务处理器（即控制器 Controller 类）处理完请求后，会执⾏ postHandle() ⽅法，然后会通过

DispatcherServlet 向客户端返回响应。

3 ）在 DispatcherServlet 处理完请求后，才会执⾏ afterCompletion() ⽅法。

三. 多个拦截器的执⾏流程

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

 

从图可以看出，当有多个拦截器同时⼯作时，它们的 preHandle() ⽅法会按照配置⽂件中拦截器的配置顺序执⾏，⽽它们的 postHandle() ⽅法和 afterCompletion() ⽅法则会按照配置顺序的反序执⾏。

四. 代码示例

⾃定义SpringMVC拦截器

package com.lagou.edu.interceptor;


import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * 自定义springmvc拦截器
 */
public class MyIntercepter01 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("MyIntercepter01 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("MyIntercepter01 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("MyIntercepter01 afterCompletion......");
    }
}

SpringMVC.xml中注册SpringMVC拦截器

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


        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <bean class="com.lagou.edu.interceptor.MyIntercepter02"/>
        </mvc:interceptor>
        
    </mvc:interceptors>