线上系统因为一个ThreadLocal直接内存飙升

hello大家好 我是大家的学习成长小伙伴Captain

前言

大家对于ThreadLocal这一个都应该听说过的吧，不知道大家对于这个掌握的怎么样了已经

这不，我那爱学习的表妹不知道又从哪里听来了这个技术点，回家就得意洋洋的给我说，表哥，我今天又学会了一个技术点ThreadLocal

哦，不错啊

你你这态度，好像不太信的样子啊，表妹咬牙切齿的说着

没没没，我信。我表妹那么聪明伶俐，肯定会

不行，你这态度太敷衍了，不信我给你讲一遍

得，你也先别给我讲了，你把你的Mac拿过来，我给你写个东西

接过她的Mac，我三下五除二给她写了一个小例子

public class ThreadPool {    private static final ThreadPoolExecutor poolExecutor = new ThreadPoolExecutor(10, 10, 1, TimeUnit.MINUTES, new LinkedBlockingQueue<>());    public static void main(String[] args) throws InterruptedException {        for (int i = 0; i < 1000; ++i) {            poolExecutor.execute(new Runnable() {                @Override                public void run() {                    ThreadLocal threadLocal = new ThreadLocal<>();                    threadLocal.set(new BigObject());                    // 其他业务代码                }            });            Thread.sleep(1000);        }    }    static class BigObject {        // 100M        private byte[] bytes = new byte[100 * 1024 * 1024];    }}

你先看看这段代码，给我说说你的理解

表妹眉头一皱，你这是侮辱我的智商吗，这不就是创建了一个线程池，然后使用for循环增加线程，往线程池里面提交一千个任务吗

这也没啥问题啊，每个任务会向ThreadLocal变量里面塞一个大对象，然后执行其他业务逻辑

总之，看着没啥大毛病，这就是表妹的结论

如果你觉得这段代码没啥问题，那看来你对ThreadLocal学的还是不够彻底啊

代码分析

来，我来给你透彻的说一遍，包教包会

先分析一下上面的代码

• 创建一个核心线程数和最大线程数都为10的线程池，保证线程池里一直会有10个线程在运行。

• 使用for循环向线程池中提交了100个任务。

• 定义了一个ThreadLocal类型的变量，Value类型是大对象。

• 每个任务会向threadLocal变量里塞一个大对象，然后执行其他业务逻辑。

• 由于没有调用线程池的shutdown方法，线程池里的线程还是会在运行。

说个结论

上面的代码会造成内存泄漏，会让服务的内存一直很高，即使GC之后也不会降低太多，这不是我们想要的结果

ThreadLocal存储模型

在ThreadLocal的内部有一个静态内部类ThreadLocalMap，这个才是真正存储对象的Map，我们平时使用的set存储的值实际上是存储到这里面的

 static class ThreadLocalMap {    // 定义一个table数组，存储多个threadLocal对象及其value值    private Entry[] table;    ThreadLocalMap(ThreadLocal firstKey, Object firstValue) {        table = new Entry[INITIAL_CAPACITY];        int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);        table[i] = new Entry(firstKey, firstValue);        size = 1;        setThreshold(INITIAL_CAPACITY);    }    // 定义一个Entry类，key是一个弱引用的ThreadLocal对象    // value是任意对象   static class Entry extends WeakReference> {        /** The value associated with this ThreadLocal. */        Object value;        Entry(ThreadLocal k, Object v) {            super(k);            value = v;        }    }    // 省略其他}

public class ThreadLocal {
 public void set(T value) {        Thread t = Thread.currentThread();        ThreadLocalMap map = getMap(t);        if (map != null)            map.set(this, value);        else            createMap(t, value);    }
    ThreadLocalMap getMap(Thread t) {        return t.threadLocals;    }
    void createMap(Thread t, T firstValue) {        t.threadLocals = new ThreadLocalMap(this, firstValue);    }    // 省略其他方法}

set的逻辑其实也是很简单的，获取当前线程的ThreadLocalMap，然后就直接往map里面添加Key和Value，而这个Key就是this，这个this就是ThreadLocal实例本身了

value就是我们要存储的数据

这里需要注意一下，map的获取是需要从Thread类对象里面取，看一下Thread类的定义。

public class Thread implements Runnable {    ThreadLocal.ThreadLocalMap threadLocals = null;    //省略其他}

ThreadLocal的get方法

class ThreadLocal {
    public T get() {        Thread t = Thread.currentThread();        ThreadLocalMap map = getMap(t);        if (map != null) {            ThreadLocalMap.Entry e = map.getEntry(this);            if (e != null)                return (T)e.value;        }        return setInitialValue();    }}

ThreadLocal的内部关系

ThreadLocal内存模型

图中左边是栈，右边是堆。线程的一些局部变量和引用使用的内存属于Stack（栈）区，而普通的对象是存储在Heap（堆）区。

• 线程运行时，我们定义的TheadLocal对象被初始化，存储在Heap，同时线程运行的栈区保存了指向该实例的引用，也就是图中的ThreadLocalRef。

• 当ThreadLocal的set/get被调用时，虚拟机会根据当前线程的引用也就是CurrentThreadRef找到其对应在堆区的实例，然后查看其对用的TheadLocalMap实例是否被创建，如果没有，则创建并初始化。

• Map实例化之后，也就拿到了该ThreadLocalMap的句柄，那么就可以将当前ThreadLocal对象作为key，进行存取操作。

• 图中的虚线，表示key对应ThreadLocal实例的引用是个弱引用。

四种引用

ThreadLocal中的弱引用和内存泄漏

static class ThreadLocalMap {    // 定义一个Entry类，key是一个弱引用的ThreadLocal对象    // value是任意对象    static class Entry extends WeakReference> {        /** The value associated with this ThreadLocal. */        Object value;        Entry(ThreadLocal k, Object v) {            super(k);            value = v;        }    }}

我们先来看下Entry的实现，Key会被保存到弱引用WeakReference中

这里的Key作为弱引用是关键，我们分两种情况来讨论

Key作为强引用的时候

引用ThreadLocal的对象被回收了，但是ThreadLocalMap还有ThreadLocal的强引用，所以如果没有进行手动删除的话，ThreadLocal是不会被GC回收的，也就是会导致Entry的内存泄露

一句话，强引用的时候需要手动删除才会释放内存

Key作为弱引用的时候

引用ThreadLocal的对象被回收了之后，由于ThreadLocalMap持有的是ThreadLocal的弱引用，即使不会手动删除这个ThreadLocal，这个ThreadLocal也会被回收

前提是该对象只被弱引用所关联，别的强引用关联不到！

而Value则是在下一次调用get、set、remove的时候进行清除，才会被GC自动回收

一句话，弱引用是多一层屏障，无外部强引用的时候，弱引用ThreadLocal会被GC回收，但是该ThreadLocal对应的Value只有执行set、get和remove的时候才会被清除

比较这两种情况

由于ThreadLocalMap的生命周期是和Thread一样的，因为它是Thread内部实现的，如果没有手动删除对应的key，都会导致内存泄漏

而ThreadLocal使用弱引用，会多了一层保障，ThreadLocal在被清理之后，也就是Map中的key会变成null，在使用对应value的时候就会将这个value进行清除

但是！但是！但是！

使用弱引用并不代表不需要考虑内存泄漏，只是多了一层屏障而已！

造成内存泄漏的根源就是：ThreadLocalMap和Thread的生命周期一样长，如果没有手动删除对应key，就会导致相应的value不能及时得到清除，造成内存泄漏

我们在线上使用最多的就是线程池了，这样问题就大了

你想啊，线程池里面有10个活跃线程，线程一直在运行，不会停止，每次线程直接拿到过来用，然后用完之后会再次放到线程池中，此时线程并不会停止

如何避免内存泄漏

ThreadLocal的应用场景

场景1：

ThreadLocal 用作保存每个线程独享的对象，为每个线程都创建一个副本，这样每个线程都可以修改自己所拥有的副本, 而不会影响其他线程的副本，确保了线程安全。

场景2：

ThreadLocal 用作每个线程内需要独立保存信息，以便供其他方法更方便地获取该信息的场景。每个线程获取到的信息可能都是不一样的，前面执行的方法保存了信息后，后续方法可以通过ThreadLocal 直接获取到，避免了传参，类似于全局变量的概念。

举个具体的使用例子

比如可以用于保存线程不安全的工具类，典型的需要使用的类就是 SimpleDateFormat。

在这种情况下，每个Thread内都有自己的实例副本，且该副本只能由当前Thread访问到并使用，相当于每个线程内部的本地变量，这也是ThreadLocal命名的含义。因为每个线程独享副本，而不是公用的，所以不存在多线程间共享的问题。

这种线程不安全的工具类如果需要在很多的线程中同时使用的话，任务数量巨大的情况下，也就是需要线程数巨多的情况下，这个不安全我们就需要让它变得安全

比如使用Synchronized锁，这样可以解决，但是Synchronized会让线程进入一个排队的状态，大大降低整体的工作效率

我们在线上一般使用线程池，ThreadLocal再合适不过了，ThreadLocal给每个线程维护一个自己的simpleDateFormat对象，这个对象在线程之间是独立的，互相没有关系的。这也就避免了线程安全问题。与此同时，simpleDateFormat对象还不会创造过多，线程池有多少个线程，所以需要多少个对象即可。

再说一个形象的场景

每个线程内需要保存类似于全局变量的信息（例如在拦截器中获取的用户信息），可以让不同方法直接使用，避免参数传递的麻烦却不想被多线程共享（因为不同线程获取到的用户信息不一样）。

例如，用 ThreadLocal 保存一些业务内容（用户权限信息、从用户系统获取到的用户名、用户ID 等），这些信息在同一个线程内相同，但是不同的线程使用的业务内容是不相同的。

在线程生命周期内，都通过这个静态 ThreadLocal 实例的 get() 方法取得自己 set 过的那个对象，避免了将这个对象（如 user 对象）作为参数传递的麻烦。

这其实就是类似于一种责任链的模式

感谢大家能够做我最初的读者和传播者，请大家相信，只要你给我一份爱，我终究会还你们一页情的。

Captain会持续更新技术文章，和生活中的暴躁文章，欢迎大家关注【Java贼船】，成为船长的学习小伙伴，和船长一起乘千里风、破万里浪

哦对了，后续所有的文章都会更新到这里

https://github.com/DayuMM2021/Java