并发之线程封闭与ThreadLocal解析

并发之线程封闭与ThreadLocal解析

什么是线程封闭

实现一个好的并发并非易事，最好的并发代码就是尽量避免并发。而避免并发的最好办法就是线程封闭，那什么是线程封闭呢？

线程封闭（thread confinement） 当前线程的变量不与其他线程共享，只在自己的线程中使用。

线程封闭的实现

1.Ad-hoc线程封闭

就是指维护线程封闭性的职责完全由程序实现来承担。

2.栈封闭

栈封闭是我们编程当中遇到的最多的线程封闭。什么是栈封闭呢？简单的说就是局部变量。多个线程访问一个方法，此方法中的局部变量都会被拷贝一分儿到线程栈中。所以局部变量是不被多个线程所共享的，也就不会出现并发问题。所以能用局部变量就别用全局的变量，全局变量容易引起并发问题。

public static void m(){
    int x = 10;
    x ++;
}

成员变量都是栈封闭的。

注意防止引用逸出。

3.ThreadLocal封闭

使用ThreadLocal是实现线程封闭的最好方法。ThreadLocal内部维护了一个Map，Map的key是每个线程的名称，而Map的值就是我们要封闭的对象。每个线程中的对象都对应着Map中一个值，也就是ThreadLocal利用Map实现了对象的线程封闭。

ThreadLocal代码演示

public class ThreadLocalExample {

