深入理解 ThreadLocal

前言

上篇文章 深入理解 handler 消息机制 中提到了获取线程的 looper 是通过 threadlocal 来实现的：

public static @nullable looper mylooper() {
    return sthreadlocal.get();
}

每个线程都有自己的 looper，它们之间不应该有任何交集，互不干扰，我们把这种变量称为 线程局部变量 。而 threadlocal 的作用正是存储线程局部变量，每个线程中存储的都是独立存在的数据副本。如果你还是不太理解，看一下下面这个简单的例子：

public static void main(string[] args) throws interruptedexception {

    threadlocal<boolean> threadlocal = new threadlocal<boolean>();
    threadlocal.set(true);

    thread t1 = new thread(() -> {
        threadlocal.set(false);
        system.out.println(threadlocal.get());
    });

    thread t2 = new thread(() -> {
        system.out.println(threadlocal.get());
    });

    t1.start();
    t2.start();
    t1.join();
    t2.join();
    system.out.println(threadlocal.get());
}

执行结果是：

false
null
true

可以看到，我们在不同的线程中调用同一个 threadlocal 的 get() 方法，获得的值是不同的，看起来就像 threadlocal 为每个线程分别存储了不同的值。那么这到底是如何实现的呢？一起来看看源码吧。

以下源码基于 jdk 1.8 , 相关文件：

thread.java

threadlocal.java

threadlocal

首先 threadlocal 是一个泛型类，public class threadlocal<t>，支持存储各种数据类型。它对外暴露的方法很少，基本就 get() 、set() 、remove() 这三个。下面依次来看一下。

set()

public void set(t value) {
    thread t = thread.currentthread();
    threadlocalmap map = getmap(t); // 获取当前线程的 threadlocalmap
    if (map != null)
        map.set(this, value);
    else
        createmap(t, value); // 创建 threadlocalmap
}

这里出现了一个新东西 threadlocalmap，暂且就把他当做一个普通的 map。从 map.set(this, value) 可以看出来这个 map 的键是 threadlocal 对象，值是要存储的 value 对象。其实看到这，threadlocal 的原理你应该基本都明白了。

每一个 thread 都有一个 threadlocalmap ，这个 map 以 threadlocal 对象为键，以要保存的线程局部变量为值。这样就做到了为每个线程保存不同的副本。

首先通过 getmap() 函数获取当前线程的 threadlocalmap ：

threadlocalmap getmap(thread t) {
    return t.threadlocals;
}

原来 thread 还有这么一个变量 threadlocals ：

/* threadlocal values pertaining to this thread. this map is maintained
* by the threadlocal class.
*
* 存储线程私有变量，由 threadlocal 进行管理
*/
threadlocal.threadlocalmap threadlocals = null;

默认为 null，所以第一次调用时返回 null ，调用 createmap(t, value) 进行初始化：

void createmap(thread t, t firstvalue) {
    t.threadlocals = new threadlocalmap(this, firstvalue);
}

get()

set() 方法是向 threadlocalmap 中插值，那么 get() 就是在 threadlocalmap 中取值了。

public t get() {
    thread t = thread.currentthread();
    threadlocalmap map = getmap(t); // 获取当前线程的 threadlocalmap
    if (map != null) {
        threadlocalmap.entry e = map.getentry(this);
        if (e != null) {
            @suppresswarnings("unchecked")
            t result = (t)e.value;
            return result; // 找到值，直接返回
        }
    }
    return setinitialvalue(); // 设置初始值
}

首先获取 threadlocalmap，在 map 中寻找当前 threadlocal 对应的 value 值。如果 map 为空，或者没有找到 value，则通过 setinitialvalue() 函数设置初始值。

private t setinitialvalue() {
    t value = initialvalue(); // 为 null
    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;
}

setinitialvalue() 和 set() 逻辑基本一致，只不过 value 是 null 而已。这也解释了文章开头的例子会输出 null。当然，在 threadlocal 的子类中，我们可以通过重写 setinitialvalue() 来提供其他默认值。

remove()

public void remove() {
    threadlocalmap m = getmap(thread.currentthread());
    if (m != null)
        m.remove(this);
}

