ThreadLocal类详解

一. 简介

ThreadLocal是一个本地线程副本变量工具类, 主要是在每个线程中都创建一个副本, 那么每个线程可以访问自己本部的副本变量

下图为ThreadLocal的内部结构图

可以看出ThreadLocal的核心机制 : 

• 每个Thread线程内部都有一个Map
• Map里面存储线程本地对象(key)和线程的副本变量(value)
• Thread内部的Map是由ThreadLocal维护的, 由ThreadLocal负责向map获取和设置线程的变量值

所以对于不同的线程, 每次获取副本值时, 别的线程并不能获取到当前线程的副本值, 形成了副本的隔离, 互不干扰.

Thread线程内部的Map在类中描述是: 

public class Thread implements Runnable{ 
    /* ThreadLocal values pertaining to this thread. This map is maintained by the ThreadLocal class. */
    ThreadLocal.ThreadLocalMap threadLocals = null;

}

二. ThreadLocal的实现

先来看看几个常用的方法

public T get()
public void set(T value)
public void remove()

• get()方法用于获取当前线程的副本变量
• set()方法用于保存当前线程的副本变量值
• remove()方法用于移除当前线程的副本变量值

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

步骤: 

1. 获取当前线程, 然后获取当前线程的ThreadLocalMap

2. 获取到<key, value>键值对, 这里获取键值对传进去的是this, 而不是当前线程t

3. 如果获取成功, 则返回value值

4. 如果map为空, 则调用setInitialValue方法返回初始值, 并保存到新创建的ThreadLocalMap中

set(T value) 方法实现 : 

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

步骤 : 

1. 获取当前线程, 然后获取到当前线程的ThreadLocalMap

2. 如果map不为空, 则将value保存到ThreadLocalMap中, 并用当前ThreadLocalMap作为key

3. 如果为空, 就创建一个ThreadLocalMap并给到当前线程, 然后保存value

remove()方法实现 : 

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

三. ThreadLocalMap

在set, get, remove方法中, 都会获取到当前线程, 然后通过当前线程获取到ThreadLocalMap, 如果ThreadLocalMap为空, 则会创建一个ThreadLocalMap, 并给到当前线程

实际上, ThreadLocalMap就是ThreadLocal的静态内部类, 只是没有实现Map接口, 而是用独立的方式实现了Map的功能, 其内部的Entry也独立实现

在ThreadLocalMap中, 也是用Entry来保存key-value结构数据的, 但是Entry中key只能是ThreadLocal对象, 这点被Entry的构造方法已经限定死了

        static class Entry extends WeakReference<ThreadLocal<?>> {
            /** The value associated with this ThreadLocal. */
            Object value;

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

Entry继承自WeakReference(弱引用 -> 生命周期只能存活到下次GC前), 但只有key是弱引用类型的, value并非弱引用

ThreadLocalMap的成员变量 :

    static class ThreadLocalMap {

        /**
         * The initial capacity -- MUST be a power of two.
         */
        private static final int INITIAL_CAPACITY = 16;

        /**
         * The table, resized as necessary.
         * table.length MUST always be a power of two.
         */
        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
   }

ThreadLocalMap的问题

由于ThreadLocalMap的key是弱引用, 而value是强引用, 这就导致了一个问题, ThreadLocal在没有外部对象强引用时, 发生GC时弱引用Key会被回收, 而value不会被回收, 如果创建ThreadLocal的线程一直持续运行, 那么这个Entry对象中的value就有可能一直得不到回收, 就会发生内存泄漏

如何避免内存泄漏

既然key是弱引用, 那么我们要做的事, 就是在调用ThreadLocal的get(), set()方法时完成后再调用remove方法, 将Entry节点和Map的引用关系移除, 这样整个Entry对象在GCRoots分析后就变成不可达了, 下次GC时就可以被回收

如果在使用ThreadLocal的set方法之后, 没有显示的调用remove方法, 就有可能发生内存泄漏, 所以在使用完ThreadLocal后, 要调用remove方法

总结:

• 每个ThreadLocal只能保存一个变量副本, 如果想要一个线程能够保存多个副本以上, 就要创建多个ThreadLocal
• ThreadLocal内部的ThreadLocalMap key为弱引用, 会有内存泄漏的风险
• 适用于无状态, 副本变量独立后不影响业务逻辑的高并发场景 ; 如果业务逻辑强, 依赖于副本变量, 则不适合用ThreadLocal解决