springMVC中拦截器执行时机和执行顺序分析

1. 拦截器的作用时机

• 和过滤器一样，拦截器也可以拦截请求。
• 过滤器是在DispatcherServlet处理之前拦截，拦截器是在DispatcherServlet处理请求然后调用控制器方法(即我们自己写的处理请求的方法，用@RequestMapping标注)之前进行拦截。

2. 拦截器的三个默认方法

• 实现拦截器需要实现HandlerInterceptor这个接口，这个接口中有三个默认方法，这三个方法的执行顺序：
  • preHandle：控制器方法执行之前执行preHandle()，返回值是一个boolean，表示是否拦截或放行，返回true为放行，即调用控制器方法；返回false表示拦截，即不调用控制器方法
  • postHandle：控制器方法执行之后执行postHandle()
  • afterComplation：处理完视图和模型数据，渲染视图完毕之后执行afterComplation()
• 我们实现接口然后重写这三个方法，就会在对应的时机被自动执行。

3. 分析拦截器方法执行时机

3.1 preHandle()和postHandle()执行时机

• 在处理请求的时候会调用DispatcherServlet，这里面有如下代码:

• 

  • mv=ha.handle()这里就是调用处理请求的方法，返回值是一个ModelAndView类型的对象。

  • 上图这里可以看见在mv=ha.handle()之前和之后调用了applayPreHandle()和applyPostHandle()两个方法。这两个方法就是执行所有拦截器的preHandle()方法和postHandle()方法。因此可以看见在处理请求之前执行preHandle()，处理请求之后执行postHandle()。

  • 上图的mappedHandler是一个处理执行链，类型为HandlerExecutionChain

    • 这个对象包含三个属性，如下图所示：
      • 第一个handler表示当前请求对应的控制器方法；
      • 第二个表示当前请求对应的所有拦截器集合，可以看见第一个是自带的拦截器，第二个是我们配置的；
      • 第三个表示的是applyPreHandle()这个方法执行完后最后一个PreHandle()方法返回ture的拦截器的索引。
      • 

  • 既然有拦截就要有放行，拦截器的三个方法中要想要进行拦截肯定得在处理器方法执行之前，即只有PreHandle()方法会进行拦截然后判断是否放行。看下三个方法的源码，只有PreHandle()方法有返回值，返回true代表放行，false代表不放行：

    

  • 这里调用applyPreHandler()方法的源码：

    boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception {
        //这里循环遍历所有的interceptor,按顺序遍历，这个顺序就是我们在配置文件中配置的顺序，除了我们配置的还有一个自带的，
        //这个拦截器是第一个生效的，索引是0
        //for循环的第三个表示将每个返回true的拦截器的索引,赋值给interceptorIndex属性,然后再让索引自增，即interceptorIndex记录的就是
        //这个applyPreHandeler()方法执行完后最后一个放行的拦截器的索引
        for(int i = 0; i < this.interceptorList.size(); this.interceptorIndex = i++) {
            HandlerInterceptor interceptor = (HandlerInterceptor)this.interceptorList.get(i);
            //这里会调用每一个interceptor的preHandle方法，然后如果返回false表示不放行
            if (!interceptor.preHandle(request, response, this.handler)) {
                this.triggerAfterCompletion(request, response, (Exception)null);
                return false;
            }
        }
    
        return true;
    }
    

    • 如果preHandle()返回false则进入if语句，里面同样会返回false，然后返回到上一层调用的地方：
      • 这里是false则进入if语句，直接retrun，因此不会执行下面的控制器方法，这就意味着preHandle()返回false代表不放行。

3.2 afterComplation方法执行时机

• 在DispatcherServlet中有如下代码：

• 
• • 这里的this.render()方法就是渲染视图的，在这个方法下面调用了treggerAfterCompletion()方法，这个方法会调用不放行的那个拦截器之前的所有拦截器的afterComplation方法。因此在渲染视图之后调用afterComplation。
  • 但是如果前面的PreHandle方法如果不放行，则执行不到这里，但是前面的applyPreHandler()方法中会在不放行的时候自己调用treggerAfterCompletion()方法，因此放行和不放行执行treggerAfterCompletion()方法的地方不是同一个。

4. 多个拦截器时每个方法的执行顺序

• 若每个拦截器的preHandle()都返回true
  • 此时多个拦截器的执行顺序和拦截器在SpringMVC的配置文件的配置顺序有关：
  • preHandle()会按照配置的顺序执行，而postHandle()和afterComplation()会按照配置的反序执行

4.1 分析顺序执行和反序执行

这里看源码：

preHandle

• 这里调用所有拦截器的preHandle()方法：

  

  • 这里for循环遍历从索引0开始遍历interceptorList集合中的所有拦截器，这个集合拦截器的索引顺序就是我们在配置文件中配置的顺序，因此preHandle()是按照配置顺序执行

postHandle

• 这里会调用所有拦截器的postHandle()方法：

  

  • 这个方法的调用是在applyPreHandler()这个方法执行完后执行的，因此如果这个applyPreHandler()方法在遍历所有拦截器的preHandle()方法时碰到了返回false的，即不放行，则会直接return掉，不会执行这个applyPostHandle()方法。因此只要有一个拦截器不放行，则所有拦截器的postHandle()都不执行，如下图：
  • 

• 如果所有的PreHandle()方法都放行，则会执行这个applyPostHandle()方法，从这里可以看到它是从interceptorList集合的最后一个索引开始向前遍历的，因此是反序

  • 

afterComplation

• 下面代码会执行所有拦截器的afterComplation()方法，可以看出for循环遍历拦截器集合的时候也是从后往前遍历的

  

上述的**triggerAfterCompletion()方法有两个地方可能会执行**：

• 1. 如果有拦截器不放行：在执行所有PreHandle()方法的applyPreHandler()方法中，如果碰到某个拦截器的PreHandle()方法不放行，就会执行triggerAfterCompletion()方法。此时不会渲染视图，因为被拦截了。

     

  2. 如果全部放行：则会在视图渲染之后执行，上面有分析。

• 有拦截器不放行时：

  • 源码：for循环里面的if语句在判断时就会执行preHandle()，如果不放行则进入if语句，里面会调用triggerAfterCompletion()方法

  • 此时preHandle()返回false的那个拦截器之前的拦截器的afterComplation()会执行，理由如下：

    • 这里会调用最后一个放行的拦截器和它之前的所有拦截器的afterComplation()方法：

      

    • this.interceptorIndex就是在applyPreHandler()方法中赋值的，它记录的是最后一个放行的拦截器在集合中的索引，而preHandle()方法在碰到返回false的preHandle()拦截器方法后就会执行这个triggerAfterCompletion()方法(即这个拦截器的preHandle()方法不放行)，此时this.interceptorIndex就记录的是最后一个放行的拦截器索引。

    • 因此返回false的拦截器之前的拦截器的afterComplation()都会执行

• 若某个拦截器的preHandle()返回了false

  • 即如果某个拦截器的preHandle()返回了false，则preHandle()执行次数会比afterComplation()执行次数多一次，多的就是按个返回false的preHandle()