并发 -- ThreadLocal

1. 介绍

ThreadLocal类主要解决的就是让每个线程绑定自己的值，可以将ThreadLocal类形象的比喻成存放数据的盒子，盒子中可以存储每个线程的私有数据。

数据结构

public class Thread implements Runnable {
    //与此线程有关的ThreadLocal值。由ThreadLocal类维护
    ThreadLocal.ThreadLocalMap threadLocals = null;

    //与此线程有关的InheritableThreadLocal值。由InheritableThreadLocal类维护
    ThreadLocal.ThreadLocalMap inheritableThreadLocals = null;
}

每个线程有一个自己的ThreadLocalMap。将它的key视作ThreadLocal（非本身，而是它的一个弱引用），value为代码中放入的值。ThreadLocalMap 为 ThreadLocal的静态内部类。

内存泄漏：
如果把ThreadLocal置为null，只有弱引用，GC是可以回收这部分空间的，但是value却存在一条从Current Thread过来的强引用链。只有当Current Thread销毁时，value才能得到释放。在threadLocal 为 null 和线程结束这段时间内，就发生了内存泄露。

解决：
ThreadLocalMap实现中考虑了这种情况，在调用 set()、get()、remove() 方法的时候，会清理掉 key 为 null 的记录。使用完 ThreadLocal方法后 最好手动调用remove()方法。

部分源码：
ThreadLocal类的set()方法：

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

ThreadLocalMap 中存的是[ThreadLocal对象引用, 存放的值]，即最终变量是放在当前线程的成员变量ThreadLocals中，而ThreadLocals是ThreadLocalMap 类型，并不是存在 ThreadLocal 上，ThreadLocal 可以理解为ThreadLocalMap的封装，传递了变量值。

ThreadLocal类的get()方法

 public T get() {
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
         if (map != null) {
             ThreadLocalMap.Entry e = map.getEntry(this);
             if (e != null)
                 return (T)e.value;
         }
         return setInitialValue();
   } 

ThreadLocal类的initialValue()方法

protected T initialValue() {
        return null;
 }

该方法实现只返回 null，并且修饰符为protected，如果用户想返回初始值不为null，则需要定义线程变量时重写该方法；最多调用此方法一次，即线程第一次使用 get() 方法访问变量的时候。如果线程先调用 set(T) 方法，再调 get 方法，则不会在线程中调用 initialValue 方法。

ThreadLocalMap Hash算法
既然是Map结构，那么ThreadLocalMap也要实现自己的hash算法来解决散列表数组冲突问题。
int i = key.threadLocalHashCode & (len-1);

public class ThreadLocal<T> {
    private final int threadLocalHashCode = nextHashCode();
    private static AtomicInteger nextHashCode = new AtomicInteger();
    private static final int HASH_INCREMENT = 0x61c88647;
    
    //每当创建一个ThreadLocal对象，这个ThreadLocal.nextHashCode这个值就会增长 `0x61c88647`
    private static int nextHashCode() {
        return nextHashCode.getAndAdd(HASH_INCREMENT);
    }
    
    static class ThreadLocalMap{
        ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
            table = new Entry[INITIAL_CAPACITY];
            int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
            table[i] = new Entry(firstKey, firstValue);
            size = 1;
            setThreshold(INITIAL_CAPACITY);
        }
    }
}

ThreadLocalMap.Entry：

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

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