    public static void main(String[] args) {
        RequestHolder rh = new RequestHolder();
        ExecutorService executorService = Executors.newCachedThreadPool();
        executorService.execute(()->{
            RequestHolder.setLong(1);
            log.info("线程{}-{}",Thread.currentThread().getId(),RequestHolder.getLong());
            try {
                Thread.sleep(1000);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
            RequestHolder.setLong(RequestHolder.getLong()*10);
            log.info("线程{}-{}",Thread.currentThread().getId(),RequestHolder.getLong());
        });
        executorService.execute(()->{
            RequestHolder.setLong(2);
            log.info("线程{}-{}",Thread.currentThread().getId(),RequestHolder.getLong());
            try {
                Thread.sleep(1000);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
            RequestHolder.setLong(RequestHolder.getLong()+1);
            log.info("线程{}-{}",Thread.currentThread().getId(),RequestHolder.getLong());
        });
        executorService.shutdown();
    }
}

结果：

16:36:50.972 [pool-1-thread-1] INFO threadconfinement.ThreadLocalExample - 线程12-1

16:36:50.972 [pool-1-thread-2] INFO threadconfinement.ThreadLocalExample - 线程13-2

16:36:51.980 [pool-1-thread-2] INFO threadconfinement.ThreadLocalExample - 线程13-3

16:36:51.980 [pool-1-thread-1] INFO threadconfinement.ThreadLocalExample - 线程12-10

可以看出两个线程的数据各自变化并没有相互干扰。

ThreadLocal源码解析

1. 什么是ThreadLocal
   
   上一节我们讲到ThreadLocal可以用来保证线程封闭，也就是说如果定义了一个了一个ThreadLocal,每个线程往这个ThreadLocal中读写是线程隔离的，互相之间不会影响。他提供了一种将可变数据通过每个线程有自己独立副本的线程封闭机制。
2. 实现原理
   
   Thread类有一个ThreadLocal.ThreadLocalMap（静态内部类）的实例变量threadLocals，也就是每个线程拥有一个自己的ThreadLocalMap,ThreadLocalMap有自己的独立实现，他的key是WeakReference<ThreadLocal<?>>,这个key是ThreadLocal本身的一个弱引用,每个线程往某个threadLocal里赋值的时候，都会往自己的ThreadLocalMap里面存值，读也是以某个ThreadLocal为引用在自己的ThreadLocalMap里找对应的key,从而实现了线程封闭。

简单的来说：

每个线程都维护了一个本地变量的ThreadLocalMap然后依据ThreadLocal实例的弱引用作为一个key,存储的值为Value保存该数据。

ThreadLocalMap的API

想要了解ThreadLocal必须先弄明白内部嵌套的ThreadLocalMap类，相信读过HashMap源码的同学都知道HashMap的的存储结构是数组加链表形式，内部的每一个key-Value都是一个Entry。但是这里的Map并不是严格意义上的java.util.Map的子类。而是概念上的Map，也就是拥有Key-Value模式的数据结构。ThreadLocal也拥有一个静态内部类（静态内部类的静态内部类）的Entry,那么我们来看看Entry节点是如何定义的。

1.静态内部类Entry

static class Entry extends WeakReference<ThreadLocal<?>> {
    //实际上线程存储的值
    //value并没有设置为私有可以被外部访问到
    Object value;
    //构造出key实例
    Entry(ThreadLocal<?> k, Object v) {
        //将ThreadLocal<?>用WeakReference包裹
        super(k);
        value = v;
    }
}

这里的Entry-key存储在父类WeakReference-referent中，Entry-value存储在Entry中。

这里为什么要使用弱引用作为key?

如果这里使用的是强引用作为key那么就会造成节点的生命周期和线程绑定，只要线程没有销毁那么节点在GC分析中一直处于可达状态，就不可能被回收，程序本身也无法判断是否需要清理节点。弱引用是java引用中的第三档，如果一个对象没有强引用、软引用链可以达到,那么一般活不过下一次GC.当某个ThreadLocal已经没有强引用可以达，则随着他被垃圾回收，在ThreadLocalMap对象中Entry里面的key==null，Entry就会失效，这为ThreadLocalMap本身的垃圾清理提供了便利。

2.类成员变量和方法

/**
 * 初始容量，必须为2的幂
 */
private static final int INITIAL_CAPACITY = 16;

/**
 * Entry表，大小必须为2的幂
 */
private Entry[] table;

/**
 * 表里entry的个数
 */
private int size = 0;

/**
 * 重新分配表大小的阈值，默认为0
 */
private int threshold;
/**
 * 设置resize阈值以维持最坏2/3的装载因子
 */
private void setThreshold(int len) {
    threshold = len * 2 / 3;
}

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

/**
 * 环形意义的上一个索引
 */
private static int prevIndex(int i, int len) {
    return ((i - 1 >= 0) ? i - 1 : len - 1);
}

实际上这两个方法时将entry数组头尾相接做成了一个环形。

由于ThreadLocalMap使用线性探测法开放寻址来解决散列冲突，而哈希map使用链表方式来解决散列冲突。所以Entry[]数组是作为一个环形存在的。

线性探测法：假设m个位置，通过某种映射首先选择某个最喜欢的位置，然后依次选择下一个位置，到了m-1，再回到初始0号位置，一共有m种不同的喜好顺序。

开放寻址：假设有一个数组里面有多少元素不知道现在要插入值，找到第一个位置如果发现该位置里有元素已经占住，则按照某种算法推断出下一个位置继续去查看该位置是否被占住，如果寻找下来都被占住了，说明该数据长度不够需要扩容。

结合上面两种解释那么该算法相当先到哈希位置找如果被占了就找下一个直到找到空的位置为止，如果超过扩容因子则执行扩容操作。取值则是先通过哈希定位到值然后一个一个对比key往下找。

ThreadLocalMap维护了Entry环形数组，数组中元素Entry的逻辑上的key是指向该ThreadLocal对象的弱引用，value为代码中该线程往该ThreadLoacl变量实际

塞入的值。

3.构造方法

/**
 * 构造一个包含firstKey和firstValue的map。
 * ThreadLocalMap是惰性构造的，所以只有当至少要往里面放一个元素的时候才会构建它。
 */
ThreadLocalMap(java.lang.ThreadLocal<?> firstKey, Object firstValue) {
    // 初始化table数组
    table = new Entry[INITIAL_CAPACITY];
    // 用firstKey的threadLocalHashCode与初始大小16取模得到哈希值
    int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
    // 初始化该节点
    table[i] = new Entry(firstKey, firstValue);
    // 设置节点表大小为1
    size = 1;
    // 设定扩容阈值 为长度了的2/3 初始值大约等于10.5
    setThreshold(INITIAL_CAPACITY);
}

这个构造函数在set和get的时候都可能会被间接调用以初始化线程的ThreadLocalMap。

4.哈希函数

构造函数中有一行

int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);

看着好像是将ThreadLocal实例哈希化然后来判断这个Entry在table中的位置。

/*
 * 生成hash code间隙为这个魔数，可以让生成出来的值或者说ThreadLocal的ID较为均匀地分布在2的幂大小的数组中。
 * 该值为类创建时就已经被固定
 */
private static final int HASH_INCREMENT = 0x61c88647;

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

private static AtomicInteger nextHashCode = new AtomicInteger();

上述代码可以看出它总是在上一个被构造出来的ThreadLocal的ID/threadLocalHashCode的基础上增加一个魔数为0x61c88647。这个魔数与斐波那契散列有关。 0x61c88647对应的十进制是1640531527。斐波那契散列的乘数可以用

(long) ((1L << 31) * (Math.sqrt(5) - 1))

可以得到2654435769，如果把这个值给转为带符号的int，则会得到-1640531527。换句话说

(1L << 32) - (long) ((1L << 31) * (Math.sqrt(5) - 1))

得到的结果就是1640531527也就是0x61c88647。通过理论与实践，当我们用0x61c88647作为魔数累加为每个ThreadLocal分配各自的ID也就是threadLocalHashCode再与2的幂取模，得到的结果分布很均匀。

ThreadLocalMap使用的是线性探测法，均匀分布的好处在于很快就能探测到下一个临近的可用slot，从而保证效率。这就回答了上文抛出的为什么大小要为2的幂的问题。为了优化效率。

对于& (INITIAL_CAPACITY - 1)，相信有过算法竞赛经验或是阅读源码较多的程序员，一看就明白，对于2的幂作为模数取模，可以用&(2^{n-1)来替代%2}n，位运算比取模效率高很多。至于为什么，因为对2^n取模，只要不是低n位对结果的贡献显然都是0，会影响结果的只能是低n位。hashMap源码研究中的put一节有详细说明

好我们写个代码测试下：

int x = 0x61c88647;
System.out.println((0+x) & 15);
System.out.println((0+x+x) & 15);
System.out.println((0+x+x+x) & 15);
System.out.println((0+x+x+x+x) & 15);
System.out.println((0+x+x+x+x+x) & 15);
System.out.println((0+x+x+x+x+x+x) & 15);
System.out.println((0+x+x+x+x+x+x+x) & 15);
System.out.println((0+x+x+x+x+x+x+x+x) & 15);

结果：7 14 5 12 3 10 1 8

基本没有发现键冲突的情况说明该魔数还是非常好用的。

5.getEntry

这个方法会被ThreadLocal的get方法直接调用，用于获取map中某个ThreadLocal存放的值。

private Entry getEntry(ThreadLocal<?> key) {
    // 根据key这个ThreadLocal的ID来获取索引，也即哈希值
    int i = key.threadLocalHashCode & (table.length - 1);
    Entry e = table[i];
    // 对应的entry存在且未失效且弱引用指向的ThreadLocal就是key，则命中返回
    if (e != null && e.get() == key) {
        return e;
    } else {
        // 因为用的是线性探测，所以往后找还是有可能能够找到目标Entry的。
        return getEntryAfterMiss(key, i, e);
    }
}
/*
 * 调用getEntry未直接命中的时候调用此方法，往后线性探测
 */
private Entry getEntryAfterMiss(ThreadLocal<?> key, int i, Entry e) {
    Entry[] tab = table;
    int len = tab.length;

    // 基于线性探测法不断向后探测直到遇到空entry。
    while (e != null) {
        ThreadLocal<?> k = e.get();
        // 找到目标
        // 第一次进来是肯定找不到的
        if (k == key) {
            return e;
        }
        //Entry还在 但是Entry的key被回收了。
        //说明这个元素无效可以占用该元素的位置set值
        if (k == null) {
            // 该entry对应的ThreadLocal已经被回收，调用expungeStaleEntry来清理无效的entry
            expungeStaleEntry(i);
        } else {
            // 环形意义下往后面走
            i = nextIndex(i, len);
        }
        //将e赋值下一个元素
        e = tab[i];
    }
    return null;
}

/**
 * 这个函数是ThreadLocal中核心清理函数，它做的事情很简单：
 * 就是从staleSlot开始遍历，将无效（弱引用指向对象被回收）清理，即对应entry中的value置为null，将指向这个entry的table[i]置为null，直到扫到空entry。
 * 另外，在过程中还会对非空的entry作rehash。
 * 可以说这个函数的作用就是从staleSlot开始清理连续段中的slot（断开强引用，rehash slot等）
 */
private int expungeStaleEntry(int staleSlot) {
    Entry[] tab = table;
    int len = tab.length;
    // 清空了key无效的entry
    // 因为entry对应的ThreadLocal已经被回收，value设为null，显式断开强引用
    tab[staleSlot].value = null;
    // 显式设置该entry为null，以便垃圾回收
    tab[staleSlot] = null;
    size--;

    Entry e;
    int i;
    // 以无效entry为起始往后继续扫荡
    for (i = nextIndex(staleSlot, len); (e = tab[i]) != null; i = nextIndex(i, len)) {
        ThreadLocal<?> k = e.get();
        // 如果再次发现key为null的Entry，继续断开连接，如果这个if发生则该元素中间将有2个空key
        if (k == null) {
            e.value = null;
            tab[i] = null;
            size--;
        } else {
            /*
             * 对于还没有被回收的情况，需要做一次rehash。也就是重新定位下该元素的位置然后再次线性探
             * 测赋值。
             * 如果对应的ThreadLocal的ID对len取模出来的索引h不为当前位置i，
             * 则从h向后线性探测到第一个空的slot，把当前的entry给挪过去。
             */
            int h = k.threadLocalHashCode & (len - 1);
            //如果 h == i 说明该元素的位置就是其哈希值标志的位置 无需替换。
            //如果 h != i 说明该元素为哈希冲突之后线性探测找到的位置。
            if (h != i) {
                //如果找到的位置没有元素存在。直接将值放入
                tab[i] = null;

                /*
                 * 在原代码的这里有句注释值得一提，原注释如下：
                 *
                 * Unlike Knuth 6.4 Algorithm R, we must scan until
                 * null because multiple entries could have been stale.
                 *
                 * 这段话提及了Knuth高德纳的著作TAOCP（《计算机程序设计艺术》）的6.4章节（散列）
                 * 中的R算法。R算法描述了如何从使用线性探测的散列表中删除一个元素。
                 * R算法维护了一个上次删除元素的index，当在非空连续段中扫到某个entry的哈希值取模后的索引
                 * 还没有遍历到时，会将该entry挪到index那个位置，并更新当前位置为新的index，
                 * 继续向后扫描直到遇到空的entry。
                 *
                 * ThreadLocalMap因为使用了弱引用，所以其实每个slot的状态有三种也即
                 * 有效（value未回收），无效（value已回收），空（entry==null）。
                 * 正是因为ThreadLocalMap的entry有三种状态，所以不能完全套高德纳原书的R算法。
                 *
                 * 因为expungeStaleEntry函数在扫描过程中还会对无效slot清理将之转为空slot，
                 * 如果直接套用R算法，可能会出现具有相同哈希值的entry之间断开（中间有空entry）。
                 */
                 // 从该元素的哈希位置往后继续探测直到找到空位置为止。
                while (tab[h] != null) {
                    h = nextIndex(h, len);
                }
                tab[h] = e;
            }
        }
    }
    // 返回staleSlot之后第一个空的slot索引
    return i;
}

expungeStaleEntry方法的逻辑比较绕需要重新解释下。

1. 从staleSlot向后进行遍历，如果发现的Entry为空则停止。
2. 遍历过程中如果Entry的key也就是TreadLocal为空，则将该元素中的value置为null将该元素Entry也置为null.
3. 如果Entry和key都不为null 则给该元素重新定位位置。

为什么要先将value置为null然后在将Entry置为null? 如果只将Entry置为null，回收Entry对象和value对象需要2次GC，而先将value置为null然后在将Entry置为null可以一次GC回收完成，节省了内存

我们来回顾一下从ThreadLocal中的get操作：

1. 如果TreadLocal哈希值位置所在的Entry中的key和ThreadLocal相同直接返回Entry中的对象。
2. 如果不同则开始调用getEntryAfterMiss线性探测，如果遇到了key无效的Entry则调用expungeStaleEntry清理，如果找到了返回entry中的value.
3. 没有找到key，返回null

5.setEntry

private void set(ThreadLocal<?> key, Object value) {

    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();
        // 找到对应的entry
        if (k == key) {
            e.value = value;
            return;
        }
        // 替换失效的entry
        if (k == null) {
            replaceStaleEntry(key, value, i);
            return;
        }
    }

