JUC-ThreadLocal详解

简单实用

• 提供一个简单例子来使用 ThreadLocal
• 声明 ThreadLocal，比如：private static final ThreadLocal<Object> threadLocal = new NamedThreadLocal<>("logs");
• 先暂时省略 set 步骤，当需要 threadLocal 的时候，我们通常是：threadLocal.get()

ThreadLocal数据结构

• Thread 类内部维护了一个 ThreadLocal.ThreadLocalMap 类型的 threadLocals 变量，也就是每个线程有自己独立的 threadLocals。
• ThreadLocalMap 当中 key 是一个弱引用，指向 ThreadLocal 对象， value 是我们存储的值。

threadLocal.get()

• 先看代码：

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();
}
ThreadLocalMap getMap(Thread t) {
    return t.threadLocals;
}
public class Thread implements Runnable {
    /* ThreadLocal values pertaining to this thread. This map is maintained
     * by the ThreadLocal class. */
    ThreadLocal.ThreadLocalMap threadLocals = null;
}

• 从代码可以看到，每个线程维护了自己的 ThreadLocal.ThreadLocalMap threadLocals 变量。
• 从 ThreadLocal 当中获取数据，本质上是以当前线程作为 key 从 ThreadLocalMap 获取 ThreadLocalMap.Entry 对象，说明 value 存储的是 Entry

ThreadLocal.set方法

ThreadLocal.set 方法获取当前线程，以当前线程作为 key，从 ThreadLocalMap 获取，如果 ThreadLocalMap 存在就 set 值，如果 ThreadLocalMap 不存在就创建 代码如下：

public void set(T value) {
    Thread t = Thread.currentThread();
    ThreadLocalMap map = getMap(t);
    if (map != null) {
        map.set(this, value);
    } else {
        createMap(t, value);
    }
}
void createMap(Thread t, T firstValue) {
    t.threadLocals = new ThreadLocalMap(this, firstValue);
}    

ThreadLocalMap.set方法

hash 算法

• 从 ThreadLocal.set 方法可以看到，如果 ThreadLocalMap 存在，会将当前值存入 ThreadLocalMap，具体的细节在 ThreadLocalMap.set 当中，
• 在 ThreadLocalMap.set 当中有一个细节，计算下标 index 的方法，ThreadLocalMap 本质上还是一个 Map 结构，需要计算 key 的 hash 值，具体的计算逻辑如下： 代码如下：

int i = key.threadLocalHashCode & (len-1);

private static final int HASH_INCREMENT = 0x61c88647;

private final int threadLocalHashCode = nextHashCode();

private static int nextHashCode() {
    return nextHashCode.getAndAdd(HASH_INCREMENT);
}

可以执行下这个代码，看看计算出来的的 index 有什么规律： 代码如下：

AtomicInteger nextHashCode = new AtomicInteger();
for (int i = 0; i < 10; i++) {
    int andAdd = nextHashCode.getAndAdd(0x61c88647) & 15;
    System.out.println(andAdd);
}

执行结果如下：

image-20250626152613924

hash 冲突

代码逻辑

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();
        }

1、计算 key 的哈希值，对应的 Entry 对象为空，直接将 Entry 放到该槽位即可 2、计算 key 的哈希值，对应的 Entry 对象不为空，与当前 ThreadLocal 的 hash 值一致，直接将值覆盖 3、当前的 Entry 对象不为空，线性查找后续节点，与当前的 ThreadLocal 的 hash 值不一致，在 Entry key 没被清理前， 4、Entry 对象不为空，线性查找后续节点，Entry key 被回收，执行 cleanSomeSlots 方法来实现过期数据清理， a、初始化过期 key 下标的值为 slotToExpunge b、以过期 key 下标为分割线，向前遍历，存在 key 被回收的情况，更新 slotToExpunge 下标值 c、以过期 key 下标为分割线，向后遍历，Entry 不为空情况下，如果碰到当前 ThreadLocal 一致的 key ，直到 ，创建新的 Entry 对象覆盖，然后执行清理过期对象

ThreadLocal.get方法

ThreadLocal key清理