Java基础之ThreadLocal
ThreadLocal 是什么
首先 它是一个数据结构 类似HashMap 可以保存 Key Value 键值对 但是ThreadLocal只能保存一个 并且每个线程互不干扰
public static void main(String[] args) {
final ThreadLocal<String> localName = new ThreadLocal();
final HashMap<Integer, String> map = new HashMap<>(2);
new Thread("线程1") {
@Override
public void run() {
localName.set("Sincerity");
String s = localName.get();
System.out.println(Thread.currentThread().getName() + "获取到ThreadLocal值=" + s);
map.put(0, Thread.currentThread().getName());
System.out.println(Thread.currentThread().getName() + "获取到map的长度" + map.size());
}
}.start();
String s = localName.get();
System.out.println("主线程获取到ThreadLocal值=" + s);
new Thread("线程2") {
@Override
public void run() {
String s = localName.get();
System.out.println(Thread.currentThread().getName() + "获取到ThreadLocal值=" + s);
System.out.println(Thread.currentThread().getName() + "获取到map的长度" + map.size());
}
}.start();
//得到结果
主线程获取到ThreadLocal值=null
线程1获取到ThreadLocal值=Sincerity
线程1获取到map的长度1
线程2获取到ThreadLocal值=null
线程2获取到map的长度1
思考一下为什么会出现这样的情况呢 我们已经知道ThreadLocal是一种数据结构 为什么除了赋值的线程之外数据无法获取呢 同样是HashMap 为什么可以可以全局获取到数据呢 带着问题 我们一起探索一下
为何ThreadLocal能实现每个线程的数据互不干扰
读懂源码
public class ThreadLocal<T> {
...
//说明创建ThreadLocal的时候什么也没有做
public ThreadLocal() {
}
...
//set方法怎么说
public void set(T value) {
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t); //默认情况下为null
if (map != null)
//set的时候 把自己当做Key 传递的值当做Value
map.set(this, value);
else
createMap(t, value); //创建一个map对象
}
...
//获取线程中保留的 ThreadLocal的映射 默认在Thread中为空
ThreadLocalMap getMap(Thread t) {
return t.threadLocals;
}
//创建一个ThreadLocalMap
void createMap(Thread t, T firstValue) {
t.threadLocals = new ThreadLocalMap(this, firstValue);
}
//get方法
public T get() {
Thread t = Thread.currentThread();
//得到当前线程的ThreadLocalMap映射
ThreadLocalMap map = getMap(t);
if (map != null) {
//拿到key等于当前ThreadLocal的Entry
ThreadLocalMap.Entry e = map.getEntry(this);
if (e != null) {
@SuppressWarnings("unchecked")
T result = (T)e.value;
return result;
}
}
//处理map等于null的情况
return setInitialValue();
}
/**
*主要就是将一个null重新存入map中 并且返回null
*/
private T setInitialValue() {
T value = initialValue();//得到一个Null值
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null)
map.set(this, value);
else
createMap(t, value);
return value;
}
protected T initialValue() {
return null;
}
}
看到这里其实我们也就明白 ThreadLocal为什么能保证每个线程数据独立了 其内部维护着一个当前线程的映射ThreadLocalMap 然后通过线程映射得到当前线程的ThreadLocalMap 这里就出现了一个问题 同一个ThreadLocal的Hashcode是一致的 怎么保证每个线程的数据独立呢
看看ThreadLocalMap
static class ThreadLocalMap {
//数组中的桶 弱引用
static class Entry extends WeakReference<ThreadLocal<?>> {
/** The value associated with this ThreadLocal. */
Object value;
Entry(ThreadLocal<?> k, Object v) {
super(k);
value = v;
}
}
private static final int INITIAL_CAPACITY = 16;
private Entry[] table;
//得到key的hashCode
private final int threadLocalHashCode = nextHashCode();
//生成hash code间隙为这个魔数，
//可以让生成出来的值或者说ThreadLocal的ID较为均匀地分布在2的幂大小的数组中。
private static final int HASH_INCREMENT = 0x61c88647;
private static int nextHashCode() {
return nextHashCode.getAndAdd(HASH_INCREMENT);
}
//构造方法 默认添加一个值
ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
//创建一个默认大小为16的数组
table = new Entry[INITIAL_CAPACITY];
//用firstKey的threadLocalHashCode与初始大小16取模得到哈希值
int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
table[i] = new Entry(firstKey, firstValue);
size = 1;
//设置阈值
setThreshold(INITIAL_CAPACITY);
}
private void setThreshold(int len) {
threshold = len * 2 / 3; //直接写成2/3了 ....
}
//向ThreadLocalMap中添加元素
private void set(ThreadLocal<?> key, Object value) {
Entry[] tab = table;
int len = tab.length;
//得到key的hashCode 线性探测法得到
//每个ThreadLocal对象都有一个hash值threadLocalHashCode，每初始化一个ThreadLocal对象，
//hash值就增加一个固定的大小0x61c88647
int i = key.threadLocalHashCode & (len-1);
//根据ThreadLocal大小的hash值得到table中的i的元素
for (Entry e = tab[i]; e != null; e = tab[i = nextIndex(i, len)]) {
//如果I位置已经有一个Entry对象 说明hash冲突了
//得到当前存储元素的key
ThreadLocal<?> k = e.get();
//如果这个元素额key正好是设置的key 重新给元素中的value赋值
if (k == key) {
e.value = value;
return;
}
// 当前i位置entry对象为空
if (k == null) {
replaceStaleEntry(key, value, i);
return;
}
}
//如果当前key的hashCode位置为空 插入一个enrty在i位置
tab[i] = new Entry(key, value);
int sz = ++size;
//清理一个没用的数据 后大小达到阈值
if (!cleanSomeSlots(i, sz) && sz >= threshold)
//扩容
rehash(); //2倍扩容
}
}
int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);可以看出，它是在上一个被构造出的ThreadLocal的ID/threadLocalHashCode的基础上加上一个魔数0x61c88647的。这个魔数的选取与斐波那契散列有关，0x61c88647对应的十进制为1640531527。斐波那契散列的乘数可以用(long) ((1L << 31) * (Math.sqrt(5) - 1))可以得到2654435769，如果把这个值给转为带符号的int，则会得到-1640531527。换句话说
(1L << 32) - (long) ((1L << 31) * (Math.sqrt(5) - 1))得到的结果就是1640531527也就是0x61c88647。通过理论与实践，当我们用0x61c88647作为魔数累加为每个ThreadLocal分配各自的ID也就是threadLocalHashCode再与2的幂取模，得到的结果分布很均匀。
ThreadLocalMap使用的是线性探测法，均匀分布的好处在于很快就能探测到下一个临近的可用slot，从而保证效率。这就回答了上文抛出的为什么大小要为2的幂的问题。为了优化效率。对于
& (INITIAL_CAPACITY - 1)，相信有过算法竞赛经验或是阅读源码较多的程序员，一看就明白，对于2的幂作为模数取模，可以用&(2n-1)来替代%2n，位运算比取模效率高很多。至于为什么，因为对2^n取模，只要不是低n位对结果的贡献显然都是0，会影响结果的只能是低n位。可以说在ThreadLocalMap中，形如
key.threadLocalHashCode & (table.length - 1)（其中key为一个ThreadLocal实例）这样的代码片段实质上就是在求一个ThreadLocal实例的哈希值，只是在源码实现中没有将其抽为一个公用函数。
内存泄漏
static class Entry extends WeakReference<ThreadLocal<?>> {
/** The value associated with this ThreadLocal. */
Object value;
Entry(ThreadLocal<?> k, Object v) {
super(k);
value = v;
}
}
通过之前的分析已经知道，当使用ThreadLocal保存一个value时，会在ThreadLocalMap中的数组插入一个Entry对象，按理说key-value都应该以强引用保存在Entry对象中，但在ThreadLocalMap的实现中，key被保存到了WeakReference对象中。
这就导致了一个问题，ThreadLocal在没有外部强引用时，发生GC时会被回收，如果创建ThreadLocal的线程一直持续运行，那么这个Entry对象中的value就有可能一直得不到回收，发生内存泄露。
如何避免内存泄露
既然已经发现有内存泄露的隐患，自然有应对的策略，在调用ThreadLocal的get()、set()可能会清除ThreadLocalMap中key为null的Entry对象，这样对应的value就没有GC Roots可达了，下次GC的时候就可以被回收，当然如果调用remove方法，肯定会删除对应的Entry对象。
如果使用ThreadLocal的set方法之后，没有显示的调用remove方法，就有可能发生内存泄露，所以养成良好的编程习惯十分重要，使用完ThreadLocal之后，记得调用remove方法。
ThreadLocal<String> localName = new ThreadLocal();
try {
localName.set("Sincerity");
} finally {
localName.remove();
}
