前面我们分析了 Thread 类的源码，有了前面的铺垫，通过源码 理解 ThreadLocal 的秘密就容易多了。

    ThreadLocal 类 提供了 get/set 线程局部变量的实现，ThreadLocal 成员变量与正常的成员变量不同，每个线程都可以通过 ThreadLocal 成员变量 get/set 自己的专属值。ThreadLocal 实例 通常是类中的私有静态变量，常用于将状态与线程关联，例如：用户 ID 或事务 ID。

    tips：在类中定义 ThreadLocal 变量时，一般在定义时就进行实例化！

    1. public class ThreadLocal<T> {
    3.     /**
    4.      * ThreadLocal能为每个 Thread线程 绑定一个专属值的奥秘就是：
    5.      * 每个Thread对象都持有一个 ThreadLocalMap类型的成员变量，其key为ThreadLocal对象，
    6.      * value为绑定的值，所以每个线程调用 ThreadLocal对象 的set(T value)方法时，都会将
    7.      * 该ThreadLocal对象和绑定的值 以键值对的形式存入当前线程，这样，同一个ThreadLocal对象
    8.      * 就可以为每个线程绑定一个专属值咯。
    9.      * 每个线程调用 ThreadLocal对象的get()方法时，就可以根据 当前ThreadLocal对象 get到 绑定的值。
    10.      */
    11.     public void set(T value) {
    12.         // 获取当前线程
    13.         Thread t = Thread.currentThread();
    14.         // 获取当前线程对象中持有的 ThreadLocalMap类型的成员变量
    15.         // ThreadLocalMap，看名字也知道它是一个 Map类型的 类
    16.         ThreadLocalMap map = getMap(t);
    17.         if (map != null)
    18.             map.set(this, value);
    19.         else
    20.             createMap(t, value);
    21.     }
    23.     ThreadLocalMap getMap(Thread t) {
    24.         // 经过前面对 Thread类 源码的分析，可以知道，Thread类中有一个 ThreadLocalMap 类型的
    25.         // threadLocals变量
    26.         return t.threadLocals;
    27.     }
    29.     void createMap(Thread t, T firstValue) {
    30.         t.threadLocals = new ThreadLocalMap(this, firstValue);
    31.     }
    33.     public T get() {
    34.         Thread t = Thread.currentThread();
    35.         ThreadLocalMap map = getMap(t);
    36.         if (map != null) {
    37.             // 通过当前 ThreadLocal对象，获取绑定的值
    38.             ThreadLocalMap.Entry e = map.getEntry(this);
    39.             if (e != null) {
    40.                 @SuppressWarnings("unchecked")
    41.                 T result = (T)e.value;
    42.                 return result;
    43.             }
    44.         }
    45.         return setInitialValue();
    46.     }
    48.      public void remove() {
    49.           // 获取当前线程的ThreadLocalMap成员变量，不为空就将当前 ThreadLocal对象
    50.           // 对应的 键值对 remove掉
    51.          ThreadLocalMap m = getMap(Thread.currentThread());
    52.          if (m != null)
    53.              m.remove(this);
    54.      }
    56.     /**
    57.      * 与大部分 Map 的实现相同，底层也是使用 动态数组来保存 键值对Entry，也有rehash、resize等
    58.      * 操作
    59.      */
    60.     static class ThreadLocalMap {
    62.         /**
    63.          * 存储键值对，key 为 ThreadLocal对象，value 为 与该ThreadLocal对象绑定的值
    64.          * Entry的key是对ThreadLocal的弱引用，当抛弃掉ThreadLocal对象时，垃圾收集器会
    65.          * 忽略这个key的引用而清理掉ThreadLocal对象，防止了内存泄漏
    66.          */
    67.         static class Entry extends WeakReference<ThreadLocal<?>> {
    68.             Object value;
    70.             Entry(ThreadLocal<?> k, Object v) {
    71.                 super(k);
    72.                 value = v;
    73.             }
    74.         }
    76.         // 看过 HashMap 或 ConcurrentHashMap 源码的同学 一定下面对这些代码很眼熟
    77.         /**
    78.          * 数组初始容量
    79.          */
    80.         private static final int INITIAL_CAPACITY = 16;
    82.         /**
    83.          * Entry数组，用于存储 <ThreadLocal<?> k, Object v>键值对
    84.          */
    85.         private Entry[] table;
    87.         /**
    88.          * Entry元素数量
    89.          */
    90.         private int size = 0;
    92.         /**
    93.          * 类似于 HashMap 扩容因子机制
    94.          */
    95.         private int threshold; // Default to 0
    96.         private void setThreshold(int len) {
    97.             threshold = len * 2 / 3;
    98.         }
    100.         private static int nextIndex(int i, int len) {
    101.             return ((i + 1 < len) ? i + 1 : 0);
    102.         }
    104.         private static int prevIndex(int i, int len) {
    105.             return ((i - 1 >= 0) ? i - 1 : len - 1);
    106.         }
    108.         /**
    109.          * 系列构造方法
    110.          */
    111.         ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
    112.             table = new Entry[INITIAL_CAPACITY];
    113.             int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
    114.             table[i] = new Entry(firstKey, firstValue);
    115.             size = 1;
    116.             setThreshold(INITIAL_CAPACITY);
    117.         }
    119.         private ThreadLocalMap(ThreadLocalMap parentMap) {
    120.             Entry[] parentTable = parentMap.table;
    121.             int len = parentTable.length;
    122.             setThreshold(len);
    123.             table = new Entry[len];
    125.             for (int j = 0; j < len; j++) {
    126.                 Entry e = parentTable[j];
    127.                 if (e != null) {
    128.                     @SuppressWarnings("unchecked")
    129.                     ThreadLocal<Object> key = (ThreadLocal<Object>) e.get();
    130.                     if (key != null) {
    131.                         Object value = key.childValue(e.value);
    132.                         Entry c = new Entry(key, value);
    133.                         int h = key.threadLocalHashCode & (len - 1);
    134.                         while (table[h] != null)
    135.                             h = nextIndex(h, len);
    136.                         table[h] = c;
    137.                         size++;
    138.                     }
    139.                 }
    140.             }
    141.         }
    143.         /**
    144.          * 根据 ThreadLocal对象 获取其对应的 Entry实例
    145.          */
    146.         private Entry getEntry(ThreadLocal<?> key) {
    147.             int i = key.threadLocalHashCode & (table.length - 1);
    148.             Entry e = table[i];
    149.             if (e != null && e.get() == key)
    150.                 return e;
    151.             else
    152.                 return getEntryAfterMiss(key, i, e);
    153.         }
    155.         /**
    156.          * 常规Map实现类 的set()方法，只不过这里的 key被规定为 ThreadLocal类型
    157.          */
    158.         private void set(ThreadLocal<?> key, Object value) {
    160.             Entry[] tab = table;
    161.             int len = tab.length;
    162.             // 根据哈希码和数组长度求元素放置的位置，如果该位置有其它元素，就依次尝试往后放
    163.             int i = key.threadLocalHashCode & (len-1);
    165.             for (Entry e = tab[i];
    166.                  e != null;
    167.                  e = tab[i = nextIndex(i, len)]) {
    168.                 ThreadLocal<?> k = e.get();
    169.                 // 如果key相等，覆盖value
    170.                 if (k == key) {
    171.                     e.value = value;
    172.                     return;
    173.                 }
    174.                 // 如果key为null，用新key、value覆盖，同时清理历史key=null的陈旧数据
    175.                 if (k == null) {
    176.                     replaceStaleEntry(key, value, i);
    177.                     return;
    178.                 }
    179.             }
    181.             tab[i] = new Entry(key, value);
    182.             int sz = ++size;
    183.             // 若超过阀值，则rehash
    184.             if (!cleanSomeSlots(i, sz) && sz >= threshold)
    185.                 rehash();
    186.         }
    188.         /**
    189.          * Remove the entry for key.
    190.          */
    191.         private void remove(ThreadLocal<?> key) {
    192.             Entry[] tab = table;
    193.             int len = tab.length;
    194.             int i = key.threadLocalHashCode & (len-1);
    195.             for (Entry e = tab[i];
    196.                  e != null;
    197.                  e = tab[i = nextIndex(i, len)]) {
    198.                 if (e.get() == key) {
    199.                     e.clear();
    200.                     expungeStaleEntry(i);
    201.                     return;
    202.                 }
    203.             }
    204.         }
    206.         /**
    207.          * 调整当前table的容量。首先扫描整个容器，以删除过时的条目，如果这不能充分缩小表的大小，
    208.          * 将进行扩容操作
    209.          */
    210.         private void rehash() {
    211.             // 扫描整个容器，删除过时的条目
    212.             expungeStaleEntries();
    214.             // 若未能充分缩小表的大小，则进行扩容操作
    215.             if (size >= threshold - threshold / 4)
    216.                 resize();
    217.         }
    219.         /**
    220.          * 扩容为原容量的两倍
    221.          */
    222.         private void resize() {
    223.             Entry[] oldTab = table;
    224.             int oldLen = oldTab.length;
    225.             int newLen = oldLen * 2;
    226.             Entry[] newTab = new Entry[newLen];
    227.             int count = 0;
    228.             // 遍历Entry[]数组
    229.             for (int j = 0; j < oldLen; ++j) {
    230.                 Entry e = oldTab[j];
    231.                 if (e != null) {
    232.                     ThreadLocal<?> k = e.get();
    233.                     // 如果key=null，把value也置null,有助于GC回收对象
    234.                     if (k == null) {
    235.                         e.value = null; // Help the GC
    236.                     } else {
    237.                         int h = k.threadLocalHashCode & (newLen - 1);
    238.                         while (newTab[h] != null)
    239.                             h = nextIndex(h, newLen);
    240.                         newTab[h] = e;
    241.                         count++;
    242.                     }
    243.                 }
    244.             }
    245.             // 设置新的阈值
    246.             setThreshold(newLen);
    247.             size = count;
    248.             table = newTab;
    249.         }
    250.     }
    251. }

    简单画个图总结一下 ThreadLocal 的原理，如下。

    avatar

    最后强调一下 ThreadLocal 的使用注意事项：

    1. ThreadLocal 不是用来解决线程安全问题的，多线程不共享，不存在竞争！其目的是使线程能够使用本地变量。

    2. 项目如果使用了线程池，那么线程回收后 ThreadLocal 变量要 remove 掉，否则线程池回收线程后，变量还在内存中，可能会带来意想不到的后果！例如 Tomcat 容器的线程池，可以在拦截器中处理：继承 HandlerInterceptorAdapter，然后复写 afterCompletion()方法，remove 掉变量！！！