专栏首页Java架构沉思录深入分析ThreadLocal

深入分析ThreadLocal

ThreadLoacal是什么?

ThreadLocal是啥?以前面试别人时就喜欢问这个,有些伙伴喜欢把它和线程同步机制混为一谈,事实上ThreadLocal与线程同步无关。ThreadLocal虽然提供了一种解决多线程环境下成员变量的问题,但是它并不是解决多线程共享变量的问题。那么ThreadLocal到底是什么呢?

API是这样介绍它的: This class provides thread-local variables. These variables differ from their normal counterparts in that each thread that accesses one (via its {@code get} or {@code set} method) has its own, independently initialized copy of the variable. {@code ThreadLocal} instances are typically private static fields in classes that wish to associate state with a thread (e.g.,a user ID or Transaction ID).

该类提供了线程局部 (thread-local) 变量。这些变量不同于它们的普通对应物,因为访问某个变量(通过其getset 方法)的每个线程都有自己的局部变量,它独立于变量的初始化副本。ThreadLocal实例通常是类中的 private static 字段,它们希望将状态与某一个线程(例如,用户 ID 或事务 ID)相关联。

所以ThreadLocal与线程同步机制不同,线程同步机制是多个线程共享同一个变量,而ThreadLocal是为每一个线程创建一个单独的变量副本,故而每个线程都可以独立地改变自己所拥有的变量副本,而不会影响其他线程所对应的副本。可以说ThreadLocal为多线程环境下变量问题提供了另外一种解决思路。

ThreadLocal定义了四个方法:

  • get():返回此线程局部变量的当前线程副本中的值。
  • initialValue():返回此线程局部变量的当前线程的“初始值”。
  • remove():移除此线程局部变量当前线程的值。
  • set(T value):将此线程局部变量的当前线程副本中的值设置为指定值。

除了这四个方法,ThreadLocal内部还有一个静态内部类ThreadLocalMap,该内部类才是实现线程隔离机制的关键,get()、set()、remove()都是基于该内部类操作。ThreadLocalMap提供了一种用键值对方式存储每一个线程的变量副本的方法,key为当前ThreadLocal对象,value则是对应线程的变量副本。

对于ThreadLocal需要注意的有两点: 1. ThreadLocal实例本身是不存储值,它只是提供了一个在当前线程中找到副本值得key。 2. 是ThreadLocal包含在Thread中,而不是Thread包含在ThreadLocal中,有些小伙伴会弄错他们的关系。

