ThreadLocal出现OOM内存溢出的场景和原理分析

一、案例代码

1、首先看一下代码,模拟了一个线程数为500的线程池,所有线程共享一个ThreadLocal变量,每一个线程执行的时候插入一个大的List集合:
ThreadLocal出现OOM内存溢出的场景和原理分析
ThreadLocal出现OOM内存溢出的场景和原理分析

2、设置JVM参数设置最大内存为256M,以便模拟出OOM:
ThreadLocal出现OOM内存溢出的场景和原理分析

3、运行代码,输出结果:
ThreadLocal出现OOM内存溢出的场景和原理分析

可以看出,单线程池执行到第212的时候,就报了错误,出现OOM内存溢出错误。
4、在运行代码的时候,同时打开JDK工具jConsole 监控内存变化:
ThreadLocal出现OOM内存溢出的场景和原理分析

可以看出,上述内存一直递增到JVM设置的最大值,然后抛出异常,程序退出。
5、这个实例可以很好的演示了:线程池的一个线程使用完ThreadLocal对象之后,再也不用,由于线程池中的线程不会退出,线程池中的线程的存在,同时ThreadLocal变量也会存在,占用内存!造成OOM溢出!

二、ThreadLocal为什么会内存泄漏

在上一篇的时候,已经简单的介绍了不正当的使用ThreadLocal造成OOM的原因,下边详细的介绍一下:
1、首先看一下ThreadLocal的原理图:
在ThreadLocal的生命周期中,都存在这些引用。看下图: 实线代表强引用,虚线代表弱引用。
ThreadLocal出现OOM内存溢出的场景和原理分析
2、ThreadLocal的实现是这样的:每个Thread 维护一个 ThreadLocalMap 映射表,这个映射表的 key 是 ThreadLocal实例本身,value 是真正需要存储的 Object。

3、也就是说 ThreadLocal 本身并不存储值,它只是作为一个 key 来让线程从 ThreadLocalMap 获取 value。值得注意的是图中的虚线,表示 ThreadLocalMap 是使用 ThreadLocal 的弱引用作为 Key 的,弱引用的对象在 GC 时会被回收。

4、ThreadLocalMap使用ThreadLocal的弱引用作为key,如果一个ThreadLocal没有外部强引用来引用它,那么系统 GC 的时候,这个ThreadLocal势必会被回收,这样一来,ThreadLocalMap中就会出现key为null的Entry,就没有办法访问这些key为null的Entry的value,如果当前线程再迟迟不结束的话,这些key为null的Entry的value就会一直存在一条强引用链:Thread Ref -> Thread -> ThreaLocalMap -> Entry -> value永远无法回收,造成内存泄漏。

5、总的来说就是,ThreadLocal里面使用了一个存在弱引用的map, map的类型是ThreadLocal.ThreadLocalMap. Map中的key为一个threadlocal实例。这个Map的确使用了弱引用,不过弱引用只是针对key。每个key都弱引用指向threadlocal。 当把threadlocal实例置为null以后,没有任何强引用指向threadlocal实例,所以threadlocal将会被gc回收。
但是,我们的value却不能回收,而这块value永远不会被访问到了,所以存在着内存泄露。因为存在一条从current thread连接过来的强引用。只有当前thread结束以后,current thread就不会存在栈中,强引用断开,Current Thread、Map value将全部被GC回收。最好的做法是将调用threadlocal的remove方法,这也是等会后边要说的。

6、其实,ThreadLocalMap的设计中已经考虑到这种情况,也加上了一些防护措施:在ThreadLocal的get(),set(),remove()的时候都会清除线程ThreadLocalMap里所有key为null的value。这一点在上一节中也讲到过!

7、但是这些被动的预防措施并不能保证不会内存泄漏:

(1)使用static的ThreadLocal,延长了ThreadLocal的生命周期,可能导致内存泄漏。
(2)分配使用了ThreadLocal又不再调用get(),set(),remove()方法,那么就会导致内存泄漏,因为这块内存一直存在。

三、为什么使用弱引用,OOM是否是弱引用的锅?

1、从表面上看内存泄漏的根源在于使用了弱引用。网上的文章大多着重分析ThreadLocal使用了弱引用会导致内存泄漏,但是另一个问题也同样值得思考:为什么使用弱引用而不是强引用?

我们先来看看官方文档的说法:
ThreadLocal出现OOM内存溢出的场景和原理分析
下面我们分两种情况讨论:

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

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

比较两种情况,我们可以发现:由于ThreadLocalMap的生命周期跟Thread一样长,如果都没有手动删除对应key,都会导致内存泄漏,但是使用弱引用可以多一层保障:弱引用ThreadLocal不会内存泄漏,对应的value在下一次ThreadLocalMap调用set、get、remove的时候会被清除。

因此,ThreadLocal内存泄漏的根源是:由于ThreadLocalMap的生命周期跟Thread一样长,如果没有手动删除对应key就会导致内存泄漏,而不是因为弱引用。

四、ThreadLocal 最佳实践

1、综合上面的分析,我们可以理解ThreadLocal内存泄漏的前因后果,那么怎么避免内存泄漏呢?

答案就是:每次使用完ThreadLocal,都调用它的remove()方法,清除数据。

在使用线程池的情况下,没有及时清理ThreadLocal,不仅是内存泄漏的问题,更严重的是可能导致业务逻辑出现问题。所以,使用ThreadLocal就跟加锁完要解锁一样,用完就清理。

注意:

并不是所有使用ThreadLocal的地方,都在最后remove(),他们的生命周期可能是需要和项目的生存周期一样长的,所以要进行恰当的选择,以免出现业务逻辑错误!但首先应该保证的是ThreadLocal中保存的数据大小不是很大!

2、那么我们修改最开始的代码为:

取消注释:threadLocal.remove(); 结果不会出现OOM,可以看出堆内存的变化呈现锯齿状,证明每一次remove()之后,ThreadLocal的内存释放掉了!线程池中的线程的数量持续增加!
ThreadLocal出现OOM内存溢出的场景和原理分析
取消注释:threadLocal.remove(); 结果不会出现OOM,可以看出堆内存的变化呈现锯齿状,证明每一次remove()之后,ThreadLocal的内存释放掉了!线程池中的线程的数量持续增加!
ThreadLocal出现OOM内存溢出的场景和原理分析
ThreadLocal出现OOM内存溢出的场景和原理分析

上一篇:JVM 在遇到OOM(OutOfMemoryError)时生成Dump文件的三种方式


下一篇:学习笔记之ANR_OOM