ThreadLocal类设计思路、使用场景与源码详解

导论

如果让你设计一个变量,在不同线程的可以直接获取使用,不需要同步操作,读写都不影响其它线程的读写,你会怎么设计?

1.0版

1.0版可能会是这样,在Thread类中定义一个字段Object threadField,以及定义一个get与set操作
这样在需要使用的时候,调用Thread.currentThread().setThreadField(obj)进行设置,Thread.currentThread().getThreadField()进行读取,即可以实现这个功能。
但是,这样设计有问题,第一,存放一个数据就要添加一个字段,显然不科学,至少应该可以存放多个数据,所以大概需要用Hashmap来存放数据。第二,数据的类型不确定,导致使用的时候,还需要向下转型,不方便,所以应该用泛型来解决这个问题。

2.0版

在Thread类中定义字段HashMap <?,object>,面临一个问题,Key值的类型是什么?这个时候大概能想到,需要设计一个Class,作为Key值,方便用户通过Key去获取存放的数据。暂且称之为ThreadFieldKey。
数据类型不确定,需要使用泛型,泛型在哪定义?很容易想到,应该在ThreadFieldKey中,定义为ThreadFieldKey<T>.而getValue()的操作最终要返回T类型,Thread类又不持有T,所以getValue应该放在ThreadFieldKey<T>类中。 至此可以得到以下代码:

class Thread{
    HashMap<ThreadFieldKey,object> threadFieldHashMap;
    public HashMap<ThreadFieldKey,object> getThreadFieldHashMap(){
    return threadFieldHashMap;
}
}

class ThreadFieldKey<T>{

 public void setValue(T value){
   getMap.put(this,value);
}

public void getMap(){
   Thread t = Thread.currentThread();
   HashMap<ThreadFieldKey<T>,T>  map = t.getThreadFieldHashMap();
   return map;
}

public void getValue(T value){
    return (T)getMap.get(this);
}
}

class Client{
   public void main(){
   ThreadFieldKey<Double> doubleKey = new ThreadFieldKey<Double>();
   doubleKey .put(***);
   Double d = doubleKey.get();
   ThreadFieldKey<Student> studentKey = new ThreadFieldKey<Student>();
   studentKey .put(***);
   Student s = studentKey .get();
}
}

至此就实现了我们想要的功能。我们来看jdk是怎么实现的

官网版

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

public class ThreadLocal<T> {
    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 getMap(Thread t) {
        return t.threadLocals;
    }
void createMap(Thread t, T firstValue) {
        t.threadLocals = new ThreadLocalMap(this, firstValue);
    }

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

class Client{
        ThreadLocal<Double> threadLocal = new ThreadLocal<>();
        threadLocal.set(0.2);
        threadLocal.get();
}
}

可以看到,和2.0相比较,区别在于把HashMap替换为了ThreadLocal的静态内部类ThreadLocalMap,两者功能一样,都是存放键值对。ThreadLocalMap其它基本一样。

ThreadLocalMap.Entry类

重点讲一下这个Entry,对比一下

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;
            }
        }
}
class WeakHashMap{
 
 private static class Entry<K,V> extends WeakReference<Object> implements Map.Entry<K,V> {
        V value;
        final int hash;
        Entry<K,V> next;
}

两者的Entry都是继承与WeakReference,有什么用?显然,这是为了避免内存泄漏。
WeakReference标志性的特点是:只要没有其它地方引用该对象,则对象必然会在GC时被回收。
当用户不再使用,容器会一直持有该对象的引用,导致其无法回收,所以使用WeakReference。

ThreadLocalMap会在set,get以及resize等方法中对stale slots(根据reference.get() == null来判断,如果为true则表示过期,程序内部称为stale slots)做自动删除replaceStaleEntry(key, value, i)(set以及get不保证所有过期slots会在操作中会被删除,而resize则会删除threadLocalMap中所有的过期slots).当然将threadLocal对象设置为null并不能完全避免内存泄露对象,最安全的办法仍然是调用ThreadLocal的remove方法,来彻底避免可能的内存泄露。

rivate void set(ThreadLocal key, Object value) {
            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();
        }

使用场景

ThreadLocal中操作的对象都是当前线程的threadLocals,所以在不同线程读写,操作的是不同线程的变量,自然就没有共享访问的问题。

ThreadLocal不是用来解决对象共享访问问题的,而主要是提供了保持对象的方法和避免参数传递的方便的对象访问方式。

  • 使用场景1
    解决复杂逻辑下的对象传递
  • 使用场景2
    存储以线程为作用域的对象。例如hibernate中的实现,不同的线程过来,获取到不同的session。
private static final ThreadLocal threadSession = new ThreadLocal();

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

推荐阅读更多精彩内容