什么是拦截器
从名称可以看出，主要是拦截Handler，在一个请求进来后，开始执行Handler之前，执行handler之后，handler执行完成后【无论成功与否】，执行一些操作（Hander可以简单理解成Controller中的带有注解@RequestMapping的方法，具体请参考springMVC 路由）
应用场景
1、日志记录，可以记录请求信息的日志，以便进行信息监控、信息统计等。
2、权限检查，如登陆检测，进入处理器检测是否登陆，如果没有直接返回到登陆页面。HandlerInterceptor 定义
1public interface HandlerInterceptor {
2 /**
3 * 预处理回调方法，实现处理器的预处理，第三个参数为响应的处理器，自定义Controller
4 * 返回值：true表示继续流程（如调用下一个拦截器或处理器）；false表示流程中断
5 * 不会继续调用其他的拦截器或处理器，此时我们需要通过response来产生响应
6 */
7 default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
8 throws Exception {
9 return true;
10 }
11 /**
12 * 后处理回调方法，实现处理器的后处理（渲染视图之前）
13 * 此时我们可以通过modelAndView（模型和视图对象）对模型数据进行处理或对视图进行处理
14 * modelAndView也可能为null，如API接口返回JSON数据时
15 */
16 default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
17 @Nullable ModelAndView modelAndView) throws Exception {
18 }
19 /**
20 * 整个请求处理完毕回调方法，即在视图渲染完毕时回调
21 * 如性能监控中我们可以在此记录结束时间并输出消耗时间
22 * 还可以进行一些资源清理，类似于try-catch-finally中的finally，但仅调用处理器执行链中
23 */
24 default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
25 @Nullable Exception ex) throws Exception {
26 }
27}
拦截器初始化
1、spring mvc中一般是通过 mvc:interceptors 个标签来配置拦截器，其中配置
1<mvc:mapping path="/**"/> 会被解析成MappedInterceptor的includePatterns属性；
2<mvc:exclude-mapping path="/**"/>会被解析成MappedInterceptor的excludePatterns属性；
3<bean/>会被解析成MappedInterceptor的interceptor属性
4<mvc:interceptors>这个标签是被InterceptorsBeanDefinitionParser类解析，可以自行查看源码
1 <mvc:interceptors>
2 <mvc:interceptor>
3 <mvc:mapping path="/**"/>
4 <bean class="com.seven.springmvc.interceptor.SyslogInterceptor" />
5 </mvc:interceptor>
6 </mvc:interceptors>
2、interceptor的初始化是在初始化HandlerMapping时完成的，HandlerMapping多数是通过继承AbstractHandlerMapping实现的，
因为AbstractHandlerMapping实现ApplicationContextAware接口，bean初始化完成后会执行setApplicationContext方法，通过源码看到最终执行如下方法
1 protected void initApplicationContext() throws BeansException {
2 extendInterceptors(this.interceptors);//用于扩展拦截器
3 detectMappedInterceptors(this.adaptedInterceptors);//直接加载spring 容器中所有实现了MappedInterceptor接口的拦截器
4 initInterceptors();//则是把extendInterceptors中的扩展方法加入到adaptedInterceptors集合中
5 }
1 protected void detectMappedInterceptors(List<HandlerInterceptor> mappedInterceptors) {
2 mappedInterceptors.addAll(
3 BeanFactoryUtils.beansOfTypeIncludingAncestors(
4 obtainApplicationContext(), MappedInterceptor.class, true, false).values());
5 }
3、detectMappedInterceptors方法就是从spring容器中遍历所有实现HandlerInterceptor接口的bean，并将其包装成MappedInterceptor，并赋值给AbstractHandlerMapping的adaptedInterceptors属性
至此每个HandlerMapping加载完成时已经完成了对应的Interceptor的加载工作
拦截器实现原理
1、当请求进来后，最终执行DispatcherServlet的doDispatch方法开始处理请求，如下
1 protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
2 HttpServletRequest processedRequest = request;
3 HandlerExecutionChain mappedHandler = null;
4 boolean multipartRequestParsed = false;
5 WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);
6 try {
7 ModelAndView mv = null;
8 Exception dispatchException = null;
9 try {
10 processedRequest = checkMultipart(request);
11 multipartRequestParsed = (processedRequest != request);
12 // 此处开始遍历HandlerMapping，获取HandlerExecutionChain，这里方法执行完后，针对此次请求，已经确定有几个拦截器可以被执行了
13 mappedHandler = getHandler(processedRequest);
14 HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());
15 //开始这行preHandler的预处理方法，会遍历HandlerExecutionChain 中的所有拦截器，并执行器preHandler方法，如果有方法返回false，则直接返回，不在继续执行
16 if (!mappedHandler.applyPreHandle(processedRequest, response)) {
17 return;
18 }
19 // 开始真正执行Handler方法
20 mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
21 applyDefaultViewName(processedRequest, mv);
22//具体Controler中的方法执行完成后开始执行拦截器的postHandler方法，注意此时是和preHandler的执行顺序是相反的
23 mappedHandler.applyPostHandle(processedRequest, response, mv);
24 }
25 //开始遍历并执行拦截器的AfterCompletion方法，注意此时是根据handlerIndex反向执行的
26 processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
27 }
28 catch (Exception ex) {
29 triggerAfterCompletion(processedRequest, response, mappedHandler, ex);
30 }
31 catch (Throwable err) {
32 triggerAfterCompletion(processedRequest, response, mappedHandler,
33 new NestedServletException("Handler processing failed", err));
34 }
35 finally {
36 if (asyncManager.isConcurrentHandlingStarted()) {
37 // Instead of postHandle and afterCompletion
38 if (mappedHandler != null) {
39 mappedHandler.applyAfterConcurrentHandlingStarted(processedRequest, response);
40 }
41 }
42 else {
43 // Clean up any resources used by a multipart request.
44 if (multipartRequestParsed) {
45 cleanupMultipart(processedRequest);
46 }
47 }
48 }
49 }
2、AbstractHandlerMapping中获取HandlerExecutionChain的过程如下，请求进来后，在HandlerMapping中会根据具体的请求path来选择合适的拦截器，因为在初始化HandlerMapping的时候，已经把所有的HandlerInterceptor全部加载完成了
1protected HandlerExecutionChain getHandlerExecutionChain(Object handler, HttpServletRequest request) {
2 HandlerExecutionChain chain = (handler instanceof HandlerExecutionChain ?
3 (HandlerExecutionChain) handler : new HandlerExecutionChain(handler));
4 String lookupPath = this.urlPathHelper.getLookupPathForRequest(request);
5 for (HandlerInterceptor interceptor : this.adaptedInterceptors) {
6 if (interceptor instanceof MappedInterceptor) {
7 MappedInterceptor mappedInterceptor = (MappedInterceptor) interceptor;
8 if (mappedInterceptor.matches(lookupPath, this.pathMatcher)) {
9 chain.addInterceptor(mappedInterceptor.getInterceptor());
10 }
11 }
12 else {
13 chain.addInterceptor(interceptor);
14 }
15 }
16 return chain;
17 }
拦截器和Filter的区别
Filter是web容器定义的，由servlet容器来加载并执行，基本可以拦截所有请求，interceptor是spring mvc这种web框架定义的，用于在handler执行前后执行的，仅针对handler进行拦截，且是pring 来加载并执行的
针对执行顺序，自然是filter先被执行，然后是拦截器的执行，拦截器是按照顺序执行prehandler，然后按照相反的顺序执行postHandler的，且不论方法执行成功与否，会按照相反的和preHander相反的顺序执行afterCompletion【仅执行已经执行过preHander方法的拦截器】
微信公众号：宋坤明
更多精彩请参考 完整版系列 请参考此博文 也可以直接关注我
共同学习，写下你的评论
评论加载中...
作者其他优质文章
