2、导致 JVM 内存泄露的 ThreadLocal

初秋和

已于 2023-03-19 12:47:06 修改

阅读量91

点赞数

分类专栏：并发编程专题文章标签： jvm java 数据库

于 2023-03-18 20:45:32 首次发布

本文链接：https://blog.csdn.net/one_leafage/article/details/129640364

版权

并发编程专题专栏收录该内容

9 篇文章 0 订阅

订阅专栏

前言

为什么要有ThreadLocal：
首先看一段JDBC原生代码
在这里插入图片描述

可以看到，在使用jdbc的时候，首先要配置后再拿到jdbc连接，然后在增删改查的业务中拿到这个连接，并把我们的SQL语句交给jdbc连接发送到真实的db上执行。
在实际的工作中，我们不会每次执行SQL都临时去创建连接，而是会借助连接池，同时因为实际业务的复杂性，为了保证数据的一致性，我们还会引入事务操作，于是上面的代码就会变成：
在这里插入图片描述
但是上面的代码开启事务后和执行insert操作会获取两个连接，导致事务失效。数据库执行事务的时候必须在一个连接中。实际上，上面的代码要保证数据的一致性，必须要启用分布式事务。
一个解决思路是把数据库连接作为方法的参数，在方法之间传递
在这里插入图片描述

但是我们分析平时我们使用 SSM 的代码会发现，我们在编写数据访问相关代码的时候从来没有把数据库连接作为方法参数进行传递。这意味着，对 Spring来说，在帮我们进行事务托管的时候，会遇到同样的问题，那么 Spring 是如何解决这个问题的？
其实稍微分析下 Spring 的事务管理器的代码就能发现端倪，在org.springframework.jdbc.datasource.DataSourceTransactionManager#doBegin 中，我们会看到如下代码在这里插入图片描述
上面的注释已经很清楚了说明“绑定连接到这个线程”，如何绑定的？继续深入看看
看来，Spring 是使用一个 ThreadLocal 来实现“绑定连接到线程”的。
现在我们可以对 ThreadLocal 下一个比较确切的定义了
This class provides thread-local variables. These variables differ from their
normal counterparts in that each thread that accesses one (via its get or set method)
has its own, independently initialized copy of the variable. ThreadLocal instances are
typically private static fields in classes that wish to associate state with a thread (e.g.,
a user ID or Transaction ID).
此类提供线程局部变量。这些变量与普通对应变量的不同之处在于，访问一个变量的每个线程（通过其 get 或 set 方法）都有自己独立初始化的变量副本。
ThreadLocal 实例通常是希望将状态与线程（例如，用户 ID 或事务 ID）相关联的类中的私有静态字段。
也就是说 ThreadLocal 为每个线程都提供了变量的副本，使得每个线程在某一时间访问到的并非同一个对象，这样就隔离了多个线程对数据的数据共享。
由此也可以看出 ThreadLocal 和 Synchonized 都用于解决多线程并发访问。可是 ThreadLocal 与 synchronized 有本质的差别。synchronized 是利用锁的机制，使变量或代码块在某一时该仅仅能被一个线程访问，ThreadLocal 则是副本机制。此时不论多少线程并发访问都是线程安全的。
ThreadLocal 的一大应用场景就是跨方法进行参数传递，比如 Web 容器中，每个完整的请求周期会由一个线程来处理。结合 ThreadLocal 再使用 Spring 里的IOC 和 AOP，就可以很好的解决我们上面的事务的问题。只要将一个数据库连接放入 ThreadLocal 中，当前线程执行时只要有使用数据库连接的地方就从ThreadLocal 获得就行了。
再比如，在微服务领域，链路跟踪中的 traceId 传递也是利用了 ThreadLocal。

一、ThreadLocal的使用

ThreadLocal的接口很简单，常见的4个方法：

