ThreadLocal 详解

1. ThreadLocal简介

1.1 官方介绍

/**
 * This class provides thread-local variables.  These variables differ from
 * their normal counterparts in that each thread that accesses one (via its
 * {@code get} or {@code set} method) has its own, independently initialized
 * copy of the variable.  {@code ThreadLocal} instances are typically private
 * static fields in classes that wish to associate state with a thread (e.g.,
 * a user ID or Transaction ID).
 *
 * <p>For example, the class below generates unique identifiers local to each
 * thread.
 * A thread's id is assigned the first time it invokes {@code ThreadId.get()}
 * and remains unchanged on subsequent calls.
 * <pre>
 * import java.util.concurrent.atomic.AtomicInteger;
 *
 * public class ThreadId {
 *     // Atomic integer containing the next thread ID to be assigned
 *     private static final AtomicInteger nextId = new AtomicInteger(0);
 *
 *     // Thread local variable containing each thread's ID
 *     private static final ThreadLocal&lt;Integer&gt; threadId =
 *         new ThreadLocal&lt;Integer&gt;() {
 *             &#64;Override protected Integer initialValue() {
 *                 return nextId.getAndIncrement();
 *         }
 *     };
 *
 *     // Returns the current thread's unique ID, assigning it if necessary
 *     public static int get() {
 *         return threadId.get();
 *     }
 * }
 * </pre>
 * <p>Each thread holds an implicit reference to its copy of a thread-local
 * variable as long as the thread is alive and the {@code ThreadLocal}
 * instance is accessible; after a thread goes away, all of its copies of
 * thread-local instances are subject to garbage collection (unless other
 * references to these copies exist).
 *
 * @author  Josh Bloch and Doug Lea
 * @since   1.2
 */
public class ThreadLocal<T> {

从Java官方文档中的描述：ThreadLocal类用来提供线程内部的局部变量。这种变量在多线程环境下访问（通过get和set方法访问）时能保证各个线程的变量相对独立于其他线程内的变量。ThreadLocal实例通常来说都是private static类型的，用于关联线程和线程的上下文。

我们可以得知ThreadLocal的作用是：提供线程内的局部变量，不同的线程之间不会相互干扰，这种变量在线程的生命周期内起作用，减少同一个线程内多个函数或组件之间一些公共变量传递的复杂度。

使用总结：

线程并发：在多线程并发的场景下使用，单线程不需要
传递数据：我们可以通过ThreadLocal在同一线程，不同组件中传递公共变量
线程隔离：每个线程的变量都是独立的，不会互相影响

1.2 基本使用

1.2.1 常用方法

方法声明	描述
ThreadLocal()	创建ThreadLocal对象
public void set(T value)	设置当前线程绑定的局部变量
public T get()	获取当前线程绑定的局部变量
public void remove()	移除当前线程绑定的局部变量

1.2.2 使用案例

看下面这个案例，感受一下ThreadLocal线程隔离的特点：

package com.study.common.threadlocal;

import lombok.Getter;
import lombok.Setter;

/**
 * 需求：线程隔离
 *      在多线程并发的场景下，每个线程中的变量都是相互独立的
 *      线程A：设置（变量1） 获取（变量1）
 *      线程B：设置（变量2） 获取（变量2）
 */
@Getter
@Setter
public class ThreadLocalTest01 {

    private String content;

    public static void main(String[] args) {
        ThreadLocalTest01 threadLocalTest = new ThreadLocalTest01();
        for (int i = 0; i < 5; i++) {
            Thread thread = new Thread(() -> {
                //每个线程存一个变量，然后再取出这个变量
                threadLocalTest.setContent(Thread.currentThread().getName() + "的数据");
                System.out.println(Thread.currentThread().getName() + "--->" + threadLocalTest.getContent());
            });
            thread.setName("线程i" + i); //线程0-4
            thread.start();
        }
    }

}

此时的输出结果：

线程i3—>线程i4的数据
线程i1—>线程i4的数据
线程i4—>线程i4的数据
线程i2—>线程i4的数据
线程i0—>线程i4的数据

这就表示普通的变量并不具有线程隔离的能力

稍作修改，使用ThreadLocal存储变量

package com.study.common.threadlocal;

/**
 * 需求：线程隔离
 *      在多线程并发的场景下，每个线程中的变量都是相互独立的
 *      线程A：设置（变量1） 获取（变量1）
 *      线程B：设置（变量2） 获取（变量2）
 *
 *      ThreadLocal:
 *          1. set()：将变量绑定到当前线程中
 *          2. get()：获取当前线程绑定的变量
 */
public class ThreadLocalTest02 {