remove() 就更简单了，根据键直接移除对应条目。

看到这里，threadlocal 的原理好像就说完了，其实不然。threadlocalmap 是什么样的一个哈希表呢？它是如何解决哈希冲突的？它是如何添加，获取和删除元素的？可能会导致内存泄露吗？

其实 threadlocalmap 才是 threadlocal 的核心。threadlocal 仅仅只是提供给开发者的一个工具而已，就像 handler 一样。带着上面的问题，来阅读 threadlocalmap 的源码，体会 jdk 工程师的鬼斧神工。

threadlocalmap

entry

threadlocalmap 是 threadlocal 的静态内部类，它没有直接使用 hashmap，而是一个自定义的哈希表，使用数组实现，数组元素是 entry。

static class entry extends weakreference<threadlocal<?>> {
    /** the value associated with this threadlocal. */
    object value;

    entry(threadlocal<?> k, object v) {
        super(k);
        value = v;
    }
}

entry 类继承了 weakreference<threadlocal<?>>，我们可以把它看成是一个键值对。键是当前的 threadlocal 对象，值是存储的对象。注意 threadlocal 对象的引用是弱引用，值对象 value 的引用是强引用。threadlocal 使用弱引用其实很好理解，源码注释中也告诉了我们答案：

to help deal with very large and long-lived usages, the hash table entries use weakreferences for keys

thread 持有 threadlocalmap 的强引用，threadlocalmap 中的 entry 的键是 threadlocal 引用。如果线程长期存活或者使用了线程池，而 threadlocal 在外部又没有任何强引用了，这种情况下如果 threadlocalmap 的键仍然使用强引用 threadlocal，就会导致 threadlocal 永远无法被垃圾回收，造成内存泄露。

图片来源：https://www.jianshu.com/p/a1cd61fa22da

那么，使用弱引用是不是就万无一失了呢？答案也是否定的。同样是上面说到使用情况，线程长期存活，由于 entry 的 key 使用了弱引用，当 threadlocal 不存在外部强引用时，可以在 gc 中被回收。但是根据可达性分析算法，仍然存在着这么一个引用链：

current thread -> threadlocalmap -> entry -> value

key 已经被回收了，此时 key == null。那么，value 呢？如果线程长期存在，这个针对 value 的强引用也会一直存在，外部是否对 value 指向的对象还存在其他强引用也不得而知。所以这里还是有几率发生内存泄漏的。就算我们不知道外部的引用情况，但至少在这里应该是可以切断 value 引用的。

所以，为了解决可能存在的内存泄露问题，我们有必要对于这种 key 已经被 gc 的过期 entry 进行处理，手动释放 value 引用。当然，jdk 中已经为我们处理了，而且处理的十分巧妙。下面就来看看 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);
}

table 是存储 entry 的数组，初始容量 initial_capacity 是 16。

firstkey.threadlocalhashcode & (initial_capacity - 1) 是 threadlocalmap 计算哈希的方式。&(2^n-1) 其实等同于 % 2^n，位运算效率更高。

threadlocalhashcode 是如何计算的呢？看下面的代码：

private static final int hash_increment = 0x61c88647;

private static atomicinteger nexthashcode = new atomicinteger();

private final int threadlocalhashcode = nexthashcode();

private static int nexthashcode() {
    return nexthashcode.getandadd(hash_increment);
}

0x61c88647 是一个增量，每次取哈希都要再加上这个数字。又是一个神奇的数字，让我想到了 integer 源码中的 52429 这个数字，见 走进 jdk 之 integer 。0x61c88647 背后肯定也有它的数学原理，总之肯定是为了效率。

原理就不去探究了，其实我也不知道是啥原理。不过我们可以试用一下，看看效果如何。按照上面的方式来计算连续几个元素的哈希值，也就是在 entry 数组中的位置。代码如下：

public class test {

    private static final int initial_capacity = 16;
    private static final int hash_increment = 0x61c88647;
    private static atomicinteger nexthashcode = new atomicinteger();

