前言
ThreadLocal的作用是提供线程内的局部变量,这种变量在多线程环境下访问时能够保证各个线程里变量的独立性。ThreadLocal无论在项目开发还是面试中都会经常碰到,本文就ThreadLocal的使用、主要方法源码详解、内存泄漏问题展开讨论。
1.基本使用
输出结果:
100
User [name=JoonWhee, age=25]
2.ThreadLocal的定义
这个类提供了线程局部变量。这个类能使线程中的某个值与保存值的对象关联起来,例如:“threadLocal.set(5)”,会将“threadLocal”和“5”作为键值对保存在该线程的threadLocals里。ThreadLocal提供了get与set等访问接口或方法,这些方法为每个使用该变量的线程都存有一份独立的副本(即每个线程的threadLocals属性),因此get总是返回由当前执行线程在调用set时设置的最新值。
只要线程处于活动状态并且Threadocal实例可以访问,每个线程就拥有对其线程局部变量副本的隐式引用;在一个线程消失之后,线程本地实例的所有副本都会被垃圾收集(除非存在对这些副本的其他引用)。
从上面的定义可以知道,ThreadLocal的hashcode(threadLocalHashCode)是从0开始,每新建一个ThreadLocal,对应的hashcode就加0x61c88647。
3.ThreadLocalMap的定义
ThreadLocalMap是一个自定义哈希映射,仅用于维护线程本地变量值。ThreadLocalMap是ThreadLocal的内部类,主要有一个Entry数组,Entry的key为ThreadLocal,value为ThreadLocal对应的值。每个线程都有一个ThreadLocalMap类型的threadLocals变量。
4.set()方法
- 先拿到当前线程,再使用getMap方法拿到当前线程的threadLocals变量
- 如果threadLocals不为空,则将当前ThreadLocal作为key,传入的值作为value,调用set方法(见下文代码块1详解)插入threadLocals。
- 如果threadLocals为空则调用创建一个ThreadLocalMap,并新建一个Entry放入该ThreadLocalMap, 调用set方法的ThreadLocal和传入的value作为该Entry的key和value
注意此处的threadLocals变量是一个ThreadLocalMap,是Thread的一个局部变量,因此它只与当前线程绑定。
代码块1:set方法
- 通过传入的key的hashCode计算出索引的位置
- 从索引位置开始遍历,由于不是链表结构,因此通过nextIndex方法来寻找下一个索引位置
- 如果找到某个Entry的key和传入的key相同,则用传入的value替换掉该Entry的value。
- 如果遍历到某个Entry的key为空,则调用replaceStaleEntry方法(见下文代码块2详解)
- 如果通过nextIndex寻找到一个空位置(代表没有找到key相同的),则将元素放在该位置上
- 调用cleanSomeSlots方法清理key为null的Entry,并判断是否需要扩容,如果需要则调用rehash方法进行扩容(见下文rehash方法详解)。
代码块2:replaceStaleEntry方法
- slotToExpunge始终记录着需要清除的元素的最前面的位置(即slotToExpunge前面的元素是不需要清除的)
- 从位置staleSlot向前遍历,直到遇到Entry为空,用staleSlot记录最后一个key为null的索引位置(也就是遍历过位置最前的key为null的位置)
- 从位置staleSlot向后遍历,直到遇到Entry为空,如果遍历到key和入参key相同的,则将入参的value替换掉该Entry的value,并将i位置和staleSlot位置的元素对换(staleSlot位置较前,是要清除的元素),遍历的时候判断slotToExpunge的值是否需要调整,最后调用expungeStaleEntry方法(见下文expungeStaleEntry方法详解)和cleanSomeSlots方法(见下文代码块3详解)清除key为null的元素。
- 如果key没有找到,则使用入参的key和value新建一个Entry,放在staleSlot位置
- 判断是否还有其他位置的元素key为null,如果有则调用expungeStaleEntry方法和cleanSomeSlots方法清除key为null的元素
代码块3:cleanSomeSlots方法
从 i 开始,清除key为空的Entry,遍历次数由当前的table长度决定,当遍历到一个key为null的元素时,调用expungeStaleEntry清除,并将遍历次数重置。至于为什么使用table长度来决定遍历次数,官方给出的解释是这个方法简单、快速,并且效果不错。
5.get()方法
- 跟set方法差不多,先拿到当前的线程,再使用getMap方法拿到当前线程的threadLocals变量
- 如果threadLocals不为空,则将调用get方法的ThreadLocal作为key,调用getEntry方法(见下文代码块5详解)找到对应的Entry。
- 如果threadLocals为空或者找不到目标Entry,则调用setInitialValue方法(见下文代码块4详解)进行初始化。
代码块4:setInitialValue方法
- 如果是threadLocals为空,创建一个新的ThreadLocalMap,并将当前的ThreadLocal作为key,null作为value,插入到新创建的ThreadLocalMap,并返回null。
- 如果threadLocals不为空,则将当前的ThreadLocal作为key,null作为value,插入到threadLocals。
- 注意上面的 initialValue()方法为protected,如果希望线程局部变量具有非null的初始值,则必须对ThreadLocal进行子类化,并重写此方法。
代码块5:getEntry方法
- 根据hash code计算出索引位置
- 如果该索引位置Entry的key和传入的key相等,则为目标Entry,直接返回
- 否则,e不是目标Entry,调用getEntryAfterMiss方法(见下文代码块6详解)继续遍历。
代码块6:getEntryAfterMiss方法
从元素e开始向后遍历,如果找到目标Entry元素直接返回;如果遇到key为null的元素,调用expungeStaleEntry方法(见下文expungeStaleEntry方法详解)进行清除;否则,遍历到Entry为null时,结束遍历,返回null。
6.remove()方法
方法很简单,拿到当前线程的threadLocals属性,如果不为空,则将key为当前ThreadLocal的键值对移除,并且会调用expungeStaleEntry方法清除key为null的Entry。
7.expungeStaleEntry方法
源码解读:从staleSlot开始,清除key为null的Entry,并将不为空的元素放到合适的位置,最后遍历到Entry为空的元素时,跳出循环返回当前索引位置。
PS:set、get、remove方法,在遍历的时候如果遇到key为null的情况,都会调用expungeStaleEntry方法来清除key为null的Entry。
8.rehash方法
- 调用expungeStaleEntries方法(该方法和expungeStaleEntry类似,只是把搜索范围扩大到整个表)清理key为空的Entry
- 如果清理后size超过阈值的3/4,则进行扩容。
- 新表长度为老表2倍,创建新表。
- 遍历老表所有元素,如果key为null,将value清空;否则通过hash code计算新表的索引位置h,如果h已经有元素,则调用nextIndex方法直到寻找到空位置,将元素放在新表的对应位置。
- 设置新表扩容的阈值、更新size、table指向新表。
9.功能测试
输出结果:
ThreadTo: 456
ThreadOne: null
ThreadOne: 123
main: null
从输出结果可以看出,线程1、线程2和主线程之间是彼此互不影响的。
10.内存泄漏问题
从上面源码可以看出,ThreadLocalMap使用ThreadLocal的弱引用作为Entry的key,如果一个ThreadLocal没有外部强引用来引用它,下一次系统GC时,这个ThreadLocal必然会被回收,这样一来,ThreadLocalMap中就会出现key为null的Entry,就没有办法访问这些key为null的Entry的value。
我们上面介绍的get、set、remove等方法中,都会对key为null的Entry进行清除(expungeStaleEntry方法,将Entry的value清空,等下一次垃圾回收时,这些Entry将会被彻底回收)。
但是如果当前线程一直在运行,并且一直不执行get、set、remove方法,这些key为null的Entry的value就会一直存在一条强引用链:Thread Ref -> Thread -> ThreadLocalMap -> Entry -> value,导致这些key为null的Entry的value永远无法回收,造成内存泄漏。
如何避免内存泄漏?
为了避免这种情况,我们可以在使用完ThreadLocal后,手动调用remove方法,以避免出现内存泄漏。
总结:
- 每个线程都有一个ThreadLocalMap 类型的 threadLocals 属性。
- ThreadLocalMap 类相当于一个Map,key 是 ThreadLocal 本身,value 就是我们的值。
- 当我们通过 threadLocal.set(new Integer(123)); ,我们就会在这个线程中的 threadLocals 属性中放入一个键值对,key 是这个threadLocal.set(new Integer(123)) 的 threadlocal,value就是值new Integer(123)。
- 当我们通过 threadlocal.get() 方法的时候,首先会根据这个线程得到这个线程的 threadLocals 属性,然后由于这个属性放的是键值对,我们就可以根据键 threadlocal 拿到值。 注意,这时候这个键 threadlocal 和 我们 set 方法的时候的那个键 threadlocal 是一样的,所以我们能够拿到相同的值。
- ThreadLocalMap 的get/set/remove方法跟HashMap的内部实现都基本一样,通过 "key.threadLocalHashCode & (table.length - 1)" 运算式计算得到我们想要找的索引位置,如果该索引位置的键值对不是我们要找的,则通过nextIndex方法计算下一个索引位置,直到找到目标键值对或者为空。
- hash冲突:在HashMap中相同索引位置的元素以链表形式保存在同一个索引位置;而在ThreadLocalMap中,没有使用链表的数据结构,而是将(当前的索引位置+1)对length取模的结果作为相同索引元素的位置:源码中的nextIndex方法,可以表达成如下公式:如果i为当前索引位置,则下一个索引位置 = (i + 1 < len) ? i + 1 : 0。