ThreadLocal源码

vibag

于 2024-03-20 21:53:36 发布

阅读量659

点赞数 24

文章标签： jvm java 开发语言

本文链接：https://blog.csdn.net/weixin_42828342/article/details/136877055

版权

ThreadLocal用来解决多线程的并发问题，ThreadLocal是线程局部变量，它的作用是为每一个使用变量的线程都提供一个变量值的副本，使得每一个线程都可以独立地改变自己的副本，而不会和其他线程的副本冲突，从线程的角度看，就好像每一个线程都完全拥有该变量，从而达到了线程隔离的效果。

ThreadLocal

ThreadLocal的设计简单，它有四个方法：get()、set(Object value)和initialValue()、remove()。其中

get()方法返回当前线程的线程局部变量副本；
set(Object value)方法设置当前线程的线程局部变量副本的值；
initialValue()方法返回当前线程的线程局部变量的初始值。initialValue()方法是一个延迟调用方法，set方法还未调用而先调用了get方法时才执行，并且仅执行1次；
remove() 方法用于从当前线程的 ThreadLocalMap 中移除与当前 ThreadLocal
对象关联的值。这个方法通常在不再需要 ThreadLocal 变量时调用，以防止内存泄漏。

实现原理：ThreadLocal 的实现原理主要基于 ThreadLocalMap 类，每个线程都有一个独立的 ThreadLocalMap 实例，ThreadLocalMap 是一个哈希表，它包含了一个 Entry 数组，Entry 对象是一个键值对，其中key是 ThreadLocal 对象，value是与之关联的值，这样可以确保线程之间的数据隔离。

Set()方法源码

set方法用于设置ThreadLocal对应的值

    public void set(T value) {
        // 得到当前的线程对象
        Thread t = Thread.currentThread();
        // 得到t线程维护的ThreadLocalMap对象
        ThreadLocalMap map = getMap(t);
        // 若map已经存在
        if (map != null)
            // 通过map的set方法设置键值对(ThreadLocal,value)
            map.set(this, value);
        else
				//创建当前线程的ThreadLocalMap
            createMap(t, value);
    }

     //返回当前线程的ThreadLocalMap对象
    ThreadLocalMap getMap(Thread t) {
        return t.threadLocals;
    }
     //创建t线程的ThreadLocalMap
	void createMap(Thread t, T firstValue) {
        //这里的this是调用此方法的threadLocal
        t.threadLocals = new ThreadLocalMap(this, firstValue);
    }

	//构造方法
	   ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
	   //初始化大小为16的Entry数组table
            table = new Entry[INITIAL_CAPACITY];
     //ThreadLocal的哈希值&（初始容量大小-1）= 索引i
     //索引i表示Entry对象在数组中存放的位置
            int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
         //在索引i的位置创建Entry对象（ThreadLocal,Value）
            table[i] = new Entry(firstKey, firstValue);
            //当前Mqp中的键值对个数为1
            size = 1;
           	//设置阈值，当达到阈值时10时需要进行扩容
            setThreshold(INITIAL_CAPACITY);
        }

set()方法的执行流程

首先获取当前线程对应的ThreadLocalMap，若Map不为空，则以键值对<ThreadLocal，Value>的方式插入到Map中，若为空，则为当前线程创建Map对象，并设置初始值null。

