Android 源码分析问题(四)—— ThreadLocal 的作用

简介

ThreadLocal 作用就像它的名字一样,通过 ThreadLocal 将传入的对象变成线程私有化的对象,即传入的对象只对传入它的线程可见。

在看 Android 的消息机制的时候,在 Looper 类的中的 prepare() 方法中看到了 ThreadLocal 的使用。

    public static void prepare() {
        prepare(true);
    }

    private static void prepare(boolean quitAllowed) {
        if (sThreadLocal.get() != null) {
            throw new RuntimeException("Only one Looper may be created per thread");
        }
        sThreadLocal.set(new Looper(quitAllowed));
    }

这里的 sThreadLocal.set(new Looper(quitAllowed)) 便是使用了 ThreadLocal 的 set() 方法传入了一个 Looper 对象。

我们也从这里看一下 ThreadLoacl 实现的原理。

ThreadLoacl 的 set() 方法

    public void set(T value) {
        //获取当前线程
        Thread t = Thread.currentThread();
        //获取当前线程的 ThreadLocalMap 
        ThreadLocalMap map = getMap(t);
        //如果 map 不为 null,那么将对象存入
        if (map != null)
            map.set(this, value);
        //否则创建一个新的 ThreadLocalMap    
        else
            createMap(t, value);
    }

这一部分的源码还是很简单,首先获取当前线程,再去获取当前线程的 ThreadLocalMap,最后将我们传入的对象存放在 ThreadLocalMap 中。

这里去 getMap() 方法中看下 ThreadLocalMap 是个怎么样的数据结构。

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

可以看到这里返回了 Thread 中的 threadLocals 字段,说明了 ThreadLocal 只是一个帮助我们实现线程对象私有化的工具,具体私有化的对象还是存放在 Thread 自身的。

再看下 createMap() 方法

    void createMap(Thread t, T firstValue) {
        //  这里就是为 Thread 创建一个 ThreadLocalMap
        t.threadLocals = new ThreadLocalMap(this, firstValue);
    }

这里我们对 set() 方法的流程有了一个清晰的认知,接下来去看一下 ThreadLocalMap。

ThreadLocalMap

这里看下 ThreadLocalMap 的结构。

ThreadLocalMap 中的弱引用

    static class ThreadLocalMap {

        /**
         * The entries in this hash map extend WeakReference, using
         * its main ref field as the key (which is always a
         * ThreadLocal object).  Note that null keys (i.e. entry.get()
         * == null) mean that the key is no longer referenced, so the
         * entry can be expunged from table.  Such entries are referred to
         * as "stale entries" in the code that follows.
         */
        static class Entry extends WeakReference<ThreadLocal<?>> {
            /** The value associated with this ThreadLocal. */
            Object value;

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

这里可以看见 ThreadLocalMap 中的 Entry 是继承弱引用的,所以当线程回收的时候,ThreadLocalMap 不会因为持有对象引用而导致线程无法回收。

构造方法

        ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
            //INITIAL_CAPACITY 的值是 16    
            table = new Entry[INITIAL_CAPACITY];
            //计算 hashcode 来确定其在数组中的位置
            int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
            table[i] = new Entry(firstKey, firstValue);
            size = 1;
            //设置阈值,超过就扩容,阈值为容积的 2/3
            setThreshold(INITIAL_CAPACITY);
        }

接下来直接去看下 set() 方法中用到过的 ThreadLocalMap 的 set() 方法,来对 ThreadLocalMap 做个基本的了解。

ThreadLocalMap 的 set()

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.
    //获取 table
    Entry[] tab = table;
    int len = tab.length;
    //计算索引
    int i = key.threadLocalHashCode & (len-1);
    //这里是为了找到已经存在的 Entry,对其中已经存在的值进行替换, 其中 nextIndex() 方法就是对 i+1 取 len 的余 
    for (Entry e = tab[i];
         e != null;
         e = tab[i = nextIndex(i, len)]) {
        ThreadLocal<?> k = e.get();
        //如果存在,则替换 value
        if (k == key) {
            e.value = value;
            return;
        }
        //如果 Entry 过期,那么全部替换(线程回收之类的会过期)
        if (k == null) {
            replaceStaleEntry(key, value, i);
            return;
        }
    }
    //如果没有重复 key 的 Entry, 那么添加新的 Entry 到数组中
    tab[i] = new Entry(key, value);
    int sz = ++size;
    //如果超出阈值,那么扩容
    if (!cleanSomeSlots(i, sz) && sz >= threshold)
        rehash();
}

这里就不介绍扩容了,对 ThredHashMap 做一个大致的了解即可,其实它的原理还是和 HashMap 非常像的。

ThreadLocal 的 get() 方法

看完上面的 set 的流程其实已经对 ThreadLocal 有一定的了解了,接下来我们看下他的 get() 方法。

    public T get() {
        //同样是获取当线程并且获取它的 ThreadLocalMap    
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        if (map != null) {
            //如果map不为空,尝试获取它的 Entry 对象
            ThreadLocalMap.Entry e = map.getEntry(this);
            if (e != null) {
                //如果 entry 不为空,返回私有化的对象
                @SuppressWarnings("unchecked")
                T result = (T)e.value;
                return result;
            }
        }
        //以上条件不符合,则返回初始值
        return setInitialValue();
    }

继续看 setInitialValue() 方法

    private T setInitialValue() {
        T value = initialValue();
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        if (map != null)
            //      
            map.set(this, value);
        else
            createMap(t, value);
        return value;
    }
    
    protected T initialValue() {
        return null;
    }

这里可以看到,它会通过 initialValue() 方法直接返回 null 值,同时再尝试去获取一下 map 是否存在,不存在的话就创建一个 map,反之将值存入map,最后会返回 null 值。

总结

ThredLocal 的介绍就到这里了,这里对它做个总结。

  • 每个 Thread 都存有一个 ThreadLocalMap
  • ThreadLocal 本身不缓存任何值,是对 Thread 中的 ThreadLocalMap 进行操作。
  • ThreadLocalMap 与 HashMap 十分相似,但是是一个纯数组的实现的 Map, 它以线程做为键值,同时每个线程只能缓存一个对象。
  • ThreadLocalMap 的初始容量 为 16, 阈值为容量的 2/3,超出阈值会触发扩容, 扩容为原来的两倍。
  • ThreadLocalMap 遇到哈希碰撞时,是将索引向后移动一位处理。
  • ThreadLocal set 和 get 都是以当前线程为键值获取 ThreadLocal Map 中的对象,以此实现线程对象的私有化。

最后回到前面我遇到 ThreadLocal 的地方

    public static void prepare() {
        prepare(true);
    }

    private static void prepare(boolean quitAllowed) {
        if (sThreadLocal.get() != null) {
            throw new RuntimeException("Only one Looper may be created per thread");
        }
        sThreadLocal.set(new Looper(quitAllowed));
    }

这里就是将 Looper 对象传入 ThreadLocal,保证 Looper 只对当前线程可见,避免并发危险。

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