Spring MVC 实现拦截器

简介: SpringMVC的拦截器Interceptor类似于Servlet开发中的过滤器Filter,用于对处理器进行预处理和后处理。比如:可以实现:权限控制、日志、异常记录、记录方法执行时间.....

1.拦截器

1.1 拦截器的定义

在Spring MVC中使用拦截器,需要对拦截器类进行定义和配置。一般拦截器可以通过两种方式类定义。

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

下面我们以实现HandlerInterceptor接口的方式来自定义拦截器类:

@Component
public class MyFirstInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("MyFirstInterceptor=====================>preHandle");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("MyFirstInterceptor=====================>postHandle");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("MyFirstInterceptor=====================>afterCompletion");
    }
}

可以看出自定义的拦截器类实现了HandlerInterceptor接口,并重写了接口中的三个方法。

1.2 拦截器的方法

拦截器有3个回调方法:

preHandle: 预处理回调方法,实现处理器的预处理,第三个参数为响应的处理器返回值:true表示继续向下执行(如调用下一个拦截器);false表示中断后续操作,不会继续调用其他的拦截器和控制器类的方法执行。

postHandle: 后处理回调方法,实现处理器的后处理,在渲染视图之前,此时我们可以通过modelAndView对模型数据进行处理或对视图进行处理。

afterCompletion: 整个请求处理完成,即在视图渲染结束之后执行,可以通过该方法进行一些资源清理,类似于try­catch­finally中的finally,但仅调用处理器执行链中preHandle返回true的拦截器才会执行。

1.3 拦截器的配置

想要使自定义的拦截器类生效,还需要在Spring MVC的配置文件中进行配置。

我们通过<mvc:interceptors>元素来配置一组拦截器,若要拦截DispatcherServlet处理的所有请求,则如下面配置:

<!--配置拦截器-->
<mvc:interceptors>
    <!--1.对DispatcherServlet处理的所有请求进行拦截-->
    <bean class="com.it.interceptor.MyFirstInterceptor"/>
    <ref bean="myFirstInterceptor"/>
</mvc:interceptors>

当然,我们也可以通过<mvc:interceptors>的子元素\<mvc:interceptor\>来定义指定路径的拦截器,他会对指定路径下的请求生效。

