ThreadLocal原理

1.简介

在使用多线程场景中，对同一个共享变量进行访问，会容易出现并发问题，造成所得到的结果不正确，通常采取的办法是在访问这个共享变量进行同步操作，一般加锁操作。

但是，众所周知，加锁操作，一定程度上会减低程序性能。假如这个变量并不需要保证在各个线程共享，各个线程都可以独立操作这个变量时，不用在意是否在读取这个变量时候，这个变量已被其他线程修改了值，那么完全可以不用同步操作，这就涉及到我们今天要讲的 ThreadLocal 这个类。

ThreaLocal 是 JKD 包提供，位于 java.lang 包下，它提供线程本地变量，简而言之，就是为每一个线程创建一个变量副本，线程操作是自己本地内存中的值，从而使每个线程都可以对这个变量为所欲为了。典型的应用场景是，数据库打开关闭操作。

2.使用

ThreadLocal 使用也非常简单，下面写一个简单例子：

@Test
public void testThreadLocal() {
    final ThreadLocal local = new ThreadLocal<>();
    Thread threadA = new Thread(new Runnable() {
         @Override
         public void run() {
             local.set("线程A对变量为所欲为");
             System.out.println("线程A：" + local.get());
         }
    });
    Thread threadB = new Thread(new Runnable() {
         @Override
         public void run() {
             local.set("线程B对变量为所欲为");
             System.out.println("线程B：" + local.get());
         }
    });
    threadA.start();
    threadB.start();
}
//输出：
//线程A：线程A对变量为所欲为
//线程B：线程B对变量为所欲为

以上程序可以看出，两个线程都通过 set 对 local 设置值，之后通过 get 读取 local 值，但是都是操作自己本地副本。

3.原理

ThreaLocal 的代码量很少，原理也比较简单，简单来说，内部维护了一个 Map，这个 Map 是 ThreadLocal 一个内部静态类，叫 ThreadLocalMap。因为每一个线程都可以关联多个 ThreadLocal 变量，所以设计成 Map结构。接下来看看各个方法主要实现逻辑：

3.1.void set(T value)

public void set(T value) {
     //1.获取当前线程
     Thread t = Thread.currentThread();
     //2.以当前线程 t 为 key，获取当前 threadLocals 变量
     ThreadLocalMap map = getMap(t);
     //3.如果存在，把 value 设置到 threadLocals 中
     if (map != null)
         map.set(this, value);
     //4.如果不存在，创建当前线程对应的 Map
     else
         createMap(t, value);
}

ThreadLocalMap getMap(Thread t) {
    //获取线程自己的变量 threadLocals
    return t.threadLocals;
}

void createMap(Thread t, T firstValue) {
     //创建当前线程的 threadLocals 变量
     t.threadLocals = new ThreadLocalMap(this, firstValue);
}

3.2.T get(T value)

public T get() {
    //1.获取当前线程
     Thread t = Thread.currentThread();
    //2.以当前线程 t 为 key，获取当前 threadLocals 变量
     ThreadLocalMap map = getMap(t);
    //3.如果不为 null，就返回 key 对应的本地变量的值
     if (map != null) {
         ThreadLocalMap.Entry e = map.getEntry(this);
         if (e != null) {
             @SuppressWarnings("unchecked")
             T result = (T)e.value;
             return result;
         }
     }
    //4.如果为null，就进行初始化
     return setInitialValue();
}

//逻辑和 void set() 差不多
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;
}

protected T initialValue() {
      return null;
}

3.3.void remove()

public void remove() {
     //1.以当前线程 t 为 key，获取当前 threadLocals 变量
     ThreadLocalMap m = getMap(Thread.currentThread());
     //2.如果不为 null，删除本地变量
     if (m != null)
         m.remove(this);
}

4.问题

在使用 ThreadLocal 中，由于每一个线程都持有一个 threadLocals 变量，他是一个HashMap类型，key 为当前线程，value 为变量副本，如果一个线程一直不消亡，会一直持有变量副本，容易造成内存泄露，所以，为了保险起见，在使用完变量副本之后，要调用 remove 方法来删除本地变量副本。