ThreadLocal

最新推荐文章于 2025-06-02 09:05:49 发布

是大眼同学！

最新推荐文章于 2025-06-02 09:05:49 发布

阅读量122

点赞数 1

文章标签： java jvm 开发语言 eclipse

本文链接：https://blog.youkuaiyun.com/weixin_52572813/article/details/132437258

版权

三、为什么使用ThreadLocal做key？

四、ThreadLocalMap如何查找数据？

五、父子线程如何共享数据？

六、ThreadLocal如何避免内存泄露？

七、ThreadLocal应用场景

1、线程数据隔离

2、跨函数传递

概述

ThreadLocal被称为线程局部变量，用于在线程中保存数据。由于在ThreadLocal中保存的数据仅属于当前线程，所以该变量对其他线程而言是隔离的，也就是说该变量是当前线程独有的变量。
ThreadLocal用于在同一个线程间，在不同的类和方法之间共享数据的的场景，也可以用于在不同线程间隔离数据的场景。
ThreadLocal利用Thread中的ThreadLocalMap来进行数据存储。

示例1：创建两个线程

public class ThreadLocal01 {
	// 线程局部变量
	public static ThreadLocal<String> threadLocal = new ThreadLocal<String>();

	public static void main(String[] args) throws InterruptedException {

        // 线程1
		Thread thread1 = new Thread(new Runnable() {
			@Override
			public void run() {
				// threadLocal.set:设置当前线程的ThreadLocal中的数据
				threadLocal.set("苏妲己");
				show();
				Sample.doSth();
			}
		}, "线程1");

        // 线程2
		Thread thread2 = new Thread(new Runnable() {
			@Override
			public void run() {
				// TODO Auto-generated method stub
				threadLocal.set("殷寿");
				show();
				Sample.doSth();
			}
		}, "线程2");

		thread1.start();
		thread2.start();

		thread1.join();
		thread2.join();
	}

	public static void show() {
		// threadLocal.get():从当前线程的ThreadLocal中获取数据
		System.out.println("show:" + Thread.currentThread().getName() + "分配角色：" + threadLocal.get());
	}
}

class Sample {
	public static void doSth() {
		System.out.println("doSth:" + Thread.currentThread().getName() + "分配角色：" + ThreadLocal01.threadLocal.get());
	}
}

输出结果：

实例2：使用线程池

public class ThreadLocal02 {

	public static ThreadLocal<String> threadLocal = new ThreadLocal<String>();

	public static void main(String[] args) {

		// 创建线程池
		ThreadPoolExecutor threadPoolExecutor = new ThreadPoolExecutor(1, 1, 0, TimeUnit.SECONDS,
				new LinkedBlockingDeque<Runnable>());

		String[] roleArr = { "姜子牙", "杨戬", "哪吒", "邓婵玉" };

		threadPoolExecutor.submit(new Runnable() {
			public void run() {
				for (String role : roleArr) {
					try {
						show();
						threadLocal.set(role);
						show();
						Sample02.doSth();
					} finally {
						threadLocal.remove();
					}
				}
			}
		});
		threadPoolExecutor.shutdown();

	}

	public static void show() {
		System.out.println("show:" + Thread.currentThread().getName() + "分配角色：" + threadLocal.get());
	}
}

class Sample02 {
	public static void doSth() {
		System.out.println("doSth:" + Thread.currentThread().getName() + "分配角色：" + ThreadLocal02.threadLocal.get());
	}
}

输出结果：

一、常用方法

1、set()方法

存储数据至当前线程的ThreadLocalMap：public void set(T value)。

public void set(T value) {
    // 获取当前线程
    Thread t = Thread.currentThread();

	// 获取当前线程的ThreadLocalMap
    ThreadLocalMap map = getMap(t);

	// 存储数据至当前线程的ThreadLocalMap中
	// 使用ThreadLocal对象做key，保存数据value
    if (map != null)
        map.set(this, value);
    else
        createMap(t, value);
}

2、get()方法

从当前线程的ThreadLocalMap中获取数据：public T get()。

public T get() {
    // 获取当前线程的ThreadLocalMap
    Thread t = Thread.currentThread();
    ThreadLocalMap map = getMap(t);

    // 使用ThreadLocal对象做key，获取数据(Entry类型)
    if (map != null) {
        ThreadLocalMap.Entry e = map.getEntry(this);
        if (e != null) {
            @SuppressWarnings("unchecked")
            T result = (T)e.value;
            return result;
        }
    }
    return setInitialValue();
}

3、remove()方法