    private static int nexthashcode() {
        return nexthashcode.getandadd(hash_increment);
    }

    private static int hash() {
        return nexthashcode() & (initial_capacity - 1);
    }

    public static void main(string[] args) {

        for (int i = 0; i < 8; i++) {
            system.out.println(hash());
        }
    }
}

运算结果如下：

0
7
14
5
12
3
10
1

计算结果分布还是比较均匀的。既然是哈希表，肯定就会存在哈希冲突的情况。那么，threadlocalmap 是如何解决哈希冲突呢？很简单，看一下 nextindex() 方法。

private static int nextindex(int i, int len) {
    return ((i + 1 < len) ? i + 1 : 0);
}

在不超过 len 的情况下直接加 1，否则置 0。其实这样又可以看成一个环形数组。

接下来看看 threadlocalmap 的数据是如何存储的。

set()

private void set(threadlocal<?> key, object value) {

    // we don't use a fast path as with get() because it is at
    // least as common to use set() to create new entries as
    // it is to replace existing ones, in which case, a fast
    // path would fail more often than not.

    entry[] tab = table;
    int len = tab.length;
    int i = key.threadlocalhashcode & (len-1); // 当前 key 的哈希，即在数组 table 中的位置

    for (entry e = tab[i];
        e != null; // 循环直到碰到空 entry
        e = tab[i = nextindex(i, len)]) {
        threadlocal<?> k = e.get();

        if (k == key) { // 更新 key 对应的值
            e.value = value;
            return;
        }

        if (k == null) { // 替代过期 entry
            replacestaleentry(key, value, i);
            return;
        }
    }

    tab[i] = new entry(key, value);
    int sz = ++size;
    if (!cleansomeslots(i, sz) && sz >= threshold)
        rehash();
}

1. 通过 key.threadlocalhashcode & (len-1) 计算出初始的哈希值
2. 不断调用 nextindex() 直到找到空 entry

3. 在第二步遍历过程中的每个元素，要处理两种情况：

   (1). k == key，说明当前 key 已存在，直接更新值即可，直接返回

   (2). k == null, 注意这里的前置条件是 entry != null。说明遇到过期 entry，直接替换
4. 不属于 3 中的两种情况，则将参数中的键值对插入空 entry 处

5. cleansomeslots()/rehash()

先来看看第三步中的第二种特殊情况。entry 不为空，但其中的 key 为空，什么时候会发生这种情况呢？对，就是前面说到内存泄漏时提到的 过期 entry。我们都知道 entry 的 key 是弱引用的 threadlocal，当外部没有它的任何强引用时，下次 gc 时就会将其回收。所以这时候的 entry 理论上也是无效的了。

由于这里是在 set() 方法插入元素的过程中发现了过期 entry，所以只要将要插入的 entry 直接替换这个 key==null 的 entry 就可以了，这就是 replacestaleentry() 的核心逻辑。

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).
    // 向前找到第一个过期条目
    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
    // 向后查找，直到找到 key 或者 空 entry
    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;
            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(expungestaleentry(slottoexpunge), len);
}

看起来挺累人的。在我理解，replacestaleentry 只是做一个标记的作用，在各种情况下最后都会调用 cleansomeslots 来真正的清理过期条目。

你可以看到 ``

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];
        if (e != null && e.get() == null) {
            n = len;
            removed = true;
            i = expungestaleentry(i); // 需要清理的 entry
        }
    } while ( (n >>>= 1) != 0);
    return removed;
}

参数 n 表示扫描控制。初始情况下扫描 log2(n) 次，如果遇到过期条目，会再扫描 log2(table.length)-1 次。在 set() 方法中调用，参数 n 表示元素的个数。在 replacestaleentry 中调用，参数 n 表示的是数组 table 的长度。

注意 do 循环里面的判断条件：e != null && e.get() == null ，还是那些 entry 不为空，key 为空的过期条目。发现过期条目之后，调用 expungestaleentry() 去清理。

expungestaleentry()

