12.ThreadLocal类的使用和实现原理

ThreadLocal

ThreadLocal,顾名思义就是线程本地对象,理解起来就是线程局部变量,这个类可以将对象绑定到线程,使之成为线程私有对象。这种解决并发安全问题的方式就是不共享,使用私有变量来保证线程安全。

线程局部变量(ThreadLocal)其实的功用非常简单,就是为每一个使用该变量的线程都提供一个变量值的副本,是Java中一种较为特殊的线程绑定机制,是每一个线程都可以独立地改变自己的副本,而不会和其它线程的副本冲突。

概括起来说,对于多线程资源共享的问题,同步机制采用了“以时间换空间”的方式,而ThreadLocal采用了“以空间换时间”的方式。前者仅提供一份变量,让不同的线程排队访问,而后者为每一个线程都提供了一份变量,因此可以同时访问而互不影响。

《Java核心技术》中关于ThreadLocal的示例:

public static final ThreadLocal<SimpleDateFormat> dateFormat= 
        ThreadLocal.withInitial(()->new SimpleDateFormat("yyyy-mm-dd"));

这段代码使得每个访问此共享变量的线程,持有一个私有的对象。
因为这个SimpleDateFormat不是线程安全的类,在并发情况下其内部的状态可能会出现安全问题,且在并发使用过程中,并不需要修改这个对象的状态,所以为了线程安全,使其“局部化”简单又安全。

// 访问数据
SimpleDateFormat format = dateFormat.get();

在一个给定的线程中首次调用get方法时,会调用initialValue方法,在此之后,get方法会返回属于当前线程的那个实例。

在Java 7中提供了一个类似ThreadLocal类的辅助类:ThreadLocalRandom类,ThreadLocalRandom.current()会返回一个特定于当前线程的Random类实例。

API

基本方法

  • public static <S> ThreadLocal<S> withInitial(Supplier<? extends S> supplier)使用函数式接口创建ThreadLocal对象,接口内实现初始化动作
  • public T get() 获取Local值
  • public void set(T value)设置Local值
  • public void remove() 删除Local值

直观的示例

public class ThreadLocalpractice {
    // 线程私有变量,和当前线程绑定,所以各个线程对其的改变不会被其他线程读取到到
    private final ThreadLocal<Integer> local = ThreadLocal.withInitial(() -> 1);

    public void add(int a) {
        local.set(local.get() + a);
    }

    public Integer get() {
        return local.get();
    }

    public static void main(String[] args) {
        ThreadLocalpractice tlp = new ThreadLocalpractice();
        for (int i = 0; i < 100; i++) {
            new Thread(() -> {
                tlp.add(1);
                System.out.println(Thread.currentThread().getName() + " get is " + tlp.get());
            }).start();
        }
        while (true) {
        }
    }
}

结果是每个打印都是2,说明各自的add都是独立的。

实现原理

ThreadLocal内部的变量是如何绑定到Thread对象上的?
  • 查看set和get的源码:
  public T get() {
        // 获取当前线程
        Thread t = Thread.currentThread();
        // 以当前线程对象为参数,调用getMap()方法-->查看getMap
        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方法可以看出,首先会获取当前线程,如何以当前线程对象为参数getMap():

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

发现getMap是获取Thread对象的一个属性,查看Thread源码关于此属性:

/* ThreadLocal values pertaining to this thread. This map is maintained
     * by the ThreadLocal class. */
    ThreadLocal.ThreadLocalMap threadLocals = null;

可见首次get,map是null,继续查看get方法,如果map为null会直接return setInitialValue():

    
    private T setInitialValue() {
    // 初始化Local的value 
        T value = initialValue();
        Thread t = Thread.currentThread();
        // 获取Thread的threadLocals属性,首次为null,触发羡慕的createMap方法
        ThreadLocalMap map = getMap(t);
        if (map != null)
            map.set(this, value);
        else
            createMap(t, value);
        return value;
    }
    // 在此方法中为Thread对象的threadlocals属性赋值,到此为止,map对象已经和Thread绑定成功了。
    void createMap(Thread t, T firstValue) {
        t.threadLocals = new ThreadLocalMap(this, firstValue);
    }

首次set也会创建map,即执行初始化工作:

    public void set(T value) {
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        if (map != null)
            map.set(this, value);
        else
            createMap(t, value);
    }
  • 总结
  1. 在创建ThreadLocal对象时,对象的值为null;
  2. 可以通过继承ThreadLocal并重写initialValue方法来设置初始值或者使用静态方法withInitial来设置初始值。
  3. 当线程首次调用TL的get或set方法时,会为当前线程对象创建一个ThreadLocalMap对象,并将ThreadLocal对象作为Map的key,ThreadLocal的value作为map的value,然后将这个map传给Thread对象的threadLocals属性,达到将ThreadLocal绑定到Thread的目的。
  4. 在之后的get、set或remove操作中,实际上只是在操作线程的threadlocals,这个属性不会在线程间共享,自然就相当于局部变量了。

ThreadLocalMap

从上面数据绑定的原理中可以知道,线程的ThreadLocal值是存在一个叫ThreadLocalMap的数据结构中的,既然是Map,一定是一个支持键值对的数据结构。那么是否使用的就是HashMap呢?

  • ThreadLocalMap部分源码
    /**
     * ThreadLocalMap is a customized hash map suitable only for
     * maintaining thread local values. No operations are exported
     * outside of the ThreadLocal class. The class is package private to
     * allow declaration of fields in class Thread.  To help deal with
     * very large and long-lived usages, the hash table entries use
     * WeakReferences for keys. However, since reference queues are not
     * used, stale entries are guaranteed to be removed only when
     * the table starts running out of space.
     */
    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;
            }
        }
        
    ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
            table = new Entry[INITIAL_CAPACITY];
            int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
            table[i] = new Entry(firstKey, firstValue);
            size = 1;
            setThreshold(INITIAL_CAPACITY);
        }
    
    private void set(ThreadLocal<?> key, Object value) {

            // We don't use a fast path as with get() because it is at
            // least as common to use set() to create new entries as
            // it is to replace existing ones, in which case, a fast
            // path would fail more often than not.

            Entry[] tab = table;
            int len = tab.length;
            int i = key.threadLocalHashCode & (len-1);

            for (Entry e = tab[i];
                 e != null;
                 e = tab[i = nextIndex(i, len)]) {
                ThreadLocal<?> k = e.get();

                if (k == key) {
                    e.value = value;
                    return;
                }
        // 支持null键
                if (k == null) {
                    replaceStaleEntry(key, value, i);
                    return;
                }
            }

            tab[i] = new Entry(key, value);
            int sz = ++size;
            if (!cleanSomeSlots(i, sz) && sz >= threshold)
                rehash();
        }

    
    // ...
    }

浏览源码可以发现,是一个ThreadLocal专用的HashMap,底层和hashmap相似。

参考资料

[1] Java并发编程实战
[2] Java核心技术

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

推荐阅读更多精彩内容