2020-03-09-Java线程本地存储ThreadLocal

ThreadLocal的使用

前面介绍Handler机制的时候，说到过每个线程最多只能绑定一个looper。但是Looper.perpare和myLooper方法是静态的，为了保证每个线程获取到的looper都是正确且唯一的，使用了ThreadLocal变量。
Looper内部有一个sThreadLocal变量，这个变量可以被多个线程共享，但是每个线程都能保存和获取自己独立的Looper变量。

    static final ThreadLocal sThreadLocal = new ThreadLocal();
    private static void prepare(boolean quitAllowed) {
        if (sThreadLocal.get() != null) {
            throw new RuntimeException("Only one Looper may be created per thread");
        }
        sThreadLocal.set(new Looper(quitAllowed));
    }
    public static @Nullable Looper myLooper() {
        return sThreadLocal.get();
    }

ThreadLocal的原理

下图是ThreadLocal的内存模型，以Looper为例，一个进程的Looper维持了一个sThreadLocal变量，但是每一个线程都自己保存了一个ThreadLocalMap，所以它们分别能取到自己的Looper变量。

ThreadLocal (1).jpg

先大概了解一下ThreadLocal的内部结构。
1.它有一个Entry类型的一维数组table，默认大小是16,；
Entry继承了WeakReference，是一个弱引用类型，实现了对ThreadLocal的弱引用。通过弱引用可以避免一些对象没释放导致的内存泄漏问题。
2.通过ThreadLocal的hashCode计算它在table中的索引；
3.放入第一个键值对数据；
4.初始化size=1；
5.设置table调整扩容的阈值是容量的三分之二。

        private Entry[] table;
        ThreadLocalMap(ThreadLocal firstKey, Object firstValue) {
            table = new Entry[INITIAL_CAPACITY];//1
            int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);//2
            table[i] = new Entry(firstKey, firstValue);//3
            size = 1;//4
            setThreshold(INITIAL_CAPACITY);//5
        }

        static class Entry extends WeakReference> {
            /** The value associated with this ThreadLocal. */
            Object value;

            Entry(ThreadLocal k, Object v) {
                super(k);
                value = v;
            }
        }

从ThreadLocal中获取变量的方法是get。
1.通过thread实例获取它对应的那个ThreadLocalMap对象；
2.通过getEntry方法获取这个ThreadLocal实例对应的Entry，这个过程类似hashMap的查找；
3.返回Entry的value实例；
4.如果该线程还没有本地ThreadLocalMap实例，通过setinitialValue方法初始化。

    public T get() {
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);//1
        if (map != null) {
            ThreadLocalMap.Entry e = map.getEntry(this);//2
            if (e != null) {
                @SuppressWarnings("unchecked")
                T result = (T)e.value;//3
                return result;
            }
        }
        return setInitialValue();//4
    }

getEntry方法是一个键值对的匹配过程，key是ThreadLocal实例，因为一个线程可能有多种ThreadLocal，比如Looper就是其中一种。

        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 出栈后，由于ThreadLocalMap中Entry对ThreadLocal只是弱引用，所以ThreadLocal对象会被回收，Entry的key会变成null，然后在每次get/set/remove ThreadLocalMap中的值的时候，会自动清理key为null的value，这样value也能被回收了。

但是如果ThreadLocal一直没有出栈，比如上面的Looper的例子，sThreadLocal具有跟Thread相同的生命周期，那么这里的虚引用便形同虚设了，所以使用完后记得调用ThreadLocal.remove将其对应的value清除。

最后，由于ThreadLocalMap中只对ThreadLocal是弱引用，对value是强引用，如果ThreadLocal因为没有其他强引用而被回收，之后也没有调用过get/set，那么就会产生内存泄露。

在使用线程池时，线程会被复用，那么里面保存的ThreadLocalMap同样也会被复用，会造成线程之间的资源没有被隔离，所以在线程归还回线程池时要记得调用remove方法。
参考：

http://www.jasongj.com/java/threadlocal/
https://mp.weixin.qq.com/s?__biz=MzAxMTg2MjA2OA==&mid=2649848413&idx=3&sn=c5010c17e3659584b4ac938d072191cc&chksm=83bf7306b4c8fa109061a494260812eeedbea47cc08ae3c0713e8eab7d595dd2a89d4f680887&mpshare=1&scene=1&srcid=&sharer_sharetime=1583753584205&sharer_shareid=01bf73f585713c020b238c5941d7b97f&key=51c25831f8852581d6784364d59b44264c6cde4415757d50b109156029811287c55d1c50a3f790d7c2d5dfc9631c9e070de6c2e9d18a0c07f24c74d9809d713b8167c7ea1166fd4229eb9a7c4f798e89&ascene=1&uin=MjMxOTM2MjkyOA%3D%3D&devicetype=Windows+10&version=62080079&lang=zh_CN&exportkey=Ax5vqeT%2FK%2BOFwca%2Fs8kSSBk%3D&pass_ticket=DyPmzA7a4d%2BLeUYYzGQWmqTavly2%2B%2B655U%2F34SqDRj1YyVOcwD1VAEJS1lTmKKw6