SpringMVC拦截器详解[附带源码分析]

落日映苍穹つ 2021-11-22 07:46 352阅读 0赞

参考：[https://www.cnblogs.com/fangjian0423/p/springMVC-interceptor.html][https_www.cnblogs.com_fangjian0423_p_springMVC-interceptor.html]

**1. HandlerExecutionChain类**

由HandlerMethod和Interceptor集合组成的类，会被HandlerMapping接口的getHandler方法获取。

![aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDAxMTYyNDYzMDc0MDQucG5n][]

**2. HandlerInterceptor接口**

**　　![aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wMzAwMjMxMzM2NDk1MDgucG5n][]**

SpringMVC拦截器基础接口。

**3. AbstractHandlerMapping**

HandlerMapping的基础抽象类。

![aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDEzMjAzNTE0NTI2NjEucG5n][]

**7. MappedInterceptor**

一个包括includePatterns和excludePatterns字符串集合并带有HandlerInterceptor的类。 很明显，就是对于某些地址做特殊包括和排除的拦截器。

![aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDExMzcwMzc1NTM2MDkucG5n][]

# 源码分析 #

首先我们看下拦截器的如何被调用的。

Web请求被DispatcherServlet截获后，会调用DispatcherServlet的doDispatcher方法。

![aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDAxMDgwNzc1NTY3MDIucG5n][]

![aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDAxMDgyNTE3NzM5NDcucG5n][]

很明显地看到，在HandlerAdapter处理之后，以及处理完成之后会调用HandlerExecutionChain的方法。

HandlerExecutionChain的applyPreHandle、applyPostHandle、triggerAfterCompletion方法如下：

![aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDEwMDg0NTc1NTk3NzcuanBn][]

![aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDAxMTc0NjM0OTgwNzIucG5n][]

![aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDAxMTc1NTcwODcxODEucG5n][]

很明显，就是调用内部实现HandlerInterceptor该接口集合的各个对应方法。

下面我们看下HandlerExecutionChain的构造过程。

HandlerExecutionChain是从HandlerMapping接口的getHandler方法获取的。

HandlerMapping的基础抽象类AbstractHandlerMapping中：

![aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDEwNDUyMDQ1ODkxMTgucG5n][]

![aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDEwNTU0Mzc4NjMwNTUucG5n][]

**我们看到，HandlerExecutionChain的拦截器是从AbstractHandlerMapping中的adaptedInterceptors和mappedInterceptors属性中获取的。**

# 拦截器的配置 #

清楚了HandlerExecutionChain的拦截器属性如何构造之后，下面来看下SpringMVC是如何配置拦截器的。

1. \*-dispatcher.xml配置文件中添加 <mvc:interceptors>配置

<mvc:interceptors>
      <mvc:interceptor>
        <mvc:mapping path="/**"/>
        <mvc:exclude-mapping path="/login"/> 　　
        <mvc:exclude-mapping path="/index"/>
        <bean class="package.interceptor.XXInterceptor"/>
      </mvc:interceptor>
    </mvc:interceptors>

这里配置的每个<mvc:interceptor>都会被解析成MappedInterceptor。

其中子标签<mvc:mapping path="/\*\*"/>会被解析成MappedInterceptor的includePatterns属性；<mvc:exclude- mapping path="/\*\*"/>会被解析成MappedInterceptor的excludePatterns属性；<bean/>会被解 析成MappedInterceptor的interceptor属性。

<mvc:interceptors>这个标签是被InterceptorsBeanDefinitionParser类解析。

![aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDE3MDUzMTE2MTYyNTMucG5n][]

2. 配置RequestMappingHandlerMapping，并配置该bean对应的interceptors集合属性。 这里的interceptors集合是个Object类型的泛型集合。

AbstractHandlerMapping抽象类只暴露了1个拦截器的set方法 -> interceptors。

adaptedInterceptors和mappedInterceptors均没有暴露set方法，因此我们只能为RequestMappingHandlerMapping配置interceptors属性。

**　　其实AbstractHandlerMapping内部的 initInterceptors方法中，会遍历interceptors集合，然后判断各个项是否是MappedInterceptor、 HandlerInterceptor、WebRequestInterceptor。**

其中MappedInterceptor类型的拦截器会被加到mappedInterceptors集合 中，HandlerInterceptor类型的会被加到adaptedInterceptors集合中，WebRequestInterceptor类 型的会被适配成WebRequestHandlerInterceptorAdapter加到adaptedInterceptors集合中。

![aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDIyMjUwMDIyNDgzOTUucG5n][]

![aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDIyMjUxNjY5MjY3OTgucG5n][]

如果读者配置了:

<mvc:annotation-driven/>

那么配置如下：

否则，可以去掉order这个属性的设置。

为什么呢？ 请参考楼主的另外一篇博客：[http://www.cnblogs.com/fangjian0423/p/spring-Ordered-interface.html][http_www.cnblogs.com_fangjian0423_p_spring-Ordered-interface.html]

**　　一般建议使用第一种方法。**

[https_www.cnblogs.com_fangjian0423_p_springMVC-interceptor.html]: https://www.cnblogs.com/fangjian0423/p/springMVC-interceptor.html
[aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDAxMTYyNDYzMDc0MDQucG5n]: /images/20211122/6b1376476582429bbcb7d92744ac159a.png
[aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wMzAwMjMxMzM2NDk1MDgucG5n]: /images/20211122/2be6c53bf6c64f9e83cef91f76c81170.png
[aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDEzMjAzNTE0NTI2NjEucG5n]: /images/20211122/376e931ae3414801ade91deeee83db6c.png
[aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDExMzcwMzc1NTM2MDkucG5n]: /images/20211122/3e426fcb55894491b5f6fe438c5649d1.png
[aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDAxMDgwNzc1NTY3MDIucG5n]: /images/20211122/981d1052b30c4c368385c21c35d93e61.png
[aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDAxMDgyNTE3NzM5NDcucG5n]: /images/20211122/e4740c60021e45e4a80736388da0960c.png
[aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDEwMDg0NTc1NTk3NzcuanBn]: /images/20211122/b965b8de954d4223b2226e325338cd36.png
[aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDAxMTc0NjM0OTgwNzIucG5n]: /images/20211122/b4705d4212b04485a9e77c6dbee51d97.png
[aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDAxMTc1NTcwODcxODEucG5n]: /images/20211122/5173456d3e9c4be29742b31eea3d75bf.png
[aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDEwNDUyMDQ1ODkxMTgucG5n]: /images/20211122/670faf96d19c4207b2bac61727c3612e.png
[aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDEwNTU0Mzc4NjMwNTUucG5n]: /images/20211122/f5e386a5e35d44208a1e595f454f9a24.png
[aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDE3MDUzMTE2MTYyNTMucG5n]: /images/20211122/db5068b7e6de4040956629a28b87de5c.png
[aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDIyMjUwMDIyNDgzOTUucG5n]: /images/20211122/9007e9444d3a4fe7a0275edd01b90606.png
[aHR0cHM6Ly9pbWFnZXMwLmNuYmxvZ3MuY29tL2kvNDExNTEyLzIwMTQwNi8wNDIyMjUxNjY5MjY3OTgucG5n]: /images/20211122/3c17e479106e49fd9876911165ca5ded.png
[http_www.cnblogs.com_fangjian0423_p_spring-Ordered-interface.html]: http://www.cnblogs.com/fangjian0423/p/spring-Ordered-interface.html