ThreadLocal内存泄漏分析

介绍

结构

Thread类里面 有一个成员变量，ThreadLocalMap。

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

这里的设计是懒加载，只有在使用到ThreadLocalMap的时候才会对该成员变量进行初始化。

该方法的调用处用两个。一个位于输入值的时候，另一个位于添加值的时候。


接下来看下ThreadLocalMap的结构。成员变量table数据是存储数据的位置，每一个元素都是一个Entry对象，它是一个静态内部类，以键值对的形式存储数据，键是一个ThreadLocal实例，值是一个对象。

小结

具体的结构如下所示，Thread维护一个ThreadLocalMap的成员变量，因为是线程内部的成员变量，所以线程隔离。ThreadLocalMap对象维护一个Entry数组，每个Entry是一个键值对对象。键是ThreadLocal，值是具体要存储的对象。

ThreadLocal.set方法

set操作就是往数组里插入值，代码如下所示。首先根据key的哈希值获取理论上的位置，如果当前位置上为空，则直接填充进去，如果当前位置上有值，则可能是哈希冲突或者临近的哈希值占据了（这里为什么接下来会介绍），则找到临近的空位置，进行插入。

主要讲一下for循环的逻辑。在此之前获取ThreadLocalMap中的所有数据。for循环的功能就是，从理论上的索引值开始遍历，如果之前有插入过（k==key），则直接修改；否则，向下寻找，找到一个空的位置，将数据插入进去。这就是上文中为什么说会理论上的位置会被相邻的哈希值占据。

for循环执行完，如果方法没有退出，则表明需要找到了新位置，然后将数据插入进去，然后数组的size自增，如果到达门限值（也是ThreadLocal的成员变量，每次自增后会更新）。

for循环不是我们常规的循环，而是从指定值 开始，进行环型遍历，即到达最大值后，然后从0继续遍历，直至找到一个空的位置。至于为什么一定会找到空位置，则是由扩容阈值解决的。当2/3的位置被占据后，则会进行扩容，保证一定有空位置。

下图是设置扩容阈值。

下图是环型遍历

ThreadLocal.get方法

有了set的基础，这里的方法也很好理解。

这个方法的逻辑时，先获取key的哈希值，与entry数组的长度进行哈希后，得到该key在entry数组中的理论上的位置。此时有三种情况，一种是该索引位置上没有元素；一种是该索引位置上有元素，但元素的key不是指定的ThreadLocal；最后一种是该索引位置上有元素，但元素的key就是指定的ThreadLocal。

如果有哈希冲突则按照下图方式解决。还是从理论上的哈希开始环型遍历，找到相邻哈希都遍历完出现空值结束。如果找到了则返回，没找到则退出。

小结

本节介绍了ThreadLocalMap的结构树，以及set和get方法。

内存泄漏问题

问题描述

当线程的生命周期过长，导致ThreadLocalMap一直被存在而无法回收的问题，产生类似泄漏的效果。

弱引用

public class WeakClass extends WeakReference<WeakClass.Student> {
    public WeakClass(Student referent) {
        super(referent);
    }

    public static void main(String[] args) {
        WeakClass weakClass = new WeakClass(new Student("chen"));
        System.out.println(weakClass.toString());
        System.gc();
        System.out.println(weakClass.toString());

    }
    static class Student{
        String name;

        public Student(String name) {
            this.name = name;
        }

        @Override
        public String toString() {
            return "Student{" +
                    "name='" + name + '\'' +
                    '}';
        }
    }

}

GC 前

GC后

即GC后引用消失

上文介绍过，Entry中也使用了弱引用，也就是key, ThreadLocal部分。如果发生了GC，那么key部分也会被回收，导致出现key为null的情况出现。

接下来介绍下JDK是如何解决这部分问题的。
如果线程寿命较短，因为ThreadLocalMap是Thread的一个成员变量，则其会随着线程的回收而被回收。
我们也可以手动调用remove方法，对应的键值对回收。remove方法会寻找key为null的Entry，进行回收。

remove回收线程

clear之前，entry的引用和值都存在。

clear操作会清空引用，但是entry的数值还有保存在ThreadLocalMap中。

接下来的操作才会清空ThreadLocalMap中的数据。

这样可以解决内存泄漏的问题。

其实不光remove的时候会调用这个方法，当我们set和get发生哈希冲突的时候，也会调用这个方法。

如何避免ThreadLocal被收集

上文说到，ThreadLocal是弱引用，会被GC回收。这样就会导致所需的数据对应的Key为null，导致无法根据之前ThreadLocal实例获取数据。
此时我们将ThreadLocal指定为静态对象，这样便可以作为GC root不被回收。不过这样的话，由于实例不会被置为空，则无法通过set/get方法清空，而必须要手动remove，否则会造成内存泄漏。