ThreadLocal使用,配合拦截器HandlerInterceptor使用

2024-03-11 09:28

本文主要是介绍ThreadLocal使用,配合拦截器HandlerInterceptor使用,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

ThreadLocal使用,配合拦截器HandlerInterceptor使用

ThreadLocal的使用场景通常涉及多线程环境下需要为每个线程保留独立状态的情况。它提供了一种简单的方式来管理线程本地变量,使得每个线程都可以独立地访问和修改自己的变量副本,而不会影响其他线程的副本。

包括的方法

ThreadLocal的主要方法包括:

  • get():获取当前线程的变量副本。
  • set(value):设置当前线程的变量副本为给定的值。
  • remove():移除当前线程的变量副本。

项目中创建

定义BaseContext类,分别设置获取当前内容、设置当前内容、移出当前内容。

public class BaseContext {public static ThreadLocal<Long> threadLocal = new ThreadLocal<>();public static Long getCurrentId() {return threadLocal.get();}public static void setCurrentId(Long currentId) {threadLocal.set(currentId);}public static void removeCurrentId(Long id) {threadLocal.remove();}
}

需要注意的是,ThreadLocal使用完毕后应该及时调用remove()方法来清除当前线程的变量副本,以避免内存泄漏问题。另外,由于ThreadLocal使用了线程封闭的设计思想,因此在使用时应当谨慎考虑其适用性,并避免滥用。

在项目中简单使用

在发送请求时,携带id,最后在service层获取。

@RestController
@RequestMapping("/test")
@Tag(name = "测试设置ThreadLocal")
@Slf4j
public class DemoThreadLocal {@AutowiredDemoThreadLocalService demoThreadLocalService;@Operation(summary = "设置userID", description = "测试方法")@GetMapping("userId={id}")public String setUserId(@PathVariable Long id) {BaseContext.setCurrentId(id);demoThreadLocalService.demoThreadLocalUserId();return "userId";}
}

service接口。

public interface DemoThreadLocalService {void demoThreadLocalUserId();
}

service实现类中获取id。

@Service
@Slf4j
public class DemoThreadLocalServiceImpl implements DemoThreadLocalService {@Overridepublic void demoThreadLocalUserId() {// 获取当前idLong currentId = BaseContext.getCurrentId();log.info("当前id为:{}", currentId);// 使用完后移出BaseContext.removeCurrentId(currentId);}
}

在这里插入图片描述

配合拦截器使用

第一步:配置拦截器

  1. 新建interceptor包和TokenUserInterceptor类,实现HandlerInterceptor;并交给spring管理。

  2. 实现public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception方法。

  3. 我是将token放在header中的,当然也可以放在cookies中。

    • 在这里插入图片描述
  4. 判断当前token是否为空,如果为空返回false,不往下执行。

  5. 做到这步还没结束,因为这样写还不会生效。