void set(Object value):数组当前线程的局部变量值
public Object get():返回当前线程所对应的局部线程变量
public void remove(）:将当前线程局部变量的值删除。目的是减少内存的占用。JDK1.5后新增的方法。线程结束后，对应改线程的局部变量会自动被垃圾回收，所以显式调用改方法不是必须的操作，但是可以加快内存的回收速度。
protect Object initialValue():返回改线程局部变量的初始值，该方法是一个protected方法，显然是为了让子类覆盖而设计的。这个方法是一个延迟调用方法，在线程第一次调用get或者set时才执行，并且只执行一次。ThreadLocal中缺省实现之间返回一个null.

1、实现解析

怎么实现ThreadLocal，既然说让每个线程都拥有自己变量的副本，最容易的方式就是用一个Map将线程的副本保存起来，map里面的key就是每个线程的唯一性标识，比如线程的ID，value就是副本的值，实现起来很简单：

public class MyThreadLocal<T> {
    private Map<Thread,T> threadTMap = new HashMap<>();
    public synchronized T get(){
        return threadTMap.get(Thread.currentThread());
    }
    public synchronized void set(T t){
        threadTMap.put(Thread.currentThread(),t);
    }
}

考虑到并发安全性，对数据的存取用synchronize关键字加锁，但是DougLee在《并发编程实战》中为我们做过性能测试
在这里插入图片描述
可以看到ThreadLocal的性能远超过synchronize的锁实现ReentrantLock,比我们后面学的AtomicInteger也要快很多，即使我们把map的实现更换为Java中专为并发设计的ConcurrentHashmap也不太可能达到这么高的性能。
怎么样设计可以让Threadlocal达到这么高的性能呢？最好的办法这是让变量副本跟随着线程本身，而不是将变量副本放在一个地方保存，这样就可以在存取时避开线程之间的竞争。
同时，因为每个线程所拥有的副本数是不定的，有些线程可能有一个，有些线程可能有2个甚至更多，则线程内部存放变量副本需要一个容器，而且容器要支持快速存取，所以在每个线程内部都可以持有一个Map来支持多个变量副本，这个Map被称为ThreadLocalMap;

在这里插入图片描述

上面先取到当前线程，然后调用getMap方法获取对应的ThreadLocalMap，ThreadLocalMap是一个声明在ThreadLocal的静态内部类，然后Thread类中有一个这样类型成员变量，也就是ThreadLocalMap实例化是在Thread内部，所以getMap是直接返回Thread的这个成员。
看下ThreadLocal的内部类Thread的LocalMap源码，这里其实是个标准的Map实现，内部有一个元素类型为Entry的数组，用以存放线程可能需要的多个副本变量。
在这里插入图片描述
可以看到有个Entry内部静态类，它继承了WeakReference,总之它记录了两个信息，一个是ThreadLocal<?>类型，一个是Object类型的值。getEntry方法则是获取某个ThreadLocal对应的值，set方法就是更新或赋值响应的ThreadLocal对应的值。在这里插入图片描述
回顾我们的get的方法，其实就是拿到每个线程独有的ThreadLocalMap，然后再用ThreadLocal的当前实例，拿到Map中相应的Entry，然后就可以拿到相应的值返回出去。当然，如果Map为空，还会先进行Map的创建，初始化工作等。

2、Hash冲突的解决

什么是Hash，就是把任意长度的输入，通过散列算法变换成固定长度输出，该输出就是散列值，输入的微小变化会导致输出的巨大变化。所以hash常用在消息摘要或者签名上，常用hash消息摘要算法有：MD4、MD5、SHA-1
hash转换是一种压缩映射，也就是，散列值的空间通常远小于输入的空间，不同的输入可能会散列成相同的输出，所以不可能从散列值来确定唯一的输入值。例如有10000个数放到100个桶里面，不管怎么放，有个桶里面的数字个数一定是大于2的。
所以hash简单的说就是一种将任意长度的消息压缩到某一固定长度的消息摘要的函数。常用的hash函数：直接取余法，平方取中法、乘法取整法。Java里面的hashmap用的就是直接取余法。
我们知道hash属于压缩映射，一定能产生多个实际值映射为一个hash值的情况，这就产生了冲突，常见处理hash冲突的方法：
1、开发定址法：基本思想是，出现冲突后按照一定算法查找一个空位置存放，根据算法的不同又可以分为线性探测再散列、二次探测再散列、伪随机探测再散列。
线性探测再散列即依次向后查找，二次探测再散列，即依次向前后查找，增量为 1、2、3 的二次方，伪随机，顾名思义就是随机产生一个增量位移。
ThreadLocal 里用的则是线性探测再散列在这里插入图片描述
2、链地址法：这种方法的基本思想是将所有哈希地址为 i 的元素构成一个称为同义词链的单链表，并将单链表的头指针存在哈希表的第 i 个单元中，因而查找、插入和删除主要在同义词链中进行。链地址法适用于经常进行插入和删除的情况。Java里的 HashMap 用的就是链地址法，为了避免 hash 洪水攻击，1.8 版本开始还引入了红黑树。
3、再哈希法：
这种方法是同时构造多个不同的哈希函数：Hi=RH1（key） i=1，2，…，k当哈希地址 Hi=RH1（key）发生冲突时，再计算 Hi=RH2（key）……，直到冲突不再产生。这种方法不易产生聚集，但增加了计算时间。
4、建立公共溢出区
这种方法的基本思想是：将哈希表分为基本表和溢出表两部分，凡是和基本表发生冲突的元素，一律填入溢出表。

2、引发内存泄漏分析

引用 Object o = new Object();这个o我们可以称之为对象引用，而new Object()可以称为在内存中产生了一个对象实例。在这里插入图片描述
当写下o=null时，只是表示o不再指向堆内存中object的对象实例，不代表这个对象实例不存在了。
强引用是指在程序代码之中普遍存在的，类似“Object obj=new Object（）”这类的引用，只要强引用还存在，垃圾收集器永远不会回收掉被引用的对象实例。
软引用是用来描述一些还有用但并非必需的对象。对于软引用关联着的对象，在系统将要发生内存溢出异常之前，将会把这些对象实例列进回收范围之中进行第二次回收。如果这次回收还没有足够的内存，才会抛出内存溢出异常。在 JDK1.2 之后，提供了 SoftReference 类来实现软引用。
弱引用也是用来描述非必需对象的，但是它的强度比软引用更弱一些，被弱引用关联的对象实例只能生存到下一次垃圾收集发生之前。当垃圾收集器工作时，无论当前内存是否足够，都会回收掉只被弱引用关联的对象实例。在 JDK 1.2 之后，提供了 WeakReference 类来实现弱引用。
虚引用也称为幽灵引用或者幻影引用，它是最弱的一种引用关系。一个对象实例是否有虚引用的存在，完全不会对其生存时间构成影响，也无法通过虚引用来取得一个对象实例。为一个对象设置虚引用关联的唯一目的就是能在这个对象实例被收集器回收时收到一个系统通知。在 JDK 1.2 之后，提供了PhantomReference 类来实现虚引用。
内存泄漏的现象

public class ThreadLocalMemoryLeak {
    private static final int TASK_LOOP_SIZE = 500;

    /*线程池*/
    final static ThreadPoolExecutor poolExecutor
            = new ThreadPoolExecutor(5, 5, 1,
            TimeUnit.MINUTES,
            new LinkedBlockingQueue<>());

    static class LocalVariable {
        private byte[] a = new byte[1024*1024*5];/*5M大小的数组*/
    }

    ThreadLocal<LocalVariable> threadLocalLV;

    public static void main(String[] args) throws InterruptedException {
        SleepTools.ms(4000);
        for (int i = 0; i < TASK_LOOP_SIZE; ++i) {
            poolExecutor.execute(new Runnable() {
                public void run() {
                    SleepTools.ms(500);
 // 1 会自动清除                   LocalVariable localVariable = new LocalVariable();
//
//
//  2、不会 自动清除                  ThreadLocalMemoryLeak oom = new ThreadLocalMemoryLeak();
//                    oom.threadLocalLV = new ThreadLocal<>();
//                    oom.threadLocalLV.set(new LocalVariable());
//
//                   oom.threadLocalLV.remove();

                    System.out.println("use local varaible");

                }
            });

            SleepTools.ms(100);
        }
        System.out.println("pool execute over");
    }

}

我们启用一个线程池大小固定为5个线程,并将堆内存大小设置为-Xmx256m

场景 1，首先任务中不执行任何有意义的代码，当所有的任务提交执行完成后，可以看见，我们这个应用的内存占用基本上为 25M 左右
在这里插入图片描述
场景 2，然后我们只简单的在每个任务中 new 出一个数组，执行完成后我们可以看见，内存占用基本和场景 1 相同

场景 3，当我们启用了 ThreadLocal 以后：
执行完成后我们可以看见，内存占用变为了 100 多 M
场景 4，于是，我们加入一行代码，再执行，看看内存情况: 在这里插入图片描述
可以看见，内存占用基本和场景 1 同。
这就充分说明，场景 3，当我们启用了 ThreadLocal 以后确实发生了内存泄漏。
分析
根据我们前面对ThreadLocal的分析，可以知道每个thread维护一个threadlocalmap，这个映射表的key是ThreadLocal实例本身，value是真正需要存储的object，也就是说ThreadLocal本身并不存储值，它只是作为一个key来让线程从ThreadLocalMap获取value。仔细观察ThreadLocalMap,这个map是使用ThreadLocal的弱引用作为key的，弱引用的对象在GC时会被回收。
因此使用了ThreadLocal后，引用链如图所示
在这里插入图片描述

图中虚线表示弱引用
这样，当把ThreadLocal变量置为null以后，没有任何强引用指向ThreadLocal实例，所以ThreadLocal会被gc回收。这样一来，ThreadLocalMap中就会出现key为null的entry，就没有办法访问这些key为null的entry的value就会一直存在一条强引用链：Thread Ref -> Thread -> ThreaLocalMap -> Entry -> value，而这块 value 永远不会被访问到了，所以存在着内存泄露。
只有当前 thread 结束以后，current thread 就不会存在栈中，强引用断开，Current Thread、Map value 将全部被 GC 回收。最好的做法是不在需要使用ThreadLocal 变量后，都调用它的 remove()方法，清除数据。
所以回到我们前面的实验场景，场景 3 中，虽然线程池里面的任务执行完毕了，但是线程池里面的 5 个线程会一直存在直到 JVM 退出，我们 set 了线程的localVariable 变量后没有调用 localVariable.remove()方法，导致线程池里面的 5 个线程的 threadLocals 变量里面的 new LocalVariable()实例没有被释放。
其实考察 ThreadLocal 的实现，我们可以看见，无论是 get()、set()在某些时候，调用了 expungeStaleEntry 方法用来清除 Entry 中 Key 为 null 的 Value，但是这是不及时的，也不是每次都会执行的，所以一些情况下还是会发生内存泄露。
只有 remove()方法中显式调用了 expungeStaleEntry 方法。
从表面上看内存泄漏的根源在于使用了弱引用，但是另一个问题也同样值得思考：为什么使用弱引用而不是强引用？
下面我们分两种情况讨论：
key 使用强引用：对 ThreadLocal 对象实例的引用被置为 null 了，但是ThreadLocalMap 还持有这个 ThreadLocal 对象实例的强引用，如果没有手动删除，ThreadLocal 的对象实例不会被回收，导致 Entry 内存泄漏。
key 使用弱引用：对 ThreadLocal 对象实例的引用被被置为 null 了，由于ThreadLocalMap 持有 ThreadLocal 的弱引用，即使没有手动删除，ThreadLocal 的对象实例也会被回收。value 在下一次 ThreadLocalMap 调用 set，get，remove 都有机会被回收。
比较两种情况，我们可以发现：由于 ThreadLocalMap 的生命周期跟 Thread一样长，如果都没有手动删除对应 key，都会导致内存泄漏，但是使用弱引用可以多一层保障。
因此，ThreadLocal 内存泄漏的根源是：由于 ThreadLocalMap 的生命周期跟Thread 一样长，如果没有手动删除对应 key 就会导致内存泄漏，而不是因为弱引用。
总结
JVM 利用设置 ThreadLocalMap 的 Key 为弱引用，来避免内存泄露。
JVM 利用调用 remove、get、set 方法的时候，回收弱引用。
当 ThreadLocal 存储很多 Key 为 null 的 Entry 的时候，而不再去调用 remove、get、set 方法，那么将导致内存泄漏。
使用线程池+ ThreadLocal 时要小心，因为这种情况下，线程是一直在不断的重复运行的，从而也就造成了 value 可能造成累积的情况。

二、错误使用 ThreadLocal 导致线程不安全

参见代码：在这里插入图片描述
结果是：
为什么每个线程都输出 115？难道他们没有独自保存自己的 Number 副本吗？
为什么其他线程还是能够修改这个值？仔细考察 ThreadLocal 和 Thead 的代码，我们发现 ThreadLocalMap 中保存的其实是对象的一个引用，这样的话，当有其他线程对这个引用指向的对象实例做修改时，其实也同时影响了所有的线程持有的对象引用所指向的同一个对象实例。这也就是为什么上面的程序为什么会输出一样的结果。
&而上面的程序要正常的工作，应该的用法是让每个线程中的 ThreadLocal 都应该持有一个新的 Number 对象。在这里插入图片描述