浅析ThreadLocal源码

我会带着你远行 2022-05-21 02:53 288阅读 0赞

在Java编程学习过程中，一定会学习如何保证线程安全，提到线程安全，也就不得不提到ThreadLocal了。

ThreadLocal 是线程的局部变量， 是每一个线程所单独持有的，其他线程不能对其进行访问， 通常是类中字段修饰为 private static ，是对该字段初始值的一个拷贝，它们希望将状态与某一个线程（例如，用户 ID 或事务 ID）相关联。

**![70][]**

当使用ThreadLocal维护变量的时候 为每一个使用该变量的线程提供一个独立的变量副本**，即每个线程内部都会有一个该变量，这样同时多个线程访问该变量并不会彼此相互影响，**因此他们使用的都是自己从内存中拷贝过来的变量的副本， 这样就不存在线程安全问题，也不会影响程序的执行性能。但是由于在每个线程中都创建了副本，所以要考虑它对资源的消耗，比如内存的占用会比不使用ThreadLocal要大。

Thread 在内部是通过ThreadLocalMap来维护ThreadLocal变量表， 在Thread类中有一个threadLocals 变量，是ThreadLocalMap类型的，它就是为每一个线程来存储自身的ThreadLocal变量的， ThreadLocalMap是ThreadLocal类的一个内部类，这个Map里面的最小的存储单位是一个Entry， 它**使用ThreadLocal作为key， 变量作为 value**，这是因为在每一个线程里面，可能存在着多个ThreadLocal变量。

初始时，在Thread里面，threadLocals为空，当通过ThreadLocal变量调用get()方法或者set()方法，就会对Thread类中的threadLocals进行初始化，并且以当前ThreadLocal变量为键值，以ThreadLocal要保存的副本变量为value，存到threadLocals。   
然后在当前线程里面，如果要使用副本变量，就可以通过get方法在threadLocals里面查找。

下面我们一起来简单研究一下TheadLocal的源码。（本文基于JDK1.8）

#### 1、get()方法 ####

/**
     * 用来获取ThreadLocal在当前线程中保存的变量副本
     * @return
     */
    public T get() {
        Thread t = Thread.currentThread();
        // 获取当前线程的ThreadLocalMap，ThreadLocalMap在后面简单进行介绍
        ThreadLocalMap map = getMap(t);
        // 若当前线程有TheadLocalMap，则得到当前theadLocal所对应的值。
        // 若当前线程不存在ThreadLocalMap，则调用setInitialValue()方法。
        if (map != null) {
            ThreadLocalMap.Entry e = map.getEntry(this);
            if (e != null) {
                @SuppressWarnings("unchecked")
                T result = (T)e.value;
                return result;
            }
        }
        return setInitialValue();
    }

若当前线程不存在TheadLocalMap则调用setInitialValue方法进行设置，并返回null，下面简单看一下其源码。

protected T initialValue() {
        return null;
    }
    
    private T setInitialValue() {
    	// initialValue()方法直接返回了null
        T value = initialValue();
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        // 若当前线程存在ThreadLocalMap，则进行set操作，否则创建新的Map，并且设置当前线程的值。
        if (map != null)
            map.set(this, value);
        else
            createMap(t, value);
        return value;
    }

#### 2、set()方法 ####

public void set(T value) {
    	// 首先获取当前线程的ThreadLocalMap，保证操作器自己的TheadLocalMap
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        // 若当前线程存在ThreadLocalMap，则进行set操作，否则创建新的Map，并且设置当前线程的值。
        if (map != null)
            map.set(this, value);
        else
            createMap(t, value);
    }

#### 3、remove方法，即将此threadLocal从当前线程所持有的TheadLocalMap中移除，较简单。 ####

#### 4、getMap()方法 ####

/**
     * 返回为指定线程的TheadLocalMap
     * @param t
     * @return
     */
    ThreadLocalMap getMap(Thread t) {
        return t.threadLocals;
    }

#### 5、creatMap()方法 ####

/**
     * 创建新的ThreadLocalMap
     * @param t
     * @param firstValue
     */
    void createMap(Thread t, T firstValue) {
        t.threadLocals = new ThreadLocalMap(this, firstValue);
    }

在ThreadLocal类中并没有TheadLocalMap成员，那么它是持有ThreadLocalMap的呢？

其实TheadLocalMap是Thread类的一个成员，TheadLocal通过Thread来持有当前线程的ThreadLocalMap，从而进一步管理当前线程的局部变量。而ThreadLocalMap是ThreadLocal的内部类，定义了初始化容量INITIAL\_CAPACITY、存放值的Entry数组、Map的大小size以及负载因子threshold。

ThreadLocalMap的键为当前threadLocal，而值为真正存储的Object。下面简单看一下getEntry方法和set方法的源码。

/**
     * 从Map中获取某一个threadLocal所所对应的值。
     * @param key
     * @return
     */
    private Entry getEntry(ThreadLocal<?> key) {
    	// 计算指定threadLocal的位置
        int i = key.threadLocalHashCode & (table.length - 1);
        Entry e = table[i];
        // 获取计算位置的元素，并且比较是否为所指定的threadLocal，否则调用getEntryAfterMiss
        if (e != null && e.get() == key)
            return e;
        else
            return getEntryAfterMiss(key, i, e);
    }
    /**
     * 设置某一个threadLocal对应的值Object
     * @param key
     * @param value
     */
    private void set(ThreadLocal<?> key, Object value) {
        Entry[] tab = table;
        int len = tab.length;
        int i = key.threadLocalHashCode & (len-1);
    
        // 获取计算位置的元素entry
        for (Entry e = tab[i];
             e != null;
             e = tab[i = nextIndex(i, len)]) {
            ThreadLocal<?> k = e.get();
    
            // 若循环的当前位置就是所执行的threadLocal的key，则将value值进行替换
            if (k == key) {
                e.value = value;
                return;
            }
    
            if (k == null) {
                replaceStaleEntry(key, value, i);
                return;
            }
        }
        
        // 若没有找到相同的threadLocal，则生成新的entry，并且自增size
        tab[i] = new Entry(key, value);
        int sz = ++size;
        if (!cleanSomeSlots(i, sz) && sz >= threshold)
            rehash();
    }

在需resize()扩容时，其所进行的操作同hashMap所做的操作大体相同，这里不咋赘述，如有需要可以去博主的HashMap源码解析中去看看。

#### 6、Entry ####

Entry作为存储数据的数据结构，是ThreadLocalMap的一个内部类，其内部只有一个成员，即Object类型的成员，用来存放各类值信息。具体如下所示：

static class Entry extends WeakReference<ThreadLocal<?>> {
        /** The value associated with this ThreadLocal. */
        Object value;
    
        Entry(ThreadLocal<?> k, Object v) {
            super(k);
            value = v;
        }
    }

[70]: /images/20220521/8e4212a3143a47dfab8354cc2c29ca9c.png