下图是Thread、ThreadLocal、ThreadLocalMap的关系(http://blog.xiaohansong.com/2016/08/06/ThreadLocal-memory-leak/)

ThreadLocal使用示例

示例如下:

public class SeqCount {   private static ThreadLocal<Integer> seqCount = new ThreadLocal<Integer>(){
       // 实现initialValue()
       public Integer initialValue() {
           return 0;
       }
   };   public int nextSeq(){
       seqCount.set(seqCount.get() + 1);       return seqCount.get();
   }   public static void main(String[] args){
       SeqCount seqCount = new SeqCount();       SeqThread thread1 = new SeqThread(seqCount);
       SeqThread thread2 = new SeqThread(seqCount);
       SeqThread thread3 = new SeqThread(seqCount);
       SeqThread thread4 = new SeqThread(seqCount);       thread1.start();
       thread2.start();
       thread3.start();
       thread4.start();
   }   private static class SeqThread extends Thread{
       private SeqCount seqCount;       SeqThread(SeqCount seqCount){
           this.seqCount = seqCount;
       }       public void run() {
           for(int i = 0 ; i < 3 ; i++){
               System.out.println(Thread.currentThread().getName() + " seqCount :" + seqCount.nextSeq());
           }
       }
   }}

运行结果:

从运行结果可以看出,ThreadLocal确实是可以达到线程隔离机制,确保变量的安全性。这里我们想一个问题,在上面的代码中ThreadLocal的initialValue()方法返回的是0,假如该方法返回得是一个对象呢,会产生什么后果呢?例如:

    A a = new A();
   private static ThreadLocal<A> seqCount = new ThreadLocal<A>(){
       // 实现initialValue()
       public A initialValue() {
           return a;
       }
   };   class A{
       // ....
   }

具体过程请参考:对ThreadLocal实现原理的一点思考

ThreadLocal源码解析

ThreadLocal虽然解决了这个多线程变量的复杂问题,但是它的源码实现却是比较简单的。ThreadLocalMap是实现ThreadLocal的关键,我们先从它入手。

ThreadLocalMap

ThreadLocalMap其内部利用Entry来实现key-value的存储,如下:

       static class Entry extends WeakReference<ThreadLocal<?>> {
           /** The value associated with this ThreadLocal. */
           Object value;           Entry(ThreadLocal<?> k, Object v) {
               super(k);
               value = v;
           }
       }

从上面代码中可以看出Entry的key就是ThreadLocal,而value就是值。同时,Entry也继承WeakReference,所以说Entry所对应key(ThreadLocal实例)的引用为一个弱引用(关于弱引用这里就不多说了,感兴趣的可以关注这篇博客:https://www.ibm.com/developerworks/cn/java/j-jtp11225/)

ThreadLocalMap的源码稍微多了点,我们就看两个最核心的方法getEntry()、set(ThreadLocal> key, Object value)方法。

**set(ThreadLocal> key, Object value)**

    private void set(ThreadLocal<?> key, Object value) {       ThreadLocal.ThreadLocalMap.Entry[] tab = table;
       int len = tab.length;       // 根据 ThreadLocal 的散列值,查找对应元素在数组中的位置
       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();           // key 存在,直接覆盖
           if (k == key) {
               e.value = value;
               return;
           }           // key == null,但是存在值(因为此处的e != null),说明之前的ThreadLocal对象已经被回收了
           if (k == null) {
               // 用新元素替换陈旧的元素
               replaceStaleEntry(key, value, i);
               return;
           }
       }       // ThreadLocal对应的key实例不存在也没有陈旧元素,new 一个
       tab[i] = new ThreadLocal.ThreadLocalMap.Entry(key, value);       int sz = ++size;       // cleanSomeSlots 清楚陈旧的Entry(key == null)
       // 如果没有清理陈旧的 Entry 并且数组中的元素大于了阈值,则进行 rehash
       if (!cleanSomeSlots(i, sz) && sz >= threshold)
           rehash();
   }

这个set()操作和我们在集合了解的put()方式有点儿不一样,虽然他们都是key-value结构,不同在于他们解决散列冲突的方式不同。集合Map的put()采用的是拉链法,而ThreadLocalMap的set()则是采用开放定址法。掌握了开放地址法该方法就一目了然了。

set()操作除了存储元素外,还有一个很重要的作用,就是replaceStaleEntry()和cleanSomeSlots(),这两个方法可以清除掉key == null 的实例,防止内存泄漏。在set()方法中还有一个变量很重要:threadLocalHashCode,定义如下:

private final int threadLocalHashCode = nextHashCode();

从名字上面我们可以看出threadLocalHashCode应该是ThreadLocal的散列值,定义为final,表示ThreadLocal一旦创建其散列值就已经确定了,生成过程则是调用nextHashCode():

    private static AtomicInteger nextHashCode = new AtomicInteger();   private static final int HASH_INCREMENT = 0x61c88647;   private static int nextHashCode() {
       return nextHashCode.getAndAdd(HASH_INCREMENT);
   }

nextHashCode表示分配下一个ThreadLocal实例的threadLocalHashCode的值,HASH_INCREMENT则表示分配两个ThradLocal实例的threadLocalHashCode的增量,从nextHashCode就可以看出他们的定义。

getEntry()

        private Entry getEntry(ThreadLocal<?> key) {
           int i = key.threadLocalHashCode & (table.length - 1);
           Entry e = table[i];
           if (e != null && e.get() == key)
               return e;
           else
               return getEntryAfterMiss(key, i, e);
       }

由于采用了开放定址法,所以当前key的散列值和元素在数组的索引并不是完全对应的,首先取一个探测数(key的散列值),如果所对应的key就是我们所要找的元素,则返回,否则调用getEntryAfterMiss(),如下:

        private Entry getEntryAfterMiss(ThreadLocal<?> key, int i, Entry e) {
           Entry[] tab = table;
           int len = tab.length;           while (e != null) {
               ThreadLocal<?> k = e.get();
               if (k == key)
                   return e;
               if (k == null)
                   expungeStaleEntry(i);
               else
                   i = nextIndex(i, len);
               e = tab[i];
           }
           return null;
       }

这里有一个重要的地方,当key == null时,调用了expungeStaleEntry()方法,该方法用于处理key == null,有利于GC回收,能够有效地避免内存泄漏。

get()

返回当前线程所对应的线程变量

    public T get() {
       // 获取当前线程
       Thread t = Thread.currentThread();       // 获取当前线程的成员变量 threadLocal
       ThreadLocalMap map = getMap(t);
       if (map != null) {
           // 从当前线程的ThreadLocalMap获取相对应的Entry
           ThreadLocalMap.Entry e = map.getEntry(this);
           if (e != null) {
               @SuppressWarnings("unchecked")               // 获取目标值        
               T result = (T)e.value;
               return result;
           }
       }
       return setInitialValue();
   }

首先通过当前线程获取所对应的成员变量ThreadLocalMap,然后通过ThreadLocalMap获取当前ThreadLocal的Entry,最后通过所获取的Entry获取目标值result。

getMap()方法可以获取当前线程所对应的ThreadLocalMap,如下:

    ThreadLocalMap getMap(Thread t) {
       return t.threadLocals;
   }

set(T value)

设置当前线程的线程局部变量的值。

    public void set(T value) {
       Thread t = Thread.currentThread();
       ThreadLocalMap map = getMap(t);
       if (map != null)
           map.set(this, value);
       else
           createMap(t, value);
   }

获取当前线程所对应的ThreadLocalMap,如果不为空,则调用ThreadLocalMap的set()方法,key就是当前ThreadLocal,如果不存在,则调用createMap()方法新建一个,如下:

    void createMap(Thread t, T firstValue) {
       t.threadLocals = new ThreadLocalMap(this, firstValue);
   }

initialValue()

返回该线程局部变量的初始值。

    protected T initialValue() {
       return null;
   }

该方法定义为protected级别且返回为null,很明显是要子类实现它的,所以我们在使用ThreadLocal的时候一般都应该覆盖该方法。该方法不能显示调用,只有在第一次调用get()或者set()方法时才会被执行,并且仅执行1次。

remove()

将当前线程局部变量的值删除。

    public void remove() {
       ThreadLocalMap m = getMap(Thread.currentThread());
       if (m != null)
           m.remove(this);
   }

该方法的目的是减少内存的占用。当然,我们不需要显示调用该方法,因为一个线程结束后,它所对应的局部变量就会被垃圾回收。

ThreadLocal为什么会内存泄漏

前面提到每个Thread都有一个ThreadLocal.ThreadLocalMap的map,该map的key为ThreadLocal实例,它为一个弱引用,我们知道弱引用有利于GC回收。当ThreadLocal的key == null时,GC就会回收这部分空间,但是value却不一定能够被回收,因为他还与Current Thread存在一个强引用关系,如下(图片来自http://www.jianshu.com/p/ee8c9dccc953):

由于存在这个强引用关系,会导致value无法回收。如果这个线程对象不会销毁那么这个强引用关系则会一直存在,就会出现内存泄漏情况。所以说只要这个线程对象能够及时被GC回收,就不会出现内存泄漏。如果碰到线程池,那就更坑了。

那么要怎么避免这个问题呢?

在前面提过,在ThreadLocalMap中的setEntry()、getEntry(),如果遇到key == null的情况,会对value设置为null。当然我们也可以显示调用ThreadLocal的remove()方法进行处理。

下面再对ThreadLocal进行简单的总结:

  • ThreadLocal 不是用于解决共享变量的问题的,也不是为了协调线程同步而存在,而是为了方便每个线程处理自己的状态而引入的一个机制。这点至关重要。
  • 每个Thread内部都有一个ThreadLocal.ThreadLocalMap类型的成员变量,该成员变量用来存储实际的ThreadLocal变量副本。
  • ThreadLocal并不是为线程保存对象的副本,它仅仅只起到一个索引的作用。它的主要木得视为每一个线程隔离一个类的实例,这个实例的作用范围仅限于线程内部。

本文分享自微信公众号 - Java架构沉思录(code-thinker)

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2018-04-27

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • ThreadLocal面试六连问,你能Hold住吗?

    中高级阶段开发者出去面试,应该躲不开ThreadLocal相关问题,本文就常见问题做出一些解答,欢迎留言探讨。

    黄泽杰
  • Java并行流Parallel Stream与Fork-Join线程池的关系,莫要乱用、滥用并行流

    在说stream之前,给大家分享一个数组匹配性能优化技巧,其实平时注意一些编码的优化,对整个系统的性能优化是有很大帮助的,积少成多。往往一个项目都是毁在一行行粗...

    黄泽杰
  • threadlocal变量透传,这些问题你都遇到过吗?

    值在线程之间的透传,你可以认为是一个bug,这些问题一般会比较隐蔽,但问题暴露的时候脾气却比较火爆,让人手忙脚乱,怀疑人生。

    黄泽杰
  • 【死磕Java并发】-----深入分析ThreadLocal

    ThreadLoacal是什么? ThreadLocal是啥?以前面试别人时就喜欢问这个,有些伙伴喜欢把它和线程同步机制混为一谈,事实上ThreadLocal与...

    用户1655470
  • 死磕Java之聊聊ThreadLocal源码(基于JDK1.8)

    记得在一次面试中被问到ThreadLocal,答得马马虎虎,所以打算研究一下ThreadLocal的源码

    haifeiWu
  • 关于ThreadLocal内存泄露的备忘

    还记得第一次接触到ThreadLocal可能导致内存泄露的问题是有一次面试的时候被问到了ThreadLocal的缺陷是什么。当然由于后来没有面试官的联系方式很遗...

    哲洛不闹
  • 面试再问ThreadLocal,别说你不会

    以前面试的时候问到ThreadLocal总是一脸懵逼,只知道有这个哥们,不了解他是用来做什么的,更不清楚他的原理了。表面上看他是和多线程,线程同步有关的一个工具...

    业余草
  • 面试再问ThreadLocal,别说你不会

    以前面试的时候问到ThreadLocal总是一脸懵逼,只知道有这个哥们,不了解他是用来做什么的,更不清楚他的原理了。表面上看他是和多线程,线程同步有关的一个工具...

    用户4143945
  • 面试官,ThreadLocal 你别再问了!

    来源:juejin.im/post/5d427f306fb9a06b122f1b94

    用户1516716
  • ThreadLocal解决了什么问题

    由于 ThreadLocal 支持范型,如 ThreadLocal< StringBuilder >,为表述方便,后文用 变量 代表 ThreadLocal 本...

    程序员小明

扫码关注云+社区

领取腾讯云代金券

玩转腾讯云 有奖征文活动