「JUC篇」之 通俗易懂而又不失深度的ThreadLocal详解

JavaLyHn
114 阅读14分钟

开启掘金成长之旅！这是我参与「掘金日新计划 · 2 月更文挑战」的第 3 天，点击查看活动详情

觉得对你有益的小伙伴记得点个赞+关注

后续完整内容持续更新中

希望一起交流的欢迎发邮件至javalyhn@163.com

1. ThreadLocal简介

1.1 是什么

image.png

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

1.2 能干嘛

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

image.png

1.3 api介绍

image.png

1.4 案例演示

/*
5个销售卖完随机数房子 各自独立销售额度 自己业绩按提成走 分灶吃饭 各个销售自己动手 丰衣足食
 */
public class ThreadLocalDemo {
    public static void main(String[] args) {
        House house = new House();
        for (int i = 0; i < 5; i++) {
            new Thread(() -> {
                int size = new Random().nextInt(5)+1;
//                System.out.println(size);
                try {
                    for (int j = 0; 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.SECONDS.sleep(1); } catch (InterruptedException e){ e.printStackTrace(); }

        System.out.println(Thread.currentThread().getName() + "\t" +"共计卖出多少车：" + house.saleCount);
    }
}

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

image.png

1.5 案例总结

  1. 因为每个Thread都有自己的实例副本，并且该副本仅有自己使用
  2. 既然其他线程不能访问，那就不存在多线程问题
  3. 统一设置初始值，但是每个线程对这个值的修改都是各自线程相互独立的

怎样才能做到不争抢 A 加入synchronized同步锁或者Lock控制对资源的访问 B 每个线程人手一份，互不争抢

2. 非线程安全的SimpleDateFormat

2.1 阿里ThreadLocal规范

image.png

2.2 官网文档

image.png

SimpleDateFormat中的日期格式不是同步的。推荐（建议）为每个线程创建独立的格式实例。如果多个线程同时访问一个格式，则它必须保持外部同步。

2.3 代码演示

  public static final SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    /**
     * 模拟并发环境下使用SimpleDateFormat的parse方法将字符串转换成Date对象
     * @param stringDate
     * @return
     * @throws Exception
     */
    public static Date parseDate(String stringDate)throws Exception
    {
        return sdf.parse(stringDate);
    }
    
    public static void main(String[] args) throws Exception
    {
        for (int i = 1; i <=30; i++) {
            new Thread(() -> {
                try {
                    System.out.println(DateUtils.parseDate("2020-11-11 11:11:11"));
                } catch (Exception e) {
                    e.printStackTrace();
                }
            },String.valueOf(i)).start();
        }
    }

image.png

可见不仅有bug而且原因还不一样

2.4 源码分析结论

SimpleDateFormat类内部有一个Calendar对象引用,它用来储存和这个SimpleDateFormat相关的日期信息,例如sdf.parse(dateStr),sdf.format(date) 诸如此类的方法参数传入的日期相关String,Date等等, 都是交由Calendar引用来储存的.这样就会导致一个问题如果你的SimpleDateFormat是个static的, 那么多个thread 之间就会共享这个SimpleDateFormat, 同时也是共享这个Calendar引用。

image.png

image.png

2.5 解决方案一

将SimpleDateFormat定义成局部变量。

缺点：每调用一次方法就会创建一个SimpleDateFormat对象，方法结束又要作为垃圾回收。

 public static final SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    /**
     * 模拟并发环境下使用SimpleDateFormat的parse方法将字符串转换成Date对象
     * @param stringDate
     * @return
     * @throws Exception
     */
    public static Date parseDate(String stringDate)throws Exception
    {
        return sdf.parse(stringDate);
    }

    public static void main(String[] args) throws Exception
    {
        for (int i = 1; i <=30; i++) {
            new Thread(() -> {
                try {
                    SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
                    System.out.println(sdf.parse("2020-11-11 11:11:11"));
                    sdf = null;
                } catch (Exception e) {
                    e.printStackTrace();
                }
            },String.valueOf(i)).start();
        }
    }

2.6 解决方案二

ThreadLocal，也叫做线程本地变量或者线程本地存储

 private static final ThreadLocal<SimpleDateFormat>  sdf_threadLocal =
            ThreadLocal.withInitial(()-> new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));

    /**
     * ThreadLocal可以确保每个线程都可以得到各自单独的一个SimpleDateFormat的对象，那么自然也就不存在竞争问题了。
     * @param stringDate
     * @return
     * @throws Exception
     */
    public static Date parseDateTL(String stringDate)throws Exception
    {
        return sdf_threadLocal.get().parse(stringDate);
    }

    public static void main(String[] args) throws Exception
    {
        for (int i = 1; i <=30; i++) {
            new Thread(() -> {
                try {
                    System.out.println(DateUtils.parseDateTL("2020-11-11 11:11:11"));
                } catch (Exception e) {
                    e.printStackTrace();
                }
            },String.valueOf(i)).start();
        }
    }

2.7 解决方案三

加锁、第三方时间库

例如DateUtils

  /*
    1   SimpleDateFormat如果多线程共用是线程不安全的类
    public static final SimpleDateFormat SIMPLE_DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

    public static String format(Date date)
    {
        return SIMPLE_DATE_FORMAT.format(date);
    }

    public static Date parse(String datetime) throws ParseException
    {
        return SIMPLE_DATE_FORMAT.parse(datetime);
    }*/

    //2   ThreadLocal可以确保每个线程都可以得到各自单独的一个SimpleDateFormat的对象，那么自然也就不存在竞争问题了。
    public static final ThreadLocal<SimpleDateFormat> SIMPLE_DATE_FORMAT_THREAD_LOCAL = ThreadLocal.withInitial(() -> new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));

    public static String format(Date date)
    {
        return SIMPLE_DATE_FORMAT_THREAD_LOCAL.get().format(date);
    }

    public static Date parse(String datetime) throws ParseException
    {
        return SIMPLE_DATE_FORMAT_THREAD_LOCAL.get().parse(datetime);
    }


    //3 DateTimeFormatter 代替 SimpleDateFormat
    /*public static final DateTimeFormatter DATE_TIME_FORMAT = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");

    public static String format(LocalDateTime localDateTime)
    {
        return DATE_TIME_FORMAT.format(localDateTime);
    }

    public static LocalDateTime parse(String dateString)
    {

        return LocalDateTime.parse(dateString,DATE_TIME_FORMAT);
    }*/

3. ThreadLocal源码分析

3.1 认识几个类

Thread、ThreadLocal、ThreadLocalMap、Entry

ThreadLocalMap是ThreadLocal的静态内部类

3.2 这三个类的关系

Thread和ThreadLocal

image.png

image.png

image.png

ThreadLocal和ThreadLocalMap

image.png 可知ThreadLocalMap是ThreadLocal的静态内部类

ThreadLocalMap和Entry

image.png

可见Entry是ThreadLocalMap定义的静态内部类

3.3 从get方法看ThreadLocal原理

public T get() {
    //1 获取当前线程
    Thread t = Thread.currentThread();
    //2 根据当前线程获取ThreadLocalMap
    ThreadLocalMap map = getMap(t);
    //3 如果获取的mao对象不为空就进入if语句
    if (map != null) {
        //4 由当前Threadlocal对象得到对应的值
        ThreadLocalMap.Entry e = map.getEntry(this);
        //5 如果e不为空，即Entry有数据，就进入if语句
        if (e != null) {
            //6 得到结果值，并返回
            @SuppressWarnings("unchecked")
            T result = (T)e.value;
            return result;
        }
    }
    //7 map对象为空，进入该方法初始化ThreadLocal成员变量的值
    return setInitialValue();
}

private T setInitialValue() {
        //1 初始化value的值
        T value = initialValue();
        //2 获取当前线程
        Thread t = Thread.currentThread();
        //3 以当前线程为key，获取ThreadLocal成员变量，它是一个ThreadLocalMap
        ThreadLocalMap map = getMap(t);
        if (map != null)
        //4 
            map.set(this, value);
        else
            //创建map
            createMap(t, value);
        return value;
    }

3.4 从set方法看ThreadLocal原理

public void set(T value) {
        //获取当前线程t
       Thread t = Thread.currentThread();
       //根据当前线程获取到ThreadLocalMap
       ThreadLocalMap map = getMap(t);
       //如果获取的ThreadLocalMap对象不为空
       if (map != null)  
           //将当前Threadlocal，value设置到ThreadLocalMap中
           map.set(this, value); 
       else
           //创建一个新的ThreadLocalMap
           createMap(t, value); 
   }
   
    ThreadLocalMap getMap(Thread t) {
        //返回Thread对象的ThreadLocalMap属性
      return t.threadLocals; 
   }

   //调用ThreadLocalMap的构造函数
   void createMap(Thread t, T firstValue) { 
       //this表示当前类ThreadLocal
       t.threadLocals = new ThreadLocalMap(this, firstValue); 
   }

3.5 Thread、ThreadLocal、ThreadLocalMap、Entry小总结

image.png

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

3.6 总结

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

每一个Thread都有属于自己的一个实例变量threadLocals，它的类型是ThreadLocal.ThreadLocalMap；

ThreadLocalMap自定义了一个静态内部类Entry，每一个Entry代表一个完整的对象，key是ThreadLocal对象，value是保存的ThreadLocal泛型值；

在并发线程的读取下，每一个Thread向ThreadLocal设置值时，都是向Thread内部的ThreadLocalMap这个成员变量进行赋值，在读取时，以当前ThreadLocal作为引用，往自己的map里找对应的key。

image.png

4. Java中的四大引用

4.1 强引用

这是在我们开发中用到的最多的引用，也是默认支持模式。

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

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

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

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

    myObject = null;
    System.gc();
    try { TimeUnit.SECONDS.sleep(1); } catch (InterruptedException e) { e.printStackTrace(); }

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

image.png

4.2 软引用

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

对于只有软引用的对象来说，

- 当系统内存充足时它 不会 被回收，

- 当系统内存不足时它 会 被回收。 软引用通常用在对内存敏感的程序中，比如高速缓存就有用到软引用，内存够用的时候就保留，不够用就回收！

static class MyObject
{
    //一般开发中不用调用这个方法，本次只是为了演示
    @Override
    protected void finalize() throws Throwable
    {
        System.out.println(Thread.currentThread().getName()+"\t"+"---finalize method invoked....");
    }
}

public static void main(String[] args)
{
    //当我们内存不够用的时候，soft会被回收的情况，设置我们的内存大小：-Xms10m -Xmx10m
    SoftReference<MyObject> softReference = new SoftReference<>(new MyObject());

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

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

image.png

4.3 弱引用

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

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

static class MyObject
{
    //一般开发中不用调用这个方法，本次只是为了演示
    @Override
    protected void finalize() throws Throwable
    {
        System.out.println(Thread.currentThread().getName()+"\t"+"---finalize method invoked....");
    }
}

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) { e.printStackTrace(); }

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

image.png

4.4 软引用与弱引用的使用场景

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

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

此时使用软引用可以解决这个问题。

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

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

4.5 虚引用

虚引用需要java.lang.ref.PhantomReference类来实现。

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

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

其意义在于：说明一个对象已经进入finalization阶段，可以被gc回收，用来实现比finalization机制更灵活的回收操作。

换句话说，设置虚引用关联的唯一目的，就是在这个对象被收集器回收的时候收到一个系统通知或者后续添加进一步的处理。

构造方法

image.png

引用队列

image.png

被回收前需要被引用队列保存一下

static class MyObject
{
    //一般开发中不用调用这个方法，本次只是为了演示
    @Override
    protected void finalize() throws Throwable
    {
        System.out.println(Thread.currentThread().getName()+"\t"+"---finalize method invoked....");
    }
}

public static void main(String[] args)
{
    ReferenceQueue<MyObject> referenceQueue = new ReferenceQueue();
    PhantomReference<MyObject> phantomReference = new PhantomReference<>(new 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(600); } catch (InterruptedException e) { e.printStackTrace(); }
            System.out.println(phantomReference.get());
        }
    },"t1").start();

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

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

}

