ThreadLocal 是一种线程安全的数据容器,实现原理就是会在不同的线程保持单独存储变量。
最简单的使用方式如下:
private ThreadLocal sName = new ThreadLocal<>();
public void testThreadLocal(){
new Thread(new Runnable() {
@Override
public void run() {
sName.set("name1");
}
}).start();
new Thread(new Runnable() {
@Override
public void run() {
sName.set("name2");
}
}).start();
}
ThreadLocal 源码解析
构造方法
构造方法如下:
public ThreadLocal() {
}
ThreadLocalMap
ThreadLocalMap 是 ThreadLocal 内部的一个类,类似 HashMap,如下:
static class ThreadLocalMap {
/**
* The table, resized as necessary.
* table.length MUST always be a power of two.
*/
private Entry[] table; //实际存储数据的地方
/**
* The number of entries in the table.
*/
private int size = 0;//长度
/**
* The next size value at which to resize.
*/
private int threshold; // Default to 0
static class Entry extends WeakReference> {
/** The value associated with this ThreadLocal. */
Object value;
Entry(ThreadLocal> k, Object v) {
super(k);
value = v;
}
}
// 省略代码
}
其中其 Entry 继承自 WeakReference 中,每次存储一个值,都会把值的 HashCode 作为 作为key,并且这个 key 是一个 WeakReference 对象。
总结一下 ThreadLocalMap 存储的是一个数组,每个数组的元素如下:
其中 key 是当前 ThreadLocal 对象的 Hash ,value 是 ThreadLocal 对象的存储的值。
set方法
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);
}
//取出当前线程的 threadLocals,每个线程唯一
ThreadLocalMap getMap(Thread t) {
return t.threadLocals;
}
//计算 hash,插入新的 Entry 或者替换旧的 Entry 的 value 值
private void set(ThreadLocal> key, Object value) {
// We don't use a fast path as with get() because it is at
// least as common to use set() to create new entries as
// it is to replace existing ones, in which case, a fast
// path would fail more often than not.
Entry[] tab = table;
int len = tab.length;
int i = key.threadLocalHashCode & (len-1);
for (Entry e = tab[i];
e != null;
e = tab[i = nextIndex(i, len)]) {
ThreadLocal> k = e.get();
if (k == key) {
e.value = value;
return;
}
if (k == null) {
replaceStaleEntry(key, value, i);
return;
}
}
tab[i] = new Entry(key, value);
int sz = ++size;
if (!cleanSomeSlots(i, sz) && sz >= threshold)
rehash();
}
其中 get() 方法,会先从当前线程对象活动 Thread.threadLocals 对象,它是一个 ThreadLocalMap 对象。简单来说,就是不同的线程保持单独保存自己线程的变量。
get方法
get()方法用于获取当前线程的变量,如下:
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();
}
通用的会先获取 会先从当前线程对象活动 Thread.threadLocals 对象,然后从 ThreadLocalMap 对象获取当前线程存储的变量。
ThreadLocal 的使用场景
线程安全,不需要多线程交互,各自线程单独运行。例如 Looper,如下:
//Looper.java
static final ThreadLocal sThreadLocal = new ThreadLocal();
public static @Nullable Looper myLooper() {
return sThreadLocal.get();
}
ThreadLocal 使用隐患
ThreadLocal 使用可能会导致内存泄露,因为 ThreadLocalMap的 Entry 的key(对应该ThreadLocal hash) 是 WeakReference 类型,可能在 GC的是会回收。也就是 ThreadLocal 存入到 ThreadLocalMap 之后,如果 key 被GC 回收,这个ThreadLocal 对象保存的内容,将永远无法被使用,并且由于线程还存活,所以ThreadLocalMap 不会被销毁,最终导致 ThreadLocal 的内容一直在内存里。
但是设计者在设计上避免了这个问题,就是当你再次调用 get() remove() set() 方法的时候,会自动清理 key 为null 的对象。
如何消除隐患
在使用完成之后,调用 remove() 方法。