ThreadLocal<T>
概述
- 此类提供线程局部变量
- 每个线程都有自己的、独立初始化的变量副本
- ThreadLocal实例通常是类中的私有静态字段
- 在一个线程消失后，它的所有线程本地实例的副本都将被垃圾收集（除非存在对这些副本的其他引用）
类文档实例代码
public class ThreadId {
private static final AtomicInteger nextId = new AtomicInteger(0);
private static final ThreadLocal<Integer> threadId = new ThreadLocal<Integer>() {
@Override protected Integer initialValue() {
return nextId.getAndIncrement();
}
};
public static int get() {
return threadId.get();
}
}
使用方式
部分源码
静态常量
private static AtomicInteger nextHashCode = new AtomicInteger()
private static final int HASH_INCREMENT = 0x61c88647
成员变量
private final int threadLocalHashCode = nextHashCode()
方法
ThreadLocal
提供的方法基本都是通过获取当前线程Thread的
成员变量ThreadLocal.ThreadLocalMap来进行操作
get() 获取此线程局部变量的当前线程副本中的值,如果该变量对于当前线程没有值，则首先将其初始化为调用initialValue方法返回的值
public T get() {
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null) {
ThreadLocalMap.Entry e = map.getEntry(this);
if (e != null) {
@SuppressWarnings("unchecked")
T result = (T)e.value;
return result;
}
}
return setInitialValue();
}
setInitialValue() 设置初始值
private T setInitialValue() {
T value = initialValue();
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null)
map.set(this, value);
else
createMap(t, value);
return value;
}
set() 将此线程局部变量的当前线程副本设置为指定值。大多数子类不需要覆盖此方法，仅依赖initialValue方法来设置线程局部变量的值
public void set(T value) {
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null)
map.set(this, value);
else
createMap(t, value);
}
remove()
删除此线程局部变量的当前线程值。
如果此线程局部变量随后被当前线程读取，则其值将通过调用其initialValue方法重新初始化，除非其值在此期间由当前线程设置。
这可能会导致在当前线程中多次调用initialValue方法。
public void remove() {
ThreadLocalMap m = getMap(Thread.currentThread());
if (m != null)
m.remove(this);
}
getMap() 和 createMap()
创建和获取ThreadLocalMap
// 从这可以看出ThreadLocalMap其实就是Thread类的threadLocals变量
ThreadLocalMap getMap(Thread t) {
return t.threadLocals;
}
// 创建ThreadLocalMap 并加入初始值
void createMap(Thread t, T firstValue) {
t.threadLocals = new ThreadLocalMap(this, firstValue);
}
创建继承线程本地映射的工厂方法。设计为仅从 Thread 构造函数调用
static ThreadLocalMap createInheritedMap(ThreadLocalMap parentMap) {
return new ThreadLocalMap(parentMap);
}
ThreadLocalMap
1.基于数组实现
2.Entry的key（ThreadLocal）采用WeakReference实现
3.计算Entry下标根据key(ThreadLocal)的threadLocalHashCode计算（ThreadLocal实列化时计算threadLocalHashCode）
4.下标冲突后直接顺序（i+1）到下一个位置直到查找到空位（线性探测法）
5.size超过数组长度2/3时扩容
构造方法
ThreadLocalMaps 是惰性构造的，只在至少有一个条目要放入其中时才创建
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);
}
构造一个新映射，包括来自给定父映射的所有可继承 ThreadLocal
仅由 createInheritedMap 调用
private ThreadLocalMap(ThreadLocalMap parentMap) {
Entry[] parentTable = parentMap.table;
int len = parentTable.length;
setThreshold(len);
table = new Entry[len];
for (int j = 0; j < len; j++) {
Entry e = parentTable[j];
if (e != null) {
@SuppressWarnings("unchecked")
ThreadLocal<Object> key = (ThreadLocal<Object>) e.get();
if (key != null) {
Object value = key.childValue(e.value);
Entry c = new Entry(key, value);
int h = key.threadLocalHashCode & (len - 1);
while (table[h] != null)
h = nextIndex(h, len);
table[h] = c;
size++;
}
}
}
}
ThreadLocalMap.Entry
ThreadLocalMap使用 Entry[]存储数据,Entry继承WeakReference
意味着ThreadLocal如果没有别的引用，则会在下一次GC中被清除
导致Entry[null,val]的出现,ThreadLocalMap提供expungeStaleEntry()方法（get,set.remove过程调用）
检测并清除这种类型的Entry
static class Entry extends WeakReference<ThreadLocal<?>> {
Object value;
Entry(ThreadLocal<?> k, Object v) {
super(k);
value = v;
}
}
get() set() remove()
根据key(也就是ThreadLocal)获取Entry
通过ThreadLocal的threadLocalHashCode计算出所在数组下标
get()
private Entry getEntry(ThreadLocal<?> key) {
int i = key.threadLocalHashCode & (table.length - 1);
Entry e = table[i];
if (e != null && e.get() == key)
return e;
else
// 处理直接找不到的情况
return getEntryAfterMiss(key, i, e);
}
private Entry getEntryAfterMiss(ThreadLocal<?> key, int i, Entry e) {
Entry[] tab = table;
int len = tab.length;
while (e != null) {
ThreadLocal<?> k = e.get();
// 找到直接返回
if (k == key)
return e;
// 发现了空key则需要删除
if (k == null)
expungeStaleEntry(i);
// 计算下一个索引（其实就是i+1,到头就成0）
else
i = nextIndex(i, len);
e = tab[i];
}
return null;
}
set()
replaceStaleEntry()
原数组：[entry,null,entry,entry,entry,null,entry...]
private void set(ThreadLocal<?> key, Object value) {
Entry[] tab = table;
int len = tab.length;
// 根据key计算所在index
int i = key.threadLocalHashCode & (len-1);
// 第一部分:之前该index已存在Entry
//
for (Entry e = tab[i]; e != null; e = tab[i = nextIndex(i, len)]) {
ThreadLocal<?> k = e.get();
// 找到了，直接替换val并return
if (k == key) {
e.value = value;
return;
}
// 若是找到了一个StaleEntry
if (k == null) {
// 执行到这说明这个entry是StaleEntry，需要替换
replaceStaleEntry(key, value, i);
return;
}
}
// 执行到这代表之前没有这个key(ThreadLocal)，实例化一个
tab[i] = new Entry(key, value);
int sz = ++size;
if (!cleanSomeSlots(i, sz) && sz >= threshold)
rehash();
}
// 这个方法处理了staleSlot下标左右最近的空Entry之间的所有Entry
private void replaceStaleEntry(ThreadLocal<?> key, Object value, int staleSlot) {
Entry[] tab = table;
int len = tab.length;
Entry e;
int slotToExpunge = staleSlot;
// 找到起始的空key下标
// prevIndex获取上一个index(其实就是i-1，到头就是len-1)
for (int i = prevIndex(staleSlot, len); (e = tab[i]) != null; i = prevIndex(i, len))
if (e.get() == null)
slotToExpunge = i;
for (int i = nextIndex(staleSlot, len); (e = tab[i]) != null; i = nextIndex(i, len)) {
ThreadLocal<?> k = e.get();
if (k == key) {
e.value = value;
tab[i] = tab[staleSlot];
tab[staleSlot] = e;
if (slotToExpunge == staleSlot)
slotToExpunge = i;
cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
return;
}
if (k == null && slotToExpunge == staleSlot)
slotToExpunge = i;
}
tab[staleSlot].value = null;
tab[staleSlot] = new Entry(key, value);
if (slotToExpunge != staleSlot)
cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
}
remove()
private void remove(ThreadLocal<?> key) {
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)]) {
// 找到直接清除返回
if (e.get() == key) {
e.clear();
expungeStaleEntry(i);
return;
}
}
}
expungeStaleEntry() 删除staleSlot(key=null)的Entry
并检测之后（到下一个null Entry为止）的Entry key=null的情况并处理
原数组：[entry,null,entry,entry,entry,null,entry...]
删除下标=2的entry后
下标3，4的entry也会被检查：
是staleSlot的话则删除
不是的话重新判断位置下标是否正确（因为插入的时候有冲突是顺着数组往下找空位)
private int expungeStaleEntry(int staleSlot) {
Entry[] tab = table;
int len = tab.length;
// 第一部分：直接删除下标上的entry，先删val，再entry
tab[staleSlot].value = null;
tab[staleSlot] = null;
size--;
Entry e;
int i;
// 第二部分：往下继续找，直到找到的Entry=null
for (i = nextIndex(staleSlot, len); (e = tab[i]) != null; i = nextIndex(i, len)) {
ThreadLocal<?> k = e.get();
// 此entry是staleSlot（key=null的）,移除数据
if (k == null) {
e.value = null;
tab[i] = null;
size--;
} else {
// 有数据的情况
// 因为删除了第一个元素，可能计算出来的下标会改变
// 下标改变的话重新放到正确位置（）
int h = k.threadLocalHashCode & (len - 1);
if (h != i) {
tab[i] = null;
while (tab[h] != null)
h = nextIndex(h, len);
tab[h] = e;
}
}
}
return i;
}
扩容相关
// 通过这个方法检测扩容
private void rehash() {
// 扩容前先删除所有 key=null 的Entry
expungeStaleEntries();// 1
// 扩容条件： 放宽了一点
// 官方：使用较低的阈值进行翻倍，以避免出现滞后现象
if (size >= threshold - threshold / 4)
resize(); // 2
}
// 1 删除所有key=null的entry
private void expungeStaleEntries() {
Entry[] tab = table;
int len = tab.length;
for (int j = 0; j < len; j++) {
Entry e = tab[j];
if (e != null && e.get() == null)
expungeStaleEntry(j);
}
}
// 2 扩容-翻倍
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();
if (k == null) {
e.value = null; // Help the GC
} else {
int h = k.threadLocalHashCode & (newLen - 1);
while (newTab[h] != null)
h = nextIndex(h, newLen);
newTab[h] = e;
count++;
}
}
}
setThreshold(newLen);
size = count;
table = newTab;
}