    tab[i] = new Entry(key, value);
    int sz = ++size;
    if (!cleanSomeSlots(i, sz) && sz >= threshold) {
        rehash();
    }
}

private void replaceStaleEntry(ThreadLocal<?> key, Object value, int staleSlot) {
    Entry[] tab = table;
    int len = tab.length;
    Entry e;

    // 向前扫描，查找最前的一个无效slot
    int slotToExpunge = staleSlot;
    for (int i = prevIndex(staleSlot, len);
         (e = tab[i]) != null;
         i = prevIndex(i, len)) {
        if (e.get() == null) {
            slotToExpunge = i;
        }
    }

    // 向后遍历table
    for (int i = nextIndex(staleSlot, len);
         (e = tab[i]) != null;
         i = nextIndex(i, len)) {
        ThreadLocal<?> k = e.get();

        // 找到了key，将其与无效的slot交换
        if (k == key) {
            // 更新对应slot的value值
            e.value = value;

            tab[i] = tab[staleSlot];
            tab[staleSlot] = e;

            /*
             * 如果在整个扫描过程中（包括函数一开始的向前扫描与i之前的向后扫描）
             * 找到了之前的无效slot则以那个位置作为清理的起点，
             * 否则则以当前的i作为清理起点
             */
            if (slotToExpunge == staleSlot) {
                slotToExpunge = i;
            }
            // 从slotToExpunge开始做一次连续段的清理，再做一次启发式清理
            cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
            return;
        }

        // 如果当前的slot已经无效，并且向前扫描过程中没有无效slot，则更新slotToExpunge为当前位置
        if (k == null && slotToExpunge == staleSlot) {
            slotToExpunge = i;
        }
    }

    // 如果key在table中不存在，则在原地放一个即可
    tab[staleSlot].value = null;
    tab[staleSlot] = new Entry(key, value);

    // 在探测过程中如果发现任何无效slot，则做一次清理（连续段清理+启发式清理）
    if (slotToExpunge != staleSlot) {
        cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
    }
}

