ThreadLocal

发布时间 2023-04-12 17:10:21作者: 橙香五花肉

ThreadLocal

介绍

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

作用

实现每一个线程都有自己专属的本地变量副本(自己用自己的变量不麻烦别人,不和其他人共享,人人有份,人各一份),主要解决了让每个线程绑定自己的值,通过使用get()和set()方法,获取默认值或将其值更改为当前线程所存的副本的值从而避免了线程安全问题。

API介绍

代码演示

需求一

5个销售卖房子,集团高层只关心销售总量的准确统计数,使用锁保证数据安全

/**
 * 资源类
 */
class House {

    int saleCount = 0;

    public synchronized void saleHouse() {
        ++saleCount;
    }
}

/**
 * @author zjh
 */
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);
    }
}

需求二

5个销售卖完随机数房子,各白独立销售额度,自己业绩按提成走,分灶吃饭,各个销售白己动手,丰衣足食,使用ThreadLocal

/**
 * 资源类
 */
class House {

    int saleCount = 0;

    public synchronized void saleHouse() {
        ++saleCount;
    }

    // 以前的写法:使用匿名内部类
    /*ThreadLocal<Integer> saleVolume = new ThreadLocal<Integer>(){
        @Override
        protected Integer initialValue() {
            return 0;
        }
    };*/


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

    public void saleVolumeByThreadLocal() {
        saleVolume.set(1 + saleVolume.get());
    }
}

/**
 * @author zjh
 */
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;
                for(int j = 1;j <= size;j ++){
                    house.saleHouse();
                    house.saleVolumeByThreadLocal();
                }
                System.out.println(Thread.currentThread().getName() + "\t" + "号销售卖出:" + house.saleVolume.get());
            },String.valueOf(i)).start();
        }

        try {
            TimeUnit.MILLISECONDS.sleep(300);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        System.out.println(Thread.currentThread().getName()+"\t"+"共计卖出多少套:"+ house.saleCount);
    }
}

// 结果
2	号销售卖出:5
5	号销售卖出:2
1	号销售卖出:1
3	号销售卖出:2
4	号销售卖出:1
main	共计卖出多少套:11

上述代码使用ThreadLocal实现了每个线程有自己的本地变量保证了线程安全,但是有个小弊端看下阿里巴巴开发手册:

优化过后:

/**
 * 资源类
 */
class House {

    int saleCount = 0;

    public synchronized void saleHouse() {
        ++saleCount;
    }

    // 以前的写法:使用匿名内部类
    /*ThreadLocal<Integer> saleVolume = new ThreadLocal<Integer>(){
        @Override
        protected Integer initialValue() {
            return 0;
        }
    };*/


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

    public void saleVolumeByThreadLocal() {
        saleVolume.set(1 + saleVolume.get());
    }
}

/**
 * @author zjh
 */
public class ThreadLocalDemo {

