Java并发之ThreadLocal使用和源码分析

本篇文章首先给出了ThreadLocal常用的方法，并举例来说明ThreadLocal的使用。然后分析了ThreadLocal的源代码中的get()方法，初始化方法，ThreadLocalMap的实现等来理解ThreadLocal的原理。

ThreadLocal为每个线程提供一个独立的对象副本，每个线程可以单独访问自己独有的对象，不存在多线程同时访问一个对象时的共享问题。

一.使用ThreadLocal

ThreadLocal是一个泛型类，使用时要指定持有的对象的类型。一般会重写initialValue()方法，来设置线程第一次通过ThreadLocal获取对象时的初始值。

常用方法：

\\1.get()方法 获取对象引用，每个线程获取到的不同
public T get(); 
\\2.set()方法，修改当前线程在ThreadLocal中存储的值
public void set(T value);
\\3.initialValue()方法，设置初始值，默认返回null，一般被重写来设置初始值
protected T initialValue();

具体例子

public class ThreadLocalDemo {
    static ThreadLocal threadLocal = new ThreadLocal(){
        @Override
        protected String initialValue() {
            return Thread.currentThread().getName();
        }
    };

    public static void main(String[] args) throws Exception{
        Thread thread1 = new Thread(new Runnable() {
            public void run() {
                System.out.println(threadLocal.get());
            }
        });

        thread1.start();
        thread1.join();
        System.out.println(threadLocal.get());
    }
}

输出结果：

Thread-0
main

可以看到，主线程和thread1通过threadLocal变量分别持有了各自的String对象。

二.源码分析

get方法的主要流程
我们从get方法入手，看看ThreadLocal的实现 原理，先po上源代码：

public T get() {
    //先获取当前线程
    Thread t = Thread.currentThread();   
    //获取当前线程的ThreadLocalMap
    ThreadLocalMap map = getMap(t);   
    if (map != null) {
        //从ThreadLocalMap中获取到要的值，注意这里使用的是当前的ThreadLocal对象作为key的
        ThreadLocalMap.Entry e = map.getEntry(this);
        if (e != null) {
            @SuppressWarnings("unchecked")
            T result = (T)e.value;
            return result;
        }
    }
    //当前线程的ThreadLocalMap为null，或者map里没有保存和当前ThreadLocal相关的值时
    return setInitialValue();                   
}

从代码中可以总结出TheadLocal.get的流程：

• 先获取到当前的线程t，
• 获取到t中保存的ThreaaLocalMap，如果没有则转到最后一步
• 以当前ThreadLocal作为键值，从上述map中获取到要的变量
• 如果获取到变量为null，则转到最后一步进行初始化
• 初始化thread的map或保存的变量值

查看getMap(t)：从线程中获取ThreadLocalMap的代码发现：Thread类中有一个名为threadLocals的ThreadLocalMap类型的变量，初始值为null，在第一次ThreadLocal.get时初始化。getMap会获取这个变量。

setInitialValue方法分析
下面再分析 一下setInitialValue()

private T setInitialValue() {
    //获取初始值，这里调用的方法常常被重写，来设置初始值。默认返回Null
    T value = initialValue();
    //获取当前线程
    Thread t = Thread.currentThread();
    //先尝试获取map，因为也不知道是因为没有map还是因为map中没有值才进来这个方法的
    ThreadLocalMap map = getMap(t);
    //map存在，放入value值，注意这里的key是当前ThreadLocal对象；和get中的map.getEntry相呼应
    if (map != null)
        map.set(this, value);
    else
        //map不存在，创建map
        createMap(t, value);
    return value;
}

看一下createMap的代码：

void createMap(Thread t, T firstValue) {
    t.threadLocals = new ThreadLocalMap(this, firstValue);
}

直接调用了ThreadLocalMap的构造方法，将其初始化并返回。这个构造方法不再细究了，只要记住，传入的两个参数是用来作为初始化后的第一个键值对存入该map的即可。
总结一下setInitialValue()方法：

• 获取value的初始化值，从initialValue方法，这里就看出initialValue的作用了
• 如果Thread有ThreadLocalMap，则直接使用，存入当前ThreadLocal->value的键值对
• 如果没有map，则创建map，并同时存入键值对
• 返回value

ThreadLocalMap简析

ThreadLocalMap是ThreadLocal的一个内部类。在每一个Thread都持有一个ThreadLocalMap变量（如果该线程没用的ThreadLocal则为null）。它是一个map，key是ThreadLocal类型，value是保存的值。

这样设计就保证了一个Thread可以存储多个ThreadLocal。

ThreadLocalMap的Entry设计：
一个map中肯定有一个Entry来存储键值对，ThreadLocal的Entry的设计的较为特殊：

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

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

可以看到它继承了WeakReference。我们知道WeakReference是四大引用的一种叫做弱引用，它的含义是当对象只被弱引用引用时，下次GC时该对象就会被回收。

Q1:ThreadLocalMap的Entry为什么继承WeekReference?
（个人理解）这样当ThreadLocal变量生命周期结束后，对应的线程的ThreadLocalMap中存储的相应键值对也会被回收，不会造成内存泄露。

参考资料

本文是Java并发专题（欢迎大家关注）的一篇。
以下是完整的目录：
Java并发之基础知识
Java并发之volatile关键字
Java并发之synchronized关键字
Java并发之原子类
Java并发之线程池
Java并发之并发工具类
Java并发之AQS原理
Java并发之ThreadLocal使用和源码分析

---

如果本文对您有帮助，欢迎关注我的原创微信公众号“Java技术小站”第一时间接收我的更多文章

Java技术小站.png