Thread、ThreadLocal、ThreadLocalMap

1.ThreadLocal

ThreadLocal中ThreadLocalMap的数据结构和关系?
ThreadLocal的key是弱引用，这是为什么?
ThreadLocal内存泄露问题你知道吗?
ThreadLocal中最后为什么要加remove方法?

1.1 ThreadLocal是什么？

ThreadLocal提供线程局部变量。这些变量与正常的变量不同，因为每一个线程在 访问ThreadLocal实例的时候(通过其get或set方法)都有自己的、独立初始化的变量副本。ThreadLocal实例通常是类中的私有静态字段，使用它的目的是希望将状态(例如，用户ID或事务ID)与线程关联起来。

实现每一个线程都有自己专属的本地变量副本(自己用自己的变量不麻烦别人，不和其他人共享，人人有份，人各一份)，
主要解决了让每个线程绑定自己的值，通过使用get()和set()方法，获取默认值或将其值更改为当前线程所存的副本的值从而避免了线程安全问题，比如我们之前讲解的8锁案例，资源类是使用同一部手机，多个线程抢夺同一部手机使用， 假如人手一份是不是天下太平?

因为每个Thread内有自己的实例副本且该副本只由当前线程自己使用
既然其它Thread不可访问，那就不存在多线程间共享的问题。
统一设置初始值，但是每个线程对这个值的修改都是各自线程互相独立的

如何才能不争抢？
加入synchronized或 者Lock控制资源的访问顺序
人手一份，大家各自安好，没必要抢夺

1.2 ThreadLocal常用API

初始化一个线程局部变量有两种方法，一种是匿名内部类的方式，一种是lambda表达式。推荐使用后者。

public class ThreadLocalTest {

    public static void main(String[] args) {

        ExecutorService executorService = Executors.newFixedThreadPool(1);
        for(int i=0;i<3;i++){
            int j =i;
            executorService.execute(()->{
                System.out.println(j+"-before："+SaleHouse.local.get());
                Integer integer = new Random().nextInt(5);
                SaleHouse.local.set(integer);
                System.out.println(j+"-after："+SaleHouse.local.get());
            });
        }
        try {
            Thread.sleep(20);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        executorService.shutdown();
        System.out.println("==============================================");
        for(int i=0;i<3;i++){
            int j =i;
            new Thread(()->{
                try {
                    Integer integer = new Random().nextInt(5);
                    SaleHouse.threadLocal.set(integer);
                    SaleHouse.add(integer);
                    System.out.println(j+"号："+SaleHouse.threadLocal.get());
                }finally {
                    SaleHouse.threadLocal.remove();
                }

            }).start();
        }
        try {
            Thread.sleep(20);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        System.out.println("总计："+SaleHouse.total);
    }

    static class SaleHouse{
        static ThreadLocal<Integer> local = new ThreadLocal<Integer>(){
            @Override
            protected Integer initialValue(){
                return 0;
            }
        };
        public static final ThreadLocal<Integer> threadLocal =  ThreadLocal.withInitial(()->0);
        static int total;
        public static synchronized void add(Integer i){
            total+=i;
        }
    }
}

阿里java开发规范

必须回收自定义的ThreadLocal变量，尤其在线程池场景下，线程经常会被复用，如果不清理自定义的ThreadLocal变量，可能会影响后续业务逻辑和造成内存泄露等问题。尽量在代理中使用try-finally块进行回收。

ThreadLocal对象使用static修饰，ThreadLocal无法解决共享对象的更新问题。
说明:这个变量是对一个线程内所有操作共享的，所以设置为静态变量，所有此类实例共享此静态变量，也就是说在类第一次被使用时装载，只分配一块存储空间，所有此类的对象(只要是这个线程内定义的)都可以操控这个变量。

2. Thread、ThreadLocal、ThreadLocalMap

2.1 Thread、ThreadLocal、ThreadLocalMap关系

ThreadLocalMap是ThreadLocal的静态内部类，ThreadLocalMap是Thread的成员变量，ThreadLocalMap中键值对键的类型为ThreadLocal<?>。一个Thread中，可以持有多个ThreadLocal。
ThreadLocal是一 个壳子，真正的存储结构是ThreadLocal里有ThreadLocalMap这么个内部类，每个Thread对象维护着一 个ThreadLocalMap的引用.
ThreadLocalMap是ThreadLocal的内部类，用Entry来进行存储。

1. 调用ThreadLocal的set()方法时， 实际上就是往ThreadLocalMap设置值，key是ThreadLocal对象，值Value是传递进来的对象
   2 )调用ThreadL ocal的get()方法时， 实际上就是往ThreadL ocalMap获取值， key是ThreadLocal对象

ThreadLocal本身并不存储值(ThreadLocal是一个壳子)， 它只是自己作为一个key来让线程从ThreadL ocalMap获取value。
正因为这个原理，所以ThreadLocal能够实现“数据隔离”，获取当前线程的局部变量值，不受其他线程影响。

2.2 ThreadLocal源码分析

2.2.1 get()方法

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

首先通过Thread.currentThread()拿到当前线程t，然后获取t的成员变量ThreadLocalMap记为map。
map不为空，则根据this去获取ThreadLocalMap的Entry对象e，this指的是当前调用get()方法的ThreadLocal对象。
e不为空，则获取e的value。
map为空，则返回初始值并设置初始值。此处说明ThreadLocalMap采用的是懒加载模式，用时再去初始化。

setInitialValue()方法