    private static ThreadLocal<String> threadLocal = new ThreadLocal<>();

    private String content;

    public String getContent() {
        return threadLocal.get();
    }

    public void setContext(String content) {
        // this.content = content;
        // 变量content绑定到当前线程
        threadLocal.set(content);
    }

    public static void main(String[] args) {
        ThreadLocalTest02 threadLocalTest = new ThreadLocalTest02();
        for (int i = 0; i < 5; i++) {
            Thread thread = new Thread(() -> {
                //每个线程存一个变量，然后再取出这个变量
                threadLocalTest.setContext(Thread.currentThread().getName() + "的数据");
                System.out.println(Thread.currentThread().getName() + "--->" + threadLocalTest.getContent());
            });
            thread.setName("线程i" + i); //线程0-4
            thread.start();
        }
    }
}

此时的输出结果：

线程i0—>线程i0的数据
线程i4—>线程i4的数据
线程i2—>线程i2的数据
线程i3—>线程i3的数据
线程i1—>线程i1的数据

1.3 ThreadLocal类与synchronized关键字

1.3.1 sychronized同步方式

package com.study.common.threadlocal;

import lombok.Getter;
import lombok.Setter;

/**
 * 需求：线程隔离
 *      在多线程并发的场景下，每个线程中的变量都是相互独立的
 *      线程A：设置（变量1） 获取（变量1）
 *      线程B：设置（变量2） 获取（变量2）
 */
@Getter
@Setter
public class ThreadLocalTest03 {

    private String content;

    public static void main(String[] args) {
        ThreadLocalTest03 threadLocalTest = new ThreadLocalTest03();
        for (int i = 0; i < 5; i++) {
            Thread thread = new Thread(() -> {
                synchronized (threadLocalTest) {
                    //每个线程存一个变量，然后再取出这个变量
                    threadLocalTest.setContent(Thread.currentThread().getName() + "的数据");
                    System.out.println(Thread.currentThread().getName() + "--->" + threadLocalTest.getContent());
                }
            });
            thread.setName("线程i" + i); //线程0-4
            thread.start();
        }
    }

}

输出：

线程i1—>线程i1的数据
线程i2—>线程i2的数据
线程i3—>线程i3的数据
线程i4—>线程i4的数据
线程i0—>线程i0的数据

上面的数据混乱的问题可以通过加锁的形式解决，但是会使代码的性能降低，而且这里强调的是线程数据隔离的问题，并不是多线程共同操作一个数据而导致的数据混乱，所以这个案例并不适合使用synchronized关键字

1.3.2 ThreadLocal与synchronized的区别

虽然ThreadLocal类与synchronized关键字都用于处理多线程并发访问变量的问题，不过两者处理问题的角度和思路不同。