get()方法源码

     //返回线程中ThreadLocal关联的值
    public T get() {
        // 得到当前线程的对象
        Thread t = Thread.currentThread();
        // 得到当前线程对应的ThreadLocalMap对象
        ThreadLocalMap map = getMap(t);
        // 若map存在
        if (map != null) {
            //获取当前ThreadLocal对应的Entry对象
            ThreadLocalMap.Entry e = map.getEntry(this);
            // 若Entry对象不为空
            if (e != null) {
                @SuppressWarnings("unchecked")
                //获取ThreadLocal关联的值
                T result = (T)e.value;
                //返回ThreadLocal关联的值
                return result;
            }
        }
         //若当前对象的ThreadLocalMap不存在或者ThreadLocal的Entry对象不存在，
         //则进行初始化
        return setInitialValue();
    }

    //设置初始化的值
    private T setInitialValue() {
        //获取初始化的值，默认为null，
        //如果需要初始化成其他值，需要子类重写该方法
        T value = initialValue();
        // 得到当前线程对象
        Thread t = Thread.currentThread();
        //得到当前对象维护的ThreadLocalMap对象
        ThreadLocalMap map = getMap(t);
        // 若map存在
        if (map != null)
            //ThreadLocalMap存在则调用set方法设置Entry对象的键值对
            map.set(this, value);
        else
         // ThreadLocalMap不存在，则创建ThreadLocalMap  
            createMap(t, value);
        // 返回所设置的值value
        return value;
    }
    
    //创建t线程的ThreadLocalMap
	void createMap(Thread t, T firstValue) {
        //这里的this是调用此方法的threadLocal
        t.threadLocals = new ThreadLocalMap(this, firstValue);
    }

	//构造方法
	   ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
	   //初始化大小为16的Entry数组table
            table = new Entry[INITIAL_CAPACITY];
     //ThreadLocal的哈希值&（初始容量大小-1）= 索引i
     //索引i表示Entry对象在数组中存放的位置
            int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
         //在索引i的位置创建Entry对象（ThreadLocal,Value）
            table[i] = new Entry(firstKey, firstValue);
            //当前Mqp中的键值对个数为1
            size = 1;
           	//设置阈值为初始容量的2/3=10，当达到阈值10时需要进行扩容
            setThreshold(INITIAL_CAPACITY);
        }

get()方法的执行流程

首先获取当前线程对象, 根据当前线程获取所维护的ThreadLocalMap，若Map存在，则根据ThreadLocal的引用作为key获取对应的Entry对象e，返回e.value；若Map为空或者Entry对象e为空，则调用initialValue方法获取初始值value，然后用ThreadLocal的引用和初始值value创建新的ThreadLocalMap。
总结: 先获取当前线程所维护的ThreadLocalMap 对象，如果存在则返回Entry对象中ThreadLocal关联的值value，若ThreadLocalMap不存在则创建并返回初始值。

initialValue()方法源码

  //返回当前ThreadLocal关联的初始值
protected T initialValue() {
    return null;
}

initialValue()方法是一个延迟调用方法，set方法还未调用而先调用了get方法时才执行，并且仅执行1次。

remove()方法源码

  public void remove() {
        // 得到当前线程所维护的ThreadLocalMap对象
         ThreadLocalMap m = getMap(Thread.currentThread());
        // 若ThreadLocalMap存在
         if (m != null)
            //调用remove方法删除当前ThreadLocal所在的entry对象
             m.remove(this);
     }

总结： remove()方法首先获取当前线程，根据当前线程对象获取ThreadLocalMap，
若Map不为空，则移除当前ThreadLocal对象对应的entry对象。

ThreadLocalMap源码分析

基本结构

在这里插入图片描述
ThreadLocalMap是ThreadLocal的内部类，实现Map接口，而是独立实现了Map的功能，内部的Entry对象也是继承了WeakReference类。

成员变量

  	//ThreadLocalMap的初始容量为16
    private static final int INITIAL_CAPACITY = 16;
     //存放键值对的Entry数组
    private Entry[] table;
     //数组中Entry对象的个数，用于判断table数组的当前大小是否超过阈值
    private int size = 0;
     //阈值，若size大于阈值则进行扩容
    private int threshold; // Default to 0

INITIAL_CAPACITY表示ThreadLocalMap的初始容量，table 是一个Entry 类型数组，用于存储键值对；size 表示table数组中的Entry个数，threshold 表示阈值，当size大于阈值时需要进行扩容。

存储结构-Entry对象

static class Entry extends WeakReference<ThreadLocal<?>> {
    Object value;
	//设置键值对
    Entry(ThreadLocal<?> k, Object v) {
        super(k);
        value = v;
    }
}

Entry来保存键值对数据<K,V>，构造方法规定了K只能是ThreadLocal对象，另外，Entry对象继承WeakReference类，也就是key（ThreadLocal）是弱引用，是为了将ThreadLocal对象的生命周期与线程的生命周期解绑，避免内存泄漏。

弱引用和内存泄漏

