ThreadLocal简介

面试题

• ThreadLocal中ThreadLocalMap的数据结构和关系是什么？
• ThreadLocal的key是弱引用，这是为什么？
• ThreadLocal内存泄漏问题你知道吗？
• ThreadLocal中最后为什么要加remove方法？

是什么？

ThreadLocal提供线程局部变量。这些变量与正常的变量不同，因为每一个线程在访问ThreadLocal实例的时候（通过其get或set方法）都有自己的、独立初始化的变量副本。ThreadLocal实例通常是类中的私有静态字段，使用它的目的是希望将状态（例如用户ID或事物ID）与线程关联起来。

能干吗？

实现每一个线程都有自己专属的本地变量副本（自己用自己的变量不用麻烦别人，不和其他人共享，人人有份，人各一份）（如和平精英里面，每个线程的血量、装备都不同）。主要解决了让每个线程绑定自己的值，通过使用get()和set()方法，获取默认值或将其改为当前线程所存的副本的值从而避免了线程安全问题，不用加锁。比如8锁案例中，资源类是使用同一部手机，多个线程抢夺同一部手机，假如一人一台就不用抢了

API介绍

initialValue方法（不推荐）

protected T initialValue(): 返回此线程局部变量的当前线程的“初始值”。此方法将在一个线程首次访问此变量并通过 get() 方法获取其值时被调用，除非该线程之前已通过 set(T) 方法设置了该值，在这种情况下，initialValue 方法将不会被该线程调用。通常，每个线程只会调用此方法一次，但如果在调用 remove() 方法之后紧接着调用 get() 方法，则可能会再次调用此方法。此方法的基本实现仅返回 null；如果程序员希望线程局部变量具有除 null 之外的初始值，必须子类化 ThreadLocal 并重写此方法。通常使用匿名内部类来实现。返回的结果是此线程局部变量的初始值。

ThreadLocal<Integer> saleVolume = new ThreadLocal<Integer>() {
    @Override
    protected Integer initialValue() {
        return 0;
    }
};

不推荐使用，因为匿名内部类写起来比较麻烦

withInitial方法（推荐）

作用和上面的相同

ThreadLocal<Integer> saleVolume = ThreadLocal.withInitial(() -> 0);

remove

不用线程池的话，会被垃圾回收，不remove也不会内存溢出

ThreadLocal入门案例

原始需求

5个销售卖房子，集团只关心销售总量的准确统计数，按照总销售额统计，方便集团公司给员工发送奖金（群雄逐鹿起纷争，为了数据安全只能加锁）

/**
需求：5个销售卖房子，集团只关心销售总量的精确统计数
*/
class House {
    int saleCount = 0;
    public synchronized void saleHouse() {
        ++saleCount;
    }
}
public class ThreadLocalDemo {
    public static void main(String[] args) {
        House house = new House();
        for (int i = 1; i <= 5; i++) {
            new Thread(() -> {
                int size = new Random().nextInt(5) + 1;
                System.out.println(size);
                for (int j = 1; j <= size; j++) {
                    house.saleHouse();
                }
            }, String.valueOf(i)).start();
        }
        try {
            TimeUnit.MILLISECONDS.sleep(300);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        System.out.println(Thread.currentThread().getName() + "\t" + "共计卖出多少套： " + house.saleCount);
    }
}

需求变更

希望各凭销售本事提成，按照出单数各自统计（比如房产中介销售都有自己的销售额）

class House {
    int saleCount = 0;
    public synchronized void saleHouse() {
        saleCount++;
    }
    // 定义一个线程局部变量，初始值是0
    ThreadLocal<Integer> saleVolume = ThreadLocal.withInitial(() -> 0);
    public void saleVolumeByThreadLocal() {
        saleVolume.set(1 + saleVolume.get());
    }
}

public class ThreadLocalDemo {
    public static void main(String[] args) {
        House house = new House();
        for (int i = 1; i <= 5; i++) {
            new Thread(() -> {
                int size = new Random().nextInt(5) + 1;
                try {
                    for (int j = 1; j <= size; j++) {
                        // 统计总数
                        house.saleHouse();
                        // 更新线程的数量（每个销售自己的销量）
                        house.saleVolumeByThreadLocal();
                    }
                    System.out.println(Thread.currentThread().getName() + "\t" + "号销售卖出：" + house.saleVolume.get());
                } finally {
                    // 记得remove
                    house.saleVolume.remove();
                }
            }, String.valueOf(i)).start();
        }
        try {
            TimeUnit.MILLISECONDS.sleep(300);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        System.out.println(Thread.currentThread().getName() + "\t" + "共计卖出多少套： " + house.saleCount);
    }
}

线程池

import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

class MyData {
    ThreadLocal<Integer> threadLocalField = ThreadLocal.withInitial(() -> 0);