	ThreadLocal	synchronized
原理	采用”以空间换时间“的方式，为每一个线程都提供了一份变量的副本，从而实现同时访问而互不干扰	采用”以时间换空间“的方式，只提供了一份变量，让不同的线程排队访问
侧重点	多线程中让每个线程之间的数据相互隔离	多个线程之间访问资源的同步

总结：在刚刚的案例中，虽然使用ThreadLocal和synchronizde关键字都能解决问题，但是使用ThreadLocal更合适，因为这样可以使程序拥有更高的并发性。

2. 运用场景事务案例

2.1 转账案例

有一个数据表account，里面有两个用户 Jack 和 Rose，用户Jack给用户Rose转账，这里就涉及两个数据库修改操作，一个转出，一个转入。这两个操作必须是原子性的，不可分割，不要就会出现问题。

所以这里就会开启事务，来保证这组操作的原子性，要么同时成功，要么同时失败。

开启事务的注意点：

为了保证所有的操作在一个事务中，案例中使用的JDBC连接必须是同一个对象，也就是说，service层开启事务的connection需要跟dao层访问数据库的connection保持一致
线程并发情况下，每个线程只能操作各自的connection

2.2 常规解决方案

2.2.1 常规方案的实现

基于上面的注意点，通常想到的方案是：

从service层将connection对象传给dao层
加锁

2.3 ThreadLocal解决方案

2.3.1 ThreadLocal方案的实现

像这种需要在项目中进行数据传递和线程隔离的场景，我们不妨用ThreadLocal来解决：把连接池放在ThreadLocal里，需要时直接去ThreadLocal里获取。

2.3.2 ThreadLocal方案的好处

在一些特定的场景下，ThreadLocal方案有两个突出的优势：

传递数据：保存每个线程绑定的数据，在需要的地方可以直接获取，避免参数直接传递带来的代码耦合问题
线程隔离：各线程之间的数据相互隔离却又具备并发性，避免同步方式带来的性能损失

3. ThreadLocal的内部结构

通过上面的学习，我们对ThreadLocal的作用有了一定的认识。现在我们来看一下ThreadLocal的内部结构，探究它能够实现线程数据隔离的原理

3.1 常见的误解

如果我们不去看源码的话，可能会猜测ThreadLocal是这样子设计的：每个 ThreadLocal 类都创建一个Map，然后用线程的ID threadID作为Map的key，要存储的局部变量作为Map的value，这样就能达到各个线程的局部变量隔离的效果。

这是最简单的设计方法，JDK最早期的 ThreadLocal 就是这样设计的，但现在早就不是了。

3.2 现在的设计

JDK后面优化了设计方案，现时JDK1.8中ThreadLocal的设计是：每个Thread维护一个ThreadLocalMap哈希表，这个哈希表的key是ThreadLocal实例本身，value才是真正要存储的值Object。

具体过程是这样的：

每个Thread线程内部都有一个Map（ThreadLocalMap）
Map里面存储ThreadLocal对象（key）和线程的变量副本（value）
Thread内部的Map是由ThreadLocal维护的，由ThreadLocal负责向Map获取和设置线程的变量值
对于不同的线程，每次获取副本值时，别的线程并不能获取到当前线程的副本值，形成了副本的隔离，互不干扰。

3.3 这样设计的好处

每个Map存储的Entry数量变少
当Thread销毁的时候，ThreadLocalMap也会随之销毁，减少内存的使用

4. ThreadLocal的核心方法源码

基于ThreadLocal的内部结构，我们继续分析它的核心方法源码，更深入的了解其操作原理。除了构造方法之外，ThreadLocal对外暴露的方法有一下4个：

方法声明	描述
protected T initialValue()	返回当前线程局部变量的初始值
public void set(T value)	设置当前线程绑定的局部变量
public T get()	获取当前线程绑定的局部变量
public void remove()	移除当前线程绑定的局部变量

以下是这4个方法的详细源码分析（为了保证思路清晰，ThreadLocalMap部分暂不展开）

4.1 set方法

4.1.1 源码和对应的中文注释

/**
 * 设置当前线程对应的ThreadLocal的值
 *
 * @param value 将要保存在当前线程对应的ThreadLocal的值
 */
public void set(T value) {
    // 获取当前线程对象
    Thread t = Thread.currentThread();
    // 获取此线程对象中维护的ThreadLocalMap对象
    ThreadLocalMap map = getMap(t);
    // 判断ThreadLocalMap是否存在
    if (map != null)
        // 存在则调用map.set设置此实体entry
        map.set(this, value);
    else
        // 否则调用createMap进行ThreadLocalMap对象的初始化，并将t（当前线程）和value（t对应的值）作为第一个entry存放至ThreadLocalMap中
        createMap(t, value);
}


/**
 * 获取当前线程Thread对应维护的ThreadLocalMap
 *
 * @param  t 当前线程
 * @return 对应维护的ThreadLocalMap
 */
ThreadLocalMap getMap(Thread t) {
    return t.threadLocals;
}


/**
 * 创建当前线程Thread对应维护的ThreadLocalMap
 *
 * @param t 当前线程
 * @param firstValue 存放到map中第一个entry的值
 */
void createMap(Thread t, T firstValue) {
    // 这里的this是调用此方法的threadLocal
    t.threadLocals = new ThreadLocalMap(this, firstValue);
}

4.1.2 代码执行流程

首先获取当前线程，并根据当前线程获取一个Map
如果获取的Map不为空，则将参数设置到Map中（当前ThreadLocal的引用作为key）
如果Map为空，则给该线程创建Map，并设置初始值

4.2 get方法

4.2.1 源码和对应的中文注释

/**
 * 返回当前线程中保存ThreadLocal的值
 * 如果当前线程没有此ThreadLocal变量，则它会通过{@link #initialValue}方法进行初始化值
 *
 * @return 返回当前线程中保存ThreadLocal的值
 */
public T get() {
    // 获取当前线程对象
    Thread t = Thread.currentThread();
    // 获取此线程对象中维护的ThreadLocalMap对象
    ThreadLocalMap map = getMap(t);
    // 如果此map存在
    if (map != null) {
        // 以当前的ThreadLocal为key，调用getEntry获取对应的存储实体e
        ThreadLocalMap.Entry e = map.getEntry(this);
        // 对e进行判空
        if (e != null) {
            @SuppressWarnings("unchecked")
            // 获取存储实体 e 对应的 value 值
            T result = (T)e.value;
            return result;
        }
    }
    /*
    	初始化：有两种情况执行当前代码
    	1. map不存在，表示此线程没有维护的ThreadLocalMap对象
    	2. map存在，但是没有与当前ThreadLocal关联的entry
     */
    return setInitialValue();
}


/**
 * 初始化
 *
 * @return the initial value 初始化后的值
 */
private T setInitialValue() {
    // 调用initialValue获取初始化的值
    // 此方法可以被子类重写，如果不重写默认返回null
    T value = initialValue();
    // 获取当前线程对象
    Thread t = Thread.currentThread();
    // 获取此线程对象中维护的ThreadLocalMap对象
    ThreadLocalMap map = getMap(t);
    // 判断map是否存在
    if (map != null)
        // 存在则调用map.set设置此实体entry
        map.set(this, value);
    else
        // 否则调用createMap进行ThreadLocalMap对象的初始化，并将t（当前线程）和value（t对应的值）作为第一个entry存放至ThreadLocalMap中
        createMap(t, value);
    // 返回设置的值value
    return value;
}

4.2.2 代码执行流程

首先获取当前线程，根据当前线程获取一个Map
如果获取的Map不为空，则在Map中以ThreadLocal的引用作为key来在Map中获取对应的Entry e，否则转到第4步
如果e不为空，则返回e.value
如果Map为空或者e为空，则通过initialValue方法获取初始化值value，然后用ThreadLocal的引用和value作为firstKey和firstValue创建一个新的Map

总结：先获取当前线程的 ThreadLocalMap 变量，如果存在则返回值，不存在则创建并返回初始值。

4.3 remove方法

4.3.1 源码和对应的中文注释

/**
 * 删除当前线程中保存的ThreadLocal对应的实体entry
 */
public void remove() {
    // 获取当前线程对象中维护的ThreadLocalMap对象
    ThreadLocalMap m = getMap(Thread.currentThread());
    // 如果此Map存在
    if (m != null)
        // 调用map.remove方法，以当前ThreadLocal为key删除对应的实体entry
        m.remove(this);
}

4.3.2 代码执行流程

获取当前线程，并根据当前线程获取一个Map
如果获取的Map不为空，则移除当前ThreadLocal对象对应的entry

4.4 initialValue方法

4.4.1 源码和对应的中文注释

/**
 * 返回当前线程对应的ThreadLocal的初始值
 * 
 * 此方法的第一次调用发生在当前线程通过get方法访问此线程的ThreadLocal值时
 * 除非线程先调用了set方法，在这种情况下，initialValue方法才不会被这个线程调用。
 * 通常情况下，每个线程最多调用一次这个方法。
 *
 * <p>这个方法仅仅简单的返回null {@code null}; 
 * 如果程序员想ThreadLocal线程局部变量有一个除了null以外的初始值
 * 必须通过子类继承{@code ThreadLocal} 的方法去重写此方法
 * 通常可以通过匿名内部类的方式实现
 *
 * @return 当前ThreadLocal的初始值
 */
protected T initialValue() {
    return null;
}

此方法的作用是：返回该线程局部变量的初始值。

这个方法其实是一个延迟调用方法，从上面的代码可知，在set方法还未调用而先调用了get方法时才执行，并且仅执行了一次。
这个方法缺省实现，直接返回一个null。
如果想要一个除null之外的初始值，可以继承ThreadLocal类，重写此方法（注意：该方法是一个protected的方法，显然是为了让子类覆盖而设计的）

5. ThreadLocalMap源码分析

在分析ThreadLocal方法的时候，我们了解到ThreadLocal的操作实际上是围绕ThreadLocalMap展开的。ThreadLocalMap的源码相对比较复杂，我们将从以下三个方面进行讨论。

5.1 基本结构

ThreadLocalMap是ThreadLocal的内部类，没有实现Map接口，用独立的方式实现了Map的功能，其内部的Entry也是独立的实现。

5.1.1 成员变量