    private T setInitialValue() {
        T value = initialValue();
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        if (map != null)
            map.set(this, value);
        else
            createMap(t, value);
        return value;
    }

首先去获取当前ThreadLocal对象设置的初始值value，若未设置，返回的就是null,就是上文所说的初始化一个线程局部变量有两种方法。
然后通过Thread.currentThread()拿到当前线程t，然后获取t的成员变量ThreadLocalMap记为map。
如果map不为空，初始化map,以当前ThreadLocal对象为key,以初始值为value。
如果map为空，则创建map。

createMap方法

void createMap(Thread t, T firstValue) {
        t.threadLocals = new ThreadLocalMap(this, firstValue);
    }

new了一个ThreadLocalMap，以当前ThreadLocal对象为key,以初始值为value。

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

首先通过Thread.currentThread()拿到当前线程t，然后获取t的成员变量ThreadLocalMap记为map。
如果map不为空，初始化map,以当前ThreadLocal对象为key,以初始值为value。
如果map为空，则创建map。

2.2.3 remove()方法

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

首先通过Thread.currentThread()拿到当前线程t，然后获取t的成员变量ThreadLocalMap记为map。
如果map不为空，删除以当前ThreadLocal对象为key的对象。

2.3 ThreadLocalMap源码分析

2.3.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.
   * 表可根据需要调整大小。表长度必须始终是2的幂。
   */
  private Entry[] table;

  /**
   * The number of entries in the table.
   * 表中的实体数。
   */
  private int size = 0;

  /**
   * The next size value at which to resize.
   * 扩容阈值
   */
  private int threshold; // Default to 0

看到上述变量，有没有感觉很熟悉？
对，它跟HashMap很像，INITIAL_CAPACITY代表这个Map的初始容量，也是16；table 是一个Entry类型的数组，用于存储数据；size 代表数组中的存储的数量； threshold 代表需要扩容时对应 size 的阈值。

ThreadLocalMap底层数据结构
ThreadLocalMap中有一个静态内部类Entry，并且存储数据用的是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;
    }
}

2.3.2 getEntry方法

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在数组中下标i，通过当前线程局部变量的线程局部哈希码与数组长度-1做与运算。
根据下标i获取对象e,如果e不为null且e的key等于当前线程局部变量，则返回e。否则开启线性探测。

根据前面知识，数组长度为2整数次幂，那么数组长度减一有什么玄机呢？
2的整数次幂-1的二进制很特殊，它的低位全是1，高位全是0。

一行代码求二进制

System.out.println(String.format("%32s", Integer.toBinaryString(15)).replace(" ", "0"));