replaceStaleEntry方法，替换key等于null的元素。

1. 从当前位置往前遍历找到最前面不为null的节点。清理的时候防止断链
   
   有可能是排序是12345位置放置的元素如下排列 哈希1 哈希1 哈希3 哈希1 哈希3

2. 向后探测寻找真正的slot，如果找到了则将该slot与当前元素交换位置位置，并且开始一次连续清理，在进行一次连续段落清理，和一次随机清理。
   
   如12 内容如下哈希1-Entry1 哈希1-Entry2，第一个Entry1的key为null则将当前新的entry放入

/**
 * 随机清理
 */
private boolean cleanSomeSlots(int i, int n) {
    boolean removed = false;
    Entry[] tab = table;
    int len = tab.length;
    do {
        // i在任何情况下自己都不会是一个无效slot，所以从下一个开始判断
        i = nextIndex(i, len);
        Entry e = tab[i];
        if (e != null && e.get() == null) {
            // 扩大扫描控制因子
            n = len;
            removed = true;
            // 清理一个连续段
            i = expungeStaleEntry(i);
        }
    } while ((n >>>= 1) != 0);
    return removed;
}

随机清理,

1. i为当前位置,清理长度为log₂ n (n/2 != 0的次数)。
2. 当发现i位置的元素需要清理时，扩大n到整个table的长度然后以i为起始点进行一次连续段清理，返回的是一个slot为null的位置。
3. 然后找到该null slot的下一个slot看是否需要清理。
4. 如果连续的null slot达到log₂ n个那么终止该次清理过程。