 /**
  * The initial capacity -- MUST be a power of two.
  *
  * 初始容量 -- 必须是2的整次幂
  */
 private static final int INITIAL_CAPACITY = 16;

 /**
  * The table, resized as necessary.
  * table.length MUST always be a power of two.
  *
  * 存放数据的table，Entry类的定义在下面分析
  * 同样数组的长度必须是2的整次幂
  */
 private Entry[] table;

 /**
  * The number of entries in the table.
  *
  * 数组里面entrys的个数，可以用于判断table当前使用量是否超过阈值
  */
 private int size = 0;

 /**
  * The next size value at which to resize.
  *
  * 进行扩容的阈值，表使用量大于它的时候进行扩容
  */
 private int threshold; // Default to 0

跟HashMap类似，INITIAL_CAPACITY代表这个Map的初始容量；table是一个Entry类型的数组，用于存储数据；size代表表中的存储数目；threshold代表需要扩容时对应size的阈值。

5.1.2 存储结构 - Entry

/**
 * Entry继承WeakReference，并且ThreadLocal作为key，
 * 如果key为null(entry.get() == null)，意味着key不再被引用，
 * 所以这时候entry也可以从table中清除。
 */
static class Entry extends WeakReference<ThreadLocal<?>> {
    /** The value associated with this ThreadLocal. */
    Object value;

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

在ThreadLocalMap中，也是用Entry来保存K-V结构数据的。不过Entry中的key只能是ThreadLocal对象，这点在构造方法中已经被限定死了。

另外，Entry继承WeakReference，也就是key（ThreadLocal）是弱引用，其目的是将ThreadLocal对象的生命周期和线程生命周期解绑。

5.2 内存泄漏

有些程序员在使用ThreadLocal的过程中会发现有内存泄露的情况发生，就猜测这个内存泄漏跟Entry中使用了弱引用的key有关系。这个理解其实是不对的。

我们先来回顾这个问题中涉及的几个名词概念，再来分析问题

5.2.1 内存泄漏相关概念

Memory overflow：内存溢出，没有足够的内存提供申请者使用。
Memory leak：内存泄漏，指程序员中已动态分配的堆内存由于某种原因，程序未释放或无法释放，造成系统内存的浪费，导致程序运行速度减慢甚至系统崩溃等严重后果。内存泄漏的堆积中将导致内存溢出。

5.2.2 弱引用相关概念

Java中的引用有4种类型：强引用¹，软引用²，弱引用³，虚引用⁴。当前这个问题主要涉及到强引用和弱引用

**强引用（StrongReference）：**就是我们最常见的普通对象引用，只要还有强引用指向一个对象，就能表明对象还“活着”，垃圾回收器就不会回收这个对象。

**弱引用（WeakReference）：**垃圾回收器一旦发现只具有弱引用的对象，不管当前内存空间是否足够，都会回收它的内存。

5.2.3 如果key使用强引用

假设ThreadLocalMap中的key使用了强引用，那么还会出现内存泄漏吗？

此时ThreadLocal的内存图（实线表示强引用）如下：

假设在业务代码中使用完ThreadLocal，ThreadLocal Ref被回收了
但是因为ThreadLocalMap的Entry强引用了ThreadLocal，造成ThreadLocal无法被回收
在没有手动删除这个Entry以及CurrentThread依然运行的前提下，始终有强引用链threadRef->currentThread->threadLocalMap->entry，Entry就不会被回收（Entry中包括了ThreadLocal实例中的Value），导致Entry内存泄漏

也就是说，ThreadLocalMap中的key使用了强引用，是无法避免内存泄漏的。

5.2.4 如果key使用弱引用

那么ThreadLocalMap中的key使用了弱引用，会出现内存泄漏吗？

同样假设在业务代码中使用完ThreadLocal，ThreadLocal Ref被回收了。
由于ThreadLocalMap只持有ThreadLocal的弱引用，没有任何强引用指向ThreadLocal实例，所以ThreadLocal就可以顺利被gc回收，此时Entry中的key=null。
但是在没有手动删除这个Entry以及CurrentThread依然运行的前提下，也存在有强引用链threadRef->currentThread->threadLocalMap->entry->value，value不会被回收，而这块value永远不会被访问到了，导致value内存泄漏。

也就是说，threadLocalMap中的key使用了弱引用，也有可能内存泄漏。

5.2.5 出现内存泄漏的真实原因

比较以上两种情况，我们就会发现，内存泄漏的发生跟ThreadLocalMap中的key是否使用弱引用是没有关系的。

那么内存泄漏的真实原因是什么呢？

在以上两种内存泄漏的情况中，都有两个前提：

没有手动删除这个Entry
CurrentThread依然运行

第一点很好理解，只要在使用完ThreadLocal，调用其remove方法删除对应的Entry，就能避免内存泄漏

第二点稍微复杂一些，由于ThreadLocalMap是Thread的一个属性，被当前线程所引用，所以它的生命周期跟Thread一样长。那么在使用完ThreadLocal的时候，如果当前Thread也随之执行结束，ThreadLocalMap自然也对被gc回收，从根源上避免了内存泄漏。

综上，ThreadLocal内存泄漏的根源是：由于ThreadLocalMap的生命周期跟Thread一样长，如果没有手动删除对应key就会导致内存泄漏。

5.2.6 为什么使用弱引用

根据刚才的分析，我们知道了：无论使用ThreadLocalMap中的key使用哪种类型引用都无法完全避免内存泄漏，跟使用弱引用没有关系。

要避免内存泄漏有两种方式：

使用完ThreadLocal，调用其remove方法删除对应的Entry
使用完ThreadLocal，当前Thread也随之运行结束

相对于第一种方式，第二种方式显然更不好控制，特别是使用线程池的时候，线程结束是不会销毁的。

也就是说，只要记得在使用完ThreadLocal后，及时调用remove方法，无论key是强引用还是弱引用都不会有问题。

那么为什么key要使用弱引用呢？

事实上，在ThreadLocalMap中的set/getEntry方法中，会对key为null（也即是ThreadLocal为null）进行判断，如果为null的话，那么是会对value置为null的。这就意味着使用完ThreadLocal，CurrentThread依然运行的前提下，就算忘记调用remove方法，**弱引用比强引用可以多一层保障：**弱引用的ThreadLocal会被回收，对应的value在下一次ThreadLocalMap调用set,get,remove中的任一方法的时候会被清除，从而避免内存泄漏。

5.3 hash冲突的解决

hash冲突的解决是Map中一个重要的内容。我们以hash冲突的解决为线索，来研究一下ThreadLocalMap的核心源码。

5.3.1 首先从ThreadLocal的set()方法入手

public void set(T value) {
    Thread t = Thread.currentThread();
    ThreadLocalMap map = getMap(t);
    if (map != null)
        // 调用了ThreadLocalMap的set方法
        map.set(this, value);
    else
        createMap(t, value);
}

void createMap(Thread t, T firstValue) {
    // 调用了ThreadLocalMap的构造方法
    t.threadLocals = new ThreadLocalMap(this, firstValue);
}

这个方法我们上面分析过，其作用是设置当前线程的局部变量：

首先获取当前线程，并根据当前线程获取一个Map
如果获取的Map不为空，则将参数设置到Map中（当前ThreadLocal的引用作为key）

这里调用了ThreadLocalMap的set方法
如果Map为空，则给该线程创建Map，并设置初始值

这里调用了ThreadLocalMap的构造方法

这段代码有两个地方分别涉及到ThreadLocalMap的两个方法，我们接着分析这两个方法。

5.3.2 ThreadLocalMap的构造方法`ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue)`

/**
 * Construct a new map initially containing (firstKey, firstValue).
 * ThreadLocalMaps are constructed lazily, so we only create
 * one when we have at least one entry to put in it.
 *
 * firstKey:本地ThreadLocal实例（this）
 * firstValue:要保存的线程本地变量
 */
ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
    // 初始化table
    table = new Entry[INITIAL_CAPACITY];
    // 计算索引（重点代码）
    int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
    // 设置值
    table[i] = new Entry(firstKey, firstValue);
    // 初始化Entry的个数
    size = 1;
    // 设置阈值(初始容量的三分之二)
    setThreshold(INITIAL_CAPACITY);
}

构造函数首先创建一个长度为16的Entry数组，然后计算出firstKey对应的索引，然后存储到table中，并设置size和setThreshold

重点分析：int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);

