Java线程局部变量的使用

知识点介绍

来源：《Java核心卷一》12.4.12 线程局部变量

前面几节中,我们讨论了在线程间共享变量的风险。有时可能要避免共享变量,使用ThreadLocal（中文文档|英文文档）辅助类为各个线程提供各自的实例。例如, SimpleDateFormat(中文文档)类不是线程安全的。假设有一个静态变量:

public static final SimpleDateFormat dateFormat 
    = new SimpleDateFormat("yyy-MM-dd");

如果两个线程都执行以下操作：

String dateStamp = dateFormat.format(new Date());

结果可能很混乱，因为dateFormat使用的内部数据结构可能会被并发的访问所破坏。当然可以使用同步,但开销很大;或者也可以在需要时构造一个局部 SimpleDateFormat对象,不过这也太浪费了。要为每个线程构造一个实例,可以使用以下代码:

private static final ThreadLocal<SimpleDateFormat> dataFormat
    = ThreadLocal.withInitial(() -> new SimpleDateFormat("yyy-MM-dd"))

要访问具体的格式化方法,可以调用:

String dataStamp = dataFormat.get().format(new Date());

在一个给定线程中首次调用get时,会调用构造器中的 lambda表达式。在此之后,get方法会返回属于当前线程的那个实例。

---

代码实现

上面的内容，第一次看没看明白，跳过了。在看完《Java并发之美》1.11 ThreadLocal，大体明白了ThreadLocal是怎么回事。

所以，我实现了下，上一节的完整代码，然后分析下整个流程。

public class ThreadLocalTest {
    
    // (2.1)创建ThreadLocal变量
    private static final ThreadLocal<SimpleDateFormat> dataFormat = new ThreadLocal<SimpleDateFormat>(){
        @Override
        protected SimpleDateFormat initialValue(){
            return new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        }
    };
    
    public static void main(String args[]){
        Thread threadOne = new Thread(new Runnable() {
            public void run(){
                String dataStamp = dataFormat.get().format(new Date());
                System.out.println(dataStamp);
            }
        });

        Thread threadTwo = new Thread(new Runnable() {
            public void run(){
                // (2.2) 使用局部变量
                String dataStamp = dataFormat.get().format(new Date());
                System.out.println(dataStamp);
            }
        });

        threadOne.start();
        threadTwo.start();
    }
}

(2.1)创建ThreadLocal变量

首先，ThreadLocal类的参数类型为SimpleDateFormat。接着，使用ThreadLocal<SimpleDateFormat>类创建了一个名为dataFormat的对象。其中类的initialValue方法被重写。

initialValue

返回此线程局部变量的当前线程的“初始值”。线程第一次使用 get() 方法访问变量时将调用此方法，但如果线程之前调用了 set(T) 方法，则不会对该线程再调用 initialValue 方法。通常，此方法对每个线程最多调用一次，但如果在调用 get() 后又调用了 remove()，则可能再次调用此方法。

该实现返回 null；如果程序员希望线程局部变量具有 null 以外的值，则必须为 ThreadLocal 创建子类，并重写此方法。通常将使用匿名内部类完成此操作。

(2.2) 使用局部变量

要明白get方法，需要去阅读源码。简单来说(复杂的我也不知道，哈哈)，第一次调用get方法，会调用initialValue方法。由我们的实现可知，会返回一个new SimpleDateFormat("yyyy-MM-dd HH:mm:ss")对象。这个对象被放入当前线程的threadLocals中，每个线程有自己的threadLocals，所以每个线程有自己的ThreadLocal变量副本并可以加以改变。

    public T get() {
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        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); // 源码在下方
        }
        if (this instanceof TerminatingThreadLocal) {
            TerminatingThreadLocal.register((TerminatingThreadLocal<?>) this);
        }
        return value;
    }

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

书上的UML图可以挺好的反应ThreadLocal，Thread和ThreadLocalMap三者之间的关系。

图片表示的是类之间的关联关系，UML的使用，可以参考：UML的使用

拓展阅读

我还没读：SimpleDateFormat 的线程安全问题与 ThreadLocal