16-1
00000000 00000000 00000000 00001111
32-1
00000000 00000000 00000000 00011111

线程局部哈希码threadLocalHashCode

private final int threadLocalHashCode = nextHashCode();

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

private static AtomicInteger nextHashCode = new AtomicInteger();

private static final int HASH_INCREMENT = 0x61c88647;

根据上述源码可知，这里定义了一个AtomicInteger类型，每次获取当前值并加上HASH_ INCREMENT, HASH _INCREMENT =0x61c88647，这个值和斐波那契散列有关(这是一种乘数散列法，只不过这个乘数比较特殊，是2^32乘以黄金分割比例的值，即是1640531527,16进制表示为0x61c88647，其主要目的就是为了让哈希码能均匀的分布在2的n次方的数组里,也就是Entry[] table中，这样做可以尽量避免hash冲突。

1640531527是一个神奇的数字，该数字的计算方法：

public static void calc(){
   System.out.println("0x61c88647的十进制是：" + 0x61c88647);
   double goldenSectionRatio = 1 - (Math.sqrt(5) - 1) / 2;
   System.out.println("goldenSectionRatio：" + goldenSectionRatio);
   BigDecimal value = new BigDecimal(Math.round(Math.pow(2, 32) * goldenSectionRatio));
   System.out.println("value的值是：" + value);
}

getEntryAfterMiss
当在其直接哈希槽中找不到键时使用的getEntry方法的版本。

private Entry getEntryAfterMiss(ThreadLocal<?> key, int i, Entry e) {
  Entry[] tab = table;
  int len = tab.length;

  while (e != null) {
      ThreadLocal<?> k = e.get();
      if (k == key)
          return e;
      if (k == null)
          expungeStaleEntry(i);
      else
          i = nextIndex(i, len);
      e = tab[i];
  }
  return null;
}

将数组对象赋值给tab,并拿到数组长度len。
开启while循环，当e的key与当前线程对象相等时，返回e。
如果e的key等于null,开启探测式清理，也就是 expungeStaleEntry() 方法
如果e的key不为null,且不等于当前线程对象，说明哈希冲突了，开启线性探测。

private static int nextIndex(int i, int len) {
    return ((i + 1 < len) ? i + 1 : 0);
}

如果i+1小于数组长度就返回i+1,否则返回0，从0开始每次递增1。

expungeStaleEntry()

private int expungeStaleEntry(int staleSlot) {
    Entry[] tab = table;
    int len = tab.length;

    // expunge entry at staleSlot
    tab[staleSlot].value = null;
    tab[staleSlot] = null;
    size--;

    // Rehash until we encounter null
    Entry e;
    int i;
    for (i = nextIndex(staleSlot, len);
         (e = tab[i]) != null;
         i = nextIndex(i, len)) {
        ThreadLocal<?> k = e.get();
        if (k == null) {
            e.value = null;
            tab[i] = null;
            size--;
        } else {
            int h = k.threadLocalHashCode & (len - 1);
            if (h != i) {
                tab[i] = null;

                // Unlike Knuth 6.4 Algorithm R, we must scan until
                // null because multiple entries could have been stale.
                while (tab[h] != null)
                    h = nextIndex(h, len);
                tab[h] = e;
            }
        }
    }
    return i;
}

当前位置的key等于null,value也置为null,entry也置为null,size–
从当前位置的下一个位置 i 开始循环，如果e等于null,退出循环,否则向i的下一个位置继续循环。
如果e的key等于null,value也置为null,entry也置为null,size–。不为null,则计算当前线程局部变量的下标h。如果h与i(当前下标)不相等，说明当时插入的时候发生了哈希冲突。开始rehash，将当前下标的entry清空，从h开始寻找空位，找到空位后插入当前对象。如果恰好h下标为null,那么当前线程局部变量则不会发生哈希冲突，直接插入到h位置。

HashMap与ThreadLocalMap解决哈希冲突的区别：

HashMap使用的是链地址法，当发生哈希冲突的时候，使用链表来存储相同哈希码的数据，满足一定条件，还可以链表红黑树互相转换
ThreadLocalMap使用的是线性探测法，当发生哈希冲突的时候，就往后寻找空位置，直到寻找到空位置插入。

3.ThreadLocal内存泄露问题

3.1 内存泄漏

不再会被使用的对象或者变量占用的内存不能被回收，就是内存泄露。

ThreadLocalMap从字面上就可以看出这是一个保存ThreadLocal对象的map(以ThreadLocal为Key)，不过是经过了两层包装的ThreadLocal对象:
1)第一层包装是使用WeakReference<ThreadLocal<?>>将ThreadLocal对象变成一个弱引用的对象; 2)第二层包装是定义了一个专门的类Entry来扩展WeakReference

