共计 7168 个字符，预计需要花费 18 分钟才能阅读完成。
概述
在并发编程中，为了控制数据的正确性，我们往往需要使用锁来来保证代码块的执行隔离性。但是在很多时候锁的开销太大了，而在某些情况下，我们的局部变量是线程私有的，每个线程都会有自己的独自的变量，这个时候我们可以不对这部分数据进行加锁操作。于是 ThredLocal 应运而生。
ThredLocal顾名思义，是线程持有的本地变量，存放在 ThredLocal 中的变量不会同步到其他线程以及主线程，所有线程对于其他的线程变量都是不可见的。那么我们来看下它是如何实现的吧。
实现原理
ThredLocal在内部实现了一个静态类 ThreadLocalMap 来对于变量进行存储，并且在 Thread 类的内部使用到了这两个成员变量
ThreadLocal.ThreadLocalMap threadLocals = null;
ThreadLocal.ThreadLocalMap inheritableThreadLocals = null;来调用 ThreadLocalMap 存储当前线程的内部变量。
ThreadLocalMap 的实现
ThreadLocalMap是键值对结构的 map，但是他没有直接使用HashMap，而是自己实现了一个。
Entry
Entry是 ThreadLocalMap 中定义的 map 节点，他以 ThreadLocal 弱引用为 key，以 Object 为 value 的 K-V 形式的节点。使用弱引用是为了可以及时释放内存避免内存泄漏。
static class Entry extends WeakReference<ThreadLocal<?>> {
Object value;
Entry(ThreadLocal<?> k, Object v) {super(k);
value = v;
}
}这里和 HashMap 不一样的地方在于两者解决 hash 冲突的方式的不同，HashMap采用的是链地址法，遇到冲突的时候将冲突的数据放入同一链表之中，等到链表到了一定程度再将链表转化为红黑树。而 ThreadLocalMap 实现采用的是开放寻址法，它内部没有使用链表结构，因此 Entry 内部没有 next 或者是 prev 指针。ThreadLocalMap的开放寻址法是怎么实现的，请看接下来的源码。
成员变量
// map 默认的初始化大小
private static final int INITIAL_CAPACITY = 16;
// 存储 map 节点数据的数组
private Entry[] table;
// map 大小
private int size = 0;
// 临界值，达到这个值的时候需要扩容
private int threshold;
// 当临界值达到 2 / 3 的时候扩容
private void setThreshold(int len) {threshold = len * 2 / 3;}这里的数组大小始终是 2 的幂次，原因和 HashMap 一样，是为了在计算 hash 偏移的时候减少碰撞。
构造函数
ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
// 初始化 table
table = new Entry[INITIAL_CAPACITY];
// 计算第一个值的 hash 值
int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
// 创建新的节点
table[i] = new Entry(firstKey, firstValue);
size = 1;
setThreshold(INITIAL_CAPACITY);
}set 方法
private void set(ThreadLocal<?> key, Object value) {
// 获取 ThreadLocal 的 hash 值偏移量
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();
// 如果节点 key 相等，即找到了我们想要的节点，// 将值赋予节点
if (k == key) {
e.value = value;
return;
}
// 如果节点的 key 为空，说明弱引用已经把 key 回收了，那么需要做一波清理
if (k == null) {replaceStaleEntry(key, value, i);
return;
}
}
// 如果没有找到对应的节点说明该 key 不存在，创建新节点
tab[i] = new Entry(key, value);
int sz = ++size;
// 进行清理，如果清理结果没能清理掉任何的旧节点，// 并且数组大小超出了临界值，就进行 rehash 操作扩容
if (!cleanSomeSlots(i, sz) && sz >= threshold)
rehash();}看到这段代码，开放寻址法的实现原理可以说是非常清楚了。首先计算节点的 hash 值，找到对应的位置，查看该位置是否为空，如果是空则插入，如果不为空，则顺延至下个节点，直到找到空的位置插入。那么我们的查询逻辑也呼之欲出：计算节点的 hash 值，找到对应的位置，查看该节点是否是我们想要找的节点，如果不是，则继续往下顺序寻找。
get 方法
private Entry getEntry(ThreadLocal<?> key) {
// 计算 hash 值
int i = key.threadLocalHashCode & (table.length - 1);
// 获取该 hash 值对应的数组节点
Entry e = table[i];
if (e != null && e.get() == key)
// 如果节点不为空并且 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();
// key 相同则说明找到，返回该节点
if (k == key)
return e;
// key 为空进行一次清理
if (k == null)
expungeStaleEntry(i);
else
i = nextIndex(i, len);
e = tab[i];
}
return null;
}replaceStaleEntry
// 这个方法的作用是在 set 操作的时候进行清理
private void replaceStaleEntry(ThreadLocal<?> key, Object value,
int staleSlot) {Entry[] tab = table;
int len = tab.length;
Entry e;
// slotToExpunge 是之后开始清理的节点位置
int slotToExpunge = staleSlot;
// 往前寻找找到第一个为空的节点记录下位置
for (int i = prevIndex(staleSlot, len);
(e = tab[i]) != null;
i = prevIndex(i, len))
if (e.get() == null)
slotToExpunge = i;
// 从 staleSlot 开始向后遍历直到节点为空
for (int i = nextIndex(staleSlot, len);
(e = tab[i]) != null;
i = nextIndex(i, len)) {ThreadLocal<?> k = e.get();
if (k == key) {
// 如果节点的 key 一致，替换 value 的值
e.value = value;
// 将当前节点和 staleSlot 上的节点互换位置（将后方的值放到前方来，之前的值等待回收）tab[i] = tab[staleSlot];
tab[staleSlot] = e;
// 如果 slotToExpunge 和 staleSlot 相等，说明前面没有需要清理的节点
// 则从当前节点开始进行清理
if (slotToExpunge == staleSlot)
slotToExpunge = i;
// 进行节点清理
cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
return;
}
// 如果 key 为空并且 slotToExpunge 和 staleSlot 相等
// 把 slotToExpunge 赋值为当前节点
if (k == null && slotToExpunge == staleSlot)
slotToExpunge = i;
}
// 如果没法找到 key 相等的节点，// 则清空当前节点的 value 并生成新的节点
tab[staleSlot].value = null;
tab[staleSlot] = new Entry(key, value);
// 如果 slotToExpunge 和 staleSlot 不相等则需要进行清理（因为前方发现空的节点）if (slotToExpunge != staleSlot)
cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
}expungeStaleEntry
// 对节点进行清理
private int expungeStaleEntry(int staleSlot) {Entry[] tab = table;
int len = tab.length;
// 释放当节点
tab[staleSlot].value = null;
tab[staleSlot] = null;
size--;
Entry e;
int i;
// 循环寻找到第一个空节点
for (i = nextIndex(staleSlot, len);
(e = tab[i]) != null;
i = nextIndex(i, len)) {ThreadLocal<?> k = e.get();
// key 为空进行节点释放
if (k == null) {
e.value = null;
tab[i] = null;
size--;
} else {
// 如果 key 不为空，找到对应的节点应该在的位置
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;
}cleanSomeSlots
// 该方法用于清理空节点
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];
// 如果有节点为空并且 key 为空
// 该节点需要被清除
if (e != null && e.get() == null) {
// 重置 n 的值并且标记 removed 为 true
n = len;
removed = true;
// 清理该节点
i = expungeStaleEntry(i);
}
} while ((n >>>= 1) != 0);
return removed;
}rehash
// 当数组的元素到达临界值，进行扩容
private void rehash() {
// 先对所有的节点进行清理
expungeStaleEntries();
// 然后判断临界值是否进行扩容
// 此处由于先做过一次清理，这里的数字可能会和之前的临界值判断有缩小
// 所以此处临界值判断为 threshold - threshold / 4
// 即 1 / 2 的 size 时进行扩容
if (size >= threshold - threshold / 4)
resize();}
private void resize() {
// 获取旧数组，开辟新数组
// 新数组大小为旧数组的 2 倍
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) {
// 如果节点不为空，判断 key 是否为空
// 如果 key 为空，将节点置空帮助 gc
// 如果 key 不为空将旧数组的节点放入新数组
// 放入方式和 set 实现一致，只是由于是刚创建的新数组
// 不会有需要清理的数据，所以不需要额外清理
ThreadLocal<?> k = e.get();
if (k == null) {e.value = null;} 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;
}expungeStaleEntries
// 清理所有节点
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);
}
}关于 Map 的清理
ThreadLocalMap实现采用的是开放寻址法，它的实现本身应该是比较简洁的，但是为了便于 GC，内部节点采用了弱引用作为 key，一旦数组中节点的强引用被设置为了 null，节点的 key 就会被 gc 自动回收。这样导致了 ThreadLocalMap 的实现变得异常的复杂。为了防止内存泄漏，在 get 和 set 方法的时候不得不进行额外的清理。
Q 为什么需要清理？
A 不清理的话 key 被回收，但是 value 依旧会存在，并且难以被回收导致内存泄漏。
Q 为什么清理的时候会涉及到节点的移动？
A 因为在开放寻址法中，可能会有相同 hash 值的节点连续排在一起，当其中的一个或多个节点被回收后会造成同 hash 值的节点中间存在 null 节点，而我们 get 节点的时候会在碰到空节点的时候停止寻找，所以如果不进行一定的清理移动会导致部分节点永远不会被查询到。
ThreadLocal 的实现
hashcode 的实现
讲完了 ThreadLocalMap 的实现原理，我们可以深深的体会到 ThreadLocal 的hashcode是多么的重要，如果 hash 值不能够以合理的方式生成，导致数据的分布不均匀，ThreadLocalMap的效率将会非常的低下。
hashcode 的实现:
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);
}ThreadLocal的 hashcode 实现代码很简短：每一个新的 ThreadLocal 的 hash 值都是在 nextHashCode 的基础上增加 0x61c88647。实现很简单，但是很让人迷惑。这个莫名其妙的魔数0x61c88647 是什么？
0x61c88647是有斐波那契构造而成的黄金比例数字，经过实验测试，这个数字生成的 hashcode 可以很大程度的保证 hash 值能够在数组中均匀的分布。
get
public T get() {
// 获取当前线程
Thread t = Thread.currentThread();
// 获取当前线程的变量 map
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();}set
public void set(T value) {Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
// 如果 map 不为空，加入数据
if (map != null)
map.set(this, value);
else
// 否则新建 map 并放入第一个和数据
createMap(t, value);
}总结
Thredlocal这个类可能对于很多人来说是一个常常会用到的类，但是未必所有人都会去关注他的内部实现，但是他的源码是比较值得去阅读的，一来它的实现代码相对其他的常用类很短，只有几百行；二来它的实现很经典，经典的开放寻址法，经典的弱引用方便 GC，可以说是很好的学习材料。
这里我虽然对于整个 Thredlocal 的源码进行了完整的注释解释，但是它最值得细细品味的还是它的设计理念以及设计思路，这会对我们写出优秀的代码有着重要的作用。
