Java多线程之ThreadLocal

前言

ThreadLocal是什么?有什么作用?我们直接说结论。

  1. ThreadLocal跟线程同步机制没有半毛钱关系。
  2. ThreadLocal提供了解决多线程环境下成员变量问题的解决方案,但是并不是用共享变量的方式。

例子1

public class Main {

    public static void main(String[] args) {
    // write your code here
        Count count = new Count();
        for (int i = 0 ; i < 3 ; i++){
            new CountThread(count).start();
        }
    }
}

class Count{
    private static ThreadLocal<Integer> count = new ThreadLocal<Integer>(){
        @Override
        protected Integer initialValue() {
            return 0;
        }
    };

    public void addCount(){
        count.set(count.get()+1);
    }

    public void printCount(){
        System.out.println(Thread.currentThread().getName()+"-"+count.get());
    }
}

class CountThread extends Thread{

    private Count count;

    public CountThread(Count count){
        this.count = count;
    }

    @Override
    public void run() {
        for (int i = 0 ;i < 5 ; i++){
            count.addCount();
            count.printCount();
        }
    }
}

这个例子中,Count类是计数器类,CountThread是执行计数的线程,用来模拟多线程情况下的计数效果。下面就是输出结果。

Thread-0-1
Thread-0-2
Thread-0-3
Thread-0-4
Thread-0-5
Thread-1-1
Thread-1-2
Thread-1-3
Thread-2-1
Thread-2-2
Thread-2-3
Thread-2-4
Thread-2-5
Thread-1-4
Thread-1-5

很明显,运行结果是符合我们预期的效果。从结果上看,线程间对变量的访问操作做到了隔离,每个计数线程都启到了计数的功能,并不相互影响。那么如果把整型换成引用类型呢?工作线程访问变量也能起到隔离的作用吗?那我们就再写个例子验证下。

例子2

public static void main(String[] args) {
    Ref ref = new Ref();
    for (int i = 0 ; i < 2 ; i++){
        new RefThread(ref).start();
    }
}

class A{}

class Ref{

    private static A a = new A();

    private static ThreadLocal<A> ref = new ThreadLocal<A>(){
        @Override
        protected A initialValue() {
            return a;
        }
    };

    public void change(){
        ref.set(new A());
    }

    public void printAddress(){
        System.out.println(Thread.currentThread().getName()+"-"+ref.get());
    }
}


class RefThread extends Thread{

    private Ref ref;

    public RefThread(Ref ref){
        this.ref = ref;
    }

    @Override
    public void run() {
       for (int i = 0 ; i < 2 ; i++) {
           ref.printAddress();
           ref.change();
           ref.printAddress();
       }
    }
}

例子2和例子1大同小异,区别在于变量类型变成了引用类型,通过打印内存地址来判断在线程内变量使用的连续性,和多线程环境下的变量隔离性。我们看下输出结果。

Thread-0-com.loubinfeng.A@c1e719b
Thread-0-com.loubinfeng.A@2d99e68
Thread-0-com.loubinfeng.A@2d99e68
Thread-0-com.loubinfeng.A@6e61aeb
Thread-1-com.loubinfeng.A@c1e719b
Thread-1-com.loubinfeng.A@189e7143
Thread-1-com.loubinfeng.A@189e7143
Thread-1-com.loubinfeng.A@16598c20

从结果上看很明显,同个线程变量初始是指向统一内存地址,后续变化是连续的,多线程环境下变量也是隔离的。也就是不同是引用类型还是基础数据类型,使用ThreadLocal都能解决多线程环境的变量问题。

例子3

从例子2中,我们发现两个线程变量副本初始都指向同一内存地址,所以我们改例子2,如下:

class A{
    int p;

    public A add(){
        p++;
        return this;
    }
}

class Ref{

    private static A a = new A();

    private static ThreadLocal<A> ref = new ThreadLocal<A>(){
        @Override
        protected A initialValue() {
            return a;
        }
    };

    public void change(){
        ref.set(ref.get().add());
    }

    public void printAddress(){
        System.out.println(Thread.currentThread().getName()+"-"+ref.get()+"-"+ref.get().p);
    }
}

class RefThread extends Thread{

    private Ref ref;

    public RefThread(Ref ref){
        this.ref = ref;
    }

    @Override
    public void run() {
       for (int i = 0 ; i < 2 ; i++) {
           ref.printAddress();
           ref.change();
           ref.printAddress();
       }
    }
}

我们在A类中添加了一个int类型的p变量,那么我们多线程操作这个变量,能做到隔离吗?我们看下结果:

Thread-0-com.loubinfeng.A@6d8b82ec-0
Thread-1-com.loubinfeng.A@6d8b82ec-0
Thread-0-com.loubinfeng.A@6d8b82ec-1
Thread-1-com.loubinfeng.A@6d8b82ec-2
Thread-0-com.loubinfeng.A@6d8b82ec-2
Thread-1-com.loubinfeng.A@6d8b82ec-2
Thread-0-com.loubinfeng.A@6d8b82ec-3
Thread-1-com.loubinfeng.A@6d8b82ec-4