5.3.2.1 关于`firstKey.threadLocalHashCode`

private final int threadLocalHashCode = nextHashCode();

private static int nextHashCode() {
    return nextHashCode.getAndAdd(HASH_INCREMENT);
}

/**
 * The next hash code to be given out. Updated atomically. Starts at zero.
 * 
 * AtomicInteger是一个提供原子操作的Integer类，通过线程安全的方式操作加减，适合在高并发情况下使用
 */
private static AtomicInteger nextHashCode = new AtomicInteger();

/**
 * 特殊的hash值
 */
private static final int HASH_INCREMENT = 0x61c88647;

这里定义了一个AtomicInteger类型，每次获取当前值并加上HASH_INCREMENT，HASH_INCREMENT = 0x61c88647，这个值跟斐波那契数列（黄金分割数）有关，其主要目的就是为了让哈希码能均匀的分布在2的n次方的数组里，也就是Entry[] table中（源码说过，table的长度必须是2的n次方），这样做可以尽量避免hash冲突。

5.3.2.2 关于`& (INITIAL_CAPACITY - 1)`

计算hash的时候里面采用了hashCode & (size - 1)的算法，这相当于取模运算hashCode % size的一个更高效的实现。正是因为这种算法，我们要求size必须是2的整次幂，这也能保证在索引不越界的前提下，使得hash发生冲突的次数减小。