<mvc:interceptors>
    <mvc:interceptor>
      <!--配置拦截器作用的路径,path的属性值“/**”表示拦截所有路径-->
         <mvc:mapping path="/**"/>
         <!--配置拦截请求中不需要拦截的请求-->
         <mvc:exclude-mapping path="/interceptor"/>
         <ref bean="myFirstInterceptor"/>
     </mvc:interceptor>
</mvc:interceptors>

注意:\<mvc:interceptor\>元素中的子元素的配置顺序不能变。

1.4 定义多个拦截器

1.4.1 添加另一个拦截器

@Component
public class MySecondInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("MySecondInterceptor=================>preHandle");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("MySecondInterceptor==================>postHandle");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("MySecondInterceptor=============>afterCompletion");
    }
}

1.4.2 配置拦截器

<mvc:interceptors>
    <ref bean="myFirstInterceptor"/>
    <ref bean="mySecondInterceptor"/>
</mvc:interceptors>

可以看到如下图所示的执行顺序:
在这里插入图片描述

从上面能够看到,若每个拦截器的preHandle()都返回true,则preHandle()会按照配置的顺序执行,而postHandle()和afterComplation()会按照配置的反序执行。

若某个拦截器的preHandle()返回了false,那么preHandle()返回false和它之前的拦截器的preHandle()都会执行,而postHandle()都不执行,返回false的拦截器之前的拦截器的afterComplation()会执行。也就是已经通过的拦截器的afterCompletion会执行。

1.4.1 示例

比如:我们将第二个拦截器的preHandle方法的返回值改为false,可以看到preHandle方法都执行了,postHandle没有执行,而afterComplation只执行了第一个拦截器的。
在这里插入图片描述

1.5 拦截器的执行流程

1.5.1 单个拦截器执行流程

单个拦截器,程序会首先执行拦截器类中的preHandle()方法,若该方法返回true,则继续向下执行处理器中的方法,否则中断;处理完请求之后会执行postHandle()方法,然后再通过DispatcherServlet请求处理之后,最后执行afterComplation()方法。

1.5.2 多拦截器执行流程

多个拦截器同时工作时,每个拦截器的preHandle()方法都会按照配置的顺序执行,而postHandle()和afterComplation()会按照配置的反序执行。
在这里插入图片描述

相关文章
|
20天前
|
设计模式 前端开发 Java
步步深入SpringMvc DispatcherServlet源码掌握springmvc全流程原理
通过对 `DispatcherServlet`源码的深入剖析,我们了解了SpringMVC请求处理的全流程。`DispatcherServlet`作为前端控制器,负责请求的接收和分发,处理器映射和适配负责将请求分派到具体的处理器方法,视图解析器负责生成和渲染视图。理解这些核心组件及其交互原理,有助于开发者更好地使用和扩展SpringMVC框架。
32 4
|
2月前
|
监控 Java 数据安全/隐私保护
如何用Spring Boot实现拦截器:从入门到实践
如何用Spring Boot实现拦截器:从入门到实践
55 5
|
2月前
|
前端开发 Java 开发者
Spring MVC中的请求映射:@RequestMapping注解深度解析
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的关键,它将HTTP请求映射到相应的处理器方法上。本文将深入探讨`@RequestMapping`注解的工作原理、使用方法以及最佳实践,为开发者提供一份详尽的技术干货。
145 2
|
3月前
|
JSON 前端开发 Java
SSM:SpringMVC
本文介绍了SpringMVC的依赖配置、请求参数处理、注解开发、JSON处理、拦截器、文件上传下载以及相关注意事项。首先,需要在`pom.xml`中添加必要的依赖,包括Servlet、JSTL、Spring Web MVC等。接着,在`web.xml`中配置DispatcherServlet,并设置Spring MVC的相关配置,如组件扫描、默认Servlet处理器等。然后,通过`@RequestMapping`等注解处理请求参数,使用`@ResponseBody`返回JSON数据。此外,还介绍了如何创建和配置拦截器、文件上传下载的功能,并强调了JSP文件的放置位置,避免404错误。
|
3月前
|
Java API Spring
springboot学习七:Spring Boot2.x 拦截器基础入门&实战项目场景实现
这篇文章是关于Spring Boot 2.x中拦截器的入门教程和实战项目场景实现的详细指南。
41 0
springboot学习七:Spring Boot2.x 拦截器基础入门&实战项目场景实现
|
4月前
|
缓存 前端开发 Java
【Java面试题汇总】Spring,SpringBoot,SpringMVC,Mybatis,JavaWeb篇(2023版)
Soring Boot的起步依赖、启动流程、自动装配、常用的注解、Spring MVC的执行流程、对MVC的理解、RestFull风格、为什么service层要写接口、MyBatis的缓存机制、$和#有什么区别、resultType和resultMap区别、cookie和session的区别是什么?session的工作原理
|
3月前
|
前端开发 Java 应用服务中间件
【Spring】Spring MVC的项目准备和连接建立
【Spring】Spring MVC的项目准备和连接建立
66 2
|
3月前
|
XML 前端开发 Java
Spring,SpringBoot和SpringMVC的关系以及区别 —— 超准确,可当面试题!!!也可供零基础学习
本文阐述了Spring、Spring Boot和Spring MVC的关系与区别,指出Spring是一个轻量级、一站式、模块化的应用程序开发框架,Spring MVC是Spring的一个子框架,专注于Web应用和网络接口开发,而Spring Boot则是对Spring的封装,用于简化Spring应用的开发。
230 0
Spring,SpringBoot和SpringMVC的关系以及区别 —— 超准确,可当面试题!!!也可供零基础学习
|
4月前
|
XML 缓存 前端开发
springMVC02,restful风格,请求转发和重定向
文章介绍了RESTful风格的基本概念和特点,并展示了如何使用SpringMVC实现RESTful风格的请求处理。同时,文章还讨论了SpringMVC中的请求转发和重定向的实现方式,并通过具体代码示例进行了说明。
springMVC02,restful风格,请求转发和重定向
|
5月前
|
Java 数据库连接 Spring
后端框架入门超详细 三部曲 Spring 、SpringMVC、Mybatis、SSM框架整合案例 【爆肝整理五万字】
文章是关于Spring、SpringMVC、Mybatis三个后端框架的超详细入门教程,包括基础知识讲解、代码案例及SSM框架整合的实战应用,旨在帮助读者全面理解并掌握这些框架的使用。
后端框架入门超详细 三部曲 Spring 、SpringMVC、Mybatis、SSM框架整合案例 【爆肝整理五万字】