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<ThreadLocal<?>> {
             /** 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<Object> reference = getReference();
    System.gc();
    Object o = reference.get();
    System.out.println(o);
}

public WeakReference<Object> getReference(){
    WeakReference<Object> reference = new WeakReference(new Object());
    return reference;
}

print 方法会输出null，这个就是我疑惑的地方，为什么ThreadLocal 不会出现上面在使用弱引用中，执行gc 后，引用被回收导致key 为空，取不到值了。
在网上找到了答案，在使用一个例子验证下就会明白了

  @Test
public void sidi() throws InterruptedException {
    getLocal();
    System.gc();
    TimeUnit.SECONDS.sleep(1);
    Thread thread = Thread.currentThread();
    System.out.println(thread); // 在这里打断点，观察thread对象里的ThreadLocalMap数据

}

private Local getLocal() {
    Local local = new Local();
    System.out.println(local.get());
    return local;
}

private static class Local {
    private ThreadLocal<String> local = ThreadLocal.withInitial(() -> "ssssssssss");

    public String get() {
        return local.get();
    }

    public void set(String str) {
        local.set(str);
    }

下面看下debug结果图

现在做一个小改动

为什么有一个返回值后，ThreadLocal就不会被gc回收掉呢，其实跟这个跟强引用有关系的。当前根对象就是local 对象，持有ThreadLocal local，虽然local是被弱引用包装有可能被gc的，但是同时被当前local 的强引用关联，对象仍然是可达的，不会被垃圾回收掉。当前方法没有持有local时，Local内部local 是没有任何对象引用它，强引用并没有作用到ThreadLocal，执行gc时肯定会删除弱引用。总结执行gc时，弱引用总会被垃圾回收掉的，但是如果弱引用的对象同时被强引用持有，强引用作用域会盖过弱引用，在强引用可达之前，对象是不会被回收的。所以平常我们在使用ThreadLocal时不会担心弱引用被删除情况，我们在操作ThreadLocal时会必须持有它的对象引用，强引用保证了在当前持有对象代码里对象不会被回收。

看上面经典图片，实线表示强引用，虚线表示弱引用。当线程栈持有ThreadLocal，作为Entry key的它不会被gc，当ThreadLocalRef 引用失效时，ThreadLocal 就会在下次gc时被回收掉。在持有ThreadLocal对象引用链时，ThreadLocal弱引用都不会被回收的。
最后一个问题，为什么ThreadLocal要作为弱引用作为ThreadLocalMap 内部key存在呢。我们知道ThreadLocal作为多线程操作自身私有变量工具类，本事不持有任何线程的变量，只是封装具体实现方便使用者调用。ThreadLocal 本身对象生命周期很短的，用完就可以回收了。试想下ThreadLocal作为Entry key存在，线程引用链就会变成Thread->ThreadLocalMap ->ThreadLocal, 在线程对象不会释放之前，ThreadLoca对象不会被回收的。如果我们不手动释放它，是不是就和Entry key 被删除一样，对象太多可能导致内存泄露。ThreadLocal 作为一个工具类没必要和Thread一起绑定，设置一个弱引用包装它，可以在对象作用域消失后有利于垃圾回收器回收它。即使没有手动释放设置value，也不必太过担心内存泄漏这块，在新增值、数组扩容时都会检查有key 被gc情况，对val 释放。