image.png

5. ThreadLocal内存泄露问题

5.1 看阿里规范手册

image.png

必须回收自定义的ThreadLocal变量

5.2 什么是内存泄漏

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

5.3 造成原因

image.png

我们再来回顾一下ThreadLocal原理

image.png

image.png

每个Thread对象维护着一个ThreadLocalMap的引用

ThreadLocalMap是ThreadLocal的内部类，用Entry来进行存储

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

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

ThreadLocal本身并不存储值，它只是自己作为一个key来让线程从ThreadLocalMap获取value，正因为这个原理，所以ThreadLocal能够实现“数据隔离”，获取当前线程的局部变量值，不受其他线程影响～

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

public void function01()
{
    ThreadLocal tl = new ThreadLocal<Integer>();    //line1
    tl.set(2021);                                   //line2
    tl.get();                                       //line3
}

line1新建了一个ThreadLocal对象，t1 是强引用指向这个对象； line2调用set()方法后新建一个Entry，通过源码可知Entry对象里的k是弱引用指向这个对象。

image.png

为什么源代码用弱引用? 当function01方法执行完毕后，栈帧销毁强引用 tl 也就没有了。但此时线程的ThreadLocalMap里某个entry的key引用还指向这个对象

若这个key引用是强引用，就会导致key指向的ThreadLocal对象及v指向的对象不能被gc回收，造成内存泄漏

若这个key引用是弱引用就大概率会减少内存泄漏的问题(还有一个key为null的雷)。使用弱引用，就可以使ThreadLocal对象在方法执行完毕后顺利被回收且Entry的key引用指向为null。

有关key为null的坑，我们下面会说

在此先大体知道一下

此后我们调用get,set或remove方法时，就会尝试删除key为null的entry，可以释放value对象所占用的内存。

5.5 弱引用就万事大吉了吗？

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

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

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

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

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

set方法

image.png

image.png

get方法

image.png

image.png

image.png

remove方法

image.png

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

image.png

image.png

一定要手动remove！！！！！！！！！！！！！！！！！

5.7 最佳实践

如何定义？

image.png

image.png

一定要手动remove！！！！！！！！！！！！！！！！！

6. 终章总结

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

那么这章就到这里了，如果对你有帮助，不妨点个赞~~~

avatar
文章
阅读
粉丝