ThreadLocal(中) ThreadLocal内部方法实现原理

ThreadLocal实现原理

下面是ThreadLocal相关类的类结构图，如图:

由该图可知，Thread类中有一个threadLocals和一个inheritableThreadLocals，它们都是ThreadLocalMap类型的变量，而ThreadLocalMap是一个定制化的HashMap。在默认情况下，每个线程中的这两个变量都为null，只有当线程第一次调用ThreadLocal的set()或get()方法时才华创建它们。其实每个线程的本地变量不是存放在ThreadLocal实例里面，而是存放在具体线程内存空间中。ThreadLocal就是一个工具壳，它通过set方法把value值放入调用线程的threadLocals里面并存放起来，当调用线程调用它的get方法时，再从当前线程的threadLocals变量里面将其拿出来使用。如果调用线程一直不重质，那么这个本地变量会一直存放在调用线程的threadLocals变量里面，所以当不需要使用本地变量的时候可以通过调用ThreadLocal变量的remove()方法，从当前线程的threadLocals里面删除该本地变量。另外，Thread里面的threadLocals为何被设计为map结构？很明显是因为每个线程可以惯量多个ThreadLocal变量。

下面简单分析ThreadLocal的set，get以及remove方法的实现逻辑。

void set(T value)

public void set(T value) {
    // (1) 获取当前线程
    Thread t = Thread.currentThread();
    // (2) 将当前线程作为key，去查找对应的线程变量，找到则设置
    ThreadLocalMap map = getMap(t);
    if (map != null) 
        map.set(this, value);
    else
        // (3) 第一次调用就创建当前线程对应的HashMap
        createMap(t, value);
}

代码 (1) 首先获取调用线程，然后使用当前线程作为参数调用getMap(t)方法，getMap(Thread t)的代码如下。

ThreadLocalMap getMap(Thread t) {
    return t.threadLocals;
}

可以看到，getMap(t)的作用时获取线程自己的变量threadLocals，threadLocal变量被绑定到了线程的成员变量上。

如果getMap(t)的返回值不为空，则把value值设置到threadLocals中，也就是把当前变量放入当前线程的内存变量threadLocals中。threadLocals是一个HashMap结构，其中key就是当前ThreadLocal的实例对象引用，value是通过set方法传递值。

如果getMap(t)返回值为空则说明是第一次调用set方法，这时创建当前线程的threadLocals变量。下面来看createMap(t, value)做什么。

void createMap(Thread t, T firstValue) {
	t.threadLocals = new ThreadLocalMap(this, firstValue);
}

它创建当前线程的threadLocals变量。

T get()

public T get() {
	// (1) 获取当前线程
	Thread t = Thread.currentThread();
	// (2) 获取当前线程的threadLocals变量
	ThreadLocalMap map = getMap(t);
	// (3) 如果threadLocals不为null，则返回对应本地变量的值
	if (map != null) {
		ThreadLocalMap.Entity e = map.getEntity(this);
		if (e != null) {
			@SuppressWrarnings("unchecked")
			T result = (T)e.value;
			return result;
		}
	}
	
	// (4) threadLocals为空则初始化当前线程的threadLocals成员变量
	return setInitialValue();
	
}

代码 (1) 首先获取当前线程实例，如果当前线程的threadLocals变量不为null，则直接返回当前线程绑定的本地线程变量，负责执行代码 (4) 进行初始化。setInitialValue() 的代码如下。

private T setInitialValue() {
    // (5) 初始化为null
    T value = initialValue();
    Thread t = Thread.currentThread();
    ThreadLocalMap map = getMap(t);
    // (6) 如果当前线程的threadLocals不为空
    if (map != null)
    	map.set(this, value);
    else
    // (7) 如果当前线程的threadLocals变量为空
    	createMap(t, value);
    return value;
}


protected T initialValue() {
    return null;
}

如果当前线程的threadLocals变量不为空，则设置当前线程的本地线程变量值为null，否则调用createMap方法创建当前线程的createMap变量。

void remove()

public void remove() {
	ThreadLocalMap m = getMap(Thread.currentThread());
	if (m != null)
		m.remove(this);
}

以上代码所示，如果当前线程的threadLocals变量不为空，则删除当前线程中指定ThreadLocal实例的本地变量。‘

总结：

在每个线程内部都有一个名为threadLocals的成员变量，该变量的类型为HashMap，其中key为我们定义的ThreadLocal变量的this引用，value则为我们使用set方法设置的值。 每个线程本地变量存放在线程自己的内存变量threadLocals中，如果当前线程一直不消亡，那么这些本地变量会一直存在，所以可能会造成内存溢出，因此使用完毕后要记得调用ThreadLocal的remove方法删除对应线程的threadLocals中的本地变量。