threadLocal

ThreadLocal，直译为“线程本地”或“本地线程”，如果你真的这么认为，那就错了！其实，它就是一个容器，用于存放线程的局部变量，我认为应该叫做 ThreadLocalVariable（线程局部变量）才对，真不理解为什么当初 Sun 公司的工程师这样命名。

早在 JDK 1.2 的时代，java.lang.ThreadLocal 就诞生了，它是为了解决多线程并发问题而设计的，只不过设计得有些难用，所以至今没有得到广泛使用。其实它还是挺有用的，不相信的话，我们一起来看看这个例子吧。

一个序列号生成器的程序，可能同时会有多个线程并发访问它，要保证每个线程得到的序列号都是自增的，而不能相互干扰。

先定义一个接口：

public interface Sequence {

 

    int getNumber();

}

每次调用 getNumber() 方法可获取一个序列号，下次再调用时，序列号会自增。

再做一个线程类：

public class ClientThread extends Thread {

 

    private Sequence sequence;

 

    public ClientThread(Sequence sequence) {

        this.sequence = sequence;

    }

 

    @Override

    public void run() {

        for (int i = 0; i < 3; i++) {

            System.out.println(Thread.currentThread().getName() + " => " + sequence.getNumber());

        }

    }

}

在线程中连续输出三次线程名与其对应的序列号。

我们先不用 ThreadLocal，来做一个实现类吧。

public class SequenceA implements Sequence {

 

    private static int number = 0;

 

    public int getNumber() {

        number = number + 1;

        return number;

    }

 

    public static void main(String[] args) {

        Sequence sequence = new SequenceA();

 

        ClientThread thread1 = new ClientThread(sequence);

        ClientThread thread2 = new ClientThread(sequence);

        ClientThread thread3 = new ClientThread(sequence);

 

        thread1.start();

        thread2.start();

        thread3.start();

    }

}

序列号初始值是0，在 main() 方法中模拟了三个线程，运行后结果如下：

Thread-0 => 1
Thread-0 => 2
Thread-0 => 3
Thread-2 => 4
Thread-2 => 5
Thread-2 => 6
Thread-1 => 7
Thread-1 => 8
Thread-1 => 9

由于线程启动顺序是随机的，所以并不是0、1、2这样的顺序，这个好理解。为什么当 Thread-0 输出了1、2、3之后，而 Thread-2 却输出了4、5、6呢？线程之间竟然共享了 static 变量！这就是所谓的“非线程安全”问题了。

那么如何来保证“线程安全”呢？对应于这个案例，就是说不同的线程可拥有自己的 static 变量，如何实现呢？下面看看另外一个实现吧。

public class SequenceB implements Sequence {

 

    private static ThreadLocal<Integer> numberContainer = new ThreadLocal<Integer>() {

        @Override

        protected Integer initialValue() {

            return 0;

        }

    };

 

    public int getNumber() {

        numberContainer.set(numberContainer.get() + 1);

        return numberContainer.get();

    }

 

    public static void main(String[] args) {

        Sequence sequence = new SequenceB();

 

        ClientThread thread1 = new ClientThread(sequence);

        ClientThread thread2 = new ClientThread(sequence);

        ClientThread thread3 = new ClientThread(sequence);

 

        thread1.start();

        thread2.start();

        thread3.start();

    }

}

通过 ThreadLocal 封装了一个 Integer 类型的 numberContainer 静态成员变量，并且初始值是0。再看 getNumber() 方法，首先从 numberContainer 中 get 出当前的值，加1，随后 set 到 numberContainer 中，最后将 numberContainer 中 get 出当前的值并返回。

是不是很恶心？但是很强大！确实稍微饶了一下，我们不妨把 ThreadLocal 看成是一个容器，这样理解就简单了。所以，这里故意用 Container 这个单词作为后缀来命名 ThreadLocal 变量。

运行结果如何呢？看看吧。

Thread-0 => 1
Thread-0 => 2
Thread-0 => 3
Thread-2 => 1
Thread-2 => 2
Thread-2 => 3
Thread-1 => 1
Thread-1 => 2
Thread-1 => 3

每个线程相互独立了，同样是 static 变量，对于不同的线程而言，它没有被共享，而是每个线程各一份，这样也就保证了线程安全。 也就是说，TheadLocal 为每一个线程提供了一个独立的副本！

搞清楚 ThreadLocal 的原理之后，有必要总结一下 ThreadLocal 的 API，其实很简单。

1. public void set(T value)：将值放入线程局部变量中
2. public T get()：从线程局部变量中获取值
3. public void remove()：从线程局部变量中移除值（有助于 JVM 垃圾回收）
4. protected T initialValue()：返回线程局部变量中的初始值（默认为 null）

为什么 initialValue() 方法是 protected 的呢？就是为了提醒程序员们，这个方法是要你们来实现的，请给这个线程局部变量一个初始值吧。

了解了原理与这些 API，其实想想 ThreadLocal 里面不就是封装了一个 Map 吗？自己都可以写一个 ThreadLocal 了，尝试一下吧。

public class MyThreadLocal<T> {

 

