SprintMVC系列第12篇：拦截器怎么用？

star2017 1年前 ⋅ 261 阅读

文末可领取最近刚整理的，后端必备的200本书籍。

1、本文内容

  • 回顾下springmvc处理请求的过程（流程图）
  • 如何干预springmvc的处理流程？
  • 加入拦截器后springmvc的处理过程
  • 拦截器的用法（具体2个步骤）
  • 多个拦截器的执行顺序
  • 通过案例验证拦截器的执行顺序
  • 一起读源码
  • 领取后端必备的200本书籍

2、回顾下springmvc处理请求的过程

简化下过程，如下图，过程还是非常简单的

3、如何干预springmvc的处理流程？

比如我们的系统中，除了登录的方法，其他所有方法都需要先验证一下用户是否登录了，若未登录，让用户先跳转到登录页面，最笨的方法是在所有需要验证的方法内部都加上验证的代码，那么有没有更好的方法呢？

如下图，如果我们将验证登录的代码放在调用自定义controller的方法之前，是不是就特别爽了，就不用在所有代码中都添加验证代码了：

springmvc确实为我们考虑到了这种需求，springmvc在处理流程中为我们提供了3个扩展点可以对整个处理流程进行干预，这个就是springmvc中拦截器提供的功能，下面咱们来看一下拦截器怎么玩的。

4、拦截器（HandlerInterceptor）

springmvc中使用org.springframework.web.servlet.HandlerInterceptor接口来表示拦截器，如下，提供了3个默认方法。

  1. public interface HandlerInterceptor {
  3.    default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
  4.          throws Exception {
  6.       return true;
  7.    }
  9.    default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
  10.          @Nullable ModelAndView modelAndView) throws Exception {
  11.    }
  13.    default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
  14.          @Nullable Exception ex) throws Exception {
  15.    }
  17. }

下面来解释下这3个方法。

preHandle方法

在调用自定义的controller之前会调用这个方法，若返回false，将跳过controller方法的调用，否则将进入到controller的方法中。

postHandle方法

调用自定义controller中的方法之后会调用这个方法，此时还没有渲染视图，也就是还没有将结果输出到客户端

afterCompletion方法

整个请求处理完毕之后，即结果以及输出到客户端之后，调用这个方法，此时可以做一些清理的工作，注意这个方法最后一个参数是Exception类型的，说明这个方法不管整个过程是否有异常，这个方法都会被调用。

其他说明

  • 3个方法中的hander参数表示处理器，通常就是我们自定义的controller

5、加入拦截器后springmvc的处理流程

加入拦截器之后处理流程如下图，注意黄色背景的几个对应拦截器的3个方法。

6、拦截器的用法（2步骤）

step1：定义拦截器

自定义一个类，需要实现org.springframework.web.servlet.HandlerInterceptor接口，如下，然后实现具体的方法

  1. public class HandlerInterceptor1 implements HandlerInterceptor {
  2.     @Override
  3.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  4.         System.out.println(this.getClass().getSimpleName() + ".preHandle");
  5.         return true;
  6.     }
  8.     @Override
  9.     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
  10.         System.out.println(this.getClass().getSimpleName() + ".postHandle");
  11.     }
  13.     @Override
  14.     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
  15.         System.out.println(this.getClass().getSimpleName() + ".afterCompletion");
  16.     }
  17. }

step2：将自定义的拦截器添加到springmvc配置文件中

