【SpringMVC】SpringMVC拦截器小结

【SpringMVC】SpringMVC拦截器

SpringMVC中的拦截器（interceptor）类似于Servlet中的过滤器（Filter），主要用于拦截用户请求并做出处理。例如权限验证、判断登录状态等。


注： 如果你也是SSM初学者，个人推荐书籍《Spring+SpringMVC+MyBatis从零开始学》（清华大学出版社），该书配合哔哩哔哩的一些视频教程可以很好的入门SSM框架。

1、SpringMVC拦截器的实现方式

• 使用SpringMVC的拦截器通常通过以下两种方式实现：

  • 一种是通过实现HandlerInterceptor接口或者继承HandlerInterceptor接口的实现类来定义。
  • 另一种是通过实现 WebRequestInterceptor 接口或继承 WebRequestInterceptor 接口的实现类来定义。

• 实际应用中通常使用继承 HandlerInterceptor 接口的方式实现，如下：

  package com.Etui.interceptor;
  
  import org.springframework.web.servlet.HandlerInterceptor;
  import org.springframework.web.servlet.ModelAndView;
  
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  
  public class LoginInterceptor implements HandlerInterceptor {
      @Override
      public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  
          if(request.getSession().getAttribute("user") == null) {
              request.setAttribute("msg", "登录失败，请重新登录！");
              request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request, response);
          }
  
          return HandlerInterceptor.super.preHandle(request, response, handler);
      }
  
      @Override
      public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
          HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
      }
  
      @Override
      public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
          HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
      }
  }
  

• 从以上代码中可以看出，自定义拦截器类实现了 HandlerInterceptor 接口，并实现了接口中的3个方法，关于这三个方法的详情如下：

  • preHandler()方法：该方法在控制器方法前执行，返回值为布尔型，表示是否中断后续操作。当返回值为true时，继续向下执行；返回值为false时，中断所有操作（包括调用下一个拦截器和控制器类中的方法执行等）。
  • postHandler()方法：该方法在控制器方法后执行，并在解析视图前执行。可以通过此方法对请求域中的模型和视图做出进一步的修改。
  • afterCompletion()方法：该方法在整个请求完成、视图渲染结束之后执行。可以通过此方法实现一些资源清理、记录日志信息等工作。

2、在springmvc配置文件中配置拦截器

自定义拦截器生效前，需要在SpringMVC的配置文件中进行配置。

<!-- 注册拦截器 -->
<mvc:interceptors>
    <mvc:interceptor>
        <bean class="com.Etui.interceptor.UserInterceptor" ></bean>
        <mvc:mapping path="/**"/>
        <mvc:exclude-mapping path="/showLogin"/>
        <mvc:exclude-mapping path="/login"/>
        <bean class="com.Etui.interceptor.LoginInterceptor"></bean>
    </mvc:interceptor>
</mvc:interceptors>

• 解析：

  • <mvc:interceptors> 的子元素 < bean > 中定义的是全局拦截器，会拦截所有的请求；
  • < mvc:interceptor > 中定义的是指定路径的拦截器，会对指定路径下的请求生效。
  • < mvc:interceptor > 的子元素 < mvc:mapping > 用于配置拦截器作用的路径，路径在其 path 属性中定义；
  • < mvc:interceptor > 的子元素 < mvc:exclude-mapping > 用于配置不需要拦截的路径；
  • < mvc:interceptor > 的子元素 < bean > 用于指定当前拦截器作用对象。

• 注意事项：

  < mvc:interceptor > 中的元素必须按照 < mvc:mapping > …… < mvc:exclude-mapping > …… < bean > 的顺序，否则文件会报错。

3、拦截器的执行流程

（1）单个拦截器的执行流程

• 如果项目中只定义了一个拦截器，程序首先会执行拦截器类中的preHandle()方法，若其返回值为true，则程序继续向下执行处理器中的方法，否则不再向下执行；在业务处理器处理完成后，会执行postHandler() 方法，然后通过DispatcherServlet向客户端返回响应；在 DispatcherServlet 处理完请求后，才会执行 afterCompletion() 方法。
  

（2）多个拦截器的执行流程

• 当有多个拦截器同时工作时，它们的 preHandler() 方法会按照配置文件中拦截器的配置顺序执行，而它们的 postHandler() 方法和 afterCompletion() 方法则会按照配置顺序的反许执行。
  

Over！