手把手教你使用ThreadLocal

最新推荐文章于 2024-08-10 08:01:31 发布
最新推荐文章于 2024-08-10 08:01:31 发布
阅读量672 收藏
点赞数 1
分类专栏： Java中的并发与多线程 文章标签： ThreadLocal 多线程 线程安全 内存泄露 Thread
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/limenghua9112/article/details/107503665
版权

什么是ThreadLocal？

首先我们来看javadoc：

This class provides thread-local variables. 
These variables differ from their normal counterparts in that each thread that accesses one 
(via its get or set method) has its own, 
independently initialized copy of the variable. 
ThreadLocal instances are typically private static fields in classes that wish to 
associate state with a thread (e.g., a user ID or Transaction ID).
译：这个类提供线程局部变量。
这些变量与其普通对应变量的不同之处在于，
访问一个变量的每个线程(通过其get或set方法)都有其自己的独立初始化的变量副本。
ThreadLocal实例通常是 
希望将状态与线程(例如，用户ID或事务ID)相关联的类中的私有静态字段。

通过阅读官方文档，我们知道：ThreadLocal是一个关于创建线程局部变量的类。
通常情况下，我们创建的成员变量都是线程不安全的。
因为他可能被多个线程同时修改，
此变量对于多个线程之间彼此并不独立，是共享变量。
而使用ThreadLocal创建的变量只能被当前线程访问，
其他线程无法访问和修改。也就是说：将线程公有化变成线程私有化。

ThreadLocal有什么作用？

使用场景1，确保线程安全

ThreadLocal 用作保存每个线程独享的对象，为每个线程都创建一个副本，这样每个线程都可以修改自己所拥有的副本, 而不会影响其他线程的副本，确保了线程安全。

使用场景2，避免传参

ThreadLocal 用作每个线程内需要独立保存信息，以便供其他方法更方便地获取该信息的场景。每个线程获取到的信息可能都是不一样的，前面执行的方法保存了信息后，后续方法可以通过 ThreadLocal 直接获取到，避免了传参，类似于全局变量的概念。

实战源码

需求：循环1000次，依次输出mm:ss格式的时间字符串。
预期：输出1000个不重复的mm:ss格式的时间字符串。

  1. 演示在单线程环境下，使用SimpleDateFormat是安全的
  2. 演示在多线程环境下，使用SimpleDateFormat是不安全的
  3. 演示使用ThreadLocal类，使SimpleDateFormat实例成为线程独享，保证线程安全

1. 单线程环境

import java.text.SimpleDateFormat;
import java.util.Date;

import lombok.extern.slf4j.Slf4j;

/**
 * <pre>
 * 程序目的：演示在单线程的环境中，使用SimpleDateFormat是ok的
 * 部分输出结果：
 * 运行总耗时：11633ms
 * </pre>
 * created at 2020/7/17 07:55
 * @author lerry
 */
@Slf4j
public class SimpleDateFormatInOneThread {
	private static SimpleDateFormat dateFormat = new SimpleDateFormat("mm:ss");

	public static void main(String[] args) {
		long startTime = System.currentTimeMillis();
		for (int i = 0; i < 1000; i++) {
			final int finalI = i;
			String date = new SimpleDateFormatInOneThread().date(finalI);
			log.info("\tdate is {}", date);
		}
		log.info("运行总耗时：{}ms", (System.currentTimeMillis() - startTime));
	}

	/**
	 * 按照秒数，输出一天开始的时间格式表示
	 * 如：第1秒 00:01
	 * 第2秒 00:02
	 * 第60秒 01:00
	 * @param seconds
	 * @return
	 */
	public String date(int seconds) {
		Date date = new Date(1000 * seconds);
		// 模拟方法执行耗时
		try {
			Thread.sleep(10);
		}
		catch (InterruptedException e) {
			e.printStackTrace();
		}
		return dateFormat.format(date);
	}
}

在这里插入图片描述

图：单线程环境下的输出结果
可以看到，程序从00:00输出到16:39，符合预期

2. 多线程环境

在此，使用了线程池来管理线程。

import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;

import lombok.extern.slf4j.Slf4j;

/**
 * <pre>
 * 程序目的：演示多线程访问线程不安全的类
 * 部分输出结果：
 * 运行总耗时：2956ms
 * </pre>
 * created at 2020/7/17 07:55
 * @author lerry
 */
@Slf4j
public class SimpleDateFormatInMultiThread {

	/**
	 * 核心线程数
	 */
	public static final int CORE_POOL_SIZE = 4;

	/**
	 * 等待队列数量
	 */
	private static ArrayBlockingQueue queue = new ArrayBlockingQueue(1000 - CORE_POOL_SIZE);