很明显,结果差强人意,因为操作的是同一内存,如果要达到p变量的隔离效果,只需要微调下,如下:

class Ref{

    private static A a = new A();

    private static ThreadLocal<A> ref = new ThreadLocal<A>(){
        @Override
        protected A initialValue() {
            return a;
        }
    };

    public void change(){
        A a = new A();
        a.p = ref.get().p+1;
        ref.set(a);
    }

    public void printAddress(){
        System.out.println(Thread.currentThread().getName()+"-"+ref.get()+"-"+ref.get().p);
    }
}
Thread-0-com.loubinfeng.A@14e672aa-0
Thread-0-com.loubinfeng.A@1a218e46-1
Thread-0-com.loubinfeng.A@1a218e46-1
Thread-0-com.loubinfeng.A@1e1e19da-2
Thread-1-com.loubinfeng.A@14e672aa-0
Thread-1-com.loubinfeng.A@45669fee-1
Thread-1-com.loubinfeng.A@45669fee-1
Thread-1-com.loubinfeng.A@4ba17932-2

这个例子想说明,使用ThreadLocal,变量又是引用类型时,请注意变量的内存地址,因为变量副本复制是引用,而不是真正的内存。

ThreadLocal工作原理及api

看到这里,大家一定对ThreadLocal的工作原理很好奇。它是怎么做到变量的隔离而没有涉及变量的共享同步。
因为线程同步机制是多线程共享同一个变量,而ThreadLocal是为每一个线程创建一个单独的变量副本,所以每个线程都可以独立的改变自己所拥有的变量副本,同时还不影响其他线程的对应副本。

ThreadLocal定义了4个方法供开发者调用:

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

ThreadLocal,ThreadLocalMap和Thread之间关系

再探究ThreadLocal工作机制源码之前,我们先要搞清ThreadLocal,ThreadLocalMap和Thread三者的角色关系。

  1. ThreadLocalMap是ThreadLocal的一个内部类
  2. 每一个Thread对象中都有一个ThreadLocalMap类型的变量,用来存储变量副本
  3. ThreadLocalMap的key是ThreadLocal类型的,value是变量类型。

补充下,ThreadLocalMap是实现变量副本机制的关键类。突然出现这个类,估计一头雾水,下节我们讲探究源码,大家会对这个类有进一步的了解。

ThreadLocal源码实现

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

这是ThreadLocal的set方法的源码实现,实现逻辑是非常清晰的,先获取到了当前的线程对象,然后得到线程内部的ThreadLocalMap对象,如果是空的话,就创建这个对象。不是空的话,就将值存入这个map中,key则为当前这个ThreadLocal对象。

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;
                }

                if (k == null) {
                    replaceStaleEntry(key, value, i);
                    return;
                }
            }

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

这个是ThreadLocalMap的set方法,跟随上面的思路,ThreadLocal的set方法最终执行了ThreadLocalMap的set方法。这里要说明的是,虽然都是key-value结构,但是和集合Map解决散列冲突的方式是不一样的。集合Map的put采用是拉链式的,而ThreadLocalMap的set采用的是开放定址法。

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();
    }

这是ThreadLocal的get方法,跟他的set方法如出一辙,也是先得到线程对象,在获取Thread中的ThreadLocalMap对象,然后根据key取值,如果map为空,直接返回ThreadLocal 的初始值。

/**
         * Get the entry associated with key.  This method
         * itself handles only the fast path: a direct hit of existing
         * key. It otherwise relays to getEntryAfterMiss.  This is
         * designed to maximize performance for direct hits, in part
         * by making this method readily inlinable.
         *
         * @param  key the thread local object
         * @return the entry associated with key, or null if no such
         */
        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);
        }

        /**
         * Version of getEntry method for use when key is not found in
         * its direct hash slot.
         *
         * @param  key the thread local object
         * @param  i the table index for key's hash code
         * @param  e the entry at table[i]
         * @return the entry associated with key, or null if no such
         */
        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;
        }

当然追踪get方法,最终还是执行到了ThreadLocalMap的getEntry方法。如果所对应的key就是我们要找的元素,则返回,否则就调用getEntryAfterMiss方法。
这部分源码就不过分展开了,大略介绍下。

ThreadLocal方法的缺陷

ThreadLocal会存在内存泄漏的情况。因为每个Thread都有一个ThreadLocalMap实例,这个map的key类型是ThreadLocal,但是是个弱引用。弱饮用有利于GC回收。当这个key为null时,GC就会回收这部分空间,但是value却不一定被回收,因为有可能他和当前线程还存在强引用关系。这就是问题所在。
当然源码中也考虑到了这种情况,已经做了很多优化的地方,但是还是不能100%避免。这是我们就要显示的调用ThreadLocal的remove方法进行处理。

总结

ThreadLocal是解决多线程变量问题的另一种思路,核心理念就是为每个线程创建变量副本,用空间换时间的思路。

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

推荐阅读更多精彩内容