JUC(七)-ThreadLocal详解

学习并掌握ThreadLocal的使用，使用场景，原理。以及相关的强、软、弱、虚引用，ThreadLocal内存泄露问题剖析以及解决办法

ThreadLocal简介

ThreadLocal又叫做线程局部变量，ThreadLocal为变量在每个线程中都创建了一个副本，那么每个线程可以访问自己内部的副本变量。

　内存溢出（memory overflow）：是指不能申请到足够的内存进行使用，就会发生内存溢出，比如出现的OOM（Out Of Memory）

　内存泄漏（memory lack）：内存泄露是指在程序中已经动态分配的堆内存由于某种原因未释放或者无法释放（已经没有用处了，但是没有释放），造成系统内存的浪费，这种现象叫“内存泄露”。

　　当内存泄露到达一定规模后，造成系统能申请的内存较少，甚至无法申请内存，最终导致内存溢出，所以内存泄露是导致内存溢出的一个原因。

如何创建

泛型可以是任意，这里以String 为例

第一种(伪代码)：set方法,当前线程赋值值，当前线程取值

private static final ThreadLocal<String> threadLocal = new ThreadLocal<String>(){};

// 在方法中调用set赋值
threadLocal.set("xxx")

第二种（伪代码）：使用withInitial，统一初始化所有线程的ThreadLocal的值

private ThreadLocal<Integer> threadLocal = ThreadLocal.withInitial(() -> 6);

Thread、ThreadLocal和ThreadLocalMap三者之间的关系

• Thread

​ 线程类，在这个类中存在一个threadLocals变量

ThreadLocal.ThreadLocalMap threadLocals = null;

• ThreadLocal

​ 此类提供了一个简单的set,get,remove方法，用于设置，获取或移除 绑定到线程本地变量中的值。里面存一个匿名静态内部类ThreadLocalMap

• ThreadLocalMap

​ 这是在ThreadLocal中定义的一个类，可以简单的将它理解成一个Map，不过它的key是WeakReference弱引用类型，这样当这个值没有在别的地方引用时，在发生垃圾回收时，这个map的key会被自动回收，不过它的值不会被自动回收。

总结关系：

Thread存在ThreadLocalMap对象(直接关系)

ThreadLocal里有ThreadLocalMap匿名内部类（直接关系）

ThreadLocal进行方法操作的时候会从Thread里面的ThreadLocalMap拿取当前ThreadLocalMap,然后操作该Map(间接关系)

源码分析 get和set

get实现

public T get() {
    // 获取当前线程
    Thread t = Thread.currentThread();
    // 获取这个线程自身绑定的 ThreadLocalMap 对象
    ThreadLocalMap map = getMap(t);
    if (map != null) {
        // this是ThreadLocal对象，获取Map中的Entry对象
        ThreadLocalMap.Entry e = map.getEntry(this);
        if (e != null) {
            @SuppressWarnings("unchecked")
            // 获取具体的值
            T result = (T)e.value;
            return result;
        }
    }
    // 设置初始值
    return setInitialValue();
}

set实现

public void set(T value) {
    // 获取当前线程
    Thread t = Thread.currentThread();
    // 获取绑定到这个线程自身的 ThreadLocalMap，这个ThreadLocalMap是从Thread类的`threadLocals`变量中获取的
    ThreadLocalMap map = getMap(t);
    if (map != null) {
        // 向map中设置值，key为 ThreadLocal 对象的实例。
        map.set(this, value);
    } else {
        // 如果map不存在，则创建出来。
        createMap(t, value);
    }
}

1. 获取当前线程Thread
2. 获取当前线程的 ThreadLocalMap 对象。
3. 向ThreadLocalMap中设置值，key为ThreadLocal对象，值为具体的值。

强引用、软引用、弱引用和虚引用是什么？

强度由高到低依次为：强引用 -> 软引用 -> 弱引用 -> 虚引用

• 强引用(StrongReference)

  强引用是使用最普遍的引用。如果一个对象具有强引用，那垃圾回收器绝不会回收它

  如:Object strongReference = new Object();

​ 当内存空间不足时，Java虚拟机宁愿抛出OutOfMemoryError错误，使程序异常终止，也不会靠随意回收具有强引用的对象来解决内存不足的问题。显式地设置strongReference对象为null，或让其超出对象的生命周期范围，则gc认为该对象不存在引用，这时就可以回收这个对象。具体什么时候收集这要取决于GC算法

• 软引用(SoftReference)

​ 如果一个对象只具有软引用，则内存空间充足时，垃圾回收器就不会回收它；如果内存空间不足了，就会回收这些对象的内存。只要垃圾回收器没有回收它，该对象就可以被程序使用。

• 弱引用(WeakReference)

  在垃圾回收器线程扫描它所管辖的内存区域的过程中，一旦发现了只具有弱引用的对象，不管当前内存空间足够与否，都会回收它的内存。

• 虚引用(PhantomReference)

  虚引用顾名思义，就是形同虚设。与其他几种引用都不同，虚引用并不会决定对象的生命周期。如果一个对象仅持有虚引用，那么它就和没有任何引用一样，在任何时候都可能被垃圾回收器回收。

ThreadLocal内部类 ThreadLocalMap采用弱引用

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

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

ThreadLocal为什么会内存泄露？

在ThreadLocal的生命周期中，都存在这些引用。看下图: 实线代表强引用，虚线代表弱引用

（图片来自网络）

每个Thread 维护一个 ThreadLocalMap 映射表，这个映射表Entry的 key 是 ThreadLocal实例本身，value 是真正需要存储的 Object

ThreadLocalMap 是使用 ThreadLocal 的弱引用作为 Key 的，如果一个ThreadLocal没有外部强引用来引用它,弱引用的对象ThreadLocal在 GC 时会被回收,这时，ThreadLocalMap中就会出现key为null的Entry，就没有办法访问这些key为null的Entry的value，这个时候如果当前线程再迟迟不结束（比如我们使用线程池复用线程），所以存在着内存泄露，因为这里只有线程结束后，存在线程栈中的Current Thread、Map value才会全部被GC回收

ThreadLocalMap的设计中已经考虑到这种情况,在ThreadLocal的get(),set(),remove()的时候都会清除线程ThreadLocalMap里所有key为null的value

ThreadLocalMap设计上已经考虑比较多，但是都是被动措施

分配使用了ThreadLocal又不再调用get(),set(),remove()方法，那么就会导致内存泄漏，因为这块内存一直存在。

为什么使用弱引用，OOM是否是弱引用的锅？

分两种情况

• key 使用强引用：引用的ThreadLocal的对象被回收了，但是ThreadLocalMap还持有ThreadLocal的强引用，如果没有手动删除，ThreadLocal不会被回收，导致Entry内存泄漏。

• key 使用弱引用：引用的ThreadLocal的对象被回收了，由于ThreadLocalMap持有ThreadLocal的弱引用，即使没有手动删除，ThreadLocal也会被回收。value在下一次ThreadLocalMap调用set、get、remove的时候会被清除。

综上所述，Entryd的key无论使用弱引用还是强引用。本质上value还是强引用，所以还是会造成内存泄露，从而引发内存溢出

最佳实践

每次使用完ThreadLocal，都调用它的remove()方法，清除数据。

使用场景

ThreadLocal 适用于每个线程需要自己独立的实例且该实例需要在多个方法中被使用，也即变量在线程间隔离而在方法或类间共享的场景