前言:
ThreadLocal是多线程中,每个线程为自己创建的一个本地副本对象,多个线程之间读写副本数据相互隔离,互不影响,没有锁的束缚。
常用于线程中数据库连接的维护,web请求session的存储,线程日志的跟踪等。
需要注意的问题:
内存泄漏,在线程池中的线程复用问题。
类结构:
基本原理是:
每个线程中存放一个ThreadLocal.ThreadLocalMap<ThreadLocal<?> k, Object v>类型的本地集合变量threadLocals;
变量threadLocals的key为ThreadLocal的实例对象本身this的弱引用,value为存放到threadLocal副本中的数值对象。
这张图是来自另一个博主的总结,我根据自己的认识又做了小改动,在下面也贴出来,各位看官可以按需所取吧。
相关代码:
public class TestThreadLocal { public static ThreadLocal<Byte[]> threadLocalRef = new ThreadLocal<Byte[]>(); public static void main(String[] args) { Byte[] value = new Byte[5 * 1024 * 1024]; threadLocalRef.set(value); System.out.println(Thread.currentThread().getName() + ":" + threadLocalRef.get()); } }
-----------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------
使用
一.多线程应用:
总体讲对于同一个 static ThreadLocal 实例是用于操作当前线程共享变量,同时也不会影响其他线程的变量。
对于ThreadLocal的操作,以jdk1.8为例,我们可以进行几个操作如下:
1.ThreadLocal.initialValue:ThreadLocal 没有被当前线程赋值时或当前线程刚调用remove方法后调用 get 方法,返回此方法值。
2.ThreadLocal.get:获取 ThreadLocal 中当前线程共享变量的值。
3.ThreadLocal.set:设置 ThreadLocal 中当前线程共享变量的值。
4.ThreadLocal.remove:移除 ThreadLocal 中当前线程共享变量的值。
代码如下:
package com.coshaho.reflect; /** * ThreadLocal用法 * * @author coshaho */ public class MyThreadLocal { private static final ThreadLocal<Object> threadLocal = new ThreadLocal<Object>() { /** * ThreadLocal没有被当前线程赋值时或当前线程刚调用remove方法后调用get方法,返回此方法值 */ @Override protected Object initialValue() { System.out.println("调用get方法时,当前线程共享变量没有设置,调用initialValue获取默认值!"); return null; } }; public static void main(String[] args) { new Thread(new MyIntegerTask("IntegerTask1")).start(); new Thread(new MyStringTask("StringTask1")).start(); new Thread(new MyIntegerTask("IntegerTask2")).start(); new Thread(new MyStringTask("StringTask2")).start(); } public static class MyIntegerTask implements Runnable { private String name; MyIntegerTask(String name) { this.name = name; } @Override public void run() { for (int i = 0; i < 5; i++) { // ThreadLocal.get方法获取线程变量 if (null == MyThreadLocal.threadLocal.get()) { // ThreadLocal.et方法设置线程变量 MyThreadLocal.threadLocal.set(0); System.out.println("线程" + name + ": 0"); } else { int num = (Integer) MyThreadLocal.threadLocal.get(); MyThreadLocal.threadLocal.set(num + 1); System.out.println("线程" + name + ": " + MyThreadLocal.threadLocal.get()); if (i == 3) { MyThreadLocal.threadLocal.remove(); } } try { Thread.sleep(1000); } catch (InterruptedException e) { e.printStackTrace(); } } } } public static class MyStringTask implements Runnable { private String name; MyStringTask(String name) { this.name = name; } @Override public void run() { for (int i = 0; i < 5; i++) { if (null == MyThreadLocal.threadLocal.get()) { MyThreadLocal.threadLocal.set("a"); System.out.println("线程" + name + ": a"); } else { String str = (String) MyThreadLocal.threadLocal.get(); MyThreadLocal.threadLocal.set(str + "a"); System.out.println("线程" + name + ": " + MyThreadLocal.threadLocal.get()); } try { Thread.sleep(800); } catch (InterruptedException e) { e.printStackTrace(); } } } } }
结果为:
调用get方法时,当前线程共享变量没有设置,调用initialValue获取默认值!
调用get方法时,当前线程共享变量没有设置,调用initialValue获取默认值!
线程StringTask2: a
线程IntegerTask1: 0
调用get方法时,当前线程共享变量没有设置,调用initialValue获取默认值!
线程StringTask1: a
调用get方法时,当前线程共享变量没有设置,调用initialValue获取默认值!
线程IntegerTask2: 0
线程StringTask2: aa
线程StringTask1: aa
线程IntegerTask1: 1
线程IntegerTask2: 1
线程StringTask2: aaa
线程StringTask1: aaa
线程IntegerTask1: 2
线程IntegerTask2: 2
线程StringTask2: aaaa
线程StringTask1: aaaa
线程IntegerTask1: 3
线程IntegerTask2: 3
线程StringTask2: aaaaa
线程StringTask1: aaaaa
调用get方法时,当前线程共享变量没有设置,调用initialValue获取默认值!
线程IntegerTask1: 0
调用get方法时,当前线程共享变量没有设置,调用initialValue获取默认值!
线程IntegerTask2: 0
二.原理:
线程共享变量缓存如下:
Thread.ThreadLocalMap<ThreadLocal, Object>;
1.Thread: 当前线程,可以通过Thread.currentThread()获取。
2.ThreadLocal:我们的static ThreadLocal变量。
3.Object: 当前线程共享变量。
我们调用ThreadLocal.get方法时,实际上是从当前线程中获取ThreadLocalMap<ThreadLocal, Object>,然后根据当前 ThreadLocal 获取当前线程共享变量Object。
ThreadLocal.set,ThreadLocal.remove实际上是同样的道理。
这种存储结构的好处:
1.线程退出的时候,线程中的共享变量 ThreadLocalMap 实例则同步销毁。
2.ThreadLocalMap<ThreadLocal,Object>键值对数量为 ThreadLocal 实例的数量,一般来说 ThreadLocal 数量很少,相比在ThreadLocal中用Map<Thread, Object>键值对存储线程共享变量(Thread数量一般来说比ThreadLocal数量多),性能提高很多。
ThreadLocalMap中的弱引用,以及线程池中的ThreadLocal使用不当都有可能导致内存泄漏的问题:
1.关于ThreadLocalMap<ThreadLocal, Object>弱引用问题:
当线程没有结束,但是 ThreadLocal 实例已经被回收了,则可能导致线程中存在ThreadLocalMap<null, Object>的键值对,而 ThreadLocalMap 实例是存放在当前线程中的,当前线程没有回收所有ThreadLocalMap实例还是存在的,所以就存在了一个key为null的键值对,造成内存泄露(ThreadLocal被回收,ThreadLocal关联的线程共享变量还存在)。
虽然当前线程的其它 ThreadLocal 实例的 get,set 方法时候可以调用 ThreadLocalMap 实例的遍历方法,并清除 ThreadLocalMap 实例中 key 为 null 的 value,但是get,set方法在内存泄露后并不会必然调用。
所以弱引用内存泄漏的问题的方法:
1.1.使用完线程共享变量后,显示调用 ThreadLocal 实例的 remove 方法清除线程共享变量;
1.2.JDK建议 ThreadLocal 定义为 private static,这样 ThreadLocal 的弱引用问题则不存在了。
2.threadlocal和线程池使用要注意的地方:
它和线程池一起使用的时候会出现问题,因为我们知道线程池有一个好处就是会让线程重用,避免创建过多的线程对象。也就是说有可能会出现 ThreadLocal 中的线程对象相同的情况,先上代码看看,代码也很简单:
public class ThreadTest { static ExecutorService defaultFixedExecutor = Executors.newFixedThreadPool(1); static ThreadLocal<String> threadLocal = new ThreadLocal<String>(); public static void main(String[] args) { for (int i = 1; i < 4; i++) { final int count = i; defaultFixedExecutor.submit(new Runnable() { @Override public void run() { System.out.println("第"+count+"次循环刚开始,ThreadLocal中的值为:"+threadLocal.get()); threadLocal.set(count+"---"); System.out.println("第"+count+"次循环结束,ThreadLocal中的值为:"+threadLocal.get()); System.out.println("当前线程名称为:"+Thread.currentThread().getName()); System.out.println("------------------"); } }); } } }
运行结果:
第1次循环刚开始,ThreadLocal中的值为:null 第1次循环结束,ThreadLocal中的值为:1--- 当前线程名称为:pool-1-thread-1 ------------------ 第2次循环刚开始,ThreadLocal中的值为:1--- 第2次循环结束,ThreadLocal中的值为:2--- 当前线程名称为:pool-1-thread-1 ------------------ 第3次循环刚开始,ThreadLocal中的值为:2--- 第3次循环结束,ThreadLocal中的值为:3--- 当前线程名称为:pool-1-thread-1 ------------------
我们看到,当前线程还没有给 ThreadLocal 赋值,但是ThreadLocal里面已经有值了。
解决办法可以看 ThreadLocal 的API:
只要在使用ThreadLocal之前或者之后remove一下就好了。