【JAVA并发编程系列】ThreadLocal
【JAVA并发编程系列】ThreadLocal
【1】ThreadLocal 类结构与关键属性
//ThreadLocal 定义类时带有泛型，
//说明 ThreadLocal 可以储存任意格式的数据
//ThreadLocal 类是泛型的，可以放任意值
public class ThreadLocal
//threadLocalHashCode 表示当前 ThreadLocal 的 hashCode
//用于计算当前 ThreadLocal 在 ThreadLocalMap 中的索引位置
private final int threadLocalHashCode = nextHashCode();
// 计算 ThreadLocal 的 hashCode 值(就是递增)
private static int nextHashCode() {
return nextHashCode.getAndAdd(HASH_INCREMENT);
}
//HASH_INCREMENT 转化为十进制是 1640531527，
//2654435769 转换成 int 类型就是 -1640531527，
//2654435769 等于 (√5-1)/2 乘以 2 的 32 次方
//(√5-1)/2 就是黄金分割数，近似为 0.618
//0x61c88647 理解为一个黄金分割数乘以 2 的 32 次方，
//它可以保证 nextHashCode 生成的哈希值，均匀的分布在 2 的幂次方上，
//且小于 2 的 32 次方
private static final int HASH_INCREMENT = 0x61c88647;
// nextHashCode 主要作用是当前 ThreadLocal 赋唯一值，计算当前 ThreadLocal 在 ThreadLocalMap 中的索引位置
// 被 static 修饰非常关键，因为一个线程在处理业务的过程中，ThreadLocalMap 是会被 set 多个 ThreadLocal 的，
// 多个 ThreadLocal 就依靠 threadLocalHashCode 进行区分
// static + AtomicInteger 保证了在一台机器上每个 ThreadLocal 的 threadLocalHashCode 是唯一的
private static AtomicInteger nextHashCode =
new AtomicInteger(); 【2】ThreadLocalMap
ThreadLocalMap 本身就是一个简单的 Map 结构，key 是 ThreadLocal，value 是 ThreadLocal 保存的值，底层是数组的数据结构
为什么使用弱引用
假设 threadLocal 使用的是强引用，在业务代码中执行 threadLocalInstance=null 操作，以实现清理掉 threadLocal 实例的目的，但是因为 threadLocalMap 的 Entry 强引用 threadLocal，因此在 gc 的时候进行可达性分析，threadLocal 依然可达，对 threadLocal 并不会进行垃圾回收，这样就无法真正达到业务逻辑的目的；
// 数组中的每个节点值，WeakReference 是弱引用，当没有引用指向时，会直接被回收
static class Entry extends WeakReference> {
// 当前 ThreadLocal 关联的值
Object value;
// WeakReference 的引用 referent 就是 ThreadLocal
// Entry 的 Key 是 ThreadLocal
Entry(ThreadLocal k, Object v) {
super(k);
value = v;
}
}
// 数组的初始化大小
private static final int INITIAL_CAPACITY = 16;
// 存储 ThreadLocal 的数组
private Entry[] table;
// 扩容的阈值， 默认是数组大小的三分之二
private int threshold;
//ThreadLocalMap : 构造函数
ThreadLocalMap(ThreadLocal firstKey, Object firstValue) {
table = new Entry[INITIAL_CAPACITY];
int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
table[i] = new Entry(firstKey, firstValue);
size = 1;
setThreshold(INITIAL_CAPACITY);
} ThreadLocalMap 解决散列冲突的方法，开放定址法，原因，在 ThreadLocalMap 中的散列值分散的十分均匀，很少会出现冲突并且 ThreadLocalMap 经常需要清除无用的对象，使用纯数组更加方便；
【3】ThreadLocal 是如何做到线程之间数据隔离的
ThreadLocalMap 是线程的属性，所以每个线程的 ThreadLocals 都是隔离独享的，父线程在创建子线程的情况下，会拷贝 inheritableThreadLocals 的值，但不会拷贝 threadLocals 的值；
【4】ThreadLocal 的 set 方法
// set 方法的主要作用是往当前 ThreadLocal 里面设置值
// set 操作每个线程都是串行的，不会有线程安全的问题
public void set(T value) {
//获取当前线程
Thread t = Thread.currentThread();
//获取当前线程的 ThreadLocalMap 对象
ThreadLocalMap map = getMap(t);
// 当前 thradLocal 之前有设置值，直接设置，否则初始化
// map 存在则设置值
if (map != null)
map.set(this, value);
else
// 初始化ThreadLocalMap
createMap(t, value);
}
//返回对应线程的 ThreadLocalMap 对象
ThreadLocalMap getMap(Thread t) {
return t.threadLocals;
}
void createMap(Thread t, T firstValue) {
//初始化线程对象的 threadLocals 成员变量
//this : 当前 ThreadLocal 类实例
t.threadLocals = new ThreadLocalMap(this, firstValue);
}
ThreadLocalMap(ThreadLocal firstKey, Object firstValue) {
table = new Entry[INITIAL_CAPACITY];
int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
table[i] = new Entry(firstKey, firstValue);
size = 1;
setThreshold(INITIAL_CAPACITY);
}ThreadLocalMap 的 set 方法
private void set(ThreadLocal key, Object value) {
Entry[] tab = table;
int len = tab.length;
// 计算 key 在数组中的下标
//根据threadLocal的hashCode确定Entry应该存放的位置
int i = key.threadLocalHashCode & (len-1);
//采用开放地址法，hash冲突的时候使用线性探测
// 查看 i 索引位置有没有值，有值的话，索引位置 + 1，直到找到没有值的位置
// 这种解决 hash 冲突的策略，也导致了其在 get 时查找策略有所不同，体现在 getEntryAfterMiss 中
for (Entry e = tab[i];
e != null;
// nextIndex 就是让在不超过数组长度的基础上，把数组的索引位置 + 1
e = tab[i = nextIndex(i, len)]) {
ThreadLocal k = e.get();
// 找到内存地址一样的 ThreadLocal，直接替换
if (k == key) {
e.value = value;
return;
}
// 当前 key 是 null，说明 ThreadLocal 被清理了，直接替换掉
//当key为null时，说明threadLocal强引用已经被释放掉，那么就无法
//再通过这个key获取threadLocalMap中对应的entry，这里就存在内存泄漏的可能性
if (k == null) {
//用当前插入的值替换掉这个key为null的“脏”entry(stale entry)
replaceStaleEntry(key, value, i);
return;
}
}
// 当前 i 位置是无值的，可以被当前 thradLocal 使用
//新建entry并插入table中i处
tab[i] = new Entry(key, value);
int sz = ++size;
//插入后再次清除一些key为null的“脏”entry(stale entry),如果大于阈值就需要扩容
// 当数组大小大于等于扩容阈值(数组大小的三分之二)时，进行扩容
if (!cleanSomeSlots(i, sz) && sz >= threshold)
rehash();
}ThreadLocalMap Entry 数组扩容
//扩容
private void resize() {
// 拿出旧的数组
Entry[] oldTab = table;
int oldLen = oldTab.length;
// 新数组的大小为老数组的两倍
int newLen = oldLen * 2;
// 初始化新数组
Entry[] newTab = new Entry[newLen];
int count = 0;
// 老数组的值拷贝到新数组上
for (int j = 0; j < oldLen; ++j) {
Entry e = oldTab[j];
if (e != null) {
ThreadLocal k = e.get();
//遍历过程中如果遇到脏entry的话直接令value为null,
//使得value能够被回收，解决隐藏的内存泄漏的问题
if (k == null) {
e.value = null; // Help the GC
} else {
// 计算 ThreadLocal 在新数组中的位置
int h = k.threadLocalHashCode & (newLen - 1);
// 如果索引 h 的位置值不为空，往后+1，直到找到值为空的索引位置
while (newTab[h] != null)
h = nextIndex(h, newLen);
// 给新数组赋值
newTab[h] = e;
count++;
}
}
}
// 给新数组初始化下次扩容阈值，为数组长度的三分之二
setThreshold(newLen);
size = count;
table = newTab;
}【5】ThreadLocal 的 get 方法
public T get() {
//获取当前线程的实例对象
//因为 threadLocal 属于线程的属性，所以需要先把当前线程拿出来
Thread t = Thread.currentThread();
//获取当前线程的threadLocalMap
//从线程中拿到 ThreadLocalMap
ThreadLocalMap map = getMap(t);
if (map != null) {
//获取map中当前threadLocal实例为key的值的entry
//从 map 中拿到 entry，由于 ThreadLocalMap 在 set 时的 hash 冲突的策略不同，
//导致拿的时候逻辑也不太一样
ThreadLocalMap.Entry e = map.getEntry(this);
// 如果不为空，读取当前 ThreadLocal 中保存的值
if (e != null) {
@SuppressWarnings("unchecked")
//当前entitiy不为null的话，就返回相应的值value
T result = (T)e.value;
return result;
}
}
//若map为null或者entry为null的话通过该方法初始化，并返回该方法返回的value
//否则给当前线程的 ThreadLocal 初始化，并返回初始值 null
return setInitialValue();
}private T setInitialValue() {
//initialValue() : 方法是protected修饰的，
//即继承ThreadLocal的子类可重写该方法，实现赋值为其他的初始值
T value = initialValue();
//获取当前线程的实例对象
Thread t = Thread.currentThread();
//获取当前线程的threadLocalMap
ThreadLocalMap map = getMap(t);
if (map != null)
//map 存在则设置值
map.set(this, value);
else
//初始化ThreadLocalMap
createMap(t, value);
//返回初始化值
return value;
}ThreadLocalMap 的 getEntry 方法
// 得到当前 thradLocal 对应的值，值的类型是由 thradLocal 的泛型决定的
// 由于 thradLocalMap set 时解决 Hash 冲突的逻辑，导致 thradLocalMap get 时的逻辑也会相应不同
// 首先尝试根据 hashcode 取模数组大小 = 索引位置i 寻找，找不到的话，自旋把 i+1，直到找到 thradLocal
private Entry getEntry(ThreadLocal key) {
// 计算索引位置：ThreadLocal 的 hashCode 取模数组大小
int i = key.threadLocalHashCode & (table.length - 1);
// 根据索引i获取entry
Entry e = table[i];
// e 不为空，并且 e 的 ThreadLocal 的内存地址和 key 相同，直接返回，
// 否则就是没有找到，继续通过 getEntryAfterMiss 方法找
if (e != null && e.get() == key)
return e;
else
// 未查找到满足条件的entry，额外在做的处理
return getEntryAfterMiss(key, i, e);
}ThreadLocalMap 的 getEntryAfterMiss 方法
// 自旋 i+1，直到找到为止
private Entry getEntryAfterMiss(ThreadLocal key, int i, Entry e) {
Entry[] tab = table;
int len = tab.length;
// 在大量使用不同 key 的 ThreadLocal 时，其实还蛮耗性能的
while (e != null) {
ThreadLocal k = e.get();
// 内存地址一样，表示找到了
if (k == key)
//找到和查询的key相同的entry则返回
return e;
// 删除没用的 key
if (k == null)
//解决脏entry的问题
expungeStaleEntry(i);
else
// 继续使索引位置 + 1
// 继续向后环形查找
i = nextIndex(i, len);
e = tab[i];
}
return null;
}【6】ThreadLocal 的 remove 方法
public void remove() {
//获取当前线程的threadLocalMap
ThreadLocalMap m = getMap(Thread.currentThread());
if (m != null)
//从map中删除以当前threadLocal实例为key的键值对
m.remove(this);
}ThreadLocalMap 的 remove 方法
private void remove(ThreadLocal key) {
Entry[] tab = table;
int len = tab.length;
int i = key.threadLocalHashCode & (len-1);
//向后环形查找与 key 对应的 Entry
for (Entry e = tab[i];
e != null;
e = tab[i = nextIndex(i, len)]) {
if (e.get() == key) {
//将entry的key置为null
e.clear();
//将该entry的value也置为null
expungeStaleEntry(i);
return;
}
}
}【7】ThreadLocal 内存泄漏问题
【7.1】ThreadLocal 内存泄漏产生的原因
threadLocal threadLocalMap entry 之间的关系图示
上图中，实线代表强引用，虚线代表的是弱引用，如果threadLocal外部强引用被置为null(threadLocalInstance=null)的话，threadLocal实例就没有一条引用链路可达，很显然在gc(垃圾回收)的时候势必会被回收，因此entry就存在key为null的情况，无法通过一个Key为null去访问到该entry的value。同时，就存在了这样一条引用链：threadRef->currentThread->threadLocalMap->entry->valueRef->valueMemory,导致在垃圾回收的时候进行可达性分析的时候,value可达从而不会被回收掉，但是该value永远不能被访问到，这样就存在了内存泄漏。
【7.2】ThreadLocal 内存泄漏的解决
ThreadLocalMap 的 cleanSomeSlots 方法
//参数 n 作用 :
//扫描控制 (scan control)，从while中是通过n来进行条件判断的，
//说明n就是用来控制扫描趟数(循环次数)的
private boolean cleanSomeSlots(int i, int n) {
boolean removed = false;
Entry[] tab = table;
int len = tab.length;
do {
i = nextIndex(i, len);
Entry e = tab[i];
if (e != null && e.get() == null) {
n = len;
removed = true;
//遇到“脏”entry(stale entry)
//调用 expungeStaleEntry 函数处理
i = expungeStaleEntry(i);
}
} while ( (n >>>= 1) != 0);
return removed;
}ThreadLocalMap 的 expungeStaleEntry 方法
private int expungeStaleEntry(int staleSlot) {
Entry[] tab = table;
int len = tab.length;
//清除当前脏entry
// expunge entry at staleSlot
// value置为null后该value域变为不可达，在下一次gc的时候就会被回收掉
// table[staleSlot]为null后以便于存放新的entry
tab[staleSlot].value = null;
tab[staleSlot] = null;
size--;
// Rehash until we encounter null
Entry e;
int i;
//往后环形继续查找,直到遇到table[i]==null时结束
for (i = nextIndex(staleSlot, len);
(e = tab[i]) != null;
i = nextIndex(i, len)) {
ThreadLocal k = e.get();
if (k == null) {
//遇到 k 为 null 则清除当前脏 entry
e.value = null;
tab[i] = null;
size--;
} else {
//处理rehash的情况
int h = k.threadLocalHashCode & (len - 1);
if (h != i) {
tab[i] = null;
// Unlike Knuth 6.4 Algorithm R, we must scan until
// null because multiple entries could have been stale.
while (tab[h] != null)
h = nextIndex(h, len);
tab[h] = e;
}
}
}
return i;
}ThreadLocalMap 的 replaceStaleEntry 方法
private void replaceStaleEntry(ThreadLocal key, Object value,
int staleSlot) {
Entry[] tab = table;
int len = tab.length;
Entry e;
// Back up to check for prior stale entry in current run.
// We clean out whole runs at a time to avoid continual
// incremental rehashing due to garbage collector freeing
// up refs in bunches (i.e., whenever the collector runs).
//向前找到第一个脏entry
//现脏entry的相邻位置也有很大概率出现脏entry，
//所以为了一次处理到位，就需要向前环形搜索，找到前面的脏entry
int slotToExpunge = staleSlot;
for (int i = prevIndex(staleSlot, len);
(e = tab[i]) != null;
i = prevIndex(i, len))
if (e.get() == null)
slotToExpunge = i;
// Find either the key or trailing null slot of run, whichever
// occurs first
for (int i = nextIndex(staleSlot, len);
(e = tab[i]) != null;
i = nextIndex(i, len)) {
ThreadLocal k = e.get();
// If we find key, then we need to swap it
// with the stale entry to maintain hash table order.
// The newly stale slot, or any other stale slot
// encountered above it, can then be sent to expungeStaleEntry
// to remove or rehash all of the other entries in run.
if (k == key) {
//如果在向后环形查找过程中发现key相同的entry就覆盖并且和脏entry进行交换
e.value = value;
tab[i] = tab[staleSlot];
tab[staleSlot] = e;
// Start expunge at preceding stale entry if it exists
//如果在查找过程中还未发现脏entry，那么就以当前位置作为cleanSomeSlots的起点
if (slotToExpunge == staleSlot)
slotToExpunge = i;
//搜索脏entry并进行清理
cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
return;
}
// If we didn't find stale entry on backward scan, the
// first stale entry seen while scanning for key is the
// first still present in the run.
//如果向前未搜索到脏entry，则在查找过程遇到脏entry的话，
//后面就以此时这个位置作为起点执行cleanSomeSlots
if (k == null && slotToExpunge == staleSlot)
slotToExpunge = i;
}
// If key not found, put new entry in stale slot
//如果在查找过程中没有找到可以覆盖的entry则将新的entry插入在脏entry
tab[staleSlot].value = null;
tab[staleSlot] = new Entry(key, value);
// If there are any other stale entries in run, expunge them
if (slotToExpunge != staleSlot)
//执行cleanSomeSlots
cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
}replaceStaleEntry 处理过程图示
1. 前向有脏 entry 后向环形查找找到可覆盖的 entry
2. 前向有脏 entry 后向环形查找未找到可覆盖的 entry
3. 前向没有脏 entry 后向环形查找找到可覆盖的 entry
4. 前向没有脏 entry 后向环形查找未找到可覆盖的 entry
ThreadLocalMap 的 getEntryAfterMiss 方法
// 自旋 i+1，直到找到为止
private Entry getEntryAfterMiss(ThreadLocal key, int i, Entry e) {
Entry[] tab = table;
int len = tab.length;
// 在大量使用不同 key 的 ThreadLocal 时，其实还蛮耗性能的
while (e != null) {
ThreadLocal k = e.get();
// 内存地址一样，表示找到了
if (k == key)
//找到和查询的key相同的entry则返回
return e;
// 删除没用的 key
if (k == null)
//解决脏entry的问题
expungeStaleEntry(i);
else
// 继续使索引位置 + 1
// 继续向后环形查找
i = nextIndex(i, len);
e = tab[i];
}
return null;
}ThreadLocalMap 的 remove 方法
private void remove(ThreadLocal key) {
Entry[] tab = table;
int len = tab.length;
int i = key.threadLocalHashCode & (len-1);
//向后环形查找与 key 对应的 Entry
for (Entry e = tab[i];
e != null;
e = tab[i = nextIndex(i, len)]) {
if (e.get() == key) {
//将entry的key置为null
e.clear();
//将该entry的value也置为null
expungeStaleEntry(i);
return;
}
}
}
参考致谢
本博客为博主学习笔记，同时参考了网上众博主的博文以及相关专业书籍，在此表示感谢，本文若存在不足之处，请批评指正。
【1】不懂ThreadLocal，面试官很难相信你懂Java并发编程
【2】ThreadLocal
【3】JAVA并发专题十七：深入理解ThreadLocal（一）
【4】JAVA并发系列十八：深入理解ThreadLocal（二）
【5】JAVA并发系列十九：深入理解ThreadLocal（三）–详解ThreadLocal内存泄漏问题