ThreadLocal类用来提供线程内部的局部变量。这种变量在多线程环境下访问(通过get或set方法访问)时能保证各个线程里的变量相对独立于其他线程内的变量。

ThreadLocal不能使用原子类型,只能使用Object类型。 threadLocal为每一个线程都提供了变量的副本, 使得每个线程在某一时间访问到的并不是同一个对象, 这样就隔离了多个线程对数据的数据共享。

ThreadLocal是一个线程内部的数据存储类,通过它可以在指定的线程中存储数据,数据存储以后,只有在指定线程中可以获取到存储的数据, 对于其它线程来说无法获取到数据。在日常开发中用到ThreadLocal的地方较少,但是在某些特殊的场景下,通过ThreadLocal可以轻松地实 现一些看起来很复杂的功能,这一点在Android的源码中也有所体现,比如Looper、ActivityThread以及AMS中都用到了ThreadLocal。 具体到ThreadLocal的使用场景,这个不好统一地来描述,一般来说,当某些数据是以线程为作用域并且不同线程具有不同的数据副本的时候, 就可以考虑采用ThreadLocal。比如对于Handler来说,它需要获取当前线程的Looper,很显然Looper的作用域就是线程并且不同线程具有 不同的Looper,这个时候通过ThreadLocal就可以轻松实现Looper在线程中的存取,如果不采用ThreadLocal,那么系统就必须提供一个 全局的哈希表供Handler查找指定线程的Looper,这样一来就必须提供一个类似于LooperManager的类了,但是系统并没有这么做而是选择 了ThreadLocal,这就是ThreadLocal的好处。

ThreadLocal另一个使用场景是复杂逻辑下的对象传递,比如监听器的传递,有些时候一个线程中的任务过于复杂, 这可能表现为函数调用栈比较深以及代码入口的多样性,在这种情况下,我们又需要监听器能够贯穿整个线程的执行过程,这个时候可以怎么做呢? 其实就可以采用ThreadLocal,采用ThreadLocal可以让监听器作为线程内的全局对象而存在,在线程内部只要通过get方法就可以获取到监听器。 而如果不采用ThreadLocal,那么我们能想到的可能是如下两种方法:第一种方法是将监听器通过参数的形式在函数调用栈中进行传递, 第二种方法就是将监听器作为静态变量供线程访问。上述这两种方法都是有局限性的。第一种方法的问题时当函数调用栈很深的时候, 通过函数参数来传递监听器对象这几乎是不可接受的,这会让程序的设计看起来很糟糕。第二种方法是可以接受的,但是这种状态是不具有可扩充性的, 比如如果同时有两个线程在执行,那么就需要提供两个静态的监听器对象,如果有10个线程在并发执行呢?提供10个静态的监听器对象? 这显然是不可思议的,而采用ThreadLocal每个监听器对象都在自己的线程内部存储,根据就不会有方法2的这种问题。

ThreadLocal的基本操作

ThreadLocal类接口需要注意如下几个方法:

1.构造函数

  
        /**
         * Creates a new thread-local variable.
         */
        public ThreadLocal() {}
    

构造函数内部什么也没做。

2.initialValue函数

  
    /**
     * Provides the initial value of this variable for the current thread.
     * The default implementation returns {@code null}.
     *
     * @return the initial value of the variable.
     */
    protected T initialValue() {
        return null;
    }
     

该函数在调用get函数的时候会第一次调用,但是如果一开始就调用了set函数,则该函数不会被调用。通常该函数只会被调用一次, 除非手动调用了remove函数之后又调用get函数,这种情况下,get函数中还是会调用initialValue函数。该函数是protected类型的, 很显然是建议在子类重载该函数的,所以通常该函数都会以匿名内部类的形式被重载,以指定初始值,比如:

  
 ThreadLocal<Integer> b = new ThreadLocal<Integer>(){
        @Override
        protected Integer initialValue() {
            return 1;
        }
    };
    

3.get函数:public T get()

该函数用来获取与当前线程关联的ThreadLocal的值,如果当前线程没有该ThreadLocal的值,则调用initialValue函数获取初始值返回。

4.set函数:public void set(T value)

set函数用来设置当前线程的该ThreadLocal的值,设置当前线程的ThreadLocal的值为value。

5.remove函数:public void remove()

remove函数用来将当前线程的ThreadLocal绑定的值删除,在某些情况下需要手动调用该函数,防止内存泄露。