5.3.3 ThreadLocalMap的set方法

/**
 * Set the value associated with key.
 *
 * @param key the thread local object
 * @param value the value to be set
 */
private void set(ThreadLocal<?> key, Object value) {

    // We don't use a fast path as with get() because it is at
    // least as common to use set() to create new entries as
    // it is to replace existing ones, in which case, a fast
    // path would fail more often than not.

    Entry[] tab = table;
    int len = tab.length;
    // 计算索引（重点代码，上面分析过）
    int i = key.threadLocalHashCode & (len-1);
	
    /*
     使用线性探测法查找元素（重点代码）
    */
    for (Entry e = tab[i];
         e != null;
         e = tab[i = nextIndex(i, len)]) {
        ThreadLocal<?> k = e.get();
		// ThreadLocal 对应的 key 存在，直接覆盖之前的值
        if (k == key) {
            e.value = value;
            return;
        }
		// key为null，但是值不为null，说明之前的ThreadLocal对象已经被回收了，
        // 当前数组中的Entry是一个陈旧的(Stale)元素
        if (k == null) {
            // 用新元素代替旧元素，这个方法进行了不少的垃圾清理动作，防止内存泄漏
            replaceStaleEntry(key, value, i);
            return;
        }
    }

    // ThreadLocal对应的key不存在并且没有找到陈旧的元素，则在空元素的位置创建一个新的Entry。
    tab[i] = new Entry(key, value);
    int sz = ++size;
    /*
     cleanSomeSlots用于清除那些e.get() == null的元素，
     这种数据key关联的对象已经被回收，所以这个Entry(table[index])可以被置为null。
     如果没有清除任何entry，并且当前使用量达到了负载因子所定义（长度的三分之二），
     那么进行rehash(执行一次全表扫描的清理工作)
    */
    if (!cleanSomeSlots(i, sz) && sz >= threshold)
        rehash();
}

