一文教你搞懂SpringBoot自定义拦截器的思路

 更新时间:2023年08月03日 08:29:28   作者:DaenCode  
在开发中,都离不开拦截器的使用,比如说在开发登录功能时,实现权限管理功能时等,这篇文章主要带大家使用SpringBoot梳理自定义拦截器的思路,需要的可以参考一下

思维导图

前言

在开发中,都离不开拦截器的使用。比如说在开发登录功能时,采用JWT登录时通过对token进行验证实现登录拦截的功能;实现权限管理功能时,通过对角色权限的拦截实现权限功能。下面带你使用SpringBoot梳理自定义拦截器的思路。

前置知识

@Configuration:用于标识一个全局配置类。注册到spring容器中,相当于xml配置时的beans标签。@Bean:用于标识全局配置类中的自定义拦截方法上,进行拦截对象的创建,方便后续注册。

具体实现步骤

定义拦截器类

自定义拦截器类:负责定义拦截的处理逻辑,包含前置拦截、后置拦截和最终拦截。以下是对其API的介绍。

API介绍

在方法参数中,HttpServletRequest代表客户端的请求,HttpServletResponse代表返回给客户端的响应。Object handler是目标处理器(如控制器方法)的实例,ModelAndView用于传递模型数据和视图名称。

方法名方法签名作用
preHandleboolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception在目标处理器执行之前被调用。可以进行一些前置处理逻辑,如权限验证、日志记录等。返回值决定请求是否继续执行后续流程,true表示继续执行,false表示中断请求处理
postHandlevoid postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception目标处理器执行之后、视图渲染之前被调用。可以对响应结果进行一些后置处理,如添加公共数据、修改视图等。此时可以对目标处理器的执行结果进行修改
afterCompletionvoid afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception整个请求处理完毕后被调用。可以进行一些清理工作,如资源释放、日志记录等。无法改变响应结果

思路

  • 创建拦截器类TestInterceptor并实现HandlerInterceptor。
  • 根据其对应的API结合业务,在对应方法上实现相应的处理逻辑。
public class TestInterceptor implements HandlerInterceptor {
    //前置处理器。进入到Controller层方法之前执行
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //TODO 前置拦截的处理逻辑
        //1.判断用户是否登录,登录返回true
        return HandlerInterceptor.super.preHandle(request, response, handler);
    }
    //后置处理器。视图渲染之前执行的方法,对响应结果进行处理。
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        //TODO 后置拦截的处理逻辑
        //添加某些数据等等
        HandlerInterceptor.super.postHandle(request, response, handler, modelAndView);
    }
    //最终处理器。整个请求完成之后执行。
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        // TODO 最终拦截处理器
        //1.记录日志
        HandlerInterceptor.super.afterCompletion(request, response, handler, ex);
    }
}

定义拦截器配置类

拦截器配置类:负责注册相应的拦截器。

思路

  • 创建拦截器配置类。并用@Configuration标识、实现WebMvcConfigurer接口。
  • 创建生成拦截器对象的方法。并用@Bean标识。方便拦截器的注册。
  • 实现addInterceptors方法,进行拦截器的注册。
@Configuration
public class TestInterceptorConfig implements WebMvcConfigurer {
    @Bean
    public TestInterceptor testInterceptor(){
        return new TestInterceptor();
    }
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(testInterceptor()).addPathPatterns("/test/**");
        WebMvcConfigurer.super.addInterceptors(registry);
    }
}

拦截器失效

如果发生拦截器没有生效,可以按照以下思路进行检查:

拦截器配置类是否添加@Configuration。拦截的是接口地址,地址末尾则为/**格式。拦截的是目录地址,地址则为/*/格式。 🌟写在最后

到此这篇关于一文教你搞懂SpringBoot自定义拦截器的思路的文章就介绍到这了,更多相关SpringBoot自定义拦截器内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • maven 在执行package,install,deploy时使用clean与不使用clean的不同之处

    maven 在执行package,install,deploy时使用clean与不使用clean的不同之处

    有时候用mvn install后,新改的内容不生效,一定要后来使用mvn clean install 才生效,由于之前没有做记录,以及记不清是什么情况下才会出现的问题,于是想看看clean和不clean的区别,感兴趣的朋友跟随小编一起看看吧
    2021-08-08
  • Spring中的@EnableConfigurationProperties使用方式以及作用详解

    Spring中的@EnableConfigurationProperties使用方式以及作用详解

    这篇文章主要介绍了Spring中的@EnableConfigurationProperties使用方式以及作用详解,使用了 @ConfigurationProperties 注解的配置类生效,将该类注入到 IOC 容器中,交由 IOC 容器进行管理,此时则不用再配置类上加上@Component,需要的朋友可以参考下
    2024-01-01
  • java开发之闹钟的实现代码

    java开发之闹钟的实现代码

    本篇文章介绍了,在java中闹钟的实现代码。需要的朋友参考下
    2013-05-05
  • Java并发机制的底层实现原理分析

    Java并发机制的底层实现原理分析

    本文主要介绍了Java中并发编程中常用的一些机制,包括volatile、synchronized和原子操作,volatile是轻量级的同步机制,保证了共享变量的可见性;synchronized是一种重量级的同步机制,通过加锁和解锁来保证线程安全
    2025-01-01
  • Java设计模式之Adapter适配器模式

    Java设计模式之Adapter适配器模式

    这篇文章主要为大家详细介绍了Java设计模式之Adapter适配器模式,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-03-03
  • Springboot中LocalDateTime对象返回给前端格式化解决方案

    Springboot中LocalDateTime对象返回给前端格式化解决方案

    在项目开发当中前后端使用什么样的时间格式,是一个值得关注的问题,这篇文章主要给大家介绍了关于Springboot中LocalDateTime对象返回给前端格式化的解决方案,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2024-04-04
  • Java定时任务的三种实现方法

    Java定时任务的三种实现方法

    在应用里经常都有用到在后台跑定时任务的需求。举个例子,比如需要在服务后台跑一个定时任务来进行垃圾回收
    2014-04-04
  • Java中关于OAuth2.0的原理分析

    Java中关于OAuth2.0的原理分析

    这篇文章主要介绍了Java中关于OAuth2.0的原理分析,OAuth是一个关于授权的开放网络标准,允许用户授权第三 方应用访问他们存储在另外的服务提供者上的信息,而不需要将用户名和密码提供给第三方移动应用或分享他们数据的所有内容,需要的朋友可以参考下
    2023-09-09
  • Java中的注解与注解处理器

    Java中的注解与注解处理器

    这篇文章主要介绍了Java中的注解与注解处理器,元注解的作用是负责注解其他注解, Java5.0定义了4个标准的meta-annotation(元注解)类型,它们被用来提供对其它注解类型进行说明,需要的朋友可以参考下
    2023-11-11
  • 微信公众号获取access_token的方法实例分析

    微信公众号获取access_token的方法实例分析

    这篇文章主要介绍了微信公众号获取access_token的方法,结合实例形式分析了java实现微信公众号获取access_token的相关原理、实现方法及操作注意事项,需要的朋友可以参考下
    2019-10-10

最新评论