【源码解析】ThreadLocal的工作原理

在 Android 中用到数据库时，就一定会和 SQLiteDatabase 打交道，我们经常会为 SQLiteDatabase 创建一个管理类。例如下面就是一个 SQLiteDatabase 操作的管理类。

public class DataBaseManager {
    private static SQLiteDatabase database;

    /**
    * 创建SQLiteDatabase工作流
    */
    public static SQLiteDatabase openDataBase() {
        if (database == null) {
            database = SQLiteDatabase.openDatabase(path, factory, flags);
        }
        return database;
    }

    /**
    * 关闭SQLiteDatabase工作流
    */
    public static void closeDataBase() {
        if (database != null) {
            database.close();
        }
    }
}
复制代码

上面的示例代码，在 DataBaseManager 管理类中有两个静态方法，一个创建 SQLiteDatabase 工作流程，一个关闭 SQLiteDatabase 工作流。在单线程环境下，这段代码完全是可以正常工作的，但是在多线程环境下就会出现问题了。

考虑这样一种场景，在多线程下，一个线程在执行 openDataBase 方法时执行了一半，另一个线程同时开始执行 openDataBase 方法，但这个时候 database 变量却没有赋值，所以会导致 database 变量被多次赋值。再考虑这样的一种情况，当一个线程刚执行了 openDataBase 方法时，这个时候另外一个线程执行了 closeDataBase ，就导致了 database 变量在刚创建又被关闭了。

上面的示例代码之所以在多线程环境下会出现问题，就是因为没有对线程进行同步。所以，上面的问题使用线程同步是可以解决的。例如，我们可以在为示例中的方法加上同步锁，在线程切换时必须要获取同步锁才能进入到相应的方法。

public class DataBaseManager {
    private static SQLiteDatabase database;

    /**
    * 创建SQLiteDatabase工作流
    */
    public synchronized static SQLiteDatabase openDataBase() {
        if (database == null) {
            database = SQLiteDatabase.openDatabase(path, factory, flags);
        }
        return database;
    }

    /**
    * 关闭SQLiteDatabase工作流
    */
    public synchronized static void closeDataBase() {
        if (database != null) {
            database.close();
        }
    }
}
复制代码

同步锁的确可以解决上面所说的线程同步的问题，但是同时也引进了另外一个问题，那就是在线程获取同步锁并执行方法时，其他线程必须要等待，这样就造成了资源的浪费。

那么有没有其他方法，在实现线程安全的同时也能做到不用线程等待呢？嗯，是有的，这就是我们下面介绍到的 ThreadLocal 。

ThreadLocal重写

ThreadLocal，顾名思义就是 线程本地变量 ，它的作用是 为每个变量在线程中都存储了一个副本 ，每个线程访问的都是自己的变量副本，和其他线程不冲突。它主要用来解决多线程环境下的 线程安全 问题。

还是上面那个例子，使用ThreadLocal，我们重新实现一遍。

public class DataBaseManager {
    private static ThreadLocal<SQLiteDatabase> dataBaseHolder = new ThreadLocal<>();
    
    private static SQLiteDatabase database;

    /**
    * 创建SQLiteDatabase工作流
    */
    public static SQLiteDatabase openDataBase() {
        SQLiteDatabase database = dataBaseHolder.get();
        if (database == null) {
            database = SQLiteDatabase.openDatabase(path, factory, flags);
            dataBaseHolder.set(database);
        }
        return database;
    }

    /**
    * 关闭SQLiteDatabase工作流
    */
    public static void closeDataBase() {
        SQLiteDatabase database = dataBaseHolder.get();
        if (database != null) {
            database.close();
        }
    }
}
复制代码

在 openDataBase 和 closeDataBase 方法中调用了 ThreadLocal 对象的 get 方法获取当前线程下的 database 对象。如果对象为空则在创建后，再通过 ThreadLocal 对象的 set 方法设置进去。

即使在多线程的环境下，由于获取到的 database 对象是当前线程内部的变量，每一个线程维护了自己的 database 变量，所以上面的代码既避免了 线程安全 问题，同时也避免了使用同步锁造成的 线程等待 问题。

ThreadLocal原理解析

ThreadLocal 为什么可以给每一个线程都创建一份副本变量呢？在解析 ThreadLocal 源码之前，我们先从整体设计上看一下 ThreadLocal 的工作流程。