  6. 新建config包,创建WebMvcConfiguration 并实现WebMvcConfigurationSupport

@Component
@Slf4j
public class TokenUserInterceptor implements HandlerInterceptor {public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {// 设置userIdString token = request.getHeader("token");System.out.println("--------------" + token + "--------------");if (token != null && !token.isEmpty()) {BaseContext.setCurrentId(Long.valueOf(token));return true;} else {return false;}}
}

第二步:配置MVC设置

匹配路径

WebMvcConfiguration内容如下。配置拦截器这样才会生效。需要拦截/test下所有请求,如图所示,拦截器识别不了通配符所以要使用addPathPatterns去匹配。

其中的方式是:protected void addInterceptors(InterceptorRegistry registry)

@Configuration
@Slf4j
public class WebMvcConfiguration extends WebMvcConfigurationSupport {@AutowiredTokenUserInterceptor tokenUserInterceptor;protected void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(tokenUserInterceptor).addPathPatterns("/test/**");}
}

在这里插入图片描述

需要注意的是,当前只是传入一个也可以传入多个。当匹配后即可实现拦截效果,检测header中是否包含token。

在这里插入图片描述

示例,为了演示效果就随便写了下。

protected void addInterceptors(InterceptorRegistry registry) {String[] list = {};registry.addInterceptor(tokenUserInterceptor).addPathPatterns("/test/**").addPathPatterns("/test2").addPathPatterns("/test3").addPathPatterns("asa", "sas","sas").addPathPatterns(list);
}

在knif4j中测试,成功输出。

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

排出路径

排出哪些路径是不需要拦截的。

protected void addInterceptors(InterceptorRegistry registry) {String[] list = {};registry.addInterceptor(tokenUserInterceptor).addPathPatterns("/test/**").excludePathPatterns("/test2").excludePathPatterns("/test3").excludePathPatterns("asa", "sas", "sas").excludePathPatterns(list);
}

在这里插入图片描述

第三步:Controller层中

controller层,在路径中不传入id,通过拦截器获取header中token。这一层并不需要做什么,只是为了写一个接口让MVC拦截。

@RestController
@RequestMapping("/test")
@Tag(name = "测试设置ThreadLocal")
@Slf4j
public class DemoThreadLocal {@AutowiredDemoThreadLocalService demoThreadLocalService;@Operation(summary = "拦截器中设置UserId", description = "测试方法")@GetMapping("userId")public String userId() {demoThreadLocalService.demoThreadLocalUserId();return "userId";}
}

第四步:查看内容

service和上面一样。

@Service
@Slf4j
public class DemoThreadLocalServiceImpl implements DemoThreadLocalService {@Overridepublic void demoThreadLocalUserId() {// 获取当前idLong currentId = BaseContext.getCurrentId();log.info("当前id为:{}", currentId);// 使用完后移出BaseContext.removeCurrentId(currentId);}
}
emoThreadLocalUserId() {// 获取当前idLong currentId = BaseContext.getCurrentId();log.info("当前id为:{}", currentId);// 使用完后移出BaseContext.removeCurrentId(currentId);}
}

这篇关于ThreadLocal使用,配合拦截器HandlerInterceptor使用的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/797399

相关文章

python中的flask_sqlalchemy的使用及示例详解

《python中的flask_sqlalchemy的使用及示例详解》文章主要介绍了在使用SQLAlchemy创建模型实例时,通过元类动态创建实例的方式,并说明了如何在实例化时执行__init__方法,... 目录@orm.reconstructorSQLAlchemy的回滚关联其他模型数据库基本操作将数据添

Spring配置扩展之JavaConfig的使用小结

《Spring配置扩展之JavaConfig的使用小结》JavaConfig是Spring框架中基于纯Java代码的配置方式,用于替代传统的XML配置,通过注解(如@Bean)定义Spring容器的组... 目录JavaConfig 的概念什么是JavaConfig?为什么使用 JavaConfig?Jav

Java使用Spire.Doc for Java实现Word自动化插入图片

《Java使用Spire.DocforJava实现Word自动化插入图片》在日常工作中,Word文档是不可或缺的工具,而图片作为信息传达的重要载体,其在文档中的插入与布局显得尤为关键,下面我们就来... 目录1. Spire.Doc for Java库介绍与安装2. 使用特定的环绕方式插入图片3. 在指定位

Springboot3 ResponseEntity 完全使用案例

《Springboot3ResponseEntity完全使用案例》ResponseEntity是SpringBoot中控制HTTP响应的核心工具——它能让你精准定义响应状态码、响应头、响应体,相比... 目录Spring Boot 3 ResponseEntity 完全使用教程前置准备1. 项目基础依赖(M

Java使用Spire.Barcode for Java实现条形码生成与识别

《Java使用Spire.BarcodeforJava实现条形码生成与识别》在现代商业和技术领域,条形码无处不在,本教程将引导您深入了解如何在您的Java项目中利用Spire.Barcodefor... 目录1. Spire.Barcode for Java 简介与环境配置2. 使用 Spire.Barco

Android使用java实现网络连通性检查详解

《Android使用java实现网络连通性检查详解》这篇文章主要为大家详细介绍了Android使用java实现网络连通性检查的相关知识,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录NetCheck.Java(可直接拷贝)使用示例(Activity/Fragment 内)权限要求

C# 预处理指令(# 指令)的具体使用

《C#预处理指令(#指令)的具体使用》本文主要介绍了C#预处理指令(#指令)的具体使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学... 目录1、预处理指令的本质2、条件编译指令2.1 #define 和 #undef2.2 #if, #el

C#中Trace.Assert的使用小结

《C#中Trace.Assert的使用小结》Trace.Assert是.NET中的运行时断言检查工具,用于验证代码中的关键条件,下面就来详细的介绍一下Trace.Assert的使用,具有一定的参考价值... 目录1、 什么是 Trace.Assert?1.1 最简单的比喻1.2 基本语法2、⚡ 工作原理3

C# IPAddress 和 IPEndPoint 类的使用小结

《C#IPAddress和IPEndPoint类的使用小结》本文主要介绍了C#IPAddress和IPEndPoint类的使用小结,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定... 目录一、核心作用网络编程基础类二、IPAddress 类详解三种初始化方式1. byte 数组初始化2. l

C语言逗号运算符和逗号表达式的使用小结

《C语言逗号运算符和逗号表达式的使用小结》本文详细介绍了C语言中的逗号运算符和逗号表达式,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习... 在C语言中逗号“,”也是一种运算符,称为逗号运算符。 其功能是把两个表达式连接其一般形式为:表达