也就是说只有连续遇到log₂ n次的不需要清理的数据该循环才会停止。一旦遇到任意一个需要清理的slot则n的值重置为table长度。

private void rehash() {
    // 做一次全量清理
    expungeStaleEntries();

    /*
     * 因为做了一次清理，所以size很可能会变小。
     * ThreadLocalMap这里的实现是调低阈值来判断是否需要扩容，
     * threshold默认为len*2/3，所以这里的threshold - threshold / 4相当于len/2
     */
    if (size >= threshold - threshold / 4) {
        resize();
    }
}

/*
 * 做一次全量清理
 */
private void expungeStaleEntries() {
    Entry[] tab = table;
    int len = tab.length;
    for (int j = 0; j < len; j++) {
        Entry e = tab[j];
        if (e != null && e.get() == null) {
            /*
             * 个人觉得这里可以取返回值，如果大于j的话取了用，这样也是可行的。
             * 因为expungeStaleEntry执行过程中是把连续段内所有无效slot都清理了一遍了。
             */
            expungeStaleEntry(j);
        }
    }
}

全清理

用for循环遍历每一个slot进行遇到需要清理的slot执行一次段落清理

/**
 * 扩容，因为需要保证table的容量len为2的幂，所以扩容即扩大2倍
 */
private void resize() {
    Entry[] oldTab = table;
    int oldLen = oldTab.length;
    int newLen = oldLen * 2;
    Entry[] newTab = new Entry[newLen];
    int count = 0;
	//将旧元素取出一个一个放入新的table中
    for (int j = 0; j < oldLen; ++j) {
        Entry e = oldTab[j];
        if (e != null) {
            ThreadLocal<?> k = e.get();
            if (k == null) {
                e.value = null;
            } else {
                // 线性探测来存放Entry
                int h = k.threadLocalHashCode & (newLen - 1);
                while (newTab[h] != null) {
                    h = nextIndex(h, newLen);
                }
                newTab[h] = e;
                count++;
            }
        }
    }
    setThreshold(newLen);
    size = count;
    table = newTab;
}