每一个 ThreadLocal 对象通过 Thread.currentThread 得到当前 Thread 对象，而 Thread 对象中引用了 ThreadLcoalMap 对象， ThreadLocalMap 对象又引用了 Entry 数组， Entry 数组中的每一个 Entry 对象是由 ThreadLocal 对象和变量值 Value 组成。遍历每一个 Entry 对象，比对其中的 ThreadLocal 对象是否和最上层传递进来的 ThreadLocal 对象相等，若相等，则返回其中的变量值 Value 。

接下来我们通过解析 ThreadLocal 的源码，深入了解一下 ThreadLocal 的工作原理。我们先从 ThreadLocal 最常用的 get 方法开始入手。

public T get() {
	//获取当前线程
    Thread t = Thread.currentThread();
    //获取当前线程的ThreadLocalMap对象
    ThreadLocalMap map = getMap(t);
    if (map != null) { //2、不为空，找到Entry对象，返回Entry对象的Value值
        ThreadLocalMap.Entry e = map.getEntry(this);
        if (e != null)
            return (T)e.value;
    }
    //1、为空，走setInitialValue方法
    return setInitialValue();
}
复制代码

get 方法通过 Thread.currentThread 方法获取当前线程，然后尝试获取当前线程的 ThreadLocalMap 对象。当 ThreadLocalMap 对象为空时，则走 setInitialValue 方法，否则去找 ThreaLocalMap 下的 Entry 对象。在第一次执行 get 方法时，当前线程的 ThreadLocalMap 对象肯定为空的，所以我们先看第一步的 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);
    return value;
}
复制代码

initialValue 方法是获取一个默认的初始值，该初始值是 ThreadLocal 对象构造时赋值的。当然你也可以在构造 ThreadLocal 对象时不赋值初始值，而通过 ThreadLocal 对象的 set 方法进行设置，两者具有一样的效果。第一次执行 setInitialValue 方法时， ThreadLocalMap 肯定为空，所以执行了 createMap 方法。

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

上述方法 new 了一个 ThreadLocalMap 对象，并将 ThreadLocal 对象和 初始值变量 作为参数传递进去。

ThreadLocalMap(ThreadLocal firstKey, Object firstValue) {
    table = new Entry[INITIAL_CAPACITY];
    int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
    table[i] = new Entry(firstKey, firstValue);
    size = 1;
    setThreshold(INITIAL_CAPACITY);
}
复制代码

ThreadLocalMap 的构造函数里面又 new 了一个 Entry 对象，参数也是 ThreadLocal 对象和 初始值变量 。

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

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

Entry 继承了 WeakReference 对象，并将 ThreadLocal 对象作为 key ，将要 存储的初始值变量 作为 value 。

Entry 存储的变量值是 ThreadLocal 构造时传入的初始值，当需要改变该值时，上面我们提到过，还可以通过 ThreadLocal 的 set 方法进行设置。

public void set(T value) {
    Thread t = Thread.currentThread();
    ThreadLocalMap map = getMap(t);
    if (map != null)
        map.set(this, value);
    else
        createMap(t, value);
}
复制代码

set 方法的逻辑是获取当前 Thread 对象，然后通过 Thread 的 ThreadLocalMap 对象，并通过 ThreadLocalMap 的 set 方法设置存储在 Entry 里面的 value 值。

现在我们再回到 ThreadLocal 的 get 方法，看看它的第二步逻辑的处理方式。我们重新写一遍 get 方法。

public T get() {
	//获取当前线程
    Thread t = Thread.currentThread();
    //获取当前线程的ThreadLocalMap对象
    ThreadLocalMap map = getMap(t);
    if (map != null) { //2、不为空，找到Entry对象，返回Entry对象的Value值
        ThreadLocalMap.Entry e = map.getEntry(this);
        if (e != null)
            return (T)e.value;
    }
    //1、为空，走setInitialValue方法
    return setInitialValue();
}
复制代码

map 是一个 ThreadLocalMap 对象，执行了它的 getEntry 方法，并传递了 ThreadLocal 对象作为参数。

private Entry getEntry(ThreadLocal key) {
    int i = key.threadLocalHashCode & (table.length - 1);
    Entry e = table[i];
    if (e != null && e.get() == key)
        return e;
    else
        return getEntryAfterMiss(key, i, e);
}
复制代码

getEntry 的逻辑也挺简单，就是从 Entry 数组中找到 ThreadLocal 对象对应的 Entry 对象，找到则返回 Entry 对象，找不到则返回 null 。通过 Entry 对象就能获取到存储在 Entry 对象里面的变量 value 值。