Java基础之ThreadLocal

ThreadLocal 是什么

首先 它是一个数据结构 类似HashMap 可以保存 Key Value 键值对 但是ThreadLocal只能保存一个 并且每个线程互不干扰

public static void main(String[] args) {
       final ThreadLocal<String> localName = new ThreadLocal();
        final HashMap<Integer, String> map = new HashMap<>(2);
        new Thread("线程1") {
            @Override
            public void run() {
                localName.set("Sincerity");
                String s = localName.get();
                System.out.println(Thread.currentThread().getName() + "获取到ThreadLocal值=" + s);
                map.put(0, Thread.currentThread().getName());
                System.out.println(Thread.currentThread().getName() + "获取到map的长度" + map.size());
            }
        }.start();
        String s = localName.get();
        System.out.println("主线程获取到ThreadLocal值=" + s);
        new Thread("线程2") {
            @Override
            public void run() {
                String s = localName.get();
                System.out.println(Thread.currentThread().getName() + "获取到ThreadLocal值=" + s);
                System.out.println(Thread.currentThread().getName() + "获取到map的长度" + map.size());
            }
        }.start();
 //得到结果
主线程获取到ThreadLocal值=null
 
线程1获取到ThreadLocal值=Sincerity
线程1获取到map的长度1
    
线程2获取到ThreadLocal值=null
线程2获取到map的长度1

思考一下为什么会出现这样的情况呢 我们已经知道ThreadLocal是一种数据结构 为什么除了赋值的线程之外数据无法获取呢 同样是HashMap 为什么可以可以全局获取到数据呢 带着问题 我们一起探索一下

为何ThreadLocal能实现每个线程的数据互不干扰

读懂源码
public class ThreadLocal<T> {  
    ...
        //说明创建ThreadLocal的时候什么也没有做
        public ThreadLocal() {
    }
    ...
     //set方法怎么说 
    public void set(T value) {
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t); //默认情况下为null
        if (map != null)
            //set的时候 把自己当做Key 传递的值当做Value
            map.set(this, value);
        else
            createMap(t, value); //创建一个map对象
    }
    ...

     //获取线程中保留的 ThreadLocal的映射 默认在Thread中为空
    ThreadLocalMap getMap(Thread t) {
        return t.threadLocals;
    }    
     //创建一个ThreadLocalMap 
     void createMap(Thread t, T firstValue) {
        t.threadLocals = new ThreadLocalMap(this, firstValue);
    }
    
    //get方法 
     public T get() {
        Thread t = Thread.currentThread();
         //得到当前线程的ThreadLocalMap映射
        ThreadLocalMap map = getMap(t);
        if (map != null) {
            //拿到key等于当前ThreadLocal的Entry 
            ThreadLocalMap.Entry e = map.getEntry(this);
            if (e != null) {
                @SuppressWarnings("unchecked")
                T result = (T)e.value;
                return result;
            }
        }
         //处理map等于null的情况 
        return setInitialValue();
    }
    /**
     *主要就是将一个null重新存入map中 并且返回null 
     */
    private T setInitialValue() {
        T value = initialValue();//得到一个Null值 
        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;
    }
}

看到这里其实我们也就明白 ThreadLocal为什么能保证每个线程数据独立了 其内部维护着一个当前线程的映射ThreadLocalMap 然后通过线程映射得到当前线程的ThreadLocalMap 这里就出现了一个问题 同一个ThreadLocal的Hashcode是一致的 怎么保证每个线程的数据独立呢