    public static void main(String[] args) {

        House house = new House();

        for(int i = 1;i <= 5;i ++){
            new Thread(()->{
                try {
                    int size = new Random().nextInt(5) + 1;
                    for(int j = 1;j <= size;j ++){
                        house.saleHouse();
                        house.saleVolumeByThreadLocal();
                    }
                    System.out.println(Thread.currentThread().getName() + "\t" + "号销售卖出:" + house.saleVolume.get());
                } finally {
                    // 回收本地变量
                    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);
    }
}

下面示例是为了演示阿里巴巴手册的中说的场景

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

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

/**
 * @author zjh
 */
public class ThreadLocalDemo2 {

    public static void main(String[] args) {

        MyData myData = new MyData();


        ExecutorService threadPool = new ThreadPoolExecutor(
                3,
                3,
                600,
                TimeUnit.SECONDS, new ArrayBlockingQueue<>(10),
                Executors.defaultThreadFactory());

        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();
        }
    }
}

// 未进行回收结果
pool-1-thread-3	 beforeInt:0	 afterInt:1
pool-1-thread-1	 beforeInt:0	 afterInt:1
pool-1-thread-2	 beforeInt:0	 afterInt:1
pool-1-thread-3	 beforeInt:1	 afterInt:2
pool-1-thread-1	 beforeInt:1	 afterInt:2
pool-1-thread-3	 beforeInt:2	 afterInt:3
pool-1-thread-2	 beforeInt:1	 afterInt:2
pool-1-thread-3	 beforeInt:3	 afterInt:4
pool-1-thread-1	 beforeInt:2	 afterInt:3
pool-1-thread-2	 beforeInt:2	 afterInt:3
// 进行回收结果
pool-1-thread-2	 beforeInt:0	 afterInt:1
pool-1-thread-3	 beforeInt:0	 afterInt:1
pool-1-thread-1	 beforeInt:0	 afterInt:1
pool-1-thread-2	 beforeInt:0	 afterInt:1
pool-1-thread-1	 beforeInt:0	 afterInt:1
pool-1-thread-3	 beforeInt:0	 afterInt:1
pool-1-thread-1	 beforeInt:0	 afterInt:1
pool-1-thread-2	 beforeInt:0	 afterInt:1
pool-1-thread-1	 beforeInt:0	 afterInt:1
pool-1-thread-3	 beforeInt:0	 afterInt:1

总结

因为每个Thread内有自己的实例副本并且该副本只由当前线程自己使用,其他Thread不可访问,那就不存在多线程间共享的问题。统一设置初始值,但是每个线程对这个值的修改都是各自线程相互独立的

如何避免争抢:

  1. 加入synchronized或者Lock控制资源的访问顺序
  2. 利用ThreadLocal(本地副本) 人手一份,没必要抢夺

ThreadLocal源码分析

Thread,ThreadLocal,ThreadLocalMap关系

  • Thread是程序中的线程,ThreadLocal是线程中的本地变量

  • ThreadLocalMap是ThreadLocal中的静态内部类

三者关系脑图

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

总结

ThreadLocalMap从字面上就可以看出这是一个保存ThreadLocal对象的map(其实是以ThreadLocal为Key),不过是经过了两层包装的ThreadLocal对象:(两层包装可以看下面的解释)

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

ThreadLocal内存泄漏问题

什么是内存泄露

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

内存泄露的原因

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

  1. 第一层包装是使用 WeakReference<ThreadLocal<?>> 将ThreadLocal对象变成一个弱引用的对象。
  2. 第二层包裝是定义了一个专门的类 Entry 来扩展 WeakReference<ThreadLocals?>>。

强引用,软引用,弱引用

  • Reference:强引用

  • SoftReference:软引用

  • WeakReference:弱引用

  • PhantomReference:虚引用

强引用(默认支持模式)

  • 当内存不足,JVM开始垃圾回收,对于强引用的对象,就算是出现了OOM也不会对该对象进行回收,死都不收

  • 强引用是我们最常见的普通对象引用,只要还有强引用指向一个对象,就能表明对象还“活着”,垃圾收集器不会碰这种对象。在 Java 中最常见的就是强引用,把一个对象赋给一个引用变量,这个引用变量就是一个强引用。当一个对象被强引用变量引用时,它处于可达状态,它是不可能被垃圾回收机制回收的,即使该对象以后永远都不会被用到JVM也不会回收。因此强引用是造成Java内存泄漏的主要原因之一。

  • 对于一个普通的对象,如果没有其他的引用关系,只要超过了引用的作用域或者显式地将相应(强)引用赋值为 null,一般认为就是可以被垃圾收集的了(当然具体回收时机还是要看垃圾收集策略)。

class MyObject {

    /**
     * 该方法不用复习,只为演示
     */
    @Override
    protected void finalize() throws Throwable {
        // finalize通常目的是在对象被不可撤销的丢弃之前进行清理操作
        System.out.println("------ invoke finalize method!!!");
    }
}

/**
 * @author zjh
 */
public class ReferenceDemo {

    public static void main(String[] args) {

        MyObject myObject = new MyObject();
        System.out.println("gc before:" + myObject);

        myObject = null;
        // 人工触发gc
        System.gc();

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

// 结果
gc before:com.zjh.threadLocal.MyObject@6d6f6e28
gc after:null
------ invoke finalize method!!!

软引用

  • 软引用是一种相对强引用弱化了一些的引用,需要用java.lang.ref.SoftReference类来实现,可以让对象豁免一些垃圾收集。

  • 对于只有软引用的对象来说:

    1. 当系统内存充足时它 不会被回收
    2. 当系统内存不足时它 会被回收
  • 软引用通常用在对内存敏感的程序中,比如高速缓存就有用到软引用,内存够用的时候就保留,不够用就回收!

设置JVM为10M

class MyObject {

    /**
     * 该方法不用复习,只为演示
     */
    @Override
    protected void finalize() throws Throwable {
        // finalize通常目的是在对象被不可撤销的丢弃之前进行清理操作
        System.out.println("------ invoke finalize method!!!");
    }
}

/**
 * @author zjh
 */
public class ReferenceDemo {

    public static void main(String[] args) {

        SoftReference<MyObject> softReference = new SoftReference<>(new MyObject());

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

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

// 结果
------gc after内存够用:com.zjh.threadLocal.MyObject@6d6f6e28 (gc过后因为内存够用所以还存在)
------gc after内存不够用:null(声明了一个20M的对象,超过了JVM内存,内存不够用所有回收了为null)
------ invoke finalize method!!!
Exception in thread "main" java.lang.OutOfMemoryError: Java heap space
	at com.zjh.threadLocal.ReferenceDemo.main(ReferenceDemo.java:34)
  • 问题:假如有一个应用需要读取大量的本地图片

    • 如果每次读取图片都从硬盘读取则会严重影响性能。
    • 如果一次性全部加载到内存中又可能造成内存溢出。、

    此时使用软引用可以解决这个问题。设计思路是:用一个HashMap来保存图片的路径和相应图片对象关联的软引用之间的映射关系,在内存不足时,JVM会自动回收这些缓存图片对象所占用的空间,从而有效地避免了OOM的问题。

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

弱引用

  • 弱引用需要用java.lang.ref.WeakReference类来实现,它比软引用的生存期更短。

  • 对于只有弱引用的对象来说,只要垃圾回收机制一运行,不管JVM的内存空间是否足够,都会回收该对象占用的内存。

class MyObject {

    /**
     * 该方法不用复习,只为演示
     */
    @Override
    protected void finalize() throws Throwable {
        // finalize通常目的是在对象被不可撤销的丢弃之前进行清理操作
        System.out.println("------ invoke finalize method!!!");
    }
}

/**
 * @author zjh
 */
public class ReferenceDemo {

    public static void main(String[] args) {

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

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

// 结果
------gc before内存够用:com.zjh.threadLocal.MyObject@6d6f6e28
------ invoke finalize method!!!
------gc after内存够用:null(只要gc后不管内存足不足都回收)

虚引用

  1. 虚引用必须和引用队列 (ReferenceQueue)联合使用

    虚引用需要java.lang.ret.PhantomReterence类来实现,顾名思义,就是形同虚设,与其他几种引用都不同,虚引用并不会决定对象的生命周期。如果一个对象仅持有虚引用,那么它就和没有任何引用一样,在任何时候都可能被垃圾回收器回收,它不能单独使用也不能通过它访问对象,虚引用必须和引用队列(ReferenceQueue)联合使用

  2. PhantomReference的get方法总是返回null

    虚引用的主要作用是跟踪对象被垃圾回收的状态。仅仅是提供了一和确保对象被 finalize以后,做某些事情的通知机制PhantomReference的get方法总是返回null,因此无法访问对应的引用对象。

  3. 处理监控通知使用

    设置虚引用关联对象的唯一目的,就是在这个对象被收集器回收的时候收到一个系统通知或者后续添加进一步的处理,用来实现比finalize机制更灵活的回收操作。

  • 虚引用

  • 引用队列

class MyObject {

    /**
     * 该方法不用复习,只为演示
     */
    @Override
    protected void finalize() throws Throwable {
        // finalize通常目的是在对象被不可撤销的丢弃之前进行清理操作
        System.out.println("------ invoke finalize method!!!");
    }
}

/**
 * @author zjh
 */
public class ReferenceDemo {

    public static void main(String[] args) {

        MyObject myObject = new MyObject();

        ReferenceQueue<MyObject> referenceQueue = new ReferenceQueue<>();
        PhantomReference<MyObject> phantomReference = new PhantomReference<>(myObject, referenceQueue);

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

        new Thread(() -> {
            while (true) {
                list.add(new byte[1 * 1024 * 1024]);
                try {TimeUnit.MILLISECONDS.sleep(500);} catch (InterruptedException e) {throw new RuntimeException(e);}
                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();
    }
}

// 结果
null	 list add ok
null	 list add ok
null	 list add ok
null	 list add ok
null	 list add ok
null	 list add ok
null	 list add ok
------ invoke finalize method!!!
------有虚对象回收加入了队列
Exception in thread "t1" java.lang.OutOfMemoryError: Java heap space
	at com.zjh.threadLocal.ReferenceDemo.lambda$main$0(ReferenceDemo.java:38)
	at com.zjh.threadLocal.ReferenceDemo$$Lambda$1/558638686.run(Unknown Source)
	at java.lang.Thread.run(Thread.java:748)

GCRoots和四大引用小总结

关系

ThreadLocal是一个壳子,真正的存储结构是ThreadLocal里有ThreadLocalMap这么个内部类,每个Thread对象维护着一个ThreadLocalMap的引用。ThreadLocalMapThreadLocal的内部类,用Entry来进行存储。

  • 调用ThreadLocalset0方法时,实际上就是往ThreadLocalMap设置值,keyThreadLocal对象,值Value是传递进来的对象
  • 调用ThreadLocalget()方法时,实际上就是往ThreadLocalMap获取值,keyThreadLocal对象ThreadLocal本身并不存储值,它只是自己作为一个key来让线程从ThreadLocalMap获取value,正因为这个原理,所以ThreadLocal能够实现“数据隔离”,获取当前线程的局部变量值,不受其他线程影响

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

为什么源代码用弱引用?

当function01方法执行完毕后,栈帧销毁强引用 tl 也就没有了。但此时线程的ThreadLocalMap里某个entry的key引用还指向这个对象若这个key引用是强引用,就会导致key指向的ThreadLocal对象及v指向的对象不能被gc回收,造成内存泄漏;若这个key引用是弱引用,就大概率会减少内存泄漏的问题。使用弱引用,就可以ThreadLocal对象在方法执行完毕后顺利被回收且Entry的key引用指向为null。

弱引用就万事大吉了吗?

线程复用的时候

  1. 当我们为threadLocal变量赋值,实际上就是当前的Entry(threadLocal实例为key,值为value)往这个threadLocalMap中存放。Entry中的key弱引用,当threadLocal外部强引用被置为null(tl=null),那么系统 GC 的时候,根据可达性分析,这个threadLocal实例就没有任何一条链路能够引用到它,这个ThreadLocal势必会被回收,这样一来,ThreadLocalMap中就会出现keynullEntry,就没有办法访问这些keynullEntryvalue,如果当前线程再迟迟不结束的话(这个tl就不会被干掉),这些keynullEntryvalue就会一直存在一条强引用链:Thread Ref -> Thread -> ThreaLocalMap -> Entry -> value永远无法回收,造成内存泄漏。

  2. 如果当前thread运行结束,threadLocalthreadLocalMap,Entry没有引用链可达,在垃圾回收的时候都会被系统进行回收。

  3. 实际使用中我们有时候会用线程池去维护我们的线程,比如在Executors.newFixedThreadPool()时创建线程的时候,为了复用线程是不会结束的,所以threadLocal内存泄漏就值得我们小心

key为null的entry,原理解析

  • ThreadLocalMap使用ThreadLocal的弱引用作为key,如果一个ThreadLocal没有外部强引用引用他,那么系统gc的时候,这个ThreadLocal势必会被回收,这样一来,ThreadLocalMap中就会出现keynullEntry,就没有办法访问这些keynullEntryvalue,如果当前线程再迟迟不结束的话(比如正好用在线程池),这些keynullEntryvalue就会一直存在一条强引用链。

  • 虽然弱引用,保证了key指向的ThreadLocal对象能被及时回收,但是v指向的value对象是需要ThreadLocalMap调用getset时发现keynull时才会去回收整个entryvalue因此弱引用不能100%保证内存不泄露。我们要在不使用某个ThreadLocal对象后,手动调用​remove()方法来删除它,尤其是在线程池中,不仅仅是内存泄露的问题,因为线程池中的线程是重复使用的,意味着这个线程的ThreadLocalMap对象也是重复使用的,如果我们不手动调用remove方法,那么后面的线程就有可能获取到上个线程遗留下来的value值,造成bug。

set、get方法会去检查所有键为null的Entry对象

  • expungeStaleEntry(清除ThreadLocal中的脏Entry的意思。脏Entry:指key为null的)
    1. set():在set方法中调用了replaceStaleEntryreplaceStaleEntry调用了cleanSomeSlots(expungeStaleEntry(slotToExpunge), len)接口,中第一个参数调用expungeStaleEntry接口清除脏Entry

    2. get():在get方法中调用getEntrygetEntry中调用了getEntryAfterMiss方法,getEntryAfterMiss方法中当keynull的时候清除脏Entry

    3. remove():删除本地变量,直接删除key和value

从前面的set,getEntry,remove方法看出,在threadLocal的生命周期里,针对threadLocal存在的内存泄漏的问题,都会通过expungeStaleEntrycleanSomeSlotsreplaceStaleEntry这三个方法清理掉key为null的脏entry。

ThreadLocal注意事项

  1. 一定要进行初始化,避免空指针问题ThreadLocal.withInitial(()- > 初始化值);

  2. 建议把ThreadLocal修饰为staticThreadLocal能实现了线程的数据隔离,不在于它自己本身,而在于ThreadThreadLocalMap所以,ThreadLocal可以只初始化一次,只分配一块存储空问就足以了,没必要作为成员变量多次被初始化。

  3. 用完记得手动remove,因为多线程线程复用的情况下会造成内存泄露

总结

  • ThreadLocal 并不解决线程间共享数据的问题

  • ThreadLocal 适用于变量在线程间隔离且在方法间共享的场景

  • ThreadLocal 通过隐式的在不同线程内创建独立实例副本避免了实例线程安全的问题

  • 每个线程持有一个只属于自己的专属Map并维护了ThreadLocal对象与具体实例的映射,

  • 该Map由于只被持有它的线程访问,故不存在线程安全以及锁的问题

  • ThreadLocalMap的Entry对ThreadLocal的引用为弱引用,避免了ThreadLocal对象无法被回收的问题

  • 都会通过expungeStaleEntry, cleanSomeSlots, replaceStaleEntry这三个方法回收键为 nullEntry

  • 对家的值(即为具体实例)以及 Entry对象本身从而防止内存证漏,属手安全加固的方法