3.2 强引用、软引用、弱引用、虚引用分别是什么?

3.2.1 强引用

当内存不足，JVM开始垃圾回收，对于强引用的对象，就算是出现了OOM也不会对该对象进行回收，死都不收。
强引用是我们最常见的普通对象引用，只要还有强引用指向一个对象，就能表明对象还“活着”，垃圾收集器不会碰这种对象。
在Java中最常见的就是强引用，把一个对象赋给一个引用变量，这个引用变量就是一个强引用。
当一个对象被强引用变量引用时，它处于可达状态，它是不可能被垃圾回收机制回收的，
即使该对象以后永远都不会被用到，JVM也不会回收。因此强引用是造成Java内存泄漏的主要原因之一。
对于一个普通的对象，如果没有其他的引用关系，只要超过了引用的作用域或者显式地将相应(强)引用赋值为null,
一般认为就是可以被垃圾收集的了(当然具体回收时机还是要看垃圾收集策略)。

3.2.2软引用

软引用是一种相对强引用弱化了- -些的引用，需要用java .lang.ref.SoftReference类来实现，可以让对象豁免- -些垃圾收集。
对于只有软引用的对象来说，当系统内存充足时，它不会被回收，当系统内存不足时它，会被回收。
软引用通常用在对内存敏感的程序中，比如高速缓存就有用到软引用，内存够用的时候就保留，不够用就回收!

3.2.3弱引用

弱引用需要用java.lang.ref.WeakReference类来实现，它比软引用的生存期更短，
对于只有弱引用的对象来说，只要垃圾回收机制一运行，不管JVM的内存空间是否足够，都会回收该对象占用的内存。

假如有一个应用需要读取大量的本地图片:如果每次读取图片都从硬盘读取则会严重影响性能，如果一次性全部加载到内存中又可能造成内存溢出。此时使用软引用可以解决这个问题。

设计思路是:
用一个HashMap来保存图片的路径和相应图片对象关联的软引用之间的映射关系，在内存不足时，
JVM会自动回收这些缓存图片对象所占用的空间，从而有效地避免了OOM的问题。
Map<String, SoftReference> imageCache = new HashMap<String, SoftReference>();

3.2.4虚引用

虚引用必须和引用队列(ReferenceQueue)联合使用
虚引用需要java.lang.ref.PhantomReference类来实现,顾名思义，就是形同虚设，与其他几种引用都不同，虚引用并不会决定对象的生命周期。如果一个对象仅持有虚引用，那么它就和没有任何引用一样，在任何时候都可能被垃圾回收器回收，它不能单独使用也不能通过它访问对象，虛引用必须和引用队列(ReferenceQueue)联合使用。

PhantomReference的get方法总是返回null
虚引用的主要作用是跟踪对象被垃圾回收的状态。仅仅是提供了一种确保对象被finalize以后，做某些事情的通知机制。
PhantomReference的get方法总是返回null，因此无法访问对应的引用对象。

处理监控通知使用
换句话说，设置虚引用关联对象的唯一目的，就是在这个对象被收集器回收的时候收到一个系统通知或者后续添加进一步的处理，用来实现比finalize机制更灵活的回收操作

3.2.5GCRoots和四大引用小总结

3.3 为什么entry中的ThreadLocal使用弱引用？

此后我们调用get,set或remove方法时，就会尝试删除key为null的entry，可以释放value对象所占用的内存。