看看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;
       //得到key的hashCode
        private final int threadLocalHashCode = nextHashCode();
       //生成hash code间隙为这个魔数，
       //可以让生成出来的值或者说ThreadLocal的ID较为均匀地分布在2的幂大小的数组中。
        private static final int HASH_INCREMENT = 0x61c88647;
        private static int nextHashCode() {
        return nextHashCode.getAndAdd(HASH_INCREMENT);
    }
       //构造方法 默认添加一个值 
           ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
             //创建一个默认大小为16的数组
            table = new Entry[INITIAL_CAPACITY];
             //用firstKey的threadLocalHashCode与初始大小16取模得到哈希值
            int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
            table[i] = new Entry(firstKey, firstValue);
            size = 1;
            //设置阈值 
            setThreshold(INITIAL_CAPACITY);
        }
         private void setThreshold(int len) {
            threshold = len * 2 / 3; //直接写成2/3了 ....
        }
       //向ThreadLocalMap中添加元素
        private void set(ThreadLocal<?> key, Object value) {
            Entry[] tab = table;
            int len = tab.length;
            //得到key的hashCode  线性探测法得到 
            //每个ThreadLocal对象都有一个hash值threadLocalHashCode，每初始化一个ThreadLocal对象，
            //hash值就增加一个固定的大小0x61c88647
            int i = key.threadLocalHashCode & (len-1);
            //根据ThreadLocal大小的hash值得到table中的i的元素 
            for (Entry e = tab[i]; e != null; e = tab[i = nextIndex(i, len)]) {
                //如果I位置已经有一个Entry对象 说明hash冲突了
                //得到当前存储元素的key 
                ThreadLocal<?> k = e.get();
                //如果这个元素额key正好是设置的key 重新给元素中的value赋值
                if (k == key) {
                    e.value = value;
                    return;
                }
               // 当前i位置entry对象为空
                if (k == null) {
                    replaceStaleEntry(key, value, i);
                    return;
                }
            }
            //如果当前key的hashCode位置为空 插入一个enrty在i位置 
            tab[i] = new Entry(key, value);
            int sz = ++size;
            //清理一个没用的数据 后大小达到阈值
            if (!cleanSomeSlots(i, sz) && sz >= threshold)
                //扩容
                rehash(); //2倍扩容
        }
   }

int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);

可以看出，它是在上一个被构造出的ThreadLocal的ID/threadLocalHashCode的基础上加上一个魔数0x61c88647的。这个魔数的选取与斐波那契散列有关，0x61c88647对应的十进制为1640531527。斐波那契散列的乘数可以用(long) ((1L << 31) * (Math.sqrt(5) - 1))可以得到2654435769，如果把这个值给转为带符号的int，则会得到-1640531527。换句话说
(1L << 32) - (long) ((1L << 31) * (Math.sqrt(5) - 1))得到的结果就是1640531527也就是0x61c88647。通过理论与实践，当我们用0x61c88647作为魔数累加为每个ThreadLocal分配各自的ID也就是threadLocalHashCode再与2的幂取模，得到的结果分布很均匀。
ThreadLocalMap使用的是线性探测法，均匀分布的好处在于很快就能探测到下一个临近的可用slot，从而保证效率。这就回答了上文抛出的为什么大小要为2的幂的问题。为了优化效率。

对于& (INITIAL_CAPACITY - 1)，相信有过算法竞赛经验或是阅读源码较多的程序员，一看就明白，对于2的幂作为模数取模，可以用&(2n-1)来替代%2n，位运算比取模效率高很多。至于为什么，因为对2^n取模，只要不是低n位对结果的贡献显然都是0，会影响结果的只能是低n位。

可以说在ThreadLocalMap中，形如key.threadLocalHashCode & (table.length - 1)（其中key为一个ThreadLocal实例）这样的代码片段实质上就是在求一个ThreadLocal实例的哈希值，只是在源码实现中没有将其抽为一个公用函数。

内存泄漏

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

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

通过之前的分析已经知道，当使用ThreadLocal保存一个value时，会在ThreadLocalMap中的数组插入一个Entry对象，按理说key-value都应该以强引用保存在Entry对象中，但在ThreadLocalMap的实现中，key被保存到了WeakReference对象中。

这就导致了一个问题，ThreadLocal在没有外部强引用时，发生GC时会被回收，如果创建ThreadLocal的线程一直持续运行，那么这个Entry对象中的value就有可能一直得不到回收，发生内存泄露。

如何避免内存泄露

既然已经发现有内存泄露的隐患，自然有应对的策略，在调用ThreadLocal的get()、set()可能会清除ThreadLocalMap中key为null的Entry对象，这样对应的value就没有GC Roots可达了，下次GC的时候就可以被回收，当然如果调用remove方法，肯定会删除对应的Entry对象。

如果使用ThreadLocal的set方法之后，没有显示的调用remove方法，就有可能发生内存泄露，所以养成良好的编程习惯十分重要，使用完ThreadLocal之后，记得调用remove方法。

ThreadLocal<String> localName = new ThreadLocal();
try {
    localName.set("Sincerity");
} finally {
    localName.remove();
}
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 206,126评论 6赞 481
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 88,254评论 2赞 382
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 152,445评论 0赞 341
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 55,185评论 1赞 278
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 64,178评论 5赞 371
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,970评论 1赞 284
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,276评论 3赞 399
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,927评论 0赞 259
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 43,400评论 1赞 300
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2赞 323
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1赞 333
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,646评论 4赞 322
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,213评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1赞 260
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2赞 352
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2赞 345