Java ThreadLocal

一、概述

ThreadLocal是java.lang包下提供的一个类,那么他的作用是什么呢?我们直接看源码中的注释:

 * 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).
     
 
此类提供线程局部变量。这些变量不同于它们的正常对应部分是,每个访问一个线程的线程
(通过{@code get}或{@code set}方法)有自己的独立初始化变量的副本。{@code ThreadLocal}
实例通常是私有的希望将状态与线程关联的类中的静态字段(例如用户ID或事务ID)。

通过字面理解就是说每一个线程访问它时,都会有一个属于线程自己的变量的副本。而且对于每个线程来说时私有的。

二、使用

我们来举个简单的例子来验证上面的话。

public static void main(String[] args) {
        //创建一个ThreadLocal
        ThreadLocal<String> threadLocal = new ThreadLocal<>();

        //在线程1中设置threadLocal的值并打印
        new Thread(() -> {
            threadLocal.set("我是线程1");
            System.out.println(Thread.currentThread().getName()+":"+threadLocal.get());
        },"线程1").start();

        //在线程2中打印threadLocal的值
        new Thread(()->{
            System.out.println(Thread.currentThread().getName()+":"+threadLocal.get());
        },"线程2").start();
    }

如果没有了解过ThreadLocal的小伙伴可能会认为,输出都是一样的,因为线程1中已经设置了threadLocal的值,所以线程2中获取到的是一样的,错。我们来看下打印结果:

线程1:我是线程1
线程2:null

可以看到,打印是不同的,在线程1中设置的值打印了,线程2中打印出来却为null,这就印证了前面说的话以及ThreadLocal的作用:每个访问ThreadLocal的线程都有自己的独立初始化变量的副本

三、分析

在了解了ThreadLocal作用以及使用之后,我们对它的源码进行分析,这里主要分析他的set和get方法。
先来看看set:

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

set方法中,首先通过当前线程获取map,如果map不为空,则设置map的值,否则就创建一个map,并以当前线程为key和value存进去。那么ThreadLocalMap是什么呢?我们来看一下:

static class ThreadLocalMap {

        static class Entry extends WeakReference<ThreadLocal<?>> {
            /** The value associated with this ThreadLocal. */
            Object value;

            Entry(ThreadLocal<?> k, Object v) {
                super(k);
                value = v;
            }
        }

        private static final int INITIAL_CAPACITY = 16;

        private Entry[] table;

        ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
            //初始化table
            table = new Entry[INITIAL_CAPACITY];
            //计算下标
            int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
            //为table[i]赋值
            table[i] = new Entry(firstKey, firstValue);
            //初始大小1
            size = 1;
            setThreshold(INITIAL_CAPACITY);
        }
    略····
}

在ThreadLocalMap中有一个内部类Entry继承自弱引用,其中ThreadLocal就是弱引用对象,value就是ThreadLocal的值,就是说ThreadLocal本身就是key。
ThreadLocalMap中还有一个Entry数组,INITIAL_CAPACITY即默认容量16。
ThreadLocalMap的构造方法的参数就是传入的key和value。

接下来继续看set方法中所调用的getMap方法,该方法传入的就是当前的线程Thread,返回Thread的threadLocals。

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

我们点进去Thread中看的确Thread中包含一个ThreadLocal.ThreadLocalMap对象,默认为空。

ThreadLocal.ThreadLocalMap threadLocals = null;

接下来继续顺着set方法看,首先当map为空时,调用了createMap方法,createMap如下:

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

这个地方new了一个ThreadLocalMap并赋值给Thread中的threadLocals。
此时就是相当于把key和value存到了Thread中。

当map不为空时,调用map.set方法。map.set方法这里就不贴了,他就是遍历table找到与传入的相同的key并改变其value。如果没有相同的key则创建一个新的Entry并赋值给table[i]。

继续来看get方法:

    public T get() {
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        if (map != null) {
            ThreadLocalMap.Entry e = map.getEntry(this);
            if (e != null) {
                @SuppressWarnings("unchecked")
                T result = (T)e.value;
                return result;
            }
        }
        return setInitialValue();
    }

get方法的原理就是拿到当前线程中的map,如果不为空时,则拿到map中的Entry,entry不为空值,则返回它的value。如果当前Thread的map为空时,则返回初始值。

三、总结

看完源码,我的个人理解就是ThreadLocal并不是用来存储数据的,真正存储数据的是ThreadLocalMap。而Thread又持有ThreadLocalMap,所以其实数据存在了Thread中,ThreadLocal只是用来实现不同线程间存储对应数据的一个桥梁而已。

关于ThreadLocal今天就分析到这里把,其实里面还有很多其他操作,比如扩容以及remove,感兴趣的话可以自己去阅读一下源码,主要是ThreadLocal和ThreadLocalMap都在一个文件中,Thread中又持有ThreadLocalMap,滑来滑去看着脑壳疼,睡觉。

最后附上一张Thread和ThreadLocal的关系图:


Thread和ThreadLocal.jpg
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,324评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,356评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,328评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,147评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,160评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,115评论 1 296
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,025评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,867评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,307评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,528评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,688评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,409评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,001评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,657评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,811评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,685评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,573评论 2 353

推荐阅读更多精彩内容