ThreadLocal解析
什么是ThreadLocal
大家是否了解JMM(java内存模型)，它主要是为了解决多线程下的共享内存操作问题，为了保证数据的一致性，我们在自己的工作内存操作修改变量后，会提交到主内存中进行覆盖，并且使其他线程中工作内存中的共享变量删除，使得其他线程在自己的工作内存中访问不到该共享变量副本，只能到主内存中去访问。这样就很好的保证了数据的可见性。但是，有时候我们希望在自己工作内存中修改共享变量副本后，不希望其他工作内存知道，即保持不可见性。那该怎么办呢，这是就要使用ThreadLocal了。
ThreadLocal简单的说就是为每个线程创建一个单独的变量副本，它们之间是相互独立的。
一个常用的应用场景是数据库的连接，如果不用ThreadLocal,一个线程执行查询操作，一个线程却先执行了关闭操作，显然这样是不行的。但是也有人问，直接在每个方法中自己设置了一连接就行了，但是这样会导致服务器压力大，并且严重影响程序执行性能。
设计思想
每个Thread维护一个ThreadLocalMap哈希表，这个哈希表的key是ThreadLocal实例本身，value是要存储的值。
public class Thread implements Runnable {
/* ThreadLocal values pertaining to this thread. This map is maintained
* by the ThreadLocal class. */
ThreadLocal.ThreadLocalMap threadLocals = null;
}
既然要使用到哈希表，那它是如何解决哈希冲突的呢？
与HashMap不同，它没有采用链地址法的思想，而是采用了开放定址法。简单的说，就是根据hashcode计算获得数组地址下标时，如果发现该位置已经被占用了，那么它向后一位或多位再进行判断。
那它为什么要使用开放定址法呢？
1）ThreadLocal中有一个神奇的属性HASH_INCREMENT = 0x61c88647,并利用AtomicInteger进行累加，它能够将哈希值均匀的分布在2的N次方的数组里。
2）ThreadLocal往往存放的数据量不会特别大，而且key是弱引用，会被垃圾回收，采用开放定址法会更省空间，而且查询效率更高。
private static int nextIndex(int i, int len) {
return ((i + 1 < len) ? i + 1 : 0);
}
private static int prevIndex(int i, int len) {
return ((i - 1 >= 0) ? i - 1 : len - 1);
}
重要方法
get()方法
public T get() {
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null) {
ThreadLocalMap.Entry e = map.getEntry(this);
if (e != null)
return (T)e.value;
}
return setInitialValue();
}
ThreadLocalMap getMap(Thread t) {
return t.threadLocals;
}
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;
}
protected T initialValue() {
return null;
}
void createMap(Thread t, T firstValue) {
t.threadLocals = new ThreadLocalMap(this, firstValue);
}
private static final int INITIAL_CAPACITY = 16;
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);
}
主要步骤：
1）获取当前线程的ThreadLocalMap,以当前的ThreadLocal为key,调用getEntry()查找，如果找到，就返回该值
2）如果当前map不为空的话，则设置当前ThreadLocal为key的value为null.
- 如果map为空，则要创建一个map,并设置当前ThreadLocal为key,value为null.
private final int threadLocalHashCode = nextHashCode();
private static AtomicInteger nextHashCode =
new AtomicInteger();
private static final int HASH_INCREMENT = 0x61c88647;
private static int nextHashCode() {
return nextHashCode.getAndAdd(HASH_INCREMENT);
}
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);
}
从上面我们可以看出ThreadLocal的hashcode()是AtomicInteger加上0x61c88647来实现的。
static class Entry extends WeakReference<ThreadLocal<?>> {
Object value;
Entry(ThreadLocal<?> k, Object v) {
super(k);
value = v;
}
}
从上面的get()方法中可以看出，我们获取的是一个加上弱引用的ThreadLocal,那它为什么要加上弱引用呢？我先介绍一下什么是弱引用。
在jvm中有四种引用，强引用、软引用、弱引用、虚引用。
具体的解释可以参考这篇:引用解释
如果key使用强引用，会出现一个问题，引用的ThreadLocal的对象被回收了，但是ThreadLocalMap还持有ThreadLocal的强引用，如果没有手动删除，ThreadLocal不会被回收，则会导致内存泄漏。
如果key使用弱引用，引用的ThreadLocal的对象被回收了，由于ThreadLocalMap持有ThreadLocal的弱引用，即使没有手动删除，ThreadLocal也会被回收。
从上面分析中可以看出，由于ThreadLocalMap的生命周期和Thread一样长，如果没有手动删除对应的key的value就会导致内存泄漏，当key是弱引用时，可以被垃圾回收，但是value又是强引用，不会被垃圾回收，所以会发生内存泄漏。
为了避免上述发生的内存泄漏，它是怎么解决的呢？
它在get(),set()和remove()方法中，都会清楚无效Entry的操作。
比如说，在上述的get()方法中，我们在获取Entry时，如果获取到null,说明可能它被垃圾回收了，但是value还存在;或者key不相等，存在哈希冲突，我们调用getEntryAfterMiss来处理。
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;
if (k == null)
expungeStaleEntry(i);
else
i = nextIndex(i, len);
e = tab[i];
}
return null;
}
在getEntryAfterMiss方法中，会利用nextIndex方法基于开放定址法的思想获取Entry,如果key相等，就返回该值，如果为null,
private int expungeStaleEntry(int staleSlot) {
Entry[] tab = table;
int len = tab.length;
// expunge entry at staleSlot
tab[staleSlot].value = null;
tab[staleSlot] = null;
size--;
// Rehash until we encounter null
Entry e;
int i;
for (i = nextIndex(staleSlot, len);
(e = tab[i]) != null;
i = nextIndex(i, len)) {
ThreadLocal<?> k = e.get();
if (k == null) {
e.value = null;
tab[i] = null;
size--;
} else {
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;
}
set()方法
public void set(T value) {
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null)
map.set(this, value);
else
createMap(t, value);
}
获取当前线程的map，然后以当前ThreadLocal为key,放入到map中。具体的添加操作在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();
if (k == key) {
e.value = value;
return;
}
if (k == null) {
replaceStaleEntry(key, value, i);
return;
}
}
tab[i] = new Entry(key, value);
int sz = ++size;
if (!cleanSomeSlots(i, sz) && sz >= threshold)
rehash();
}
首先根据hash计算到在数组中的位置下标，如果当前位置存在节点并key相等，则进行值覆盖，并返回；如果为null,则调用replaceStaleEntry；如果当前位置没有存放节点，则新建一个Entry实例，并执行cleanSomeSlots(i, sz)方法，并判断是否扩容。
remove
从中可以看出，在删除该节点后，也会执行expungeStaleEntry来删除key为null的值。
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;
}
}
}
如何扩容
哈希表一般都有扩容操作，那么它是如何触发扩容和如何扩容的呢?
在ThreadLocalMap中有一个阈值threshold=table长度*2/3。当size>=threshold时，遍历table并删除key为null的元素，如果删除后size>=threshold*3/4时，需要进行扩容操作。
private void rehash() {
expungeStaleEntries();
if (size >= threshold - threshold / 4)
resize();
}
扩容操作比较简单，但是会先判断key是否为null,如果为null,将对应的value也设置为null，帮助gc。
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;
}
Note：
如果想详细了解去除空key的步骤，可以阅读这篇。
被大厂面试官连环炮轰炸的ThreadLocal （吃透源码的每一个细节和设计原理）
