ThreadLocal源码解析

ThreadLocal 如何实现线程间隔离，为什么ThreadLocal经常容易出现内存溢出。带着这两个问题，在源码中找寻答案。
先从设置值开始，看ThreadLocal.set()如何实现的值保存。

    public void set(T value) {
        Thread t = Thread.currentThread();
        //获取线程私有属性 threadLocals
        ThreadLocalMap map = getMap(t);
        if (map != null) {
            map.set(this, value);
        } else {
            createMap(t, value);
        }
    }

• threadLocals: 线程Thread 对象内部属性，这个属性默认就是null，现在看来就是由ThreadLocal.set 进行初始化的了。
  先不用管ThreadLocalMap如何实现，只有把他当作当成类型Map这类容器。一开始没有想明白线程使用变量不是一个Object，而是一个容器。set 值时为什么不直接ThreadLocal set val 直接给Thread.threadLocals 而是将一个容器赋值。转念一想一个Thread + 一个ThreadLocal 只能保存一个val，但是一个Thread 可以对应多个ThreadLocal，一个线程对象属性可能被多个ThreadLocal共同持有，差点被一个Thread、一个ThreadLocal 限制了思路。
  先看下createMap如何初始化的，value如何保存起来。

    void createMap(Thread t, T firstValue) {
        t.threadLocals = new ThreadLocalMap(this, firstValue);
    }

• ThreadLocalMap: ThreadLocal 一个内部类，名字看起来像Map实现类，其实本质并没有和Map有任何关系，也没有实现Map接口。内部使用Entry(类似Map key-value 对象) 数组存储数据，使用Hash 算法计算下标。如果出现hash 冲突如何解决呢，这个低配Entry 并没有链表或者红黑树这样黑科技。

   static class ThreadLocalMap {
  
        /**
         *  使用弱引用包装ThreadLocal 作为map Key 
         *  在某些情况下key会被回收掉
         */
        static class Entry extends WeakReference> {
            /** 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];
           //使用hashCode 计算下标
          //这里使用hashCode 跟我们普通对象不一样，通过自增长计算出来
            int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
            table[i] = new Entry(firstKey, firstValue);
            size = 1;
            setThreshold(INITIAL_CAPACITY);
        }

• WeakReference: 弱引用的对象拥有更短暂的生命周期。在垃圾回收器线程扫描它所管辖的内存区域的过程中，一旦发现了只具有弱引用的对象，不管当前内存空间足够与否，都会回收它的内存。
  因此一旦出现gc ThreadLocalMap的key 就会被回收掉，从而导致ThreadLocal 设置value不能被删除，对象积压过多导致内存溢出。现在第二个问题得到答案了因为map key 会被gc 释放，从而导致value不能被删除，所以使用完成后必须手动释放掉val。

        private void set(ThreadLocal key, Object value) {
            Entry[] tab = table;
            int len = tab.length;
            int i = key.threadLocalHashCode & (len-1);
          // 循环里面处理hash冲突情况
            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) { // key 已经被gc
                   //这个i 不会变，只能向后找一位
                   //这里会继续向后找，直到找到符合条件位置，并且将key被gc  value 也回收掉，
                  //这个只有在一定条件下才生效
                    replaceStaleEntry(key, value, i);
                    return;
                }
            }
            // 当hash 冲突时，会一直向后找，直到有空位置
            tab[i] = new Entry(key, value);
            int sz = ++size;
            //在位置i 后面搜寻是否有key 回收情况，则删除数组位置，返回true 
            // 当有删除，不需要判断扩容情况了，一个新增对应删除，容量都没有增加
            if (!cleanSomeSlots(i, sz) && sz >= threshold)
                rehash(); //扩容数组
        }

  在出现hash冲突时，只是将下标向后移动，找到空闲的位置。正如set 方法注释上写，set 并不支持快速set、冲突了通过向后遍历数组找到空位置。
  ThreadLocalMap 居然还有检测key 为空机制，并且删除数组中位置。这个机制要一定情况才能触发，首先被回收key必须在新增key 后面位置才能被发现。
  看下ThreadLocal.get如何取值

    public T get() {
        Thread t = Thread.currentThread();
        // 调用get 并不会初始化threadLocals
        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;
            }
        }
        //没有取到值，会返回null
        return setInitialValue();
    }

  看下ThreadLocalMap内部如何将值返回的吧

        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);
        }
  
        //向后查找符合要去key
        private Entry getEntryAfterMiss(ThreadLocal key, int i, Entry e) {
            Entry[] tab = table;
            int len = tab.length;
  
            while (e != null) { //遇到null 就停下来
                ThreadLocal k = e.get();
                if (k == key)
                    return e;
                if (k == null)
                     // k 已经被gc 了
                    //在数组中删除这个位置，这样可以帮助value 回收了
                    expungeStaleEntry(i);
                else
                    i = nextIndex(i, len);
                e = tab[i];
            }
            return null;
        }

  这里get 也不是一次性找到，会通过向后遍历匹配出来，这个以HashMap 相比差距挺大的。插入、查找效率都在N之间。
  开头两个疑惑，现在都得到解决了。
  不知道大家是否和我好奇ThreadLocalMap 的弱引用在使用时为什么不会被gc掉，导致传值进去而不能获取返回值呢，为什么要使用弱引用来包装Key，如何权衡利弊的。
  做一个小例子

    public void  print(){
        WeakReference