当我们为threadLocal变量赋值，实际上就是当前的EntrythreadLocal实例为key，值为value往这个threadLoacalMap中存放。Entry中的key是弱引用，当threadLocal外部强引用被置为nul，t=null,那么系统GC的时候，根据可达性分析，这个threadLocal实例就没有任何一条链路能够引用到它，这个ThreadLocal势必会被回收。这样一来，ThreadLocalMap中就会出现key is nul的Entry，就没有办法访问这些key is null的Enty的value,如果当前线程再迟迟不结束的话，这些key为null的Entry的value就会一直存在一条强引用链:Thread Ref -> Thread -> ThreaLocalMap -> Enty->value永远无法回收，造成内存泄漏。

当然，如果当前thread运行结束，threadLocal，threadLocalMap,Entry没有引用链可达，在垃圾回收的时候都会被系统进行回收。
但在实际使用中我们有时候会用线程池去维护我们的线程，比如在Executors.newFixed ThreadPool()时创建线程的时候.为了复用线程是不会结束的，所以threadLocal内存泄漏就值得我们小心

虽然弱引用，保证了key指向的ThreadLocal对象能被及时回收，但是v指向的value对象是需要ThreadLocalMap调用get、set发现key is null才会去回收整个entry、value，因此弱引用不能100%保证内存不泄露。我们要在不使用某个ThreadLocal对象后，手动调remove方法来删除它。尤其是在线程池中，不仅仅是内存泄露的问题，因为线程池中的线租是重复使用的，意味着这个线程的ThreadLocalMap对象也是重复使用的，如果我们不手动调用remove方法，那么后面的线程就有可能获取到上个线程遗留下来的value值，造成bug。

从前面的set.getEntry,remove方法看出，在threadLocal的生命周期里，针对threadLocal存在的内存泄漏的问题，都会通过expungeStaleEntry，cleanSomeSlots,replaceStaleEntry这三个方法清理掉key为null的脏entry。

4. ThreadLocal总结：

最佳实践：
ThreadLocal.withInitial(() ->初始化值);
建议把ThreadLocal修饰为static
用完记得手动remove

面试总结：
ThreadLocal并不解决线程间共享数据的问题
ThreadLocal适用于变量在线程间隔离且在方法间共享的场景
ThreadLocal通过隐式的在不同线程内创建独立实例副本避免了实例线程安全的问题每个线程持有一个只属于自己的专属Map并维护了ThreadLocal对象与具体实例的映射，该Map由于只被持有它的线程访问，故不存在线程安全以及锁的问题
ThreadLocalMap的Entry对ThreadLocal的引用为弱引用，避免了ThreadLocal对象无法被回收的问题都会通过expungeStaleEntry，cleanSomeSlots,replaceStaleEntry这三个方法回收键为null 的Entry对象的值（即为具体实例）以及Entry对象本身从而防止内存泄漏，属于安全加固的方法
群雄逐鹿起纷争，人各一份天下安
ThreadLocal如何实现线程隔离以及弱引用的问题？
每个Thread中都有一个ThreadLocalMap，ThreadLocalMap的key为ThreadLocal，value为想要传递的值。静态的ThreadLocal只会加载一次，是所有线程共享的，但是每个线程通过私有的ThreadLocalMap实现了线程间的隔离。
Thread对ThreadLocalMap是强引用，方法栈对ThreadLocal是强引用，ThreadLocalMap中对ThreadLocal是弱引用。方法执行结束，方法栈对ThreadLocal的引用就会消失。此时仅剩ThreadLocalMap对ThreadLocal的弱引用，下一次GC后，ThreadLocalMap中当前key为null,只剩value有值，还是存在内存泄漏，只不过相对于key和value都泄漏好一点。然后再调用get,set,remove方法的时候都会对key为null的value值清空。所以在结束引用的一定要调用remove方法，可以清空掉ThreadLocalMap中对应的entry,entry引用置空，对应的key和value也就清空了。但是当value是Map情形时，好像还是有问题。

注：本文是学习B站周阳老师《尚硅谷2022版JUC并发编程》课程所做学习笔记。