由浅入深全面解析threadlocal

最新推荐文章于 2024-08-14 10:17:22 发布

笼中小夜莺

最新推荐文章于 2024-08-14 10:17:22 发布

阅读量509

点赞数

分类专栏：后端技术精进文章标签： java 后端 threadlocal 并发编程

本文链接：https://blog.csdn.net/m0_46521785/article/details/121024359

版权

后端技术精进专栏收录该内容

3 篇文章 0 订阅

订阅专栏

https://blog.csdn.net/weixin_50280576/article/details/113849450

ThreadLocal介绍

ThreadLocal 是什么

从Java官方文档中的描述：ThreadLocal类用来提供线程内部的局部变量。这种变量在多线程环境下访问（通过get和set方法访问）时能保证各个线程的变量相对独立于其他线程内的变量。ThreadLocal实例通常来说都是private static类型的，用于关联线程和线程上下文。

ThreadLocal 有两大作用：

线程间：线程隔离，避免争用引发线程安全问题
线程内：实现了线程内资源共享

总结：

线程并发：在多线程并发的场景下，即单线程是用不到的
传递数据：我们可以通过ThreadLocal在同一线程，不同组件中传递公共变量
线程隔离：每个线程的变量都是独立的，不会互相影响

ThreadLocal原理

每个线程内有一个 ThreadLocalMap类型的成员变量，用来存储资源对象

调用set方法，就是以 Threadlocal自己作为key，资源对象作为vaue，放入当前线程的 ThreadLocalMap集合中
调用get方法，就是以 Threadlocal自己作为key，到当前线程中查找关联的资源值
调用 remove方法，就是以 Threadloca自己作为key，移除当前线程关联的资源值

常用方法介绍

方法声明	描述
ThreadLocal()	创建ThreadLocal对象
public void set( T value)	设置当前线程绑定的局部变量
public T get()	获取当前线程绑定的局部变量
public void remove()	移除当前线程绑定的局部变量
protected T initialValue()	返回当前线程的这个线程局部变量的初始值
public static ThreadLocal withInitial(xxx)	创建线程局部变量，通过get方法，jdk1.8 才支持

ThreadLocal简单使用

问题引出

首先，看一个卖票的场景，使用 3 个线程进行卖票，由于 ticketNumber 是每个线程共享的资源，存在线程安全问题，所以使用 synchronized 加锁，上面的代码存在的问题是，多个线程只有一把锁，只有当上一个线程释放锁，才有机会拿到锁，这是因为多个线程使用的是一个共享的变量，如果说每个线程都有自己的本地副本变量，那么也就不会存在线程安全问题，是一种不加锁的方式解决线程安全问题。

使用ThreadLocal解决

多个线程在访问同一个变量的时候出现的异常，线程间的数据没有隔离，如果不用ThreadLocal的话线程之间的数据隔离没有实现，采用 ThreadLocal 可以解决这个问题

public class MyDemo1 {
    private static ThreadLocal<String> tl = new ThreadLocal<>();
    private String content;
    private String getContent() {
        //return content;//不使用ThreadLocal
        return tl.get();
    }
    private void setContent(String content) {
        //this.content = content;//不使用ThreadLocal
        tl.set(content);
    }
    public static void main(String[] args) {
        MyDemo demo = new MyDemo();
        for (int i = 0; i < 5; i++) {
            Thread thread = new Thread(new Runnable() {
                @Override
                public void run() {
                    demo.setContent(Thread.currentThread().getName() + "的数据");
                    System.out.println("-----------------------");
                    System.out.println(Thread.currentThread().getName() + "--->" + demo.getContent());
                }
            });
            thread.setName("线程" + i);
            thread.start();
        }
    }
}

ThreadLocal类与synchronized关键字的区别

	synchronized	ThreadLocal
原理	同步机制采用`以时间换空间`的方式，只提供了一份变量，让不同的线程排队访问	ThreadLocal采用`以空间换时间`的方式，为每一个线程都提供了一份变量的副本，从而实现同时访问而相不干扰
侧重点	多个线程之间访问资源的同步	多线程中让每个线程之间的数据相互隔离
并发性	线程隔离：各线程之间的数据相互隔离却又具备并发性，避免同步方式带来的性能损失	不具有并发性

ThreadLocal的内部结构

早期的设计

如果我们不去看源代码的话，可能会猜测ThreadLocal是这样子设计的：每个ThreadLocal都创建一个Map，然后用线程作为Map的key，要存储的局部变量作为Map的value，这样就能达到各个线程的局部变量隔离的效果。这是最简单的设计方法，JDK最早期的ThreadLocal 确实是这样设计的，但现在早已不是了。
在这里插入图片描述

