细说ThreadLocal(一)

前言

java虚拟机在执行Java程序的过程中会把它所管理的内存划分为若干个不同的数据区域。如下图所示:

其中堆是占虚拟机中内存最大的，堆被所有线程所共享，其最主要的便是存放实例对象。也因为堆内存是共享的，因此在多线程操作的条件下，多线程中堆内存中的数据十分容易发生线程安全的问题。因此为了保证多个线程对变量的安全访问，我们可以将变量放到ThreadLocal对象中，变量在每个线程中都有独立值，线程只能操作自己的变量，访问不到其他线程中的变量。

ThreadLocal

ThreadLocal顾名思义便是线程本地变量的意思,在JAVA程序中每new一个ThreadLocal对象实例时，每个线程就会有一个隶属于自己的变量，一个专属于线程的变量，也因此该变量不会被其他的线程访问到，以此来规避了线程安全的问题。

那么ThreadLocal如何使得每个线程拥有自己独有的本地值呢?

在JDK8的版本中，每一个线程都有一个属于自己的ThreadLocalMap,ThreadLocalMap随着Thread的创建而存在，随着Thread的实例销毁而销毁。

        //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即是保存本地变量的关键之一，它首先以ThreadLocal实例和变量值作为Entry对象的构造参数来构造Entry对象,后以ThreadLocal实例进行散列计算hash,在散列函数计算后,每个ThreadLocal会均匀地、独立地被分布在Entry数组中,也就是会得到自己在Entry数组中的索引值,然后用此索引将构造出来的Entry对象放入到Entry数组中。也由于每个线程都有自己的ThreadLocalMap，因此变量值是存放在专属于自己线程的ThreadLocalMap中，这个ThreadLocalMap其他线程获取不到，所以每个线程都有专属于自己的变量值，在操作的时候也是对自己专属的变量值进行操作。

从上图我们也可以知道ThreadLocalMap其实是由ThreadLocal来进行管理的，两者的关系密不可分。

我们在平时的操作中，大多是操作ThreadLocal的get(),set()方法，似乎ThreadLocalMap接触的较少，但在接下来深入ThreadLocal的时候，我们会发现ThreadLocal这个类其实是基于ThreadLocalMap来完成的。

ThreadLocal的get方法

    /**
     * Returns the value in the current thread's copy of this
     * thread-local variable.  If the variable has no value for the
     * current thread, it is first initialized to the value returned
     * by an invocation of the {@link #initialValue} method.
     *
     * @return the current thread's value of this thread-local
     */
    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();
    }

上面的代码块展示的是ThreadLocal中get方法的源码,通过源码我们可以了解到get方法有以下步骤:

1. 首先它会获取当前占有CPU时间片的线程的实例，然后通过当前线程的实例调用getMap()方法来获取当前线程的ThreadLocalMap。

 //getMap()方法
 ThreadLocalMap getMap(Thread t) {
        return t.threadLocals;
    }

1. 如果ThreadLocalMap不为空的话,就以自身ThreadLocal实例作为参数调用ThreadLocalMap的getEntry()方法来获取到Entry对象，如果Entry对象不为空,则获取Entry的value属性值返回。
2. 如果map为空的话或者此ThreadLocal实例计算出的hash值最为Entry数组的索引在Entry数组中并未存在Entry对象，证明当前线程并未初始化ThreadLocalMap,调用setInitialValue方法后返回。

ThreadLocal的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);
        }
        if (this instanceof TerminatingThreadLocal) {
            TerminatingThreadLocal.register((TerminatingThreadLocal<?>) this);
        }
        return value;
    }

我们来探寻get()方法中调用的setInitialValue方法,在以下代码中我们可以知道:

1. 首先一上来就会调用一个钩子函数initialValue()来给value变量赋值,但是我们进入initialValue()方法却发现这个方法的返回值是null,如果需要继承ThreadLocal来重写这个方法就太麻烦,JDK已经为大家定义了ThreadLocal的内部SuppliedThreadLocal静态子类，并且提供了ThreadLocal.withInitial()静态工厂方法，我们只需要在定义一个ThreadLocal类型变量时，使用这个方法。

initialValue钩子函数只会调用一次，且只在不使用ThreadLocal.set()方法去设置值就使用ThreadLocal.get()方法去获取值的时候，会执行。

      //钩子函数
      protected T initialValue() {
                return null;
          }

      //静态工厂方法
      public static <S> ThreadLocal<S> withInitial(Supplier<? extends S> supplier) {
          return new SuppliedThreadLocal<>(supplier);
      }

1. 与get方法的步骤一致，也是获取当前的线程后，获取当前线程的ThreadLocalMap,如果没有的话则创建为ThreadLocalMap创建一个map,这是因为一开始Thread下面的ThreadLocalMap初始值为空，所以有create这个步骤。在creatMap的方法中，我们可以看到了新建了一个ThreadLocalMap类，并以当前的ThreadLocal实例对象和initialValue产生的值作为构造参数，以此生成Entry对象保存在Entry数组中。

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

1. 最后方法返回。

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

以上是ThreadLocal的set方法的源码,它相对于get方法较简单，也是获取当前线程并获取当前线程的ThreadLocalMap,如果有的话调用ThreadLocalMap的set方法将值设置进去，如果ThreadLocal为空，则使用createMap方法去创建一个ThreadLocalMap。

ThreadLocal的remove方法

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

ThreadLocal的remove方法便更简单了，它仅判断获取到的当前线程的ThreadLocalMap不为空，则调用了ThreadLocalMap的remove方法去删除值。

后续

从以上的ThreadLocal函数，我们可以看到，许多重要的方法都是依靠着ThreadLocalMap及其api去完成对ThreadLocal方法的实现的，不难看出理解ThreadLocalMap其实相较于理解ThreadLocal是比较重要的，而ThreadLocalMap内部对Entry这个子类的实现，更是考虑到了ThreadLocal的内存泄漏，因此使用了WeakReference弱引用去关联ThreadLocal实例，防止强引用导致的内存泄露的问题。

对ThreadLocalMap我会另开一个随笔去写，请多多担待。

结尾

本文参考

[1] 周志明.深入理解Java虚拟机:JVM高级特性与最佳实践.-2版.北京:机械工业出版社,2013.6

[2] 尼恩.Java高并发编程.卷2，多线程、锁、JMM、JUC、高并发设计模式.北京:机械工业出版社,2021,5