private int expungestaleentry(int staleslot) {
    entry[] tab = table;
    int len = tab.length;

    // expunge entry at staleslot
    // 清空 staleslot 处的 过期 entry
    // 将 value 置空，保证不会因为这里的强引用造成 memory leak
    tab[staleslot].value = null;
    tab[staleslot] = null;
    size--;

    // rehash until we encounter null
    // 继续搜索直到遇到 tab 中的空 entry
    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 {
            // key 还没有被回收
            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; // 此时从 staleslot 到 i 之间不存在过期条目
}

直接将 entry.value 和 entry 都置空，消除内存泄露的隐患。注意这里仅仅只是置空，并不是回收对象。因为你不知道 value 在外部的引用情况，只需要管好自己的引用就可以了。

除此之外，不甘寂寞的 expungestaleentry() 又发起了一次扫描，直到碰到空 entry未知。期间遇到的过期 entry 要置空。

整个 set() 方法就看完了，原理很简单，但是其中关于内存泄漏的预防处理十分复杂，看的我一度放弃了，也让我对源码阅读产生了一些疑问。有些时候是不是没有必要逐行去玩去完全理解？比如这一系列关于内存泄露的处理，核心思想就是清理 entry 不为 null 但 key 为 null 的过期条目。理解了核心思想，对于其中复杂的细节处理是不是没有必要去深究？不知道你怎么看，欢迎在评论区写下你的看法。

下面来看一看 getgetentry 方法。

getentry()

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

getentry() 比较粗暴，上来直接根据哈希值查找 table 数组，如果直接命中，就返回。未直接命中，调用 getentryaftermiss() 继续查找。

private entry getentryaftermiss(threadlocal<?> key, int i, entry e) {
    entry[] tab = table;
    int len = tab.length;

    // 向后查找直到遇到空 entry
    while (e != null) {
        threadlocal<?> k = e.get();
        if (k == key) // get it
            return e;
        if (k == null) // key 等于 null，清理过期 entry
            expungestaleentry(i);
        else
            i = nextindex(i, len); // 继续向后查找
        e = tab[i];
    }
    return null;
}

调用 nextindex() 向后查找，直到遇到 空 entry，也就是队尾：

• k==key，说明找到了对应 entry
• k==null，说明遇到了过期 entry，调用 expungestaleentry() 处理

对过期 entry 的处理真的是无处不在，就是为了最大程度的降低内存泄漏发生的几率。那么有没有什么一劳永逸的办法呢？那就是 threadlocalmap 的 remove() 方法。

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

直接清除当前 threadlocal 对应的 entry，根本上避免了发生内存泄露。所以，当我们不再需要使用 threadlocal 中的相应数据时，调用一下 remove() 方法肯定是个好习惯。

虽然在长期存活的线程（例如线程池）中使用 threadlocal 并发生内存泄漏是一个小概率事件，但 jdk 开发者却为此多写了很多代码。我们在使用中也要多加注意，仔细考虑是否会涉及到内存泄露的问题。

end

最后说说在网上看到的一个观点，threadlocal 比 synchronized 更适合解决线程同步问题。

首先这个问题本身就不是那么严谨。threadlocal 是用来解决线程同步问题的吗？表面上看，threadlocal 的机制的确是线程安全的，但它并不是为了解决多线程访问同一个变量的竞争问题，而是给每一个线程都提供单独的变量，有些文章称之为 数据备份，但它们并不是备份，每一个都是独立存在的，互不干扰，并不存在什么同步问题。

threadlocal 和 synchronized 的应用场景也是千差万别的。例如银行的转账场景，涉及多个账户同时转账的多线程同步问题，threadlocal 根本就没法解决，即使每个线程都单独保存着用户的余额也没法解决并发问题。threadlocal 在 android 中的典型应用就是 looper，每个线程都有自己的 looper 对象，它们都是独立工作，互不干扰的。

关于 threadlocal 就说到这里了。后续分享的方向主要集中在两块，一方面是 aosp 源码的阅读和解析，另一方面是 kotlin 和 java 相关特性的对比，敬请期待！

文章首发微信公众号： 秉心说 ， 专注 java 、 android 原创知识分享，leetcode 题解。

更多最新原创文章，扫码关注我吧！