现在的设计

但是，JDK后面优化了设计方案，在JDK8中 ThreadLocal的设计是：每个Thread维护一个ThreadLocalMap，这个Map的key是ThreadLocal实例本身，value才是真正要存储的值Object。

具体的过程是这样的：

每个Thread线程内部都有一个Map (ThreadLocalMap)
Map里面存储ThreadLocal对象（key）和线程的变量副本（value）
Thread内部的Map是由ThreadLocal维护的，由ThreadLocal负责向map获取和设置线程的变量值。
对于不同的线程，每次获取副本值时，别的线程并不能获取到当前线程的副本值，形成了副本的隔离，互不干扰。

这样设计的好处

这个设计与我们一开始说的设计刚好相反，这样设计有如下两个优势：

这样设计之后每个Map存储的Entry数量就会变少。因为之前的存储数量由Thread的数量决定，现在是由ThreadLocal的数量决定。在实际运用当中，往往ThreadLocal的数量要少于Thread的数量。
当Thread销毁之后，对应的ThreadLocalMap也会随之销毁，能减少内存的使用。

ThreadLocal的核心方法源码

基于ThreadLocal的内部结构，我们继续分析它的核心方法源码，更深入的了解其操作原理。

除了构造方法之外， ThreadLocal对外暴露的方法有以下4个：

方法声明	描述
protected T initialValue()	返回当前线程局部变量的初始值
public void set( T value)	设置当前线程绑定的局部变量
public T get()	获取当前线程绑定的局部变量
public void remove()	移除当前线程绑定的局部变量

以下是这4个方法的详细源码分析(为了保证思路清晰, ThreadLocalMap部分暂时不展开,下一个知识点详解)

set方法执行流程

首先获取当前线程，并根据当前线程获取一个Map
如果获取的Map不为空，则将参数设置到Map中（当前ThreadLocal的引用作为key）
如果Map为空，则给该线程创建 Map，并设置初始值

get方法执行流程

首先获取当前线程, 根据当前线程获取一个Map
如果获取的Map不为空，则在Map中以ThreadLocal的引用作为key来在Map中获取对应的Entry e，否则转到D
- 如果e不为null，则返回e.value，否则转到D
Map为空或者e为空，则通过initialValue函数获取初始值value，然后用ThreadLocal的引用和value作为firstKey和firstValue创建一个新的Map

总结：先获取当前线程的 ThreadLocalMap 变量，如果存在则返回值，不存在则创建并返回初始值

remove方法执行流程

首先获取当前线程，并根据当前线程获取一个Map
如果获取的Map不为空，则移除当前ThreadLocal对象对应的entry

initialValue方法执行流程

此方法被protected修饰，作用是返回该线程局部变量的初始值。此方法的第一次调用发生在，当线程通过get方法访问此线程的ThreadLocal值时，除非线程先调用了set方法，在这种情况下，initialValue 才不会被这个线程调用。通常情况下，每个线程最多调用一次这个方法。

这个方法是一个延迟调用方法，从上面的代码我们得知，在set方法还未调用而先调用了get方法时才执行，并且仅执行1次。
这个方法缺省实现直接返回一个null。
如果想要一个除null之外的初始值，可以重写此方法。（备注：该方法是一个protected的方法，显然是为了让子类覆盖而设计的）

ThreadLocalMap基本结构

ThreadLocalMap是ThreadLocal的内部类，没有实现Map接口，用独立的方式实现了Map的功能，其内部的Entry也是独立实现。
在这里插入图片描述

成员变量

//初始容量 —— 必须是2的整次幂
private static final int INITIAL_CAPACITY = 16;

//存放数据(键值对)的table，Entry类的定义在下面分析，同样，数组长度必须是2的整次幂。
private Entry[] table;

//数组里面entrys的个数，可以用于判断table当前使用量是否超过阈值。
private int size = 0;

//进行扩容的阈值，表使用量大于它的时候进行扩容。
private int threshold; // Default to 0

存储结构 - Entry

/*
 * Entry继承WeakReference，并且用ThreadLocal作为key.
 * 如果key为null(entry.get() == null)，意味着key不再被引用，
 * 因此这时候entry也可以从table中清除。
 */
static class Entry extends WeakReference<ThreadLocal<?>> {
    /** The value associated with this ThreadLocal. */
    Object value;
    Entry(ThreadLocal<?> k, Object v) {
        super(k);
        value = v;
    }
}

在ThreadLocalMap中，也是用Entry来保存K-V结构数据的。不过Entry中的key只能是ThreadLocal对象，这点在构造方法中已经限定死了。