配置如下，需要将自定义的拦截器添加到springmvc配置文件中

  • 可以同时配置多个拦截器，每个拦截器通过<mvc:interceptor>标签来定义，多个拦截器之间可以指定顺序，顺序和<mvc:interceptor>定义的顺序一致
  • 每个拦截器需要指定实现类、拦截的url、排除的url
  1. <!-- interceptors用来定义拦截器，其内部可以定义多个拦截器 -->
  2. <mvc:interceptors>
  3.     <!-- mvc:interceptor 标签用来定义一个拦截器 -->
  4.     <mvc:interceptor>
  5.         <!-- 用来指定拦截器匹配的url，比如/user/**会拦截所有以/user开头的url -->
  6.         <mvc:mapping path="/user/**"/>
  7.         <!-- 用来指定拦截器排除的url，即这些url不会被拦截器拦截 -->
  8.         <mvc:exclude-mapping path="/user/login"/>
  9.         <!-- 用来指定拦截器 -->
  10.         <bean class="com.javacode2018.springmvc.chat09.intercetor.HandlerInterceptor1"/>
  11.     </mvc:interceptor>
  12.     <!-- 其他拦截器配置信息 -->
  13.     <mvc:interceptor>
  14.         .....
  15.     </mvc:interceptor>
  16. </mvc:interceptors>

7、多个拦截器时如何执行？

当请求的url匹配到多个拦截器的时候，执行顺序如下图

  • preHandler方法是顺序执行的，即和定义的顺序是一致的
  • 而拦截器中的其他2个方法postHandler、afterCompletion是逆序执行的，和pewHandler的顺序相反

8、案例验证拦截器的执行顺序

下面通过案例结合3个场景来看一下拦截器的执行顺序，加深大家的理解。

准备代码

UserController

  1. package com.javacode2018.springmvc.chat09.controller;
  3. import org.springframework.web.bind.annotation.RequestMapping;
  4. import org.springframework.web.bind.annotation.RestController;
  6. @RestController
  7. @RequestMapping("/user")
  8. public class UserController {
  9.     @RequestMapping("/login")
  10.     public String login() {
  11.         return "login view";
  12.     }
  14.     @RequestMapping("/add")
  15.     public String add() {
  16.         return "add view";
  17.     }
  19.     @RequestMapping("/del")
  20.     public String modify() {
  21.         return "modify view";
  22.     }
  24.     @RequestMapping("/list")
  25.     public String list() {
  26.         return "list view";
  27.     }
  28. }

创建2个拦截器

拦截器1：HandlerInterceptor1
  1. package com.javacode2018.springmvc.chat09.intercetor;
  4. import org.springframework.web.servlet.HandlerInterceptor;
  5. import org.springframework.web.servlet.ModelAndView;
  7. import javax.servlet.http.HttpServletRequest;
  8. import javax.servlet.http.HttpServletResponse;
  10. public class HandlerInterceptor1 implements HandlerInterceptor {
  11.     @Override
  12.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  13.         System.out.println(this.getClass().getSimpleName() + ".preHandle");
  14.         return true;
  15.     }
  17.     @Override
  18.     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
  19.         System.out.println(this.getClass().getSimpleName() + ".postHandle");
  20.     }
  22.     @Override
  23.     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
  24.         System.out.println(this.getClass().getSimpleName() + ".afterCompletion");
  25.     }
  26. }
拦截器2：HandlerInterceptor2
  1. package com.javacode2018.springmvc.chat09.intercetor;
  4. import org.springframework.web.servlet.HandlerInterceptor;
  5. import org.springframework.web.servlet.ModelAndView;
  7. import javax.servlet.http.HttpServletRequest;
  8. import javax.servlet.http.HttpServletResponse;
  10. public class HandlerInterceptor2 implements HandlerInterceptor {
  11.     @Override
  12.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  13.         System.out.println(this.getClass().getSimpleName() + ".preHandle");
  14.         return true;
  15.     }
  17.     @Override
  18.     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
  19.         System.out.println(this.getClass().getSimpleName() + ".postHandle");
  20.     }
  22.     @Override
  23.     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
  24.         System.out.println(this.getClass().getSimpleName() + ".afterCompletion");
  25.     }
  26. }

配置文件中配置拦截器

下面将2个拦截器加入springmvc的配置文件中，都会拦截/user开头的所有请求，/user/login被排除在外

  1. <!-- interceptors用来定义拦截器，其内部可以定义多个拦截器 -->
  2. <mvc:interceptors>
  3.     <!-- mvc:interceptor 标签用来定义一个拦截器 -->
  4.     <mvc:interceptor>
  5.         <!-- 用来指定拦截器匹配的url -->
  6.         <mvc:mapping path="/user/**"/>
  7.         <!-- 用来指定拦截器排除的url，即这些url不会被拦截器拦截 -->
  8.         <mvc:exclude-mapping path="/user/login"/>
  9.         <!-- 用来指定拦截器 -->
  10.         <bean class="com.javacode2018.springmvc.chat09.intercetor.HandlerInterceptor1"/>
  11.     </mvc:interceptor>
  12.     <!-- mvc:interceptor 标签用来定义一个拦截器 -->
  13.     <mvc:interceptor>
  14.         <!-- 用来指定拦截器匹配的url -->
  15.         <mvc:mapping path="/user/**"/>
  16.         <!-- 用来指定拦截器排除的url，即这些url不会被拦截器拦截 -->
  17.         <mvc:exclude-mapping path="/user/login"/>
  18.         <!-- 用来指定拦截器 -->
  19.         <bean class="com.javacode2018.springmvc.chat09.intercetor.HandlerInterceptor2"/>
  20.     </mvc:interceptor>
  21. </mvc:interceptors>

场景1

按照下列表格，调整下2个拦截器的preHandle方法返回值

拦截器 preHandle方法返回值
HandlerInterceptor1 true
HandlerInterceptor2 true

访问http://localhost:8080/chat09/user/add，输出

  1. HandlerInterceptor1.preHandle
  2. HandlerInterceptor2.preHandle
  3. HandlerInterceptor2.postHandle
  4. HandlerInterceptor1.postHandle
  5. HandlerInterceptor2.afterCompletion
  6. HandlerInterceptor1.afterCompletion

场景2

按照下列表格，调整下2个拦截器的preHandle方法返回值

拦截器 preHandle方法返回值
HandlerInterceptor1 false
HandlerInterceptor2 true

访问http://localhost:8080/chat09/user/add，输出

  1. HandlerInterceptor1.preHandle

场景3

按照下列表格，调整下2个拦截器的preHandle方法返回值

拦截器 preHandle方法返回值
HandlerInterceptor1 true
HandlerInterceptor2 false

访问http://localhost:8080/chat09/user/add，输出

  1. HandlerInterceptor1.preHandle
  2. HandlerInterceptor2.preHandle
  3. HandlerInterceptor1.afterCompletion

9、源码解析

拦截器的执行过程主要位于下面这段代码中

  1. 代码位置：org.springframework.web.servlet.DispatcherServlet#doDispatch

如下代码，咱们将关键代码提取出来，大家注意看注释，解释了每个方法内部干的事情，具体每个方法的内部，咱们就不进去了，很简单，有兴趣的可以自己去看，这里给大家提点建议：看源码的时候，先站在高的层次上面看代码，了解大的功能及流程之后，再去细看某个功能点，要避免上来就陷入细节中，容易迷失方向。

  1. protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
  2.     HttpServletRequest processedRequest = request;
  3.     HandlerExecutionChain mappedHandler = null;
  4.     try {
  5.         Exception dispatchException = null;
  6.         try {
  7.             //①、根据请求找到处理器
  8.             mappedHandler = getHandler(processedRequest);
  9.             HandlerAdapter ha = getHandlerAdapter(mappedHandler.getHandler());
  11.             //②、内部会调用拦截器的preHandler方法
  12.             if (!mappedHandler.applyPreHandle(processedRequest, response)) {
  13.                 return;
  14.             }
  16.             //③、调用实际的处理器（即这里面会调用咱们controller中的方法）
  17.             ModelAndView mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
  19.             //④、调用拦截器的postHandle方法
  20.             mappedHandler.applyPostHandle(processedRequest, response, mv);
  21.         } catch (Exception ex) {
  22.             dispatchException = ex;
  23.         }
  25.         //⑤、渲染视图 & 调用拦截器的afterCompletion
  26.         processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);
  27.     } catch (Exception ex) {
  28.         //⑥：异常情况，调用拦截器的afterCompletion
  29.         triggerAfterCompletion(processedRequest, response, mappedHandler, ex);
  30.     }
  31. }

10、案例代码

  1. git地址：https://gitee.com/javacode2018/springmvc-series

最新资料

更多内容请访问：IT源点

注意：本文归作者所有，未经作者允许，不得转载

#SpringMVC教程
阅读全部
相关文章推荐
  • 1

全部评论: 0 条

    我有话说: