详解ThreadLocal

ThreadLocal 是什么

---

ThreadLocal类提供了一种线程本地变量的实现方式。不同于各线程都可以访问的全局变量，ThreadLocal中的变量属于线程私有，只有当前线程才能访问到。

ThreadLocal能做什么

---

案例：为每个线程生成唯一的标识符；第一次调用ThreadId.get()时会返线程Id会被赋值。当第一次调用get方法时会触发initialValue生成初始值。

import java.util.concurrent.atomic.AtomicInteger;
  
   public class ThreadId {
       private static final AtomicInteger nextId = new AtomicInteger(0);
  
       //生成每个线程的ID
       private static final ThreadLocal<Integer> threadId =
           new ThreadLocal<Integer>() {
               @Override protected Integer initialValue() {
                   return nextId.getAndIncrement();
           }
       };
  
       // 返回线程的唯一id;
       public static int get() {
           return threadId.get();
       }
   }

上面的案例可以衍生出其他适用场景，比如登录token信息的传递等等。

ThreadLocal是怎么实现线程本地变量的

---

想必大家看到这，内心中还是存在疑问，为什么ThreadLocal能够实现线程的本地变量？数据是怎么存储的？那么先上图说明其存储结构和实现本地变量的原理，然后再通过关键方法的源码解析去支撑和印证我们的说法。

从图中我们可以看到

• 每个线程持有一个ThreadLocalMap的对象。

• ThreadLocalMap内部有个数组，数组对象是Entry。

• Entry的key是ThreadLocal对象，value是我们设置的具体值。

通过每个线程自己持有一个单独的ThreadLocalMap对象，并向这个对象中设置对应的value值，实现了线程私有的本地变量设置和获取。

接下来我们通过源码来看下本地变量的设置、获取、删除方法。

set(T value)

    public void set(T value) {
        //获取当前线程
        Thread t = Thread.currentThread();
        //获取当前线程的ThreadLocalMap对象
        ThreadLocalMap map = getMap(t);
        if (map != null)
            map.set(this, value);
        else
            createMap(t, value);
    }
    
     ThreadLocalMap getMap(Thread t) {
        return t.threadLocals;
    }
    
    void createMap(Thread t, T firstValue) {
        t.threadLocals = new ThreadLocalMap(this, firstValue);
    }

set方法通过获取当前线程的ThreadLocalMap对象并以ThreadLocal为key，设置的值为value向其设值。ThreadLocalMap大家可以简单的理解成为一个map，由于不是本文重点解释内容，ThreadlocalMap详细的细节，感兴趣的小伙伴可以自行查阅源码。

get()

    public T get() {
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        //获取到ThreadLocalMap对象后取值
        if (map != null) {
            ThreadLocalMap.Entry e = map.getEntry(this);
            if (e != null) {
                @SuppressWarnings("unchecked")
                T result = (T)e.value;
                return result;
            }
        }
        //设置初始值后返回
        return 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;
    }
    //默认初始值生成为null，可以通过重写该方法设置初始值，如上面样例。
    protected T initialValue() {
        return null;
    }

get方法是获取到当前线程的ThreadLocalMap 对象，然后去对应的值。如果获取到的ThreadLocalMap值是null则initialValue() 返回的值设置到ThreadLocalMap中并返回。

remove()

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

获取到当前线程的ThreadLocalMap值，并删除对应的值。

ThreadLocal 使用注意点

---

避免读取到脏数据

现在代码中比较常见的使用到了线程池，线程池中的线程是可重复利用的，假设使用ThreadLocal 设置了value值，如果没有进行remove操作，下次改线程又被取到，通过get方法取到的值是上次设置的value值。

处理方式：使用完后进行remove操作。

避免内存泄漏

使用了线程池后，由于线程一直存在，对应的value值就不能被垃圾回收掉，容易产生内存泄漏问题。

处理方式：使用完后进行remove操作。