ThreadLocal之内存泄漏

ゞ浴缸里的玫瑰 2023-02-15 03:57 16阅读 0赞

![format_png][]

点击上方蓝色字体，关注我们

![format_png 1][]

使用 ThreadLocal 不当可能会导致内存泄露，是什么原因导致的内存泄漏呢？

我们首先看一个例子，代码如下：

public class ThreadLocalOutOfMemoryTest {
        static class LocalVariable {
            private Long[] a = new Long[1024*1024];
        }
    
        // (1)
     final static ThreadPoolExecutor poolExecutor = new ThreadPoolExecutor(6,6,1,TimeUnit.MINUTES,
                new LinkedBlockingQueue<>());
        // (2)
        final static ThreadLocal<LocalVariable> localVariable = new ThreadLocal<LocalVariable>();
    
        public static void main(String[] args) throws InterruptedException {
            // (3)
            for (int i = 0; i < 50; ++i) {
                poolExecutor.execute(new Runnable() {
                    public void run() {
                        // (4)
                        localVariable.set(new LocalVariable());
                        // (5)
                        System.out.println("use local varaible");
    //                    localVariable.remove();
    
                    }
                });
    
                Thread.sleep(1000);
            }
            // (6)
            System.out.println("pool execute over");
        }
    }

代码（1）创建了一个核心线程数和最大线程数为 6 的线程池，这个保证了线程池里面随时都有 6 个线程在运行。

代码（2）创建了一个 ThreadLocal 的变量，泛型参数为 LocalVariable，LocalVariable 内部是一个 Long 数组。

代码（3）向线程池里面放入 50 个任务。

代码（4）设置当前线程的 localVariable 变量，也就是把 new 的 LocalVariable 变量放入当前线程的 threadLocals 变量。

由于没有调用线程池的 shutdown 或者 shutdownNow 方法所以线程池里面的用户线程不会退出，进而 JVM 进程也不会退出。

运行后，我们立即打开jconsole 监控堆内存变化，如下图：

![format_png 2][]

接着，让我们打开 localVariable.remove() 注释，然后在运行，观察堆内存变化如下:

![format_png 3][]

从第一次运行结果可知，当主线程处于休眠时候进程占用了大概 75M 内存，打开 localVariable.remove() 注释后第二次运行则占用了大概 25M 内存，可知 没有写 localVariable.remove() 时候内存发生了泄露，下面分析下泄露的原因，如下：

第一次运行的代码，在设置线程的 localVariable 变量后没有调用`localVariable.remove()` 方法，导致线程池里面的 5 个线程的 threadLocals 变量里面的`new LocalVariable()`实例没有被释放，虽然线程池里面的任务执行完毕了，但是线程池里面的 5 个线程会一直存在直到 JVM 退出。这里需要注意的是由于 localVariable 被声明了 static，虽然线程的 ThreadLocalMap 里面是对 localVariable 的弱引用，localVariable 也不会被回收。运行结果二的代码由于线程在设置 localVariable 变量后即使调用了`localVariable.remove()`方法进行了清理，所以不会存在内存泄露。

接下来我们要想清楚的知道内存泄漏的根本原因，那么我们就要进入源码去看了。

我们知道ThreadLocal 只是一个工具类，具体存放变量的是在线程的 threadLocals 变量里面，threadLocals 是一个 ThreadLocalMap 类型的，我们首先一览ThreadLocalMap的类图结构，类图结构如下图：

![format_png 4][]

如上图 ThreadLocalMap 内部是一个 Entry 数组, Entry 继承自 WeakReference，Entry 内部的 value 用来存放通过 ThreadLocal 的 set 方法传递的值，那么 ThreadLocal 对象本身存放到哪里了吗?

下面看看 Entry 的构造函数，如下所示：

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

接着我们再接着看Entry的父类WeakReference的构造函数super（k），如下所示：

public WeakReference(T referent) {
       super(referent);
    }

接着我们再看WeakReference的父类Reference的构造函数super（referent），如下所示：

Reference(T referent) {
       this(referent, null);
    }

接着我们再看WeakReference的父类Reference的另外一个构造函数this（referent , null），如下所示：

Reference(T referent, ReferenceQueue<? super T> queue) {
       this.referent = referent;
       this.queue = (queue == null) ? ReferenceQueue.NULL : queue;
    }

可知 k 被传递到了 WeakReference 的构造函数里面，也就是说 ThreadLocalMap 里面的 key 为 ThreadLocal 对象的弱引用，具体是 referent 变量引用了 ThreadLocal 对象，value 为具体调用 ThreadLocal 的 set 方法传递的值。

当一个线程调用 ThreadLocal 的 set 方法设置变量时候，当前线程的 ThreadLocalMap 里面就会存放一个记录，这个记录的 key 为 ThreadLocal 的引用，value 则为设置的值。

