image.png

ThreadLocal三个主要方法

• set方法，用于设置当前线程本地变量的值，传入的参数为要设置的值。比如 threadLocal.set("value") 。
• get方法，用于获取当前线程本地变量的值，无需传入任何参数。比如 String threadLocalValue = (String) threadLocal.get() 。
• remove方法，用于删除当前线程本地变量，无需传入任何参数。比如 threadLocal.remove() 。

原理

要通过一个Map结构就能实现该功能了。其中Map的key是当前线程，而Map的value则是变量值。下图展示了ThreadLocal的设计思想。

image.png

自己实现简单版本ThreadLocal

image.png

JDK中ThreadLocal

上面的实现方式虽然简单且符合我们的思考方式，但是它存在多线程并发性能问题。我们实现的ThreadLocal内部使用了一个Map对象，所有线程的操作都是针对该Map对象进行的操作，需要保证该对象访问的线程安全，这就需要额外的锁机制来保证。

JDK为我们提供的ThreadLocal的实现则比较巧妙，为了避免并发时涉及锁问题，它在每个线程对象中都放一个Map对象，但它并没有直接使用JDK的Map类，而是自己实现了一个key-value数据结构。每个线程都操作自己的Map对象则不存在并发问题，如下图，线程一包含了一个Map对象，该Map对象的key是ThreadLocal对象，而value则是变量值。注意这里的实现需要将思维转换一下，ThreadLocal对象变成了key，也就是说可能存在很多不同的ThreadLocal对象，要查找时需要传入对应的ThreadLocal对象。

image.png

JDK的实现源码

我们先来看Thread类与ThreadLocal类的关系，看到Thread类中包含了一个threadLocals变量，它是一种ThreadLocal.ThreadLocalMap类型，该类型定义在ThreadLocal类里面，也就是一个内部类。而ThreadLocalMap这个内部类即是实现了一个Map结构，该类又包含了Entry内部类，ThreadLocal对象和变量值则是通过Entry来保存。

image.png

Thread类

Thread类里面声明了threadLocals变量用于关联ThreadLocal.ThreadLocalMap对象，注意默认为null。

image.png

ThreadLocal类

提供了主要的三个方法，其ThreadLocalMap内部类实现Map结构。Map结构具体由Entry类实现，该类继承了WeakReference类，目的是为了避免内存泄漏。

image.png

对于多个线程与多个线程本地变量来说，它们的结构如下图。

image.png

ThreadLocalMap类

ThreadLocalMap类实际上就是一个Map结构的实现
ThreadLocalMap类使用数组来保存key-value，数组的每个元素对应一个key-value
保存之前会先用哈希算法计算线程对象的哈希值，这是一个整型值，通过该值就能定位数组的某个位置的元素，这样就能找到对应的key-value进行操作

image.png

ThreadLocal的set方法

ThreadLocal类的set方法逻辑为：首先获取当前线程对象，然后通过getMap方法获取当前线程的ThreadLocalMap，其实就是从Thread对象中获取，最后调用ThreadLocalMap对象的set方法保存key-value。注意如果Thread对象中的ThreadLocalMap对象为空的话则需要调用createMap方法先创建ThreadLocalMap对象并关联到Thread对象中

image.png

ThreadLocal的get方法

get方法的逻辑为：首先获取当前线程对象，然后通过getMap方法获取当前线程的ThreadLocalMap对象，如果该对象不为空则调用ThreadLocalMap对象的getEntry方法获取Entry，Entry对象即包含了我们要的value。如果获取不到值则最终还会执行setInitialValue方法，它是根据ThreadLocal对象的initialValue方法来设置初始值，默认是null，如果你想要设置一个初始值则可以重写initialValue方法

image.png

ThreadLocal的remove方法

remove方法的逻辑很简单，直接获取当前线程对象的ThreadLocalMap对象，然后调用该对象的remove方法删除对应的key-value。

image.png

ThreadLocal的内存泄漏

• JDK的实现是让Entry继承了WeakReference类，所以可以指定对某个对象进行弱引用，弱引用类型在没有其它强引用的情况下会被JVM的垃圾回收器回收。

• 我们知道ThreadLocal被创建后就会伴随Thread的整个生命周期，假如这个线程的生命周期很长则会导致严重的内存泄漏，下面看具体的情况。

• 运行栈运行过程中假如某个时刻ThreadLocal引用不再指向ThreadLocal对象，则该对象仅仅剩下一个弱引用，这时该对象就会被JVM回收，从而导致Entry的key为null，key为null时就导致ThreadLocalMap无法再找到这个Entry的value。一旦运行时间被拉长，value将一直存在内存中而无法被回收，这样就造成了内存泄漏，整个引用关系为Thread对象->ThreadLocalMap对象->Entry对象->value。

  
  image.png

• 那是不是不要继承WeakReference类，让它默认强引用就不会导致内存泄漏呢？那肯定不是，不然也就不用多此一举了。运行栈运行过程中假如某个时刻ThreadLocal引用不再指向ThreadLocal对象，则ThreadLocal对象因为存在强引用而不被JVM回收，此时除了value无法被回收外，ThreadLocal对象也无法被回收，同样产生内存泄漏问题。

• 综上所述，不管Entry有没有继承WeakReference类都存在内存泄漏问题，如果我们不手动去执行remove操作的话都会导致内存泄漏。那么JDK团队为什么又要继承WeakReference类呢？那是因为他们想采取一些措施来尽量保证内存不泄漏，也就是说他们会在ThreadLocalMap类的get、set、remove方法中去执行一个清除操作，把ThreadLocalMap包含的所有Entry中key为null的value给清除掉，并且将对应的Entry也置为null，以便被JVM回收。

• 所以我们在使用ThreadLocal时要注意的一点是：当我们使用完ThreadLocal时都要手动调用remove方法，从而避免内存泄漏。

总结

• threadlocal的使用还是比较简单的。重点就是要搞清内存泄露的原因。
  创建两个线程，使用同一个threadlocal对象。分别向里边存入1和2.
  当线程结束，threadlocal对象被回收。这时候线程的threadlocalMap中还有这个threadlocal为key的一个entry。如果线程不结束，他就永远不会被回收了。如果是使用线程池，那么线程可能就永远不会结束。

• 针对上边的情况。jdk源码中entry的key这个threadlocal使用的是弱引用，如果threadlocal被回收，那么entry的key就会变成null。在threadlocalmap的set，get的时候，会清理这种key是null的entry。
  比如一个线程有多个threadlocal，一个已经回收了，key是null了。调用另一个的get，set的时候，会吧threadlocalMap中所有的key是null的处理掉。但是这种情况，如果后边再没有调用这些方法了，也就清理不掉了。

• 所以，只要threadlocal用完了，就remove掉，这个时候线程的threadlocalMap中就在没有这个threadlocal的entry了，就不会有内存泄露的风险了。