源码 之 ThreadLocal
大家都用过ThreadLocal吧,这是一个线程安全的变量,通常我们为了线程隔离或者传值方便,就使用了ThreadLocal,那么ThreadLocal为什么是线程隔离的呢?今天我们可以带着源码一起解读一下,其实很简单的
用法
首先定义一个int类型的ThreadLocal
ThreadLocal<Integer> local = new ThreadLocal<>();
使用set对其进行赋值
local.set(10);
在任何地方都可以使用get获取到值
local.get();
多线程下会为每一个线程都保留独自的变量,所以线程之间互不感染,那么怎么实现的呢?
源码
我先说一下整体的操作吧,首先要有个大概的印象:每个线程对象中都维护了一个ThreadLocalMap对象,对象里面包含一个Entry数组,存储着key和value,key是ThreadLocal类型的,value就是我们需要的这个这个变量,我们使用set的时候就是加入到这个Entry数组,get操作就是从Entry数组里面取出来。
因为每个线程都有各自的ThreadLocalMap,所以是线程隔离的
好的,说完了,那现在开始看源码吧!
set
public void set(T value) {
Thread t = Thread.currentThread(); //获取当前线程
ThreadLocalMap map = getMap(t);//从当前线程对象中取出map
if (map != null)
map.set(this, value); //把value插入到map中
else
createMap(t, value);
}
首先我们应该找到当前线程变量,然后使用getMap找到对应的ThreadLocalMap,那个getMap是怎么操作的呢?实际上Thread类有个属性就是threadLocals,我们直接把它取出来就行了,第一次threadLocals肯定是null,所以执行了createMap操作,之后每次都是 map.set(this, value)插入到map中。
ThreadLocalMap
这是一个静态内部类,里面有个Entry数据,就是我之前提到的,存放key和value的
static class Entry extends WeakReference<ThreadLocal<?>> {
/** The value associated with this ThreadLocal. */
Object value;
Entry(ThreadLocal<?> k, Object v) {
super(k);
value = v;
}
}
有的人可能会比较好奇,为什么要定义成弱引用,这我等下再将。我们可以着重看一下set方法,看它是如何插入到这个Entry数组的
ThreadLocalMap.set
private void set(ThreadLocal<?> key, Object value) {
Entry[] tab = table;
int len = tab.length;
int i = key.threadLocalHashCode & (len-1); //算hash值,这里和HashMap的思想一样,为了分布均匀,len一般都是2的倍数
for (Entry e = tab[i];
e != null;
e = tab[i = nextIndex(i, len)]) {
ThreadLocal<?> k = e.get(); //存在冲突的情况,找下一个
if (k == key) { //key相同就覆盖
e.value = value;
return;
}
if (k == null) { //key 被gc回收了,这个位置相当于没用了,直接覆盖使用
replaceStaleEntry(key, value, i);
return;
}
}
tab[i] = new Entry(key, value);
int sz = ++size;
if (!cleanSomeSlots(i, sz) && sz >= threshold)
rehash(); //超过阈值,扩容
}
因为这是一个Entry数组,不像hashmap一样还有链表解决冲突问题,所以这里如果产生hash冲突的话就挨个往下找,直到找到一个为止。
我们可能会比较疑惑k 为什么会有等于null的情况,其实是这样的,如果外部的强引用没有了,当jvm启动gc的时候 key就会被回收,因为key是弱引用。
set操作说完了,大家都应该理解了吧,接下来就是get操作,这其实没什么好讲的,和set一模一样
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();
}
获取当前线程的map,如果map为空就返回null,不为空就从ThreadLocalMap 的Entry数组中get,有兴趣的可以自己去看一看,没什么好说的。
接下来我就说一下Entry为什么要继承WeakReference<ThreadLocal<?>>
内存泄漏问题
假设你不定义成弱引用,直接用强引用,当ThreadLocal被赋值为null后,你这里还设置了对ThreadLocal的强引用,就会导致ThreadLocal无法被回收,间接的可能导致外层的也不能被回收,引起连锁反应,例如如果在Android的activity中,那个就会导致activity也无法回收,就会导致内存泄漏。
那么是不是像它这样写就不会造成泄漏呢?不是的,我们可以看到源码,只有key被保存到了WeakReference对象中,但value没有。
ThreadLocal在没有外部强引用时,发生GC时会被回收,如果创建ThreadLocal的线程一直持续运行,那么这个Entry对象中的value就有可能一直得不到回收,发生内存泄露。
所以说怎么解决这个问题呢?每次使用完ThreadLocal之后要记得remove一下,养成一个好的习惯