但是考虑如果这个 ThreadLocal 变量没有了其他强依赖，而当前线程还存在的情况下，由于线程的 ThreadLocalMap 里面的 key 是弱依赖，则当前线程的 ThreadLocalMap 里面的 ThreadLocal 变量的弱引用会被在 gc 的时候回收，但是对应 value 还是会造成内存泄露，这时候 ThreadLocalMap 里面就会存在 key 为 null 但是 value 不为 null 的 entry 项。

其实在 ThreadLocal 的 set 和 get 和 remove 方法里面有一些时机是会对这些 key 为 null 的 entry 进行清理的，但是这些清理不是必须发生的，下面简单讲解ThreadLocalMap 的 remove 方法的清理过程，remove 的源码，如下所示：

private void remove(ThreadLocal<?> key) {
    
      //(1)计算当前ThreadLocal变量所在table数组位置，尝试使用快速定位方法
      Entry[] tab = table;
      int len = tab.length;
      int i = key.threadLocalHashCode & (len-1);
      //(2)这里使用循环是防止快速定位失效后，变量table数组
      for (Entry e = tab[i]; e != null; e = tab[i = nextIndex(i, len)]) {
          //(3)找到
          if (e.get() == key) {
              //(4)找到则调用WeakReference的clear方法清除对ThreadLocal的弱引用
              e.clear();
              //(5)清理key为null的元素
              expungeStaleEntry(i);
              return;
          }
       }
    }
     private int expungeStaleEntry(int staleSlot) {
                Entry[] tab = table;
                int len = tab.length;
                //（6）去掉去value的引用
                tab[staleSlot].value = null;
                tab[staleSlot] = null;
                size--;
    
    Entry e;
                int i;
                for (i = nextIndex(staleSlot, len); (e = tab[i]) != null; i = nextIndex(i, len)) {
                    ThreadLocal<?> k = e.get();
                    //(7)如果key为null,则去掉对value的引用。
                    if (k == null) {
                        e.value = null;
                        tab[i] = null;
                        size--;
                    } else {
                        int h = k.threadLocalHashCode & (len - 1);
                        if (h != i) {
                            tab[i] = null;
                            while (tab[h] != null)
                                h = nextIndex(h, len);
                            tab[h] = e;
                        }
                    }
                }
                return i;
      }

代码（4）调用了 Entry 的 clear 方法，实际调用的是父类 WeakReference 的 clear 方法，作用是去掉对 ThreadLocal 的弱引用。

代码（6）是去掉对 value 的引用，到这里当前线程里面的当前 ThreadLocal 对象的信息被清理完毕了。

代码（7）从当前元素的下标开始看 table 数组里面的其他元素是否有 key 为 null 的，有则清理。循环退出的条件是遇到 table 里面有 null 的元素。所以这里知道 null 元素后面的 Entry 里面 key 为 null 的元素不会被清理。

##  ##

总结

1.ThreadLocalMap 内部 Entry 中 key 使用的是对 ThreadLocal 对象的弱引用，这为避免内存泄露是一个进步，因为如果是强引用，那么即使其他地方没有对 ThreadLocal 对象的引用，ThreadLocalMap 中的 ThreadLocal 对象还是不会被回收，而如果是弱引用则这时候 ThreadLocal 引用是会被回收掉的。

2.但是对于的 value 还是不能被回收，这时候 ThreadLocalMap 里面就会存在 key 为 null 但是 value 不为 null 的 entry 项，虽然 ThreadLocalMap 提供了 set,get,remove 方法在一些时机下会对这些 Entry 项进行清理，但是这是不及时的，也不是每次都会执行的，所以一些情况下还是会发生内存泄露，所以在使用完毕后即使调用 remove 方法才是解决内存泄露的最好办法。

3.线程池里面设置了 ThreadLocal 变量一定要记得及时清理，因为线程池里面的核心线程是一直存在的，如果不清理，那么线程池的核心线程的 threadLocals 变量一直会持有 ThreadLocal 变量。

![format_png 5][]

[TCP 知识脉络大全，建议收藏再看][TCP]

[Java垃圾收集器一网打尽， ZGC 和 Shenandoah 听说过吗][Java_ ZGC _ Shenandoah]

[动图帮你理解【Java垃圾收集机制】][Java]

[一文搞懂 JVM 架构和运行时数据区 (内存区域)][JVM _]

[为什么你的 Spring Task 定时任务没有定时执行？][Spring Task]

[搞java开发，看懂JVM的GC日志真的很重要][java_JVM_GC]

[一次容器化springboot程序OOM问题探险][springboot_OOM]

[Java 应用性能调优的一些实践][Java 1]

[可视化界面在线生成JVM参数][JVM]

![format_png 6][]

![format_png 7][]

![format_png 8][]