    public void add() {
        threadLocalField.set(1 + threadLocalField.get());
    }
}

/**
 * .【强制】必须回收自定义的 ThreadLocal 变量，尤其在线程池场景下，线程经常会被复用，如果不清理
 * 自定义的 ThreadLocal 变量，可能会影响后续业务逻辑和造成内存泄露等问题。尽量在代理中使用
 * try-finally 块进行回收。
 */
public class ThreadLocalDemo2 {
    public static void main(String[] args) throws InterruptedException {
        MyData myData = new MyData();

        ExecutorService threadPool = Executors.newFixedThreadPool(3);

        try {
            for (int i = 0; i < 10; i++) {
                threadPool.submit(() -> {
                    Integer beforeInt = myData.threadLocalField.get();
                    myData.add();
                    Integer afterInt = myData.threadLocalField.get();
                    System.out.println(Thread.currentThread().getName() + "\t" + "beforeInt:" + beforeInt + "\t afterInt: " + afterInt);
                });
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            threadPool.shutdown();
        }

    }
}

添加remove

import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;

class MyData {
    ThreadLocal<Integer> threadLocalField = ThreadLocal.withInitial(() -> 0);

    public void add() {
        threadLocalField.set(1 + threadLocalField.get());
    }
}

/**
 * .【强制】必须回收自定义的 ThreadLocal 变量，尤其在线程池场景下，线程经常会被复用，如果不清理
 * 自定义的 ThreadLocal 变量，可能会影响后续业务逻辑和造成内存泄露等问题。尽量在代理中使用
 * try-finally 块进行回收。
 */
public class ThreadLocalDemo2 {
    public static void main(String[] args) throws InterruptedException {
        MyData myData = new MyData();

        ExecutorService threadPool = Executors.newFixedThreadPool(3);

        try {
            for (int i = 0; i < 10; i++) {
                threadPool.submit(() -> {
                    try {
                        Integer beforeInt = myData.threadLocalField.get();
                        myData.add();
                        Integer afterInt = myData.threadLocalField.get();
                        System.out.println(Thread.currentThread().getName() + "\t" + "beforeInt:" + beforeInt + "\t afterInt: " + afterInt);
                    } finally {
                        myData.threadLocalField.remove();
                    }
                });
            }
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            threadPool.shutdown();
        }

    }
}

总结

• 每个Thread内有自己的实例副本且该副本只有当前线程自己使用
• 其他ThreadLocal不可访问，不存在多线程间共享问题
• 统一设置初始值，但是每个线程对这个值得修改都是各自线程互相独立的
• 如何才能不争抢
  • 加入synchronized或者Lock控制资源的访问顺序
  • ThreadLocal：人手一份，不用争抢

ThreadLocal源码分析

Thread、ThreadLocal、ThreadLocalMap关系

Thread和ThreadLocal：每个线程有一份ThreadLocalMap

ThreadLocal和ThreadLocalMap

类关系概括

• ThreadLocalMap实际上就是一个以ThreadLocal实例为Key，任意对象为value的Entry对象
• 当我们为ThreadLocal变量赋值，实际上就是以当前ThreadLocal实例为Key，值为value的Entry往这个ThreadLocalMap中存放

ThreadLocal是一个壳子，它只是自己作为一个key来让线程从ThreadLocalMap获取value，真正的存储结构是ThreadLocal里有ThreadLocalMap这么个内部类，每个Thread对象维护着一个ThreadLocalMap的引用，ThreadLocalMap是ThreadLocal的内部类，用Entry来进行存储。

1、调用ThreadLocal的set()方法时，实际上就是往ThreadLocalMap设置值，key是ThreadLocal对象，值Value是传递进来的对象

2、调用ThreadLocal的get()方法时，实际上就是往ThreadLocallap获取值，key是ThreadLocal对象

正因为这个原理，所以ThreadLocal能够实现“数据隔离”，获取当前线程的局部变量值，不受其他线程影响～

总结

• ThreadLocalMap从字面上就可以看出这是一个保存ThreadLocal对象的map（其实是以ThreadLocal为Key），不过是经过了两层包装的ThreadLocal对象

• JVM内部维护了一个线程版的Map<ThreadLocal, Value>（通过ThreadLocal对象的set方法，把ThreadLocal对象自己当作Key，放进了ThreadLocalMap中），每个线程要用到这个T的时候，用当前的线程去Map里面获取，通过这样让每个线程都拥有了自己独立的变量，人手一份，竞争条件被彻底消除，在并发模式下绝对安全

ThreadLocal内存泄漏问题

什么是内存泄漏

不会被使用的对象或者变量占用的内存不能被回收，就是内存泄漏

谁惹的祸？

回首ThreadLocalMap

ThreadLocalMap从字面上就可以看出这是一个保存ThreadLocal对象的map（以ThreadLocal为Key），不过是经过了两层包装的ThreadLocal对象：

（1）第一层包装是使用 WeakReference<ThreadLocal<>>将ThreadLocal对象变成一个弱引用的对象

（2）第二层包装是定义了一个专门的类 Entry来扩展 WeakReference<ThreadLocal<?>>

finalize方法

• 当垃圾回收器确定没有对该对象的更多引用时，由对象上的垃圾回收器调用。子类重写finalize方法以处置系统资源或执行其他清理
• finalize的通常目的是在对象被不可撤销地丢弃之前，执行清理操作

强软弱虚引用

强引用

• 强引用是我们最常见的普通对象引用，只要还有强引用指向一个对象，就能表明对象还“活着”，垃圾回收器不会碰这种对象
• 在Java 中最常见的就是强引用，把一个对象赋给一个引用变量(Student s1 = new Student())，这个引用变量就是一个强引用
• 当一个对象被强引用变量引用时，它处于可达状态，它是不可能被垃圾回收机制回收的
• 对于强引用的对象，就算是出现了OOM也不会对该对象进行回收，即使该对象以后永远都不会被用到，JVM也不会回收，因此强引用是造成Java内存泄露的主要原因之一
• 对于一个普通的对象，如果没有其他的引用关系，只要超过了引用的作用域或者显式地将相应（强）引用赋值为null，就可以被垃圾回收的了（当然具体回收时机还是要看垃圾回收策略）

class MyObject {
    //这个方法一般不用复写，我们只是为了教学给大家演示案例做说明
    @Override
    protected void finalize() throws Throwable {
        // finalize的通常目的是在对象被不可撤销地丢弃之前执行清理操作。
        System.out.println("-------invoke finalize method~!!!");
    }
}

private static void strongReference() {
    MyObject myObject = new MyObject();
    System.out.println("gc before: " + myObject);

    myObject = null;
    System.gc();//人工开启GC，一般不用

    //暂停毫秒
    try {
        TimeUnit.MILLISECONDS.sleep(500);
    } catch (InterruptedException e) {
        e.printStackTrace();
    }

    System.out.println("gc after: " + myObject);
}

软引用

• 是一种比强引用弱一些的引用，需要用java.lang.ref.SoftReference类来实现，可以让对象豁免一些垃圾回收
• 对于只有软引用的对象而言，当系统内存充足时，不会被回收；当系统内存不足时，会被回收
• 软引用通常用在对内存敏感的程序中，比如高速缓存，内存够用就保留，不够用就回收

private static void softReference() {
    SoftReference<MyObject> softReference = new SoftReference<>(new MyObject());
    //System.out.println("-----softReference:"+softReference.get());

    System.gc();
    try {
        TimeUnit.SECONDS.sleep(1);
    } catch (InterruptedException e) {
        e.printStackTrace();
    }
    System.out.println("-----gc after内存够用: " + softReference.get());

    try {
        byte[] bytes = new byte[20 * 1024 * 1024];//20MB对象
    } catch (Exception e) {
        e.printStackTrace();
    } finally {
        System.out.println("-----gc after内存不够: " + softReference.get());
    }
}

使用场景

假如有一个应用需要读取大量的本地图片

• 如果每次读取图片都从硬盘读取则会严重影响性能
• 如果一次性全部加载到内存中又可能会造成内存溢出
• 此时使用软应用来解决，设计思路时：用一个HashMap来保存图片的路径和与相应图片对象关联的软引用之间的映射关系，在内存不足时，JVM会自动回收这些缓存图片对象所占用的空间，有效避免了OOM的问题

Map<String, SoftReference<Bitmap>> imageCache = new HashMap<String, SoftReference<Bitmap>>();

弱引用

• 弱引用需要用java.lang.ref.WeakReference类来实现，它比软引用的生存期更短
• 对于只有弱引用的对象而言，只要垃圾回收机制一运行，不管JVM的内存空间是否足够，都会回收该对象占用的内存。

private static void weakReference() {
    WeakReference<MyObject> weakReference = new WeakReference<>(new MyObject());
    System.out.println("-----gc before 内存够用： " + weakReference.get());

    System.gc();
    //暂停几秒钟线程
    try {
        TimeUnit.SECONDS.sleep(1);
    } catch (InterruptedException e) {
        e.printStackTrace();
    }

    System.out.println("-----gc after 内存够用： " + weakReference.get());
}

虚引用

• 虚引用必须和引用队列ReferenceQueue联合使用，需要调用java.lang.ref.PhantomReference类来实现，如果一个对象仅持有虚引用，那么它就和没有任何引用一样，在任何时候都有可能被垃圾回收器回收，它不能单独使用也不能通过它访问对象。
• PhantomReference的get方法总是返回null，虚引用的主要作用是跟踪对象被垃圾回收的状态，不是业务逻辑处理的方法。仅仅是提供了一种确保对象被finalize后，做某些事情的通知机制。
• 设置虚引用关联对象的唯一目的就是在对象被GC的时候会收到一个系统通知或者后续添加进一步的处理，用来实现比finalize机制更灵活的回收操作。
• 虚引用的对象，在回收前，会进入引用队列，后续可以弹出队列的元素，看看弹出的时候要做一些什么操作

public static void main(String[] args) {
    MyObject myObject = new MyObject();
    // 引用队列
    ReferenceQueue<MyObject> referenceQueue = new ReferenceQueue<>();
    PhantomReference<MyObject> phantomReference = new PhantomReference<>(myObject, referenceQueue);
    //System.out.println(phantomReference.get());

    List<byte[]> list = new ArrayList<>();

    new Thread(() -> {
        while (true) {
            list.add(new byte[1 * 1024 * 1024]);
            try {
                TimeUnit.MILLISECONDS.sleep(500);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
            System.out.println(phantomReference.get() + "\t" + "list add ok");
        }
    }, "t1").start();

    new Thread(() -> {
        while (true) {
            Reference<? extends MyObject> reference = referenceQueue.poll();
            if (reference != null) {
                System.out.println("-----有虚对象回收加入了队列");
                break;
            }
        }
    }, "t2").start();

}

设置堆内存为10M，运行

为什么要用弱引用？不用如何？

为什么要用弱引用

• 当function1方法执行完毕后，栈帧销毁，方法的局部变量出栈了，强引用t1也就没有了，但此时线程的ThreadLocalMap（线程还存活，ThreadLocalMap就存活）里某个entry的Key引用还指向这个对象，若这个Key是强引用，就会导致Key指向的ThreadLocal对象即V指向的对象不能被gc回收，造成内存泄露（就像人去世了，身份证要注销）
• 若这个引用时弱引用就大概率会减少内存泄漏的问题（当然，还得考虑key为null这个坑），使用弱引用就可以使ThreadLocal对象在方法执行完毕后顺利被回收且entry的key引用指向为null
• 我们调用get,set或remove方法时，就会尝试删除key为null的entry，可以释放value对象所占用的内存

弱引用需要注意的问题：

• 当我们为threadLocal变量赋值，实际上就往这个threadLocalMap中存放（threadLocal实例为key，值为value）。Entry中的key是弱引用，当threadLocal外部强引用被置为null（t1 = null），那么系统GC的时候，根据可达性分析，这个threadLocal实例就没有任何一条链路能够引用到它，这个ThreadLocal势必会被回收，但是value还没有回收。这样一来，ThreadLocalMap中就会出现key为null的Entry，没有办法访问这些key为null的Entry的value。如果当前线程迟迟不结束的话（线程池场景），这些key为null的Entry的value就会一直存在一条强引用链：Thread Ref-> Thread-> ThreaLocalMap-> Entry ->value，这样value永远无法回收，造成内存泄漏
  • 当前如果当前thread运行结束，threadLocal，threadLocalMap，Entry没有引用链可达，在垃圾回收的时候都会被系统进行回收
  • 但在实际使用中我们有时候会用线程池去维护我们的线程，比如在Executors.newFixedThreadPool()时创建线程的时候，为了复用线程是不会结束的，所以threadLocal内存泄漏就值得我们小心
• 虽然弱引用保证了Key指向的ThreadLocal对象能够被及时回收，但是v指向的value对象是需要ThreadLocalMap调用get、set时发现key为null时才会去回收整个entry、value，因此弱引用不能100%保证内存不泄露，我们要在不使用某个ThreadLocal对象后，手动调用remove方法来删除它，尤其是在线程池中，不仅仅是内存泄漏的问题，因为线程池中的线程是重复使用的，意味着这个线程的ThreadLocalMap对象也是重复使用的，如果我们不手动调用remove方法，那么后面的线程就有可能获取到上个线程遗留下来的value值，造成bug。

清除脏Entry(调用expungestaleEntry方法)

脏Entry即key为null的entry

set()方法

get()方法

remove()

总结

• ThreadLocal并不解决线程间共享数据的问题
• ThreadLocal适用于变量在线程间隔离且在方法间共享的场景
• ThreadLocal通过隐式的在不同线程内创建独立实例副本避免了实例线程安全的问题
• 每个线程持有一个只属于它自己的专属map并维护了ThreadLocal对象与具体实例的映射，该Map由于只被持有他的线程访问，故不存在线程安全以及锁的问题
• ThreadLocalMap的Entry对ThreadLocal的引用为弱引用。避免了ThreadLocal对象无法被回收的问题
• 都会通过expungeStaleEntry，cleanSomeSlots，replaceStaleEntry这三个方法回收键为null的Entry对象的值（即为具体实例）以及entry对象本身从而防止内存泄漏，属于安全加固的方法

最佳实践

• ThreadLocal一定要初始化ThreadLocal.withInitiaL(()->初始化值)，避免空指针异常
• 建议把ThreadLocal修饰为static（建议），ThreadLocal可以只初始化一次，只分配一块存储空间就可以了，没必要作为成员变量多次被初始化
• 用完记得手动remove（强制）

文章说明

该文章是本人学习 尚硅谷 的学习笔记，文章中大部分内容来源于 尚硅谷 的视频尚硅谷JUC并发编程（对标阿里P6-P7），也有部分内容来自于自己的思考，发布文章是想帮助其他学习的人更方便地整理自己的笔记或者直接通过文章学习相关知识，如有侵权请联系删除，最后对 尚硅谷 的优质课程表示感谢。