	/**
	 * 线程池
	 */
	private static ThreadPoolExecutor threadPool = new ThreadPoolExecutor(CORE_POOL_SIZE, CORE_POOL_SIZE, 0, TimeUnit.SECONDS, queue);

	/**
	 * 线程共享的成员变量
	 */
	private static SimpleDateFormat dateFormat = new SimpleDateFormat("mm:ss");

	public static void main(String[] args) {
		long startTime = System.currentTimeMillis();
		for (int i = 0; i < 1000; i++) {
			final int finalI = i;
			threadPool.submit(() -> {
				String date = new SimpleDateFormatInMultiThread().date(finalI);
				log.info("\tdate is {}", date);
			});
		}
		threadPool.shutdown();

		for (; ; ) {
			if (threadPool.isTerminated()) {
				log.info("运行总耗时：{}ms", (System.currentTimeMillis() - startTime));
				break;
			}
		}
	}

	/**
	 * 按照秒数，输出一天开始的时间格式表示
	 * 如：第1秒 00:01
	 * 第2秒 00:02
	 * 第60秒 01:00
	 * @param seconds
	 * @return
	 */
	public String date(int seconds) {
		Date date = new Date(1000 * seconds);
		// 模拟方法执行耗时
		try {
			Thread.sleep(10);
		}
		catch (InterruptedException e) {
			e.printStackTrace();
		}
		return dateFormat.format(date);
	}
}

在这里插入图片描述

图：多线程环境下，存在重复输出

3. 使用ThreadLocal线程独享SimpleDateFormat

import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.concurrent.ArrayBlockingQueue;
import java.util.concurrent.ThreadPoolExecutor;
import java.util.concurrent.TimeUnit;

import lombok.extern.slf4j.Slf4j;

/**
 * <pre>
 * 程序目的：演示多线程访问线程不安全的类，逐步引入 ThreadLocal 类
 * 可以让每个线程都拥有一个自己的 simpleDateFormat 对象，来保证线程安全
 * 输出结果：
 * 运行总耗时：2985ms
 * </pre>
 * created at 2020/7/17 07:55
 * @author lerry
 */
@Slf4j
public class ThreadLocalDemoWithThreadLocal {

	/**
	 * 核心线程数
	 */
	public static final int CORE_POOL_SIZE = 4;

	/**
	 * 等待队列数量
	 */
	private static ArrayBlockingQueue queue = new ArrayBlockingQueue(1000 - CORE_POOL_SIZE);

	/**
	 * 线程池
	 */
	private static ThreadPoolExecutor threadPool = new ThreadPoolExecutor(CORE_POOL_SIZE, CORE_POOL_SIZE, 0, TimeUnit.SECONDS, queue);

	public static void main(String[] args) throws InterruptedException {
		long startTime = System.currentTimeMillis();
		for (int i = 0; i < 1000; i++) {
			final int finalI = i;
			threadPool.submit(() -> {
				String date = new ThreadLocalDemoWithThreadLocal().date(finalI);
				log.info("\tdate is {}", date);
			});
		}
		threadPool.shutdown();

		for (; ; ) {
			if (threadPool.isTerminated()) {
				log.info("运行总耗时：{}ms", (System.currentTimeMillis() - startTime));
				break;
			}
		}
	}

	/**
	 * 按照秒数，输出一天开始的时间格式表示
	 * 如：第1秒 00:01
	 * 第2秒 00:02
	 * 第60秒 01:00
	 * @param seconds
	 * @return
	 */
	public String date(int seconds) {
		Date date = new Date(1000 * seconds);
		SimpleDateFormat dateFormat = ThreadSafeFormatter.dateFormatThreadLocal.get();
		// 模拟方法执行耗时
		try {
			Thread.sleep(10);
		}
		catch (InterruptedException e) {
			e.printStackTrace();
		}
		return dateFormat.format(date);
	}
}

/**
 * <pre>
 * 我们使用了 ThreadLocal 帮每个线程去生成它自己的 simpleDateFormat 对象，
 * 对于每个线程而言，这个对象是独享的。
 * 但与此同时，这个对象就不会创造过多，一共只有 4 个，因为在线程池管理下，线程只有 4 个。
 * </pre>
 * created at 2020/7/17 08:11
 * @author lerry
 */
@Slf4j
class ThreadSafeFormatter {
	public static ThreadLocal<SimpleDateFormat> dateFormatThreadLocal = ThreadLocal.withInitial(() -> {
		SimpleDateFormat simpleDateFormat = new SimpleDateFormat("mm:ss");
		log.info("simpleDateFormat对象的hashCode:{}", System.identityHashCode(simpleDateFormat));
		return simpleDateFormat;
	});
}

在这里插入图片描述

图：使用了ThreadLocal的输出结果

接下来，演示：

使用场景2，避免传参

