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

相关文章

使用Java解析JSON数据并提取特定字段的实现步骤(以提取mailNo为例)

《使用Java解析JSON数据并提取特定字段的实现步骤(以提取mailNo为例)》在现代软件开发中,处理JSON数据是一项非常常见的任务,无论是从API接口获取数据,还是将数据存储为JSON格式,解析... 目录1. 背景介绍1.1 jsON简介1.2 实际案例2. 准备工作2.1 环境搭建2.1.1 添加

如何使用celery进行异步处理和定时任务(django)

《如何使用celery进行异步处理和定时任务(django)》文章介绍了Celery的基本概念、安装方法、如何使用Celery进行异步任务处理以及如何设置定时任务,通过Celery,可以在Web应用中... 目录一、celery的作用二、安装celery三、使用celery 异步执行任务四、使用celery

使用Python绘制蛇年春节祝福艺术图

《使用Python绘制蛇年春节祝福艺术图》:本文主要介绍如何使用Python的Matplotlib库绘制一幅富有创意的“蛇年有福”艺术图,这幅图结合了数字,蛇形,花朵等装饰,需要的可以参考下... 目录1. 绘图的基本概念2. 准备工作3. 实现代码解析3.1 设置绘图画布3.2 绘制数字“2025”3.3

Jsoncpp的安装与使用方式

《Jsoncpp的安装与使用方式》JsonCpp是一个用于解析和生成JSON数据的C++库,它支持解析JSON文件或字符串到C++对象,以及将C++对象序列化回JSON格式,安装JsonCpp可以通过... 目录安装jsoncppJsoncpp的使用Value类构造函数检测保存的数据类型提取数据对json数

python使用watchdog实现文件资源监控

《python使用watchdog实现文件资源监控》watchdog支持跨平台文件资源监控,可以检测指定文件夹下文件及文件夹变动,下面我们来看看Python如何使用watchdog实现文件资源监控吧... python文件监控库watchdogs简介随着Python在各种应用领域中的广泛使用,其生态环境也

Python中构建终端应用界面利器Blessed模块的使用

《Python中构建终端应用界面利器Blessed模块的使用》Blessed库作为一个轻量级且功能强大的解决方案,开始在开发者中赢得口碑,今天,我们就一起来探索一下它是如何让终端UI开发变得轻松而高... 目录一、安装与配置:简单、快速、无障碍二、基本功能:从彩色文本到动态交互1. 显示基本内容2. 创建链

springboot整合 xxl-job及使用步骤

《springboot整合xxl-job及使用步骤》XXL-JOB是一个分布式任务调度平台,用于解决分布式系统中的任务调度和管理问题,文章详细介绍了XXL-JOB的架构,包括调度中心、执行器和Web... 目录一、xxl-job是什么二、使用步骤1. 下载并运行管理端代码2. 访问管理页面,确认是否启动成功

使用Nginx来共享文件的详细教程

《使用Nginx来共享文件的详细教程》有时我们想共享电脑上的某些文件,一个比较方便的做法是,开一个HTTP服务,指向文件所在的目录,这次我们用nginx来实现这个需求,本文将通过代码示例一步步教你使用... 在本教程中,我们将向您展示如何使用开源 Web 服务器 Nginx 设置文件共享服务器步骤 0 —

Java中switch-case结构的使用方法举例详解

《Java中switch-case结构的使用方法举例详解》:本文主要介绍Java中switch-case结构使用的相关资料,switch-case结构是Java中处理多个分支条件的一种有效方式,它... 目录前言一、switch-case结构的基本语法二、使用示例三、注意事项四、总结前言对于Java初学者

Golang使用minio替代文件系统的实战教程

《Golang使用minio替代文件系统的实战教程》本文讨论项目开发中直接文件系统的限制或不足,接着介绍Minio对象存储的优势,同时给出Golang的实际示例代码,包括初始化客户端、读取minio对... 目录文件系统 vs Minio文件系统不足:对象存储:miniogolang连接Minio配置Min