SpringMVC中拦截器使用实践详解-阿里云开发者社区

SpringMVC中拦截器使用实践详解

2023-11-23 63

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

简介： SpringMVC中拦截器使用实践详解

SpringMVC可以使用拦截器对请求进行处理，用户可以实现自定义拦截器。自定义拦截器必须实现HandlerInterceptor接口。

【1】拦截器方法

SpringMVC中的拦截器有三个抽象方法：

preHandle：控制器方法执行之前执行preHandle()，其boolean类型的返回值表示是否拦截或放行，返回true为放行，即调用控制器方法；返回false表示拦截，即不调用控制器方法
postHandle：控制器方法执行之后执行postHandle()
afterComplation：处理完视图和模型数据，渲染视图完毕之后执行afterComplation()

① preHandle()

这个方法在业务处理请求之前被调用，在该方法中对用户请求request进行处理。如果继续调用其他拦截器或者业务处理器，那么请返回true；否则返回false。

② postHandle()

这个方法在业务处理器处理完请求后但是未渲染视图前(即DispatcherServlet未向客户端发出响应)时调用，在该方法中对用户请求request进行处理。

③ afterCompletion()

这个方法在DispatcherServlet完全处理完请求后被调用，可以在方法中执行一些资源清理的工作。

【2】自定义拦截器

自定义拦截器FirstInterceptor 实现HandlerInterceptor接口

public class FirstInterceptor implements HandlerInterceptor{
  /**
   * 该方法在目标方法之前被调用.
   * 若返回值为 true, 则继续调用后续的拦截器和目标方法. 
   * 若返回值为 false, 则不会再调用后续的拦截器和目标方法. 
   * 可以考虑做权限. 日志, 事务等. 
   */
  @Override
  public boolean preHandle(HttpServletRequest request,
      HttpServletResponse response, Object handler) throws Exception {
    System.out.println("[FirstInterceptor] preHandle");
    return true;
  }
  /**
   * 调用目标方法之后, 但渲染视图之前. 
   * 可以对请求域中的属性或视图做出修改. 
   */
  @Override
  public void postHandle(HttpServletRequest request,
      HttpServletResponse response, Object handler,
      ModelAndView modelAndView) throws Exception {
    System.out.println("[FirstInterceptor] postHandle");
  }
  /**
   * 渲染视图之后被调用. 释放资源
   */
  @Override
  public void afterCompletion(HttpServletRequest request,
      HttpServletResponse response, Object handler, Exception ex)
      throws Exception {
    System.out.println("[FirstInterceptor] afterCompletion");
  }
}

拦截器方法执行顺序示意图

【3】spingmvc.xml配置使用

① springmvc.xml配置实例

XML配置环境下，SpringMVC的拦截器必须在SpringMVC的配置文件中进行配置。

配置bean的两种方式

<!--可以通过ref或bean标签设置拦截器-->
<bean id="firstInterceptor" class="com.interceptor.FirstInterceptor"></bean>
<!-- ref 表示引用容器中已经存在的bean-->
<ref bean="firstInterceptor"></ref>

引入路径拦截

<mvc:interceptors>
  <mvc:interceptor>
    <mvc:mapping path="/**"/>
    <mvc:exclude-mapping path="/testRequestEntity"/>
    <ref bean="firstInterceptor"></ref>
  </mvc:interceptor>
</mvc:interceptors>

<mvc:interceptors>
  <!-- 配置自定义的拦截器 -->
  <bean class="com.web.springmvc.interceptors.FirstInterceptor"></bean>
  <!-- 配置 LocaleChanceInterceptor -->
  <bean class="org.springframework.web.servlet.i18n.LocaleChangeInterceptor">          </bean>
</mvc:interceptors>

② 配置拦截器作用路径

使用 or 指定拦截器的作用路径。

<mvc:interceptors>
  <!-- 配置自定义的拦截器 -->
  <bean class="com.web.springmvc.interceptors.FirstInterceptor"></bean>
  <!-- 配置拦截器(不)作用的路径 -->
  <mvc:interceptor>
    <!--配置拦截器作用的路径-->
    <mvc:mapping path="/emp"/>
    <bean class="com.web.springmvc.interceptors.SecondInterceptor"/>
      <!--配置拦截器不作用的路径-->
    <mvc:exclude-mapping path="/emp2"/>
  </mvc:interceptor>
  <!-- 配置 LocaleChanceInterceptor -->
  <bean class="org.springframework.web.servlet.i18n.LocaleChangeInterceptor"></bean>
</mvc:interceptors>

还可以使用通配符的方式配置路径拦截：

<mvc:interceptors>
   <mvc:interceptor>
    <mvc:mapping path="/*_*.do"/>
     <bean class="com.main.interceptor.AuthInterceptor"/>
  </mvc:interceptor>
</mvc:interceptors>

③ 多个拦截器时执行顺序

[FirstInterceptor] preHandle
[SecondInterceptor] preHandle
@ModelAttribute  方法执行
list method execute...
[SecondInterceptor] postHandle
[FirstInterceptor] postHandle
[SecondInterceptor] afterCompletion
[FirstInterceptor] afterCompletion

aHR0cDovL2ltZy5ibG9nLmNzZG4ubmV0LzIwMTcwNTAzMjA1NDAwNDU2.png

如果第二个拦截器的preHandle返回false：

[FirstInterceptor] preHandle
[SecondInterceptor] preHandle
[FirstInterceptor] afterCompletion

不会执行目标方法,执行完第二个拦截器的preHandle之后，直接执行了第一个拦截器的afterCompletion.

④ 总结

若每个拦截器的preHandle()都返回true

此时多个拦截器的执行顺序和拦截器在SpringMVC的配置文件的配置顺序有关：

preHandle()会按照配置的顺序执行，而postHandle()和afterComplation()会按照配置的反序执行

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

preHandle()返回false和它之前的拦截器的preHandle()都会执行，postHandle()都不执行，返回false的拦截器之前的拦截器的afterComplation()会执行