（1）内存泄漏相关概念

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

（2）弱引用相关概念

Java中的引用有4种类型：强、软、弱、虚。ThreadLocal的问题主要涉及到强引用和弱引用：

强引用（“Strong” Reference）：指的是最常见的普通对象引用，只要有强引用指向一个对象，就表明该对象还“活着”，垃圾回收器就不会回收该对象。

弱引用（WeakReference）：垃圾回收器只要发现了只具有弱引用的对象，不管当前内存空间是否足够，都会回收它的内存。

内存泄漏的根本原因

ThreadLocal出现内存泄漏与使用强引用还是弱引用是没有关联的，是因为ThreadLocalMap的生命周期与线程Thread的生命周期是一样的，如果在使用的过程中没有使用remove()方法移除Entry对象，那么就会出现内存泄漏。

（1）若Entry的key使用强引用

此时ThreadLocal的内存图（实线表示强引用）如下：

在这里插入图片描述

若在业务代码中使用完ThreadLocal ，threadLocal Ref被回收了。

但由于ThreadLocalMap的Entry强引用了ThreadLocal，使得ThreadLocal无法被回收。

在没有手动remove()这个Entry对象且CurrentThread依然运行的情况下，始终有强引用链 threadRef->currentThread->ThreadLocalMap->Entry，Entry就不会被回收（Entry中包括了ThreadLocal实例和value），导致Entry出现内存泄漏。所以Entry中的key使用强引用是无法完全避免内存泄漏的。

（2）若Entry的key使用弱引用

此时ThreadLocal的内存图（实线表示强引用，虚线表示弱引用）如下：

在这里插入图片描述

若在业务代码中使用完ThreadLocal ，threadLocal Ref被回收了。

由于ThreadLocalMap只持有ThreadLocal的弱引用，没有任何强引用指向threadlocal实例, 所以threadlocal就可以顺利被gc回收，此时Entry中的key=null。

但是在没有手动remove()这个Entry以及CurrentThread依然运行的情况下，也存在有强引用链 threadRef->currentThread->threadLocalMap->entry -> value ，此时value不会被回收，造成value内存泄漏。所以ThreadLocalMap中的key使用了弱引用，也有可能内存泄漏。

（3）出现内存泄漏的真实原因

以上两种情况的内存泄漏，都有两个前提条件：
1. 没有手动remove这个Entry对象
2. CurrentThread依然在运行

所以防止内存泄漏可以从这两点避免，针对第一种情况，在使用完ThreadLocal完后，调用其remove方法删除对应的Entry对象，就能避免内存泄漏。
针对第二点，由于ThreadLocalMap是Thread的一个属性，被当前线程所引用，所以它的生命周期跟Thread一样。那么在使用完ThreadLocal的使用，如果当前Thread也随之执行结束，ThreadLocalMap自然也会被gc回收，从而避免了内存泄漏。

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

（4）为什么使用弱引用

根据刚才的分析, 我们知道了：无论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中的任一方法的时候会被清除，从而避免内存泄漏。

hash冲突的解决

hash冲突的解决是Map中的一个重要内容。我们以hash冲突的解决为线索，来研究一下ThreadLocalMap的核心源码。

（1）首先从ThreadLocal的set() 方法入手

  public void set(T value) {
        Thread t = Thread.currentThread();
        ThreadLocal.ThreadLocalMap map = getMap(t);
        if (map != null)
            //调用了ThreadLocalMap的set方法
            map.set(this, value);
        else
            createMap(t, value);
    }
    
    ThreadLocal.ThreadLocalMap getMap(Thread t) {
        return t.threadLocals;
    }

    void createMap(Thread t, T firstValue) {
        	//调用了ThreadLocalMap的构造方法
        t.threadLocals = new ThreadLocal.ThreadLocalMap(this, firstValue);
    }

这个方法我们刚才分析过, 其作用是设置当前线程绑定的局部变量 :

A. 首先获取当前线程，并根据当前线程获取一个Map

B. 如果获取的Map不为空，则将参数设置到Map中（当前ThreadLocal的引用作为key）

(这里调用了ThreadLocalMap的set方法)

C. 如果Map为空，则给该线程创建 Map，并设置初始值