    private Map<Thread, T> container = Collections.synchronizedMap(new HashMap<Thread, T>());

 

    public void set(T value) {

        container.put(Thread.currentThread(), value);

    }

 

    public T get() {

        Thread thread = Thread.currentThread();

        T value = container.get(thread);

        if (value == null && !container.containsKey(thread)) {

            value = initialValue();

            container.put(thread, value);

        }

        return value;

    }

 

    public void remove() {

        container.remove(Thread.currentThread());

    }

 

    protected T initialValue() {

        return null;

    }

}

以上完全山寨了一个 ThreadLocal，其中中定义了一个同步 Map（为什么要这样？请读者自行思考），代码应该非常容易读懂。

下面用这 MyThreadLocal 再来实现一把看看。

public class SequenceC implements Sequence {

 

    private static MyThreadLocal<Integer> numberContainer = new MyThreadLocal<Integer>() {

        @Override

        protected Integer initialValue() {

            return 0;

        }

    };

 

    public int getNumber() {

        numberContainer.set(numberContainer.get() + 1);

        return numberContainer.get();

    }

 

    public static void main(String[] args) {

        Sequence sequence = new SequenceC();

 

        ClientThread thread1 = new ClientThread(sequence);

        ClientThread thread2 = new ClientThread(sequence);

        ClientThread thread3 = new ClientThread(sequence);

 

        thread1.start();

        thread2.start();

        thread3.start();

    }

}

 

 

每个线程的变量副本是存储在哪里的？

2、变量副本是怎么从共享的那个变量赋值出来的？源码中的threadlocal的初始值是什么时机设置的？

=====================================

最关键的问题是：ThreadLocal是怎么实现了多个线程之间每个线程一个变量副本的？它是如何实现共享变量的。

ThreadLocal提供了set和get访问器用来访问与当前线程相关联的线程局部变量。

可以从ThreadLocal的get函数中看出来，其中getmap函数是用t作为参数，这里t就是当前执行的线程。

从而得知，get函数就是从当前线程的threadlocalmap中取出当前线程对应的变量的副本【注意，变量是保存在线程中的，而不是保存在ThreadLocal变量中】。当前线程中，有一个变量引用名字是threadLocals，这个引用是在ThreadLocal类中createmap函数内初始化的。每个线程都有一个这样的threadLocals引用的ThreadLocalMap，以ThreadLocal和ThreadLocal对象声明的变量类型作为参数。这样，我们所使用的ThreadLocal变量的实际数据，通过get函数取值的时候，就是通过取出Thread中threadLocals引用的map，然后从这个map中根据当前threadLocal作为参数，取出数据。现在，变量的副本从哪里取出来的（本文章提出的第一个问题）已经确认解决了。

【ThreadLocal整体上给我的感觉就是，一个包装类。声明了这个类的对象之后，每个线程的数据其实还是在自己线程内部通过threadLocals引用到的自己的数据。只是通过ThreadLocal访问这个数据而已】

=================================

那么还剩下第二个问题。变量副本是什么时候“复制”到threadlocal中的呢？这里“复制”两个字用的很不专业。准确的说，应该是，变量副本【每个线程中保存的那个map中的变量】是怎么声明和初始化的？

看下面set函数的源码：

当线程中的threadlocalmap是null的时候，会调用createmap创建一个map。同时根据函数参数设置上初始值。也就是说，当前线程的threadlocalmap是在第一次调用set的时候创建map并且设置上相应的值的。

对于这篇文章中的例子，每个线程打印的东西都是相互独立的，是因为SequenceNumber的getNextNum()函数中先set了一个值，再get。写到这里，终于清楚了ThreadLocal的运作方法了。

解释如下：

1、在代码中声明的ThreadLocal对象，实际上只有一个。

2、在每个线程中，都维护了一个threadlocals对象，在没有ThreadLocal变量的时候是null的。一旦在ThreadLocal的createMap函数中初始化之后，这个threadlocals就初始化了。以后每次那个ThreadLocal对象想要访问变量的时候，比如set函数和get函数，都是先通过getMap(t)函数，先将线程的map取出，然后再从这个在线程（Thread）中维护的map中取出数据【以当前threadlocal作为参数】。

到此，第二个问题也解决了。

从这个函数中可以看出来，Thread中的threadlocals变量是在ThreadLocal对象中调用createMap函数来初始化的。其实在Thread的代码中可以搜搜看，是没有threadlocals这个变量的很多应用场景的。主要就是用在ThreadLocal中用来set和get函数中。

———————————————————-

那么上面的问题解决之后，又来了一个问题。不同的线程局部变量，比如说声明了n个(n>=2)这样的线程局部变量threadlocal，那么在Thread中的threadlocals中是怎么存储的呢？threadlocalmap中是怎么操作的？

在ThreadLocal的set函数中，可以看到，其中的map.set(this, value);把当前的threadlocal传入到map中作为键，也就是说，在不同的线程的threadlocals变量中，都会有一个以你所声明的那个线程局部变量threadlocal作为键的key-value。假设说声明了N个这样的线程局部变量变量，那么在线程的ThreadLocalMap中就会有n个分别以你的线程局部变量作为key的键值对。