ThreadLocal的作用和实现原理

ThreadLocal的作用

ThreadLocal是一个线程内部的数据存储类，通过它可以在指定的线程中存储数据，数据存储以后，只有在指定的线程中可以获取到存储的数据，对于其他线程来说则无法取到数据。

ThreadLocal的主要作用

轻松实现一些看起来很复杂的功能，适合以下一些应用场景。

• 应用场景1

某些数据是以线程为作用域并且不同线程具有不同的数据的副本时，就可以考虑用ThreadLocal。

例如：Android中，Handler需要获取当前线程的Looper，很显然Looper的作用域是线程并且不同线程具有不同的Looper。

通过ThreadLocal就可以轻松实现Looper在线程中的存取。

• 应用场景2

复杂逻辑下的对象传递，比如监听器的传递，有些时候一个线程中的任务过于复杂，我们又需要监听器能够贯穿整个线程的执行过程。

采用ThreadLocal可以让监听器作为线程内的全局对象而存在，在线程内部只要通过get方法就可以获取到监听器。

ThreadLocal的使用示例

ThreadLocal<Boolean> mBooleanThreadLocal = new ThreadLocal<>();

mBooleanThreadLocal.set(true);
Log.d("@@@", "[Thread@main]mBooleanThreadLocal = " + mBooleanThreadLocal.get());

new Thread("Thread@1") {
    @Override
    public void run() {
        mBooleanThreadLocal.set(false);
        Log.d("@@@", "[Thread@1]mBooleanThreadLocal = " + mBooleanThreadLocal.get());
    }
}.start();

new Thread("Thread@2") {
    @Override
    public void run() {
        Log.d("@@@", "[Thread@2]mBooleanThreadLocal = " + mBooleanThreadLocal.get());
    }
}.start();

输出的日志如下

D/@@@: [Thread@main]mBooleanThreadLocal = true
D/@@@: [Thread@1]mBooleanThreadLocal = false
D/@@@: [Thread@2]mBooleanThreadLocal = null

在上面示例代码中，主线程的mBooleanThreadLocal的值设置为true，子线程1的mBooleanThreadLocal的值设置为false，子线程2的mBooleanThreadLocal的值不设置。

从日志可以看出，虽然在不同线程中访问同一个ThreadLocal对象，但是他们通过ThreadLocal获取到值却是不一样的，这就是ThreadLocal的神奇之处。

ThreadLocal的实现原理

ThreadLocal是一个泛型类，定义为public class ThreadLocal<T>，只要弄清楚ThreadLocal的get方法和set方法，就可以明白它的实现原理。

ThreadLocal的set方法（Android API 26），源码如下

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源码可以看出，首先getMap方法来获取当前线程的ThreadLocalMap，这个Map是一个自定义的hash map，key是TheadLocal，value是对应存储的值。

ThreadLocal的get方法（Android API 26），源码如下

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();
}

从get源码可以看出，首先也是一样用getMap方法来获取当前线程的ThreadLocalMap，然后根据key=当前ThreadLocal来获取对应的value值。

从ThreadLocal的set和get方法可以看出，它们所操作的都是当前线程的ThreadLocalMap对象。

因此在不同线程中，访问同一个ThreadLocal的set和get方法，它们对ThreadLocalde的读、写操作仅限于各自线程的内部，从而使ThreadLocal可以在多个线程中互不干扰地存储和修改数据。

ThreadLocal在Android中的应用

获取当前线程的Looper

在Looper类中，定义了一个ThreadLocal静态常量

static final ThreadLocal<Looper> sThreadLocal = new ThreadLocal<Looper>();

1、初始化Looper，即调用Looper.perpar()，源码如下

private static void prepare(boolean quitAllowed) {
    if (sThreadLocal.get() != null) {
        throw new RuntimeException("Only one Looper may be created per thread");
    }
    sThreadLocal.set(new Looper(quitAllowed));
}

private Looper(boolean quitAllowed) {
    mQueue = new MessageQueue(quitAllowed);
    mThread = Thread.currentThread();
}

从源码可以看到，在一个线程中初始化Looper，是用ThreadLocal存储Looper对象。同时保证一个线程只拥有一个Looper，否则在初始化会报错
Only one Looper may be created per thread

2、获取当前线程的Looper，即Looper.myLooper（），源码如下

public static @Nullable Looper myLooper() {
    return sThreadLocal.get();
}

从源码可以看到，返回Looper对象是调用ThreadLocal.get()，即当前线程对应的Looper对象。

我们可以根据此，判断当前线程是否是主线程

public boolean isMainThread() {
    return Looper.myLooper() == Looper.getMainLooper();
}

另外，Handler也用来判断当前线程是否有Looper，否则报错Can't create handler inside thread that has not called Looper.prepare()

mLooper = Looper.myLooper();
if (mLooper == null) {
    throw new RuntimeException(
        "Can't create handler inside thread that has not called Looper.prepare()");
}

参考
任玉刚的《Android开发艺术探索》