我们来回顾一下ThreadLocal的set实现流程

1. 探测过程中slot都不无效，并且顺利找到key所在的slot，直接替换即可
2. 探测过程中发现有无效slot，调用replaceStaleEntry，效果是最终一定会把key和value放在这个slot，并且会尽可能清理无效slot
3. 在replaceStaleEntry过程中，如果找到了key，则做一个swap把它放到那个无效slot中，value置为新值
4. 在replaceStaleEntry过程中，没有找到key，直接在无效slot原地放entry
5. 探测没有发现key，则在连续段末尾的后一个空位置放上entry，这也是线性探测法的一部分。放完后，做一次随机清理，如果没清理出去key，并且当前table大小已经超过阈值了，则做一次rehash，rehash函数会调用一次全量清理slot方法也即expungeStaleEntries，如果完了之后table大小超过了threshold - threshold / 4，则进行扩容2倍

remove方法

/**
 * 从map中删除ThreadLocal
 */
private void remove(ThreadLocal<?> key) {
    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)]) {
        if (e.get() == key) {
            // 显式断开弱引用
            e.clear();
            // 进行段清理
            expungeStaleEntry(i);
            return;
        }
    }
}

remove方法相对于getEntry和set方法比较简单，直接在table中找key，如果找到了，把弱引用断了做一次段清理。

关于ThreadLocal内存清理的问题

关于ThreadLocal是否会引起内存泄漏也是一个比较有争议性的问题，其实就是要看对内存泄漏的准确定义是什么。