另外，Entry继承WeakReference，也就是key（ThreadLocal）是弱引用，其目的是将ThreadLocal对象的生命周期和线程生命周期解绑。

弱引用和内存泄漏

有些程序员在使用ThreadLocal的过程中会发现有内存泄漏的情况发生，就猜测这个内存泄漏跟Entry中使用了弱引用的key有关系。这个理解其实是不对的。

我们先来回顾这个问题中涉及的几个名词概念，再来分析问题。

内存泄漏相关概念

内存溢出：没有足够的内存提供申请者使用。
内存泄漏：指程序中已动态分配的堆内存由于某种原因程序未释放或无法释放，造成系统内存的浪费，导致程序运行速度减慢甚至系统崩溃等严重后果。内存泄漏的堆积终将导致内存溢出。

Java中引用类型及特点

Java中的引用有4种类型：强、软、弱、虚，当前这个问题主要涉及到强引用和弱引用

强引用：我们平时一般都是这种引用，当一个对象被一个或一个以上的引用变量所引用时，它处于可达状态，不可能被系统垃圾回收机制回收。
软引用：软引用需要通过SoftReference类来实现，当一个对象只具有软引用时，它有可能被垃圾回收机制回收。对于只有软引用的对象而言，当系统内存空间足够时，它不会被系统回收，程序也可以使用该对象，当系统内存空间不够时，系统可能回收它。软引用通常用于对内存敏感的程序中。
弱引用：弱引用通过WeakReference类实现，弱引用和软引用很像，但弱引用的引用级别更低。对于只有弱引用的对象而言，当系统垃圾回收机制运行时，不管系统内存是否足够，总会回收该对象所占用的内存。当然，并不是说当一个对象只有弱引用时，它就会被立即回收，而是必须等到系统垃圾回收机制运行时才会被回收。
虚引用：虚引用通过PhantomReference类实现，虚应用完全类似于没有引用。虚引用对对象本身没有太大影响，对象甚至感觉不到虚引用的存在。

如果key使用强引用

假设ThreadLocalMap中的key使用了强引用，那么会出现内存泄漏吗？此时ThreadLocal的内存图（实线表示强引用）如下：
在这里插入图片描述

假设在业务代码中使用完ThreadLocal ，threadLocal Ref被回收了。
但是因为threadLocalMap的Entry强引用了threadLocal，造成threadLocal无法被回收。
在没有手动删除这个Entry以及CurrentThread依然运行的前提下，始终有强引用链 threadRef->currentThread->threadLocalMap->entry，Entry就不会被回收（Entry中包括了ThreadLocal实例和value），导致Entry内存泄漏。
也就是说ThreadLocalMap中的key使用了强引用，是无法完全避免内存泄漏的。

如果key使用弱引用

那么ThreadLocalMap中的key使用了弱引用，会出现内存泄漏吗？

此时ThreadLocal的内存图（实线表示强引用，虚线表示弱引用）如下：
在这里插入图片描述

同样假设在业务代码中使用完ThreadLocal ，threadLocal Ref被回收了。
由于ThreadLocalMap只持有ThreadLocal的弱引用，没有任何强引用指向threadlocal实例, 所以threadlocal就可以顺利被gc回收，此时Entry中的key=null。
但是在没有手动删除这个Entry以及CurrentThread依然运行的前提下，也存在有强引用链 threadRef->currentThread->threadLocalMap->entry -> value ，value不会被回收，而这块value永远不会被访问到了，导致value内存泄漏。
也就是说，ThreadLocalMap中的key使用了弱引用，也有可能内存泄漏。

出现内存泄漏的真实原因

比较以上两种情况，我们就会发现，内存泄漏的发生跟ThreadLocalMap中的key是否使用弱引用是没有关系的，在以上两种内存泄漏的情况中，都有两个前提：

没有手动删除这个Entry
CurrentThread依然运行

第一点很好理解，只要在使用完ThreadLocal，调用其remove方法删除对应的Entry，就能避免内存泄漏。

第二点稍微复杂一点，由于ThreadLocalMap是Thread的一个属性，被当前线程所引用，所以它的生命周期Thread一样长。那么在使用完ThreadLocal之后，如果当前Thread也随之执行结束，ThreadLocalMap自然也会被gc回收，从根源上避免了内存泄漏。

综上，ThreadLocal内存泄漏的根源是：由于ThreadLocalMap的生命周期跟Thread一样长，如果没有手动删除对应key就会导致内存泄漏。

为什么使用弱引用

我们知道，无论ThreadLocalMap中的key使用哪种类型引用都无法完全避免内存泄漏，跟使用弱引用没有关系。