ThreadLocal的使用

下面写一个demo来演示ThreadLocal的作用,用一个android的中多线程来演示,代码如下

  
public class TestActivity extends Activity {
    private int a = 1 ;
    private ThreadLocal<Integer> b = new ThreadLocal<Integer>(){
        @Override
        protected Integer initialValue() {
            return 1;
        }
    };
    final Handler myHandler = new Handler() {
        @Override
        //重写handleMessage方法,根据msg中what的值判断是否执行后续操作
        public void handleMessage(Message msg) {
            Log.e(Thread.currentThread().getName(),"a的值是:"+a+",   b的值是:" + b.get()) ;
        }
    };
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_test11);
        new Timer().schedule(new TimerTask() {
            @Override
            public void run() {
                a ++ ;
                b.set(a);
                Log.e(Thread.currentThread().getName(),"a的值是:"+a+",   b的值是:" + b.get()) ;
                myHandler.sendEmptyMessage(0x123);
            }
        }, 0,1000);
    }
}
    

在activity中先初始两个变量a和b,都等于1,b使用ThreadLocal初始化,在子线程中每隔一秒改变a和b的值,然后分别输出:

可以看出a的值是两个线程共享的,多个线程可以同时改变a的值,如果不加上同步锁的情况下,这是线程不安全的。 而主线程中b的值始终是1,没有改变,而子线程中的b每次增加1,可见b的值并没有被共享,而是相互独立的。

ThreadLocal的原理

Android中的ThreadLocal的源码在libcore/luni/src/main/java/java/lang目录下,在Android中,ThreadLocal像是对原来的ThreadLcal做了优化的实现。 android中ThreadLocal比java原生的这个类少了一些API,而且保存线程变量的内部类名字也改为Values,里面没有再定义内部类。 仔细地阅读比较,我们可以看到Android中对Java原生的ThreadLocal做了一些优化的工作。

我们来看一下Values这个类是怎么定义和设计的。 Values是被设计用来保存线程的变量的一个类,它相当于一个容器,存储保存进来的变量。它的成员变量如下:

  
    /** 
     * Map entries. Contains alternating keys (ThreadLocal) and values. 
     * The length is always a power of 2. 
     */  
    private Object[] table;  
    /** Used to turn hashes into indices. */  
    private int mask;  
    /** Number of live entries. */  
    private int size;  
    /** Number of tombstones. */  
    private int tombstones;  
    /** Maximum number of live entries and tombstones. */  
    private int maximumLoad;  
    /** Points to the next cell to clean up. */  
    private int clean;  
    

同样table是实际上保存变量的地方,但它在这里是个Object类型的数组,它的长度必须是2的n次方的值。mask即计算下标的掩码, 它的值是table的长度-1。size表示存放进来的实体的数量。这与前面原生的ThreadLocal的ThreadLocalMap是一样的。 但是在这里它还定义了三个int类型的变量:tombstones表示被删除的实体的数量,maximumLoad是一个阈值,用来判断是否需要进行rehash, clean表示下一个要进行清理的位置点。 我们来看一下当Values对象被创建时进行了什么工作,代码如下:

  
/** 
 * Constructs a new, empty instance. 
 */  
Values() {  
    initializeTable(INITIAL_SIZE);  
    this.size = 0;  
    this.tombstones = 0;  
}  
/** 
 * Creates a new, empty table with the given capacity. 
 */  
private void initializeTable(int capacity) {  
    this.table = new Object[capacity * 2];  
    this.mask = table.length - 1;  
    this.clean = 0;  
    this.maximumLoad = capacity * 2 / 3; // 2/3  
}  
    

上面的代码我们可以看到,当初始化一个Values对象时,它会创建一个长度为capacity*2的数组。 然后在add()方法当中,也可以看到它会把ThreadLocal对象(key)和对应的value放在连续的位置中。

  
/** 
 * Adds an entry during rehashing. Compared to put(), this method 
 * doesn't have to clean up, check for existing entries, account for 
 * tombstones, etc. 
 */  
void add(ThreadLocal<?> key, Object value) {  
    for (int index = key.hash & mask;; index = next(index)) {  
        Object k = table[index];  
        if (k == null) {  
            table[index] = key.reference;  
            table[index + 1] = value;  
            return;  
        }  
    }  
}  
    