/**
 * 获取环形数组的下一个索引
 */
private static int nextIndex(int i, int len) {
    return ((i + 1 < len) ? i + 1 : 0);
}

代码执行流程：

首先还是根据key计算出索引i，然后查找i位置上的Entry
若Entry已经存在并且key等于传入的key，那么这时候直接给这个Entry赋新的value值
若Entry存在但是key为null，则调用replaceStaleEntry来更换这个key为空的Entry
不断循环检测，直到遇到为null的地方，这时候要是还没在循环过程中return，那么就在这个null的位置新建一个Entry，并且插入，同时size增加1.
最后调用cleanSomeSlots，清理key为null的Entry，最后返回是否清理了Entry，接下来再判断sz是否 >= threshold，如果两个条件成立，则会调用rehash执行一次全表的扫描清理。

**重点分析：**ThreadLocalMap使用线性探测法来解决哈希冲突的。

该方法一次探测下一个地址，知道有空的地址后插入，若整个空间都找不到空余的地址，则产生溢出。

举个例子，假设当前table长度为16，也就是说如果计算出来的key的hash值为14，如果table[14]上已经有值，并且其key与当前key不一致，那么就发生了hash冲突，这时候将14 + 1 得到15，取table[15]进行判断，这个时候如果还是冲突会回到0，取table[0]，以此类推，直到可以插入。

按照上面的描述，可以把Entry[] table看成一个环形数组。

强引用是使用最普遍的引用。如果一个对象具有强引用，那垃圾回收器绝不会回收它。当内存空间不足，Java虚拟机宁愿抛出OutOfMemoryError错误，使程序异常终止，也不会靠随意回收具有强引用的对象来解决内存不足的问题。 ↩︎
如果一个对象只具有软引用，则内存空间足够，垃圾回收器就不会回收它；如果内存空间不足了，就会回收这些对象的内存。只要垃圾回收器没有回收它，该对象就可以被程序使用。 ↩︎
弱引用与软引用的区别在于：只具有弱引用的对象拥有更短暂的生命周期。在垃圾回收器线程扫描它所管辖的内存区域的过程中，一旦发现了只具有弱引用的对象，不管当前内存空间足够与否，都会回收它的内存。不过，由于垃圾回收器是一个优先级很低的线程，因此不一定会很快发现那些只具有弱引用的对象。 ↩︎
“虚引用”顾名思义，就是形同虚设，与其他几种引用都不同，虚引用并不会决定对象的生命周期。如果一个对象仅持有虚引用，那么它就和没有任何引用一样，在任何时候都可能被垃圾回收器回收。 ↩︎