[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2dpZi9FZUpTdXJyRnVYTjhrNzR4dEJwZWljdVhXTXk5QWptVHM2Q3pMR1JmcDVLRnpKNDlFVlNYRFRZajJudHVUb0JOdGVuVGpDRUVaQnVldXRoRElnTzl5TEEvNjQw?x-oss-process=image/format,png
[format_png 1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2pwZy94aWNXWVRTSUN6UnRMaHFhWDV4WFQzNGFLaGRQbkdiaWFWM3FvcHU1TEx6ODRUaWFzRWN6SXdNQVhXaWNhZ0dhSEFCNHlMaWNEd2VheExsbDRqUHdlUHJXRnR3LzY0MA?x-oss-process=image/format,png
[format_png 2]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy94aWNXWVRTSUN6UnRMaHFhWDV4WFQzNGFLaGRQbkdiaWFWVVFES0kzekxrbllpYTdqSkJHNnVVUUNzbkl2NXZKSWhwMzB1ZU04NlhRQWdEOGZpY3VWNlJqSGcvNjQw?x-oss-process=image/format,png
[format_png 3]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy94aWNXWVRTSUN6UnRMaHFhWDV4WFQzNGFLaGRQbkdiaWFWbUtFWWtmMmY4cmFaRHNvcG9YbEJreEJrQ2ZXMmZwN2ZiV0pQTHMwUkRudjZTaHpINUxpY1ZuUS82NDA?x-oss-process=image/format,png
[format_png 4]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy94aWNXWVRTSUN6UnRMaHFhWDV4WFQzNGFLaGRQbkdiaWFWS1pPSjU2TncxMXlHZ0xZTzcya0ppYm1vaWE2SFN4M2ZwNWgyZkFpY1lnVTlMUW1pYTdmSlRXeVJwdy82NDA?x-oss-process=image/format,png
[format_png 5]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2dpZi94aWNXWVRTSUN6UnRDYWxzMWRGZFVjZ1lTWDVFMFhQN2liWklsc2FpYzNnMGg5TWtDT2VONkI5aWNuOHJCa3Z0TnBWbmxoc2hGQ1BxNHFXcjFxMnJYdk5HSmcvNjQw?x-oss-process=image/format,png
[TCP]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44f6a7cb337fb18dcf3687184cfe7ab9512fcd4f65723dd7c3085976a8d2bad7011264ca8c&idx=1&mid=2247484318&scene=21&sn=2622d390580903dfb9d0c20860144fb8#wechat_redirect
[Java_ ZGC _ Shenandoah]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44f6a3cb337fb5178467fa7493fa9ec02a4483368d586d3f64f70923119ea5bcba2b637a3e&idx=1&mid=2247484314&scene=21&sn=747414155ae8ccbe83c886229aa91650#wechat_redirect
[Java]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44f6abcb337fbd28546c59d12a5c29b33866b5fd281cfd6ef8191572a2cb3b2ad9652a8b32&idx=1&mid=2247484306&scene=21&sn=0dfd877e423f2c22278edaa3fb79afc3#wechat_redirect
[JVM _]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44f6bfcb337fa9e8b7a24847c566565dad8f8768988c0fa94c6f9ef98e840362a23c37c4e4&idx=1&mid=2247484294&scene=21&sn=69755e078a0d992dc5cceeebecf4d683#wechat_redirect
[Spring Task]: https://blog.csdn.net/u012811805/article/details/105131364
[java_JVM_GC]: https://blog.csdn.net/u012811805/article/details/105131324
[springboot_OOM]: https://blog.csdn.net/u012811805/article/details/101085547
[Java 1]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44f7dccb337ecadd6f748c4d5aae213003d3cc40c501d9865591e18539343083070888203b&idx=1&mid=2247484133&scene=21&sn=70156fc59563970321007d04a3d160b0#wechat_redirect
[JVM]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44f7e6cb337ef0bf114949eec1eb93e404f8ae64988a03cdc53a014119f496172a5de568f4&idx=1&mid=2247484127&scene=21&sn=92e774ee1edc2dd0013c60f1347d0fe6#wechat_redirect
[format_png 6]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X3BuZy94aWNXWVRTSUN6UnZ6aGRLck1pY1NQSWliZzhQRWJPa2E4bmpjOHJFZmFLa09YTHAyd21wckxpY0JRaWNYMWlhdVFzWEdTTDlpYXhreFZTb3RQQ2F2U2hva1NvVHcvNjQw?x-oss-process=image/format,png
[format_png 7]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2dpZi9MRk5lc2hnczFIMWliRUt2VGlicUl3dmljWVR0YlhieGljYVRnM1BaMGRmS0MyaFl5aWNSR1JRQmlhQmtuS3lTU25qRUVxQWdMQmZSR0tHb29xSG03UzBVMjRlZy82NDA?x-oss-process=image/format,png
[format_png 8]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9tbWJpei5xcGljLmNuL21tYml6X2pwZy94aWNXWVRTSUN6UnRMaHFhWDV4WFQzNGFLaGRQbkdiaWFWSld4TENqM0JNbndsdEt5Y2ZIYjY0cVB1eGlhQXZSMmsyUDl5SzhPZ1I5N0ZMb1duM09EUmljdWcvNjQw?x-oss-process=image/format,png