(这里调用了ThreadLocalMap的构造方法)

这段代码有两个地方分别涉及到ThreadLocalMap的两个方法, 我们接着分析这两个方法。

（2）构造方法ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue)

 /*
  * 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)。

a. 关于firstKey.threadLocalHashCode：

 	private final int threadLocalHashCode = nextHashCode();
    
    private static int nextHashCode() {
        return nextHashCode.getAndAdd(HASH_INCREMENT);
    }
//AtomicInteger是一个提供原子操作的Integer类，通过线程安全的方式操作加减,适合高并发情况下的使用
    private static AtomicInteger nextHashCode =  new AtomicInteger();
     //特殊的hash值
    private static final int HASH_INCREMENT = 0x61c88647;

这里定义了一个AtomicInteger类型，每次获取当前值并加上HASH_INCREMENT，HASH_INCREMENT = 0x61c88647,这个值跟斐波那契数列（黄金分割数）有关，其主要目的就是为了让哈希码能均匀的分布在2的n次方的数组里, 也就是Entry[] table中，这样做可以尽量避免hash冲突。

b. 关于& (INITIAL_CAPACITY - 1)

计算hash的时候里面采用了hashCode & (size - 1)的算法，这相当于取模运算hashCode % size的一个更高效的实现。正是因为这种算法，我们要求size必须是2的整次幂，这也能保证在索引不越界的前提下，使得hash发生冲突的次数减小。

（3） ThreadLocalMap中的set方法

private void set(ThreadLocal<?> key, Object value) {
        ThreadLocal.ThreadLocalMap.Entry[] tab = table;
        int len = tab.length;
        //计算索引(重点代码，刚才分析过了）
        int i = key.threadLocalHashCode & (len-1);
        /**
         * 使用线性探测法查找元素（重点代码）
         */
        for (ThreadLocal.ThreadLocalMap.Entry e = tab[i];
             e != null;
             e = tab[i = nextIndex(i, len)]) {
            ThreadLocal<?> k = e.get();
            //ThreadLocal 对应的 key 存在，直接覆盖之前的值
            if (k == key) {
                e.value = value;
                return;
            }
            // key为 null，但是值不为 null，说明之前的 ThreadLocal 对象已经被回收了，
           // 当前数组中的 Entry 是一个陈旧（stale）的元素
            if (k == null) {
                //用新元素替换陈旧的元素，这个方法进行了不少的垃圾清理动作，防止内存泄漏
                replaceStaleEntry(key, value, i);
                return;
            }
        }
    
    	//ThreadLocal对应的key不存在并且没有找到陈旧的元素，则在空元素的位置创建一个新的Entry。
            tab[i] = new Entry(key, value);
            int sz = ++size;
            /**
             * cleanSomeSlots用于清除那些e.get()==null的元素，
             * 这种数据key关联的对象已经被回收，所以这个Entry(table[index])可以被置null。
             * 如果没有清除任何entry,并且当前使用量达到了负载因子所定义(长度的2/3)，那么进行				 * rehash（执行一次全表的扫描清理工作）
             */
            if (!cleanSomeSlots(i, sz) && sz >= threshold)
                rehash();
}

 /**
     * 获取环形数组的下一个索引
     */
    private static int nextIndex(int i, int len) {
        return ((i + 1 < len) ? i + 1 : 0);
    }

代码执行流程：

A. 首先还是根据key计算出索引 i，然后查找i位置上的Entry，

B. 若是Entry已经存在并且key等于传入的key，那么这时候直接给这个Entry赋新的value值,

C. 若是Entry存在，但是key为null，则调用replaceStaleEntry来更换这个key为空的Entry,

D. 不断循环检测，直到遇到为null的地方，这时候要是还没在循环过程中return，那么就在这个null的位置新建一个Entry，并且插入，同时size增加1。

最后调用cleanSomeSlots，清理key为null的Entry，最后返回是否清理了Entry，接下来再判断sz 是否>= thresgold达到了rehash的条件，达到的话就会调用rehash函数执行一次全表的扫描清理。

重点分析 ： ThreadLocalMap使用线性探测法来解决哈希冲突的。

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

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

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