/**
 * <pre>
 * 程序目的：演示ThreadLocal类的用法
 * 每个线程内需要保存类似于全局变量的信息（例如在拦截器中获取的用户信息），
 * 可以让不同方法直接使用，避免参数传递的麻烦却不想被多线程共享（因为不同线程获取到的用户信息不一样）。
 * 例如，用 ThreadLocal 保存一些业务内容（用户权限信息、从用户系统获取到的用户名、用户ID 等），
 * 这些信息在同一个线程内相同，但是不同的线程使用的业务内容是不相同的。
 * 在线程生命周期内，都通过这个静态 ThreadLocal 实例的 get() 方法取得自己 set 过的那个对象，
 * 避免了将这个对象（如 user 对象）作为参数传递的麻烦。
 * </pre>
 * created at 2020/7/18 12:28
 * @author lerry
 */
@Slf4j
public class ThreadLocalDemo07 {

	public static void main(String[] args) {
		new Service1().service1();
	}
}

/**
 * 需要执行的服务类
 * created at 2020-07-18 12:28
 * @author lerry
 */
@Slf4j
class Service1 {

	public void service1() {
		String name = "浩克";
		User user = new User(name);
		log.info("service1设置用户名:{}", name);
		UserContextHolder.holder.set(user);
		new Service2().service2();
	}
}

@Slf4j
class Service2 {

	public void service2() {
		User user = UserContextHolder.holder.get();
		log.info("Service2拿到用户名：{}", user.name);
		new Service3().service3();
	}
}

@Slf4j
class Service3 {

	public void service3() {
		User user = UserContextHolder.holder.get();
		log.info("Service3拿到用户名：{}", user.name);
		UserContextHolder.holder.remove();
	}
}

/**
 * 持有一个ThreadLocal成员变量，保存了User用户信息
 * created at 2020-07-18 12:29
 * @author lerry
 */
class UserContextHolder {
	public static ThreadLocal<User> holder = new ThreadLocal<>();
}

/**
 * 保存用户数据
 * created at 2020-07-18 12:27
 * @author lerry
 */
class User {

	String name;

	public User(String name) {
		this.name = name;
	}
}

在这里插入图片描述

图：使用ThreadLocal避免传参的输出结果

注意事项
  1. 如果各Service，异步执行，那么ThreadLocal传参的方式就不适用了。
  2. 使用完毕，需要手动ThreadLocal的remove()方法，来避免内存泄露。 详情可参照：ThreadLocal内存泄漏问题 - 掘金