也就是table被设计为下标为0,2,4…2n的位置存放key,而1,3,5…(2n +1 )的位置存放value。直接通过下标存取线程变量, 它比用WeakReference类在内存占用上更经济,性能也更好。它也保证了在计算key的下标时,一定是偶数位。 而在remove()方法中,移除变量时它是把对应的key的位置赋值为TOMBSTONE,value赋值为null,然后 tombstones++;size--;。 TOMBSTONE是前面定义的一个常量,表示被删除的实体。

再看看ThreadLocal的set方法,如下所示:

  
public void set(T value) {  
    Thread currentThread = Thread.currentThread();  
    Values values = values(currentThread);  
    if (values == null) {  
        values = initializeValues(currentThread);  
    }  
    values.put(this, value);  
}  
    

在上面的set方法中,首先会通过values方法来获取当前线程中的ThreadLocal数据,如果获取呢?其实获取的方式也是很简单的, 在Thread类的内容有一个成员专门用于存储线程的ThreadLocal的数据,如下所示:ThreadLocal.Values localValues, 因此获取当前线程的ThreadLocal数据就变得异常简单了。如果localValues的值为null,那么就需要对其进行初始化, 初始化后再将ThreadLocal的值进行存储。下面看下ThreadLocal的值到底是怎么localValues中进行存储的。在localValues内部有一个数组: private Object[] table,ThreadLocal的值就是存在在这个table数组中,下面看下localValues是如何使用put方法将ThreadLocal的值存 储到table数组中的,如下所示:

  
void put(ThreadLocal<?> key, Object value) {  
    cleanUp();  
    // Keep track of first tombstone. That's where we want to go back  
    // and add an entry if necessary.  
    int firstTombstone = -1;  
    for (int index = key.hash & mask;; index = next(index)) {  
        Object k = table[index];  
        if (k == key.reference) {  
            // Replace existing entry.  
            table[index + 1] = value;  
            return;  
        }  
        if (k == null) {  
            if (firstTombstone == -1) {  
                // Fill in null slot.  
                table[index] = key.reference;  
                table[index + 1] = value;  
                size++;  
                return;  
            }  
            // Go back and replace first tombstone.  
            table[firstTombstone] = key.reference;  
            table[firstTombstone + 1] = value;  
            tombstones--;  
            size++;  
            return;  
        }  
        // Remember first tombstone.  
        if (firstTombstone == -1 && k == TOMBSTONE) {  
            firstTombstone = index;  
        }  
    }  
}  
    

上面的代码实现数据的存储过程,这里不去分析它的具体算法,但是我们可以得出一个存储规则,那就是ThreadLocal的值在table 数组中的存储位置总是为ThreadLocal的reference字段所标识的对象的下一个位置,比如ThreadLocal的reference对象在table数组的 索引为index,那么ThreadLocal的值在table数组中的索引就是index+1。最终ThreadLocal的值将会被存储在table数组中: table[index + 1] = value。上面分析了ThreadLocal的set方法,这里分析下它的get方法,如下所示:

  
public T get() {  
    // Optimized for the fast path.  
    Thread currentThread = Thread.currentThread();  
    Values values = values(currentThread);  
    if (values != null) {  
        Object[] table = values.table;  
        int index = hash & values.mask;  
        if (this.reference == table[index]) {  
            return (T) table[index + 1];  
        }  
    } else {  
        values = initializeValues(currentThread);  
    }  
    return (T) values.getAfterMiss(this);  
} 
    

可以发现,ThreadLocal的get方法的逻辑也比较清晰,它同样是取出当前线程的localValues对象,如果这个对象为null那么就返回初始值, 初始值由ThreadLocal的initialValue方法来描述,默认情况下为null,当然也可以重写这个方法。

如果localValues对象不为null,那就取出它的table数组并找出ThreadLocal的reference对象在table数组中的位置, 然后table数组中的下一个位置所存储的数据就是ThreadLocal的值。

我们会注意到其中的代码如下:

 
if (this.reference == table[index]) {  
    return (T) table[index + 1];  
}  
    

从ThreadLocal的set和get方法可以看出,它们所操作的对象都是当前线程的localValues对象的table数组, 因此在不同线程中访问同一个ThreadLocal的set和get方法,它们对ThreadLocal所做的读写操作仅限于各自线程的内部, 这就是为什么ThreadLocal可以在多个线程中互不干扰地存储和修改数据.