从当前线程的ThreadLocalMap中删除数据：public void remove()。

注意：在线程池的线程复用场景中，线程执行完毕时一定要调用remove()，避免在线程被重新放入线程池中时被本地变量的旧状态仍然被保存。

public void remove() {
     // 获取当前线程的ThreadLocalMap
     ThreadLocalMap m = getMap(Thread.currentThread());
     // 使用当前ThreadLocal对象做key，删除数据
     if (m != null)
         m.remove(this);
}

ThreadLocal的get()方法、set()方法和remove()方法，其实最终操作的都是ThreadLocalMap类中的数据。

二、ThreadLocalMap内部结构

ThreadLocalMap内部数据结构是一个Entry类型的数组。每个Entry对象的key为ThreadLocal对象，value为存储的数据。

三、为什么使用ThreadLocal做key？

如果在应用中，一个线程中只使用了一个ThreadLocal对象，那么使用Thread做key也是可以的，代表每个Thread线程对应一个value。

public class ThreadLocalService {
    private static final ThreadLocal<Integer> threadLocal = new ThreadLocal<>();
}

但是，在实际应用程序开发过程中，一个线程中很有可能不只使用了一个ThreadLocal对象。这时使用Thread做key就会产生混淆。所以，不能使用Thread做key，而应该改成用ThreadLocal对象做key，这样才能通过具体ThreadLocal对象的get()方法，获取到当前线程的ThreadLocalMap，然后进一步获取到对应的Entry。

public class ThreadLocalService {
    private static final ThreadLocal<Integer> threadLocal1 = new ThreadLocal<>();
    private static final ThreadLocal<Integer> threadLocal2 = new ThreadLocal<>();
    private static final ThreadLocal<Integer> threadLocal3 = new ThreadLocal<>();
}

四、ThreadLocalMap如何查找数据？

当我们使用ThreadLocal获取当前线程中保存的Value数据时，是以ThreadLocal对象作为Key，通过访问Thread当前线程对象的内部ThreadLocalMap集合来获取到Value。
ThreadLocalMap集合的底层数据结构使用Entry[ ]数组保存Key-Value键值对数据。所以，当通过ThreadLocal的get、set()、remove()等方法，访问ThreadLocalMap时，最终都会通过一个下标，来完成对数组中的元素访问。该下标通过key的“hashCode值”跟"数组的长度减1" 做“&按位与”运算得到。其中key就是ThreadLocal对象。这种计算方式，相当于用“hashCode值”跟“数组的长度”进行“%取余”运算。

int i = key.threadLocalHashCode & (len-1);

五、父子线程如何共享数据？

在实际工作中，有可能需要在父子线程中共享数据的。即：在父线程中往ThreadLocal设置了值，在子线程中能够获取到。此时我们使用ThreadLocal是行不通的。原因是main方法是在主线程中执行的，相当于父线程，在main方法中开启了另外一个线程，相当于子线程。两个线程对象，各自拥有不同的ThreadLocalMap。应该使用InheritableThreadLocal，它是JDK自带的类，继承了ThreadLocal类。

public class ThreadLocal03 {
	public static void main(String[] args) {
		ThreadLocal<String> threadLocal = new InheritableThreadLocal<String>();
		
		threadLocal.set("天王盖地虎，宝塔镇河妖");
		System.out.println("main主线程：" + threadLocal.get());

		// 子线程
		Thread thread = new Thread(new Runnable() {
			public void run() {
				System.out.println("thread子线程：" + threadLocal.get());
			}
		});
		thread.start();
	}
}

输出结果：

六、ThreadLocal如何避免内存泄露？

使用完毕后，在finally调用ThreadLocal对象的remove()方法。

remove()方法中会把Entry中的key和value都设置成null，这样就能被GC(垃圾收集)及时回收，无需触发额外的清理机制，所以它能解决内存泄露问题。

注意：一定要在finally代码块中，调用remove()方法清理没用的数据。如果业务代码出现异常，也能及时清理没用的数据。

七、ThreadLocal应用场景

1、线程数据隔离

ThreadLocal的主要价值在于线程隔离，ThreadLocal中的数据只属于当前线程，该数据对别的线程是不可见的，起到隔离作用。这样操作，可以在多线程环境下，可以防止当前线程的数据被其他线程修改。另外，由于各个线程之间的数据相互隔离，避免了同步加锁带来的性能损失，大大提升了并发性的性能。
例如：SqlSession会话对象绑定，避免多个线程使用同一个SqlSession对象，由于关闭导致异常。