本文目录结构

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-HTv5ThNl-1595376196416)(evernotecid://A0276EB5-0616-4074-A4BE-0A1331D6E773/appyinxiangcom/1711267/ENResource/p8716)]

图：本文目录结构

参考资料

ThreadLocal内存泄漏问题 - 掘金

环境说明

  • java -version
java version "1.8.0_251"
Java(TM) SE Runtime Environment (build 1.8.0_251-b08)
Java HotSpot(TM) 64-Bit Server VM (build 25.251-b08, mixed mode)
  • OS：macOS High Sierra 10.13.4
  • 日志：logback
快乐柠檬
关注
专栏目录
手把手教你，使用JWT实现单点登录
Java极客技术
05-15 1万+
每天早上七点三十，准时推送干货JSON Web Token（JWT）是目前最流行的跨域身份验证解决方案之一，今天我们一起来揭开它神秘的面纱！一、故事起源说起 JWT，我们先来谈一谈基于传...
jwt如何加盐_手把手教你使用JWT实现单点登录
weixin_29556943的博客
01-27 666
JSON Web Token(JWT)是目前最流行的跨域身份验证解决方案之一，今天我们一起来揭开它神秘的面纱！一、故事起源说起 JWT，我们先来谈一谈基于传统session认证的方案以及瓶颈。传统session交互流程，如下图：当浏览器向服务器发送登录请求时，验证通过之后，会将用户信息存入seesion中，然后服务器会生成一个sessionId放入cookie中，随后返回给浏览器。当浏览器再次发送...
ThreadLocal的使用
04-05
NULL 博文链接：https://xuranpaoche.iteye.com/blog/1514071
ThreadLocal的正确用法
热门推荐
Alpha's 学习笔记
11-06 5万+
ThreaLocal的JDK文档中说明：ThreadLocal instances are typically private static fields in classes that wish to associate state with a thread。如果我们希望通过某个类将状态（例如用户ID、事务ID）与线程关联起来，那么通常在这个类中定义private static类型的ThreadLocal 实例。
ThreadLocal详解
落日的博客
07-23 1916
get() 方法首先获取当前线程，然后尝试从当前线程的 ThreadLocalMap 中获取与当前 ThreadLocal 实例关联的值。如果找到了该值，则直接返回；否则调用 setInitialValue() 设置并返回初始值。getMap(Thread t) 方法返回当前线程的 ThreadLocalMap。> key) 方法通过计算哈希值获取与 key 关联的条目，如果没有找到，则调用 getEntryAfterMiss 继续查找。
Java ThreadLocal 使用详解
weixin_33725722的博客
09-09 178
ThreadLocal的官方API解释为： "该类提供了线程局部 (thread-local) 变量。这些变量不同于它们的普通对应物，因为访问某个变量（通过其get或set方法）的每个线程都有自己的局部变量，它独立于变量的初始化副本。ThreadLocal实例通常是类中的 private static 字段，它们希望将状态与某一个线程（例如，用户 ID 或事务 ID）相关联。" ...
ThreadLocal使用
浪不虚传
11-05 132
转载http://gaofeihang.blog.163.com/blog/static/84508285201293071940706/ ThreadLocal的含义是Thread Local Variable，它可以声明一个字段，使得不同的线程访问这个字段时，获取的都是不同的副本，互不影响。 ThreadLocal的作用和在每个Thread类声明一个字段相同，那么什么时候使用它呢？还是在...
手把手教你实现MySQL读写分离+故障转移，不信你学不会！
Java笔记虾
12-06 1638
上一篇发了手动搭建Redis集群和MySQL主从同步(非Docker)之后，很多同学对文中主从结构提到的读写分离感兴趣，本打算在双十一期间直接把读写分离分享给大家，奈何工作一直没停下，所以这周抽空把这些分享出来。
手把手教你入门vue+springboot开发（十二）--无感token后端实现
最新发布
dreamflyly的博客
08-10 661
上一篇我们详细解读了token实现，有一个问题：如果token过期失效时间设置过长，安全性得不到保障；如果token过期失效时间设置过短，会经常需要重新登录来获取新的token，用户体验很差。为了解决这个问题，一个常用的做法就是无感刷新token，那么如何实现无感刷新token呢？
手把手教你写一个RPC框架（三）
weixin_43395911的博客
12-15 2548
承接着上一节，手把手教你写一个RPC框架（二） 我们定义了两个注解、编写了的连接Zookeeper注册中心的逻辑，这一节，我们继续来完成RPC框架吧！ 七 序列化 RPC框架中，离不开网络请求，服务A调用服务B的方法，要发送一个网络请求，服务B收到网络请求后，解析请求，然后把方法的执行结果返回给服务A。为了实现这些步骤，需要编写消息请求体、消息相应体、序列化与反序列化的相关逻辑。下面一起来看看怎么写吧～ import lombok.Data; import java.io.Serializable; .
ThreadLocal使用方法
weixin_33896069的博客
01-04 349
  创建一个Bean，通过不同的线程对象设置Bean属性，保证各个线程Bean对象的独立性。   /**  * Created by IntelliJ IDEA.  * User: leizhimin  * Date: 2007-11-23  * Time: 10:45:02  * 学生  */ public class Student {  ...
如何正确使用 ThreadLocal，你真的用对了吗？
weixin_44421461的博客
05-16 3562
点击上方“Java基基”，选择“设为星标”做积极的人，而不是积极废人！每天14:00更新文章，每天掉亿点点头发...源码精品专栏原创 | Java 2021超神之路，很肝~中文详细注释的开源项目RPC 框架 Dubbo 源码解析网络应用框架 Netty 源码解析消息中间件 RocketMQ 源码解析数据库中间件 Sharding-JDBC 和 MyCAT 源码解析...
Threadlocal的使用
HsiunKao
12-16 284
Threadlocal就是一个线程绑定的变量，这个变量只能在当前现成访问，其他线程无法访问这个变量。在保存一些线程相关的变量是特别有用。 使用示例 以下代码用来保存一次用户登陆的信息。用户登陆之后将其userId保存在ThreadLocal中，这样在需要的时候就能从ThreadLocal中取出。 public class CurrentUser { private static fina...
ThreadLocal 使用
姚棉伟的博客
05-02 158
ThreadLocal使用ThreadLocal概念ThreadLocal使用基本使用多线程案例ThreadLocal使用场景场景1场景2 ThreadLocal概念 ThreadLocal 是 JDK 包提供的，它提供线程本地变量，如果创建 ThreadLocal 变量，那么访问这个变量的每个线程都会有这个变量的一个副本，在实际多线程操作的时候，操作的是自己本地内存中的变量，实现了线程的数据隔离，从而规避了线程安全问题。 ThreadLocal使用 基本使用 ThreadLocal 基本API包括：构
ThreadLocal的使用教程
05-30
以下是ThreadLocal的使用教程： 1. 定义ThreadLocal对象 ```java private static ThreadLocal<VariableType> threadLocalName = new ThreadLocal(); ``` 其中VariableType是您要保存的变量类型，threadLocalName...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值