ThreadLocal原理简单版

深碍√TFBOYSˉ_ 2022-05-18 06:47 107阅读 0赞

首先，简单的讲解一下。

1、每个线程里面有一个ThreadLocalMap，他存的键就是一个ThreadLocal对象，值是用户设置进去的。

2、ThreadLocal每次get、set都会拿出当前线程的ThreadLocalMap对象。

3、但是ThreadLocalMap又是ThreadLocal里面的一个内部类。

所以，我再补充一下第二点，ThreadLocal每次get，都是通过Thread.currentThread()找出当前线程，然后通过当前线程就能拿到ThreadLocalMap对象，然后把当前threadLocal对象作为key值传入，就能获取到用户设置的值。由于拿出当前线程的ThreadLocalMap对象，每个线程都有ThreadLocalMap对象对应，所以保证了线程安全。

怎么使用threadLocal我就不写了，大家自行网上搜索。这里主要介绍原理。

### 原理解释 ###

解释第一点：

查看Thread的源码，里面有一端代码：

/* ThreadLocal values pertaining to this thread. This map is maintained
         * by the ThreadLocal class. */
        ThreadLocal.ThreadLocalMap threadLocals = null;

这就是每个线程都有一个ThreadLocalMap的解释。

另外查看ThreadLocal的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是当前线程的threadLocalMap对象，下面会讲到，map调用set方法的时候，key是this，也解释了“他存的键就是一个ThreadLocal对象，值是用户设置进去的”这一点。

解释第二点：

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

getMap(t)方法就是把当前线程的ThreadLocalMap找出来：

/**
         * Get the map associated with a ThreadLocal. Overridden in
         * InheritableThreadLocal.
         *
         * @param  t the current thread
         * @return the map
         */
        ThreadLocalMap getMap(Thread t) {
            return t.threadLocals;
        }

这时候，就和第一点串起来了。

所以，通过这种方式，一个相同ThreadLocal对象，在不同的线程里面，通过不同线程的threadLocalMap对象，以这一个ThreadLocal对象为key，保存的value却是不相同的，可以避免线程安全的问题。

解释第三点：

用idea查看源码，很简单地得出结论，

![70][]

之所以要提到这一点，是因为这里有点绕，容易绕进去。不过，最好还是看源码，毕竟源码最实在。

这就是简单版的解释，如果想要简单的知道原理，这里就可以停下了。后面我们继续从ThreadLocalMap深入：

本文分析的是1.8的源码。

在ThreadLoalMap中，也是初始化一个大小16的Entry数组，Entry对象用来保存每一个key-value键值对，只不过这里的key永远都是ThreadLocal对象，是不是很神奇，通过ThreadLocal对象的set方法，结果把ThreadLocal对象自己当做key，放进了ThreadLoalMap中。

![tp_webp_wxfrom_5_wx_lazy_1_wx_co_1][]

这里需要注意的是，ThreadLoalMap的Entry是继承WeakReference，和HashMap很大的区别是，Entry中没有next字段，所以就不存在链表的情况了。

### hash冲突 ###

没有链表结构，那发生hash冲突了怎么办？

先看看ThreadLoalMap中插入一个key-value的实现

/**
             * Set the value associated with key.
             *
             * @param key the thread local object
             * @param value the value to be 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);
    
                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();
            }

每个ThreadLocal对象都有一个hash值 `threadLocalHashCode`，每初始化一个ThreadLocal对象，hash值就增加一个固定的大小 `0x61c88647`。（ThreadLocal源码可以看到private final int threadLocalHashCode = nextHashCode();点进去看实现就明白了）

在插入过程中，根据ThreadLocal对象的hash值，定位到table中的位置i，过程如下： 1、如果当前位置是空的，那么正好，就初始化一个Entry对象放在位置i上； 2、不巧，位置i已经有Entry对象了，如果这个Entry对象的key正好是即将设置的key，那么重新设置Entry中的value； 3、很不巧，位置i的Entry对象，和即将设置的key没关系，那么只能找下一个空位置（e = tab\[i = nextIndex(i, len)\]，其实它寻找下一个位置也是+1而已，如果是超过了长度，又从零开始，参考nextindex的源码）；

这样的话，在get的时候，也会根据ThreadLocal对象的hash值，定位到table中的位置，然后判断该位置Entry对象中的key是否和get的key一致，如果不一致，就判断下一个位置。

可以发现，set和get如果冲突严重的话，效率很低，因为ThreadLoalMap是Thread的一个属性，所以即使在自己的代码中控制了设置的元素个数，但还是不能控制其它代码的行为。

### 内存泄露 ###

ThreadLocal可能导致内存泄漏，为什么？ 先看看Entry的实现：

static class Entry extends WeakReference<ThreadLocal<?>> {
                /** The value associated with this ThreadLocal. */
                Object value;
    
                Entry(ThreadLocal<?> k, Object v) {
                    super(k);
                    value = v;
                }
            }

通过之前的分析已经知道，当使用ThreadLocal保存一个value时，会在ThreadLocalMap中的数组插入一个Entry对象，按理说key-value都应该以强引用保存在Entry对象中，但在ThreadLocalMap的实现中，\*\*key被保存到了WeakReference对象\*\*中。

这就导致了一个问题，ThreadLocal在没有外部强引用时，发生GC时会被回收，如果创建ThreadLocal的线程一直持续运行，那么这个Entry对象中的value就有可能一直得不到回收，发生内存泄露。（这里可以参考[http://www.importnew.com/22039.html][http_www.importnew.com_22039.html]）

如何避免内存泄露

既然已经发现有内存泄露的隐患，自然有应对的策略，在调用ThreadLocal的get()、set()可能会清除ThreadLocalMap中key为null的Entry对象，这样对应的value就没有GC Roots可达了，下次GC的时候就可以被回收.在set方法里面，有一段代码：

if (k == null) {
        replaceStaleEntry(key, value, i);
        return;
     }

如果是k为空（有可能是弱引用被回收），就替换掉（stale：陈腐的; 不新鲜的;走了味的;）

当然如果调用remove方法，肯定会删除对应的Entry对象。

如果使用ThreadLocal的set方法之后，没有显示的调用remove方法，就有可能发生内存泄露，所以养成良好的编程习惯十分重要，使用完ThreadLocal之后，记得调用remove方法。

ThreadLocal<String> localName =new ThreadLocal();
    try{
        localName.set("嗯嗯");  
    // 其它业务逻辑
    } finally{
        localName.remove();
    }

参考：[https://mp.weixin.qq.com/s/1ccG1R3ccP0\_5A7A5zCdzQ][https_mp.weixin.qq.com_s_1ccG1R3ccP0_5A7A5zCdzQ]

[70]: /images/20220518/66b6c0e322c34c7eb3dad99525e5e603.png
[tp_webp_wxfrom_5_wx_lazy_1_wx_co_1]: /images/20220518/b1a1115b19024d6f8986459055e52f2b.png
[http_www.importnew.com_22039.html]: http://www.importnew.com/22039.html
[https_mp.weixin.qq.com_s_1ccG1R3ccP0_5A7A5zCdzQ]: https://mp.weixin.qq.com/s/1ccG1R3ccP0_5A7A5zCdzQ