要避免内存泄漏有两种方式：

使用完ThreadLocal，调用其remove方法删除对应的Entry
使用完ThreadLocal，当前Thread也随之运行结束

相对第一种方式，第二种方式显然更不好控制，特别是使用线程池的时候，线程结束是不会销毁的。

也就是说，只要记得在使用完ThreadLocal及时的调用remove，无论key是强引用还是弱引用都不会有问题。那么为什么key要用弱引用呢？

事实上，在ThreadLocalMap中的set/getEntry方法中，会对key为null（也即是ThreadLocal为null）进行判断，如果为null的话，那么是会对value置为null的。
这就意味着使用完ThreadLocal，CurrentThread依然运行的前提下，就算忘记调用remove方法，弱引用比强引用可以多一层保障：弱引用的ThreadLocal会被回收，对应的value在下一次ThreadLocalMap调用set,get,remove中的任一方法的时候会被清除，从而避免内存泄漏。

ThreadLocalMap释放value的时机

获取key发现 null key，然后清除掉
set key时，会使用启发式扫描，清除当前（如果key为null就清理当前值）和临近的 null key。启发次数与元素个数，元素多就扫描范围多一些，元素少就扫描范围少一些，是否发现null key有关，如果发现了null key就扫描的多，没发现就扫描的少
remove时(推荐)，因为一般使用 Threadloca时都把它作为静态变量，因此GC无法回收

ThreadLocalMap的hash冲突

冲突的产生

在构造方法中计算ThreadLocal的firstKey变量对应的索引时会产生冲突

冲突的解决

ThreadLocalMap使用线性探测法来解决哈希冲突的。

该方法一次探测下一个地址，直到有空的地址后插入，若整个空间都找不到空余的地址，则产生溢出。

举个例子，假设当前table长度为16，也就是说如果计算出来key的hash值为14，如果table[14]上已经有值，并且其key与当前key不一致，那么就发生了hash冲突，这个时候将14加1得到15，取table[15]进行判断，这个时候如果还是冲突会回到0，取table[0],以此类推，直到可以插入。

按照上面的描述，可以把Entry[] table看成一个环形数组。

ThreadLocal的set() 方法

首先获取当前线程，并根据当前线程获取一个Map
如果获取的Map不为空，则将参数设置到Map中（当前ThreadLocal的引用作为key），这里调用了ThreadLocalMap的set方法
如果Map为空，则给该线程创建 Map，并设置初始值，这里调用了ThreadLocalMap的构造方法

ThreadLocalMap的构造方法

 /*
  * firstKey : 本ThreadLocal实例(this)
  * firstValue ： 要保存的线程本地变量
  */
ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
        //初始化table
        table = new ThreadLocal.ThreadLocalMap.Entry[INITIAL_CAPACITY];
        //计算索引(重点代码）
        int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
        //设置值
        table[i] = new ThreadLocal.ThreadLocalMap.Entry(firstKey, firstValue);
        size = 1;
        //设置阈值
        setThreshold(INITIAL_CAPACITY);
    }

构造函数首先创建一个长度为16的Entry数组，然后计算出firstKey对应的索引，然后存储到table中，并设置size和threshold。

重点分析： int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY \- 1)。

关于firstKey.threadLocalHashCode：定义了一个AtomicInteger类型，每次获取当前值并加上HASH_INCREMENT，HASH_INCREMENT = 0x61c88647,这个值跟斐波那契数列（黄金分割数）有关，其主要目的就是为了让哈希码能均匀的分布在2的n次方的数组里, 也就是Entry[] table中，这样做可以尽量避免hash冲突。
关于& (INITIAL_CAPACITY - 1)：计算hash的时候里面采用了hashCode & (size - 1)的算法，这相当于取模运算hashCode % size的一个更高效的实现。正是因为这种算法，我们要求size必须是2的整次幂，这也能保证在索引不越界的前提下，使得hash发生冲突的次数减小。

ThreadLocalMap中的set方法

首先还是根据key计算出索引 i，然后查找i位置上的Entry
若是Entry已经存在并且key等于传入的key，那么这时候直接给这个Entry赋新的value值
若是Entry存在，但是key为null，则调用replaceStaleEntry来更换这个key为空的Entry
不断循环检测，直到遇到为null的地方，这时候要是还没在循环过程中return，那么就在这个null的位置新建一个Entry，并且插入，同时size增加1。
最后调用cleanSomeSlots，清理key为null的Entry，最后返回是否清理了Entry，接下来再判断sz 是否>= thresgold达到了rehash的条件，达到的话就会调用rehash函数执行一次全表的扫描清理。