认为ThreadLocal会引起内存泄漏的说法是因为如果一个ThreadLocal对象被回收了，我们往里面放的value对于【当前线程->当前线程的threadLocals(ThreadLocal.ThreadLocalMap对象）->Entry数组->某个entry.value】这样一条强引用链是可达的，因此value不会被回收。

认为ThreadLocal不会引起内存泄漏的说法是因为ThreadLocal.ThreadLocalMap源码实现中自带一套自我清理的机制。比如set get remove方法中都有清理。

然而如果Thread对象或者ThreadLocal对象的生命周期过长，比如static Threadlocal，线程池的线程复用。

在线程复用如线程池的场景中，一个线程的寿命很长，大对象长期不被回收影响系统运行效率与安全。如果线程不会复用，用完即销毁了也不会有ThreadLocal引发内存泄露的问题。《Effective Java》一书中的第6条对这种内存泄露称为unintentional object retention(无意识的对象保留）。

//无意识的对象保留
Object obj1 = new Object();
Object obj2 = obj1;
Object obj3 = obj2;
object1 = null
//虽然obj2 obj3都源自于obj1 这时将obj1置为null并不会引发 GC对obj1对象的回收。

当我们仔细读过ThreadLocalMap的源码，我们可以推断，如果在使用的ThreadLocal的过程中，显式地进行remove是个很好的编码习惯，这样是不会引起内存泄漏。

那么如果没有显式地进行remove呢？只能说如果对应线程之后调用ThreadLocal的get和set方法都有很高的概率会顺便清理掉无效对象，断开value强引用，从而大对象被收集器回收。

但无论如何，我们应该考虑到何时调用ThreadLocal的remove方法。一个比较熟悉的场景就是对于一个请求一个线程的server如tomcat，在代码中对web api作一个切面，存放一些如用户名等用户信息，在连接点方法结束后，再显式调用remove。

InheritableThreadLocal实现

对于InheritableThreadLocal，本文不作过多介绍，只是简单略过。

ThreadLocal本身是线程隔离的，InheritableThreadLocal提供了一种父子线程之间的数据共享机制。

它的具体实现是在Thread类中除了threadLocals外还有一个inheritableThreadLocals对象。

在线程对象初始化的时候，会调用ThreadLocal的createInheritedMap从父线程的inheritableThreadLocals中把有效的entry都拷过来

private ThreadLocalMap(ThreadLocalMap parentMap) {
    Entry[] parentTable = parentMap.table;
    int len = parentTable.length;
    setThreshold(len);
    table = new Entry[len];

    for (int j = 0; j < len; j++) {
        Entry e = parentTable[j];
        if (e != null) {
            @SuppressWarnings("unchecked")
            ThreadLocal<Object> key = (ThreadLocal<Object>) e.get();
            if (key != null) {
                // 这里的childValue方法在InheritableThreadLocal中默认实现为返回本身值，可以被重写
                Object value = key.childValue(e.value);
                Entry c = new Entry(key, value);
                int h = key.threadLocalHashCode & (len - 1);
                while (table[h] != null)
                    h = nextIndex(h, len);
                table[h] = c;
                size++;
            }
        }
    }
}

还是比较简单的，做的事情就是以父线程的inheritableThreadLocalMap为数据源，过滤出有效的entry，初始化到自己的inheritableThreadLocalMap中。其中childValue可以被重写。

需要注意的地方是InheritableThreadLocal只是在子线程创建的时候会去拷一份父线程的inheritableThreadLocals。如果父线程是在子线程创建后再set某个InheritableThreadLocal对象的值，对子线程是不可见的。

ThreadLocal的API

写完了ThreadLocalMap的API其实 Threadlocal的API理解起来就是比较简单的了。

public T get() {
    Thread t = Thread.currentThread();
    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;
        }
    }
    return setInitialValue();
}

public void set(T value) {
    Thread t = Thread.currentThread();
    ThreadLocalMap map = getMap(t);
    if (map != null)
        map.set(this, value);
    else
        createMap(t, value);
}

 public void remove() {
     ThreadLocalMap m = getMap(Thread.currentThread());
     if (m != null)
         m.remove(this);
 }

总结

Thread类有一个类型为ThreadLocal.ThreadLocalMap的实例变量threadLocals，也就是说每个线程有一个自己的ThreadLocalMap。ThreadLocalMap有自己的独立实现，可以简单地将它的key视作ThreadLocal，value为代码中放入的值（实际上key并不是ThreadLocal本身，而是它的一个弱引用）。每个线程在往某个ThreadLocal里塞值的时候，都会往自己的ThreadLocalMap里存，读也是以某个ThreadLocal作为引用，在自己的map里找对应的key，从而实现了线程隔离。

引用

ThreadLocal源码解读