转载

浅谈ThreadLocal（线程本地变量）

ThreadLocal作为JDK1.2以来的一个java.lang包下的一个类，在面试和工程中都非常重要，这个类的主要目的是 提供线程本地的变量 ，所以也有很多地方把这个类叫做 线程本地变量

从字面理解，这个类为每个线程都创建了一个本地变量，实际上是ThreadLocal为变量在 每个线程中 都创建了一个副本，使得每个线程都可以访问自己内部的 副本变量

通常提到多线程，都会考虑 变量同步 的问题，但是ThreadLocal并不是为了解决多线程共享变量同步的问题，而是为了让每个线程的变量不互相影响，相当于线程之间操纵的都是 变量的副本 ，自然就不用考虑多线程竞争的问题，也自然没有性能损耗

使用方式

先来看常用的这几个方法

public T get() { }
	public void set(T value) { }
	public void remove() { }
	protected T initialValue() { }
复制代码

显而易见，get()方法获取线程拥有的副本值，set()方法进行设值，remove()方法移除，initialValue()进行变量初始化，我们先来看下面这个实例，同时体会一下应用场景

public class Demo {
    public static ThreadLocal<Integer> threadLocal = null;
    
    public static void main(String[] args) {
        threadLocal = new ThreadLocal<Integer>() {
        	/**
        	 * 通过重写该方法来初始化ThreadLocal的值
        	 */
            @Override
            protected Integer initialValue() {
                return 10;
            }
        };

        MyThread t1 = new MyThread(20);
        MyThread t2 = new MyThread(30);

        t1.start();
        // 这里为了描述清晰，省略了try-catch语句块
        t1.join();
        t2.start();
    }
}
复制代码

在上述方法中，我们定义并初始化一个ThreadLocal类为10（通过重写initialValue()方法实现），然后开启了两个线程，同时我们这里让t2线程等待t1线程执行完再执行

MyThread类详细信息如下

class MyThread extends Thread {

    private int val = 0;

    MyThread(int val) {
        this.val = val;
    }

    @Override
    public void run() {
        System.out.println(Thread.currentThread() + "-BEFORE-" + Demo.threadLocal.get());
        Demo.threadLocal.set(val);
        System.out.println(Thread.currentThread() + "-AFTER-" + Demo.threadLocal.get());
    }
}
复制代码

我们通过调用ThreadLocal对象的get()方法来获取当前的值，然后通过set()方法设置一个新值（每个线程我们设置不同的值），然后再通过get()方法来获取设置后的值

运行结果如下

重点是图中标注的t2线程变量的初始值，虽然我们在t1线程中修改了变量的值，但是在t2线程中变量值并没有被改变，这样就实现了每个线程独有的变量

同时，如果一个ThreadLocal对象要在很多地方进行复用时，需要在使用前通过调用**remove()**方法来将本地变量恢复到默认值

也许有人会问了，我们给每个线程定义自己的私有变量不是也可以实现同样的操作吗，理论上当然是可行的，但是ThreadLocal远比私有变量的形式方便，不仅可以在 线程外部 进行统一的初始化，而且避免在线程内部额外设置变量

原理

点进ThreadLocal的源码中，发现并没有存储变量的字段值，那看来ThreadLocal并不负责保存变量，我们只能从方法下手

先看initial()方法，毕竟我们的变量默认初始值就是在这个方法中设置，如下

protected T initialValue() {
        return null;
    }
复制代码

我们在每次创建ThreadLocal都要重写这个方法，那么这个方法到底在哪调用呢，我们点进get()方法源码中，如下

public T get() {
    	// 获取当前线程
        Thread t = Thread.currentThread();
        // 获取当前线程的map
        ThreadLocalMap map = getMap(t);
        if (map != null) {
            ThreadLocalMap.Entry e = map.getEntry(this);
            if (e != null) {
                T result = (T)e.value;
                return result;
            }
        }
        // 如果map为空则进行创建
        return setInitialValue();
    }
复制代码

有点眉头了，我们发现这里获取了一个 ThreadLocalMap 对象，所以会想到有可能是通过让 线程与变量 作一个KV表，来实现每个线程拥有自己独有的变量

我们点进getMap(t)方法中，发现返回了线程t的一个 threadLocals 属性，这是Thread类的一个字段：

ThreadLocal.ThreadLocalMap threadLocals = null;
复制代码

这是一个由ThreadLocal类维护的属性，Thread的任何方法都没有对这个字段进行修改操作，而这个ThreadLocalMap本身又是ThreadLocal的一个内部类，可以把它理解成一个Map（虽然这个类没有继承Map接口）

同时要注意，在ThreadLocalMap对象中的Entry对象（键值对），继承了一个ThreadLocaMap的弱引用，如下

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

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

也就是说，当ThreadLocal被置为空时，Entry中的Key则会在下一次YGC中被回收

我们还是没有看到initialValue()方法，别急，点进setInitialValue()方法，也就是如果在get()方法中检测到map为空时调用的方法，如下

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;
    }
复制代码

现在基本操作我们都清楚了，set()方法和initialValue()几乎完全一致，remove()方法则是普通地移除了一个KV键值对（K为当前线程），这里均不再列出，如果感兴趣可以自行查看