1. ThreadLocal介绍
1.1 官方介绍
从Java官方文档中的描述:ThreadLocal类用来提供线程内部的局部变量。这种变量在多线程环境下访问(通过get和set方法访问)时能保证各个线程的变量相对于独立于其他线程内的变量。ThreadLocal实例通常来说都是 private static 类型的,用于关联线程和线程上下文。
我们可以得知 ThreadLocal 的作用是:提供线程内的局部变量,不同的线程之间不会相互干扰,这种变量在线程的生命周期内起作用,减少同一个线程内多个函数或组件之间一些公共变量传递的复杂度。
总结:
- 线程并发:在多线程并发的场景下
- 传递数据:我们可以通过ThreadLocal在同一线程,不同组件中传递公共变量
- 线程隔离:每个线程的变量都是独立地,不会互相影响
1.2 基本使用
1.2.1 常用方法
方法声明 | 描述 |
---|---|
public void set (T value) | 设置当前线程绑定的局部变量 |
public T get() | 获取当前线程绑定的局部变量 |
public void remove() | 移除当前线程绑定的局部变量 |
1.2.2 使用案例
根据以下案例,感受 ThreadLocal 线程隔离的特点:
/**
* 需求:线程隔离
* 在多线程并发的场景下,每个线程中的变量都是相互独立的
* 线程A : 设置(变量1) 获取(变量1)
* 线程B : 设置(变量2) 获取(变量2)
*
* ThreadLocal:
* 1. set() : 将变量绑定到当前线程中
* 2. get() : 获取当前线程绑定的变量
*/
public class Demo {
//变量
private String content;
private String getContent() {
return this.content;
}
private void setContent(String content) {
this.content = content;
}
public static void main(String[] args) {
Demo demo = new Demo();
for (int i = 0; i < 5; i++) {
Thread thread = new Thread(new Runnable() {
@Override
public void run() {
/*
每个线程:存一个变量,再取一个变量
*/
demo.setContent(Thread.currentThread().getName() + "的数据");
System.out.println("---------------------");
System.out.println(Thread.currentThread().getName() + "---->" + demo.getContent());
}
});
thread.setName("线程" + i); //线程0 ~ 4
thread.start();
}
}
}
运行结果如下:
对局部代码做调整(应用ThreadLocal类):
ThreadLocal<String> threadLocal = new ThreadLocal<>();
//变量
private String content;
private String getContent() {
//return this.content;
return threadLocal.get();
}
private void setContent(String content) {
//this.content = content;
threadLocal.set(content);
}
运行结果如下:
1.3 ThreadLocal类 & synchronized关键字
1.3.1 synchronized 同步方式
上述例子可以通过加锁实现这个功能,我们来看看使用 synchronized 代码块实现的效果:
public class DemoA {
//变量
private String content;
private String getContent() {
return this.content;
}
private void setContent(String content) {
this.content = content;
}
public static void main(String[] args) {
DemoA demo = new DemoA();
for (int i = 0; i < 5; i++) {
Thread thread = new Thread(new Runnable() {
@Override
public void run() {
/*
每个线程:存一个变量,再取一个变量
*/
synchronized (DemoA.class) {
demo.setContent(Thread.currentThread().getName() + "的数据");
System.out.println("---------------------");
System.out.println(Thread.currentThread().getName() + "---->" + demo.getContent());
}
}
});
thread.setName("线程" + i); //线程0 ~ 4
thread.start();
}
}
}
运行结果如下:
从结果可以发现,加锁确实可以解决这个问题,但是在这里我们强调的是数据隔离的问题,并不是多线程共享数据的问题,在这个案例中使用 synchronized 关键字是不合适的。
使用 synchronized 加锁解决该问题,将会降低程序的并发性。
1.3.2 ThreadLocal 与 synchronized 的区别
虽然 ThreadLocal 与 synchronized 关键字都用于处理多线程并发访问变量的问题,不过两者处理问题的角度和思路不同。
synchronized | ThreadLocal | |
---|---|---|
原理 | 同步机制采用 ‘以时间换空间’ 的方式,只提供了一份变量,让不同的线程排队访问 | ThreadLocal采用 ‘以空间换时间’ 的方式,为每一个线程都提供了一份变量副本,从而实现同时访问而互不干扰 |
侧重点 | 多个线程之间访问资源的同步 | 多线程中让每个线程之间的数据相互隔离 |
总结:
- 在刚刚的案例中,虽然使用 ThreadLocal 和 synchronized 都能解决问题,但是使用 TreadLocal 更为何时,因为这样可以是程序员拥有更高的并发性。
2. ThreadLocal 内部结构
通过以上学习,我们对其有一定的了解,下面来了解 ThreadLocal 的内部结构,探究其能够实现线程数据隔离的原理。
2.1 常见的误解
如果我们不去看源代码,可能会猜测ThreadLocal
的设计:每个ThreadLocal
都创建一个Map
,然后用线程作为Map
的key
,要存储的局部变量作为Map
的value
,这样就能达到各个线程的局部变量隔离的效果。这是最简单的设计方法,JDK早期的ThreadLocal
确实是这样设计的,但现在不是了。
2.2 现在的设计
但是,JDK后面优化了设计方案,JDK8 中ThreadLocal
的设计是:每个Thread
维护一个ThreadLocalMap
,这个Map的key
是ThreadLocal
实例本身,value
才是真正要存储的值Object
。
具体的过程是这样的:
- 每个Thread线程内部都有一个Map(ThreadLocalMap)
- Map里存储ThreadLocal对象(key)和线程的变量副本(value)
- Thread内部的Map是由ThreadLocal维护的,由ThreadLocal负责向Map获取和设置线程的变量值。
- 对于不同的线程,每次获取副本值时,别的线程并不能获取到当前线程的副本值,形成了副本的隔离,互不干扰。
2.3 这样设计的好处
JDK8 的设计方案两个好处:
- 每个Map存储的Entry数量变少
- 当Thead销毁的时候,ThreadLocalMap也会随之销毁,减少内存的使用
3. ThreadLocal 的核心方法源码
基于ThreadLocal的内部结构,我们继续分析它的核心方法源码,更深入的了解其操作原理。
除了构造方法之外,ThreadLocal 对外暴露的方法有以下4个:
方法声明 | 描述 |
---|---|
protected T initialValue() | 返回当前线程局部变量的初始值 |
public void set (T value) | 设置当前线程绑定的局部变量 |
public T get() | 获取当前线程绑定的局部变量 |
public void remove() | 移除当前线程绑定的局部变量 |
以下是这4个方法的详细源码分析
3.1 set 方法
(1)源码和对应的中文注释
/**
* 设置当前线程对应的ThreadLocal值
*
* @param value 将要保存在当前线程对应的ThreadLocal的值
*/
public void set(T value) {
// 获取当前对象
Thread t = Thread.currentThread();
// 获取此线程对象中维护的ThreadLocalMap对象
ThreadLocalMap map = getMap(t);
// 判断map是否存在
if (map != null) {
//存在则调用map.set设置此实体的entry
map.set(this, value);
} else {
// 1)当前线程Thread 不存在ThreadLocalMap对象
// 2)调用createMap进行ThreadLocalMap对象的初始化
// 3)并将 t(当前线程)和value(t对应值)作为第一个entry存放至ThreadLocalMap中
createMap(t, value);
}
}
/**
* 获取当前线程Thread对应维护的ThreadLocalMaps
*
* @param t (the current thread) 当前线程
* @return (the map) 对应维护的ThreadLocalMap
*/
ThreadLocalMap getMap(Thread t) {
return t.threadLocals;
}
/**
* 创建当前线程Thread对应维护的ThreadLocalMap
*
* @param t (the current thread) 当前线程
* @param firstValue (value for the initial entry of the map) 存放到map中的第一个entry值
*/
void createMap(Thread t, T firstValue) {
//这里的this是调用此方法的threadlocal
t.threadLocals = new ThreadLocalMap(this, firstValue);
}
(2)代码执行流程
- 如果获取当前线程,并根据当前线程获取一个Map
- 如果获取的Map不为空,则将参数设置到Map中(当前ThreadLocal的引用作为key)
- 如果Map为空,则给该线程创建Map,并设置初始值
3.2 get 方法
(1)源码和对应的中文注释
/**
* 返回当前线程中保存ThreadLocal的值
* 如果当前线程没有此ThreadLocal变量
* 则它会通过调用{@link #initialValue} 方法进行初始化值
*
* @return (the current thread's value of this thread-local) 返回当前线程对应此ThreadLocal的值
*/
public T get() {
// 获取当前线程对象
Thread t = Thread.currentThread();
// 获取此线程对象中维护的ThreadLocalMap对象
ThreadLocalMap map = getMap(t);
// 如果map存在
if (map != null) {
// 以当前的ThreadLocal 为 key,调用getEntry获取对应的存储实体e
ThreadLocalMap.Entry e = map.getEntry(this);
// 对e进行判空
if (e != null) {
@SuppressWarnings("unchecked")
// 获取存储实体 e 对应的 value 值
// 即为我们想要的当前线程对应此ThreadLocal的值
T result = (T)e.value;
return result;
}
}
/*
初始化:有两种情况执行当前代码
第一种情况:map不存在,表示此线程没有维护的ThreadLocalMap对象
第二种对象:map存在,但是没有与当前ThreadLocal关联的entry
*/
return setInitialValue();
}
/**
* 初始化
*
* @return (the initial value) 初始化后的值
*/
private T setInitialValue() {
// 调用initialValue获取初始化的值
// 此方法可以被子类重写,如果不重写默认返回null
T value = initialValue();
// 获取当前线程对象
Thread t = Thread.currentThread();
// 获取此线程对象中维护的ThreadLocalMap对象
ThreadLocalMap map = getMap(t);
// 判断map是否存在
if (map != null) {
map.set(this, value);
} else {
// 1)当前线程Thread 不存在ThreadLocalMap对象
// 2)则调用createMap进行ThreadLocalMap对象的初始化
// 3)并将 t(当前线程)和value(t对应的值)作为第一个entry存放至ThreadLocalMap中
createMap(t, value);
}
// 判断当前对象是否是TerminatingThreadLocal的子类
if (this instanceof TerminatingThreadLocal) {
TerminatingThreadLocal.register((TerminatingThreadLocal<?>) this);
}
// 返回设置的值value
return value;
}
(2)代码执行流程
- 首先获取当前线程,根据当前线程获取一个Map
- 如果获取的Map不为空,则在Map中以ThreadLocal的引用作为key来在Map中获取对应的Entry e,否则转到第4步
- 如果e不为null,则返回e.value,否则转到第4步
- Map为空或e为空,则通过initialValue方法获取初始值value,然后用ThreadLocal的引用和value作为firstKey和fisrtValue创建一个新的Map
总结:先获取当前线程的 ThreadLocalMap 变量,如果存在则返回值,不存在则创建并返回初始值。
3.3 remove 方法
(1)源码和对应的中文注释
/**
* 删除当前线程中保存的ThreadLocal对应的实体entry
*/
public void remove() {
// 获取当前线程对象中维护的ThreadLocalMap对象
ThreadLocalMap m = getMap(Thread.currentThread());
// 如果此map存在
if (m != null) {
// 存在则调用map.remove
// 以当前ThreadLocal为key删除对应的实体entry
m.remove(this);
}
}
(2)代码执行流程
- 首先获取当前线程,并根据当前线程获取一个Map
- 如果获取的Map不为空,则移除当前TheadLocal对象对应的entry
3.4 initialValue 方法
/**
* 返回当前线程对应的ThreadLocal的初始值
*
* 此方法的第一次调用发生在,当线程通过get方法访问此线程的ThreadLocal值时
* 除非线程先调用了set方法,在这种情况下,initialValue 才不会被这个线程调用
* 通常情况下,每个线程最多调用一次这个方法
*
* 这个方法仅仅简单的返回null {@code null};
* 如果程序员想ThreadLocal线程局部变量有一个除null以外的初始值
* 必须通过子类继承{@code ThreadLocal} 的方式去重写此方法
* 通常,可以通过匿名内部类的方式实现
*
* @return (the initial value for this thread-local) 当前ThreadLocal的初始值
*/
protected T initialValue() {
return null;
}
此方法的作用是返回该线程局部变量的初始值。
(1)这个方法是一个延迟调用方法,从上面的代码我们得知,在set方法还未调用而先调用了get方法时才执行,并且仅执行一次。
(2)这个方法缺省实现直接返回一个null
。
(3)如果想要一个除null之外的初始值,可以重写此方法。(备注:此方法是一个protected
方法,显然是为了让子类覆盖而设计的)
4. ThreadLocalMap 源码分析
在分析ThreadLocal方法的时候,我们了解到ThreadLocal的操作实际上是围绕ThreadLocalMap展开的。ThreadLocalMap源码相对较为复杂,我们从以下三个方面讨论。
4.1 基本结构
ThreadLocalMap是ThreadLocal的内部类,没有实现Map接口,用独立的方式实现了Map的功能,其内部的Entry也是独立实现的。
(1)成员变量
/**
* 初始容量 —— 必须是2的整次幂
*/
private static final int INITIAL_CAPACITY = 16;
/**
* 存放数据的table,Entry类的定义在下面分析
* 同样,数组长度必须是2的整次幂。
*/
private Entry[] table;
/**
* 数组里面entrys的个数,可以用于判断table当前使用量是否超过阈值。
*/
private int size = 0;
/**
* 进行扩容的阈值,表使用量大于它的时候进行扩容。
*/
private int threshold; //Default to 0
与HashMap类似,INITIAL_CAPACITY代表这个Map的初始容量;table 是一个Entry类型的数组,用于存储数据;size 代表表中的存储数目;threshold 代表需要扩容时对应 size 的阈值。
(2)存储结构 - Entry
/*
* Entry继承WeakReference,并且用ThreadLocal作为key.
* 如果key为null(entry.get() == null),意味着key不再被引用,
* 因此这时候entry也可以从table中清除。
*/
static class Entry extends WeakReference<ThreadLocal<?>> {
/** The value associated with this ThreadLocal. */
Object value;
Entry(ThreadLocal<?> k, Object v) {
super(k);
value = v;
}
}
在ThreadLocalMap中,也是用Entry来保存K-V结构数据的。不过Entry中的key只能是ThreadLocal对象。这点在构造方法中已经限定死了。
另外,Entry继承WeakReference,也就是key(ThreadLocal)是弱引用,其目的是将ThreadLocal对象的生命周期和线程生命周期解绑
4.2 弱引用 & 内存泄漏
有些程序员在使用ThreadLocal的过程中发现有内存泄漏的情况发生,就猜测这个内存泄露跟Entry中使用了弱引用的key有关系,这个理解其实是不对的。
我们先回顾这个问题涉及的几个名词概念,再分析问题。
(1)内存泄漏相关概念
- Memory overflow:内存溢出,没有足够的内存提供申请者使用。
- Memory leak:内存泄漏,程序中已动态分配的堆内存由于某种原因程序未释放或无法释放,造成系统内存的浪费,导致程序运行速度减慢,甚至系统崩溃等严重后果。内存泄露的堆积终将导致内存溢出。
(2)弱引用相关概念
Java中的引用有4种类型:强、软、弱、虚。该问题主要涉及到强引用和弱引用。
强引用(“Stron” Reference):我们最常见的普通对象的引用,只要还有强引用指向一个对象,就表明对象还“活着”,垃圾回收器就不会回收这种对象。
弱引用(WeakReference):垃圾回收器一旦发现了只持有弱引用的对象,无论当前内存空间足够与否,都会回收它的内存。
(3)如果key使用强引用
此时ThreadLocal内存图(实线表示强引用)如下:
假设ThreadLocalMap中的使用了 强引用 ,那么会出现内存泄漏吗?
- 假设在业务代码中使用完ThreadLocal,ThreadLocal Ref被回收了。
- 但是因为ThreadLocalMap的Entry强引用了ThreadLocal,造成 ThreadLocal无法被回收。
- 在没有手动删除这个Entry以及CurrentThread依然运行的前提下,始终有强引用链 ThreadRef → CurrentThread → ThreadLocalMap → Entry,Entry就不会被回收(Entry中包括ThreadLocal实例和value),导致Entry内存泄漏。
所以,ThreadLocalMap中的key使用了强引用,是完全无法避免内存泄漏的。
(4)如果key使用弱引用
假设ThreadLocalMap中的使用了 弱引用 ,那么会出现内存泄漏吗?
- 同样假设再业务代码中使用完ThreadLocal,ThreadLocal Ref被回收了。
- 由于ThreadLocalMap只持有ThreadLocal的弱引用,没有任何强引用指向ThreadLocal实例,所以ThreadLocal就可以被GC回收,此时Entry中的key=null。
- 但是在没有手动删除这个Entry以及CurrentThread依然运行的前提下,也存在有强引用链 ThreadRef → CurrentThread → ThreadLocalMap → Entry → value,value不会被回收,而这块value永远不会被访问到了,导致value内存泄漏。
所以,ThreadLocalMap中的key使用了弱引用,也有可能内存泄漏。
(5)出现内存泄漏的真实原因:
比较以上两种情况,我们就会发现,内存泄漏的发生给TheadLocalMap中的key是否使用弱引用是没有关系的。
这两种内存泄漏的情况,都有两个前提:
- 没有手动删除这个Entry
- CurrentThread依然运行
第一点很好理解,只要在使用完ThreadLocal,调用其remove方法删除对应的Entry,就能避免内存泄漏。
第二点稍微复杂一些,由于ThreadLocalMap是Thread的一个属性,被当前线程所引用,所以它的生命周期和Thread一样长。那么在使用完ThreadLocal时,如果当前Thread也随之执行结束,ThreadLocalMap自然也会被GC回收,从根源上避免了内存泄露。
综上,ThreadLocal内存泄漏的根源:由于ThreadLocalMap的生命周期与Thread一样长,如果没有手动删除对应key就会导致内存泄漏。
(6)为什么使用弱引用
根据当前的分析,我们知道了:无论使用ThreadLocalMap中的key使用哪种类型引用都无法完全避免内存泄露,与使用弱引用无关。
避免内存泄露的两种方式:
- 使用完ThreadLocal,调用其remove方法删除对应的Entry
- 使用完ThreadLocal,当前Thread也随着结束。
相对于第一种方式,第二种方式显然更不好控制,特别是使用线程池的时候,线程结束是不会销毁的。
也就是说,只要记得在使用完ThreadLocal及时调用remove,无论key是强引用还是弱引用都不会有问题的。
那么为什么key要用弱引用呢?
事实上,在ThreadLocalMap中的set/getEntry方法中,会对key为null(也即是ThreadLocal为null)进行判断,如果为null,则将value置为null。
这就意味着使用完ThreadLocal,CurrentThread依然运行的前提下,就算忘记调用remove方法,弱引用比强引用可以多一层保障:弱引用的ThreadLocal会被回收,对应的value在下一次ThreadLocalMap调用set、get、remove中的任一方法时会被清除,从而避免内存泄漏。
4.3 hash冲突的解决
hash冲突的解决是Map中的一个重要内容,我们已hash冲突为线索,研究ThreadLocalMap的核心源码。
处理哈希表处理冲突的方法:线性探测法(开放地址法)、拉链法,Hashtable、HashMap、ConcurrentHashMap采用拉链法,而ThreadLocalMap采用线性探测法(开放地址法)。
(1)ThreadLocal的set() 方法
public void set(T value) {
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null) {
//调用了ThreadLocalMap的set方法
map.set(this, value);
} else {
createMap(t, value);
}
}
ThreadLocalMap getMap(Thread t) {
return t.threadLocals;
}
void createMap(Thread t, T firstValue) {
//调用了ThreadLocalMap的构造方法
t.threadLocals = new ThreadLocalMap(this, firstValue);
}
这个方法我们刚才分析过,其作用是设置当前线程绑定的局部变量:
-
首先获取当前线程,并根据当前线程获取一个Map
-
如果获取的Map不为空,则将参数设置到Map中(当前ThreadLocal的引用作为key)
(这里调用了ThreadLocalMap的set方法)
-
如果Map为空,则给该线程创建 Map,并设置初始值
(这里调用了ThreadLocalMap的构造方法)
这段代码有两个地方分别涉及到ThreadLocalMap的两个方法,我们接着分析这两个方法。
(2)构造方法 TheadLocalMap(ThreadLocal<?> firstKey, Object firstValue)
/*
* firstKey : 本ThreadLocal实例(this)
* firstValue : 要保存的线程本地变量
*/
ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
//初始化table
table = new Entry[INITIAL_CAPACITY];
//计算索引(重点代码)
int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
//设置值
table[i] = new Entry(firstKey, firstValue);
size = 1;
//设置阈值
setThreshold(INITIAL_CAPACITY); //初始容量的2/3
}
构造方法首先创建一个长度为16的Entry数组,然后计算出firstKey对应的索引,然后存储到table中,并设置size和threshold。
重点分析:int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1)
。
1、关于firstKey.threadLocalHashCode
:
private final int threadLocalHashCode = nextHashCode();
private static int nextHashCode() {
return nextHashCode.getAndAdd(HASH_INCREMENT);
}
//AtomicInteger 是一个提供原子操作额度Integer类,通过线程安全的方式操作加减,适合高并发情况下的使用
private static AtomicInteger nextHashCode = new AtomicInteger();
//特殊的hash值
private static final int HASH_INCREMENT = 0x61c88647;
这里定义了一个AtomicInteger类型,每次获取当前值并加上HASH_INCREMENT,HASH_INCREMENT = 0x61c88647
,这个值与斐波那契数列(黄金分割数)有关,其目的是为了让哈希码能均匀的分布在2的n次方的数组里,也就是Entry[] table中,这样做可以尽量避免hash冲突。
2、关于& (INITIAL_CAPACITY - 1)
计算hash的时候采用了hashCode & (size - 1)的算法,这相当于取模运算hashCode % size的一个更高效的实现。正是因为这种算法,我们要求size必须是2的整次幂,这也能保证在索引不越界的前提下,使得hash发生冲突的次数减小。
(3)ThreadLocalMap的set() 方法
private void set(ThreadLocal<?> key, Object value) {
Entry[] tab = table;
int len = tab.length;
//计算索引(重点代码,上面已分析)
int i = key.threadLocalHashCode & (len-1);
/**
* 使用线性探测法查找元素(重点代码)
*/
for (Entry e = tab[i];
e != null;
e = tab[i = nextIndex(i, len)]) {
ThreadLocal<?> k = e.get();
//ThreadLocal 对应的 key 存在,直接覆盖之前的值
if (k == key) {
e.value = value;
return;
}
// key 为 null,但是值不为 null,说明之前的 hreadLocal 对象已经被回收了
if (k == null) {
//用新元素替换旧元素,这个方法进行了不少的垃圾清理动作,防止内存泄漏
replaceStaleEntry(key, value, i);
return;
}
}
//ThreadLocal对应的key不存在并且没有找到旧元素,则在空元素的位置创建了一个新的Entry。
tab[i] = new Entry(key, value);
int sz = ++size;
/**
* cleanSomeSlots 用于清楚那些e.get()==null的元素,
* 如果数据key关联的对象已经被回收,所以这个Entry(table[index])可以被置null。
* 如果没有清除任何entry,并且当前使用量达到了负载因子所定义(长度的2/3),那么进行
* rehash(执行一次全表的扫描清理工作)
*/
if (!cleanSomeSlots(i, sz) && sz >= threshold)
rehash();
}
/**
* 获取环形数组的下一个索引
*/
private static int nextIndex(int i, int len) {
return ((i + 1 < len) ? i + 1 : 0);
}
代码执行流程:
- 首先还是根据key计算出索引i,然后查找i位置上的Entry;
- 若Entry已经存在并且key等于传入的key,此时直接给这个Entry赋予新的value值;
- 若Entry存在,但key为null,则调用replaceStaleEntry来更换这个key为空的Entry;
- 不断循环检测,直至遇到为null的地方,此时若未在循环过程中return,那么就在这个null的位置新建一个Entry,并且插入,同时size+1。
重点分析:ThreadLocalMap使用线性探测法
来解决哈希冲突。
- 该方法一次探测下一个地址,直到有空的地址后插入,若整个空间都找不到空余的地址,则产生溢出。
- 举例:假设当前table长度为16,也就是说如果计算出来的key的hash值为14,如果table[14]上已经有值,并且其key与当前key不一致,那么就发生了hash冲突,此时将14加1得到15,取table[15]进行判断,若仍会产生冲突则回到0,取table[0],再次判断。以此类推,直至可以插入。
- 依照以上描述,可将Entry[] table看成一个环形数组。