探索ThreadLocal

学 无 止 境 ，与 君 共 勉 。

特点

• ThreadLocal是一个线程内部的变量，只在本线程中使用，隔离其他线程
• ThreadLocal内部维护了一个ThreadLocalMap
• Thread内部引用了ThreadLocalMap
• ThreadLocalMap可以保存<k, v>键值对，但是一个ThreadLocal只能保存一个值，并且各个线程数据互不干扰
• ThreadLocalMap存储时的key永远为当前的ThreadLocal
• ThreadLocalMap存储时的key是弱引用的

ThreadLocalMap

每个ThreadLocal只能存储一个数据，如果需要存储多个值的话，可以定义多个ThreadLocal。ThreadLocal在内部维护了一个ThreadLocalMap用来存储这些值。

ThreadLocalMap并没有去实现Map接口，它定义了一个Entry数组，每个Entry以<key,value>的形式来保存值，其中key为当前ThreadLocal本身，value为要保存的值。

注意Entry继承了WeakReference，它的key是弱引用的，会被垃圾回收掉，所以会存在key为null的情况

ThreadLocalMap提供了三个方法：

• set()：以当前ThreadLocal为key存放值
• get()：以当前ThreadLocal为key获取存放的值
• remove()：清除数据

set()方法

• 获取当前线程Thread.currentThread()
• 获取当前线程的ThreadLocalMap
• 判断ThreadLocalMap是否存在
• 不存在的，通过createMap，初始化一个ThreadLocalMap，并赋值
• 存在的，将当前ThreadLocal作为key，进行插入操作：
  • 通过ThreadLocal的哈希值获取要插入的位置
  • 如果当前位置的Entry为空，直接在该位置初始化一个Entry对象来实现插入操作；
  • 如果当前位置Entry的key和要设置的key相同，则覆盖原来的value
  • 如果当前位置Entry的key为null：
    • 循环获取下一位置
    • 如果key和要设置的key相同，则覆盖这个位置的值，并将这个位置和要插入点的entry互换，清理key为null的值；
    • 如果当前位置的Entry为null，退出循环，并在当前位置生成一个新的entry，并清理key为null的值；

get()方法

• 获取当前线程Thread.currentThread()
• 从当前线程获取ThreadLocalMap
• 判断ThreadLocalMap是否存在
• 不存在的调用setInitialValue进行初始化，并返回null;
• 存在的，则以当前ThreadLocal作为key获取值：
  • 通过ThreadLocal的哈希值获取要获取值的位置
  • 当前位置的entry存在且key相同的，直接返回当前值;
  • 当前位置的entry存在且当前key为null的，执行清理重置方法
  • 循环获取下一位置的entry进行对比，如果下一位置的key相同，则返回该值;
  • 如果下一位置的entry为null，则说明该值不存在退出循环返回null;

remove()方法

清理当前ThreadLocal对应的Entry对象。并调用清理重置方法。

清理重置方法

• 处理区间：Entry数组当前位置到下一个不为null的Entry之间的数据；
• 清理key为null的Entry：value设为null，Entry设为null；
• 重置key不为null的Entry：
  • 通过key的哈希值获取在Entry的数组的索引h;
  • 如果h和当前Entry的索引不一致进行位置重置：
    • 将当前位置的Entry设为null
    • 从h处开始往后找到首个Entry为null的位置
    • 将找到的新位置处的Entry设为原来的entry

Hash冲突

ThreadLocalMap并没有实现Map接口，它不是通过链表的形式去避免Hash冲突的，而是通过后移的方式去实现。set方法时，如果当前要存放的位置的key和要设置的key不一致，则会对下一个位置进行判断，直到找到key相同或者为null或者Entry为null的位置。

内存泄漏问题

在实际的项目中，我们的线程一般都是由线程池来管理的，线程会一直存在，ThreadLocalMap的value就有可能得不到回收，发送内存泄漏。为了处理这一问题，ThreadLocal的get()、set()方法都有可能会清除key为null的Entry对象。安全起见，当我们使用完后应该手动调用remove()方法清理掉数据。

用途

全局变量

某些数据比如用户ID，很可能在整条业务线上多个方法中都需要用到，如果通过方法参数的形式一层一层的传递下去，整体代码显得凌乱不优雅，这时可以通过ThreadLocal的方式存储。通常可以通过AOP或者拦截器的方式进行赋值，执行完业务逻辑之后调用remove()方法。

private final static ThreadLocal<UserInfo> TL_USER = new ThreadLocal<>();

TL_USER.set(userInfo);

UserInfo userInfo = TL_USER.get();

TL_USER.remove();

独享对象

在实际项目中我们通常会将时间相关的方法写在一个工具类中，往往会用到SimpleDateFormat进行格式化，它是线程不安全的。可以通过ThreadLocal来实现独享对象

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

日常求赞

创作不易，如果各位觉得有帮助，求点赞 支持

---

求关注

微信公众号： 俞大仙