ThreadLocal到底有没有内存泄漏？

1. 前言

ThreadLocal 也是一个使用频率较高的类，在框架中也经常见到，比如 Spring。

有关 ThreadLocal 源码分析的文章不少，其中有个问题常被提及：ThreadLocal 是否存在内存泄漏？

不少文章对此讲述比较模糊，经常让人看完脑子还是一头雾水，我也有此困惑。因此找时间跟小伙伴讨论了一番，总算对这个问题有了一定的理解，这里记录和分享一下，希望对有同样困惑的朋友们有所帮助。当然，若有理解不当的地方也欢迎指正。

啰嗦就到这里，下面先从 ThreadLocal 的一个应用场景开始分析吧。

2. 应用场景

ThreadLocal 的应用场景不少，这里举个简单的例子：单点登录拦截。

也就是在处理一个 HTTP 请求之前，判断用户是否登录：

• 若未登录，跳转到登录页面；
• 若已登录，获取并保存用户的登录信息。

先定义一个 UserInfoHolder 类保存用户的登录信息，其内部用 ThreadLocal 存储，示例如下：

public class UserInfoHolder {
    private static final ThreadLocal<Map<String, String>> USER_INFO_THREAD_LOCAL = new ThreadLocal<>();

    public static void set(Map<String, String> map) {
        USER_INFO_THREAD_LOCAL.set(map);
    }
    
    public static Map<String, String> get() {
        return USER_INFO_THREAD_LOCAL.get();
    }
    
    public static void clear() {
        USER_INFO_THREAD_LOCAL.remove();
    }
    
    // ...
}

通过 UserInfoHolder 可以存储和获取用户的登录信息，以便在业务中使用。

Spring 项目中，如果我们想在处理一个 HTTP 请求之前或之后做些额外的处理，通常定义一个类继承 HandlerInterceptorAdapter，然后重写它的一些方法。举例如下（仅供参考，省略了一些代码）：

public class LoginInterceptor extends HandlerInterceptorAdapter {

    // ...
    
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        
        // ...

        // 请求执行前，获取用户登录信息并保存
        Map<String, String> userInfoMap = getUserInfo();

        UserInfoHolder.set(userInfoMap);

        return true;
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        // 请求执行后，清理掉用户信息
        UserInfoHolder.clear();
    }
}

在本例中，我们在处理一个请求之前获取用户的信息，在处理完请求之后，将用户信息清空。应该有朋友在框架或者自己的项目中见过类似代码。

下面我们深入 ThreadLocal 的内部，来分析这些方法做了些什么，跟内存泄漏又是怎么扯上关系的。

3. 源码剖析

3.1 类签名

先从头开始，也就是类签名：

public class ThreadLocal<T> {
}

可见它就是一个普通的类，并没有实现任何接口、也无父类继承。

3.2 构造器

ThreadLocal 只有一个无参构造器：

public ThreadLocal() {
}

此外，JDK 1.8 引入了一个使用 lambda 表达式初始化的静态方法 withInitial，如下：

public static <S> ThreadLocal<S> withInitial(Supplier<? extends S> supplier) {
    return new SuppliedThreadLocal<>(supplier);
}

该方法也可以初始化一个对象，和构造器也比较接近。

3.3 ThreadLocalMap

3.3.1 主要代码

ThreadLocalMap 是 ThreadLocal 的一个内部嵌套类。

由于 ThreadLocal 的主要操作实际都是通过 ThreadLocalMap 的方法实现的，因此先分析 ThreadLocalMap 的主要代码：

public class ThreadLocal<T> {
    // 生成 ThreadLocal 的哈希码，用于计算在 Entry 数组中的位置
    private final int threadLocalHashCode = nextHashCode();

    private static final int HASH_INCREMENT = 0x61c88647;

    private static int nextHashCode() {
        return nextHashCode.getAndAdd(HASH_INCREMENT);
    }

    // ...
    
    static class ThreadLocalMap {

        static class Entry extends WeakReference<ThreadLocal<?>> {
            Object value;
            Entry(ThreadLocal<?> k, Object v) {
                super(k);
                value = v;
            }
        }
    
        // 初始容量，必须是 2 的次幂
        private static final int INITIAL_CAPACITY = 16;
    
        // 存储数据的数组
        private Entry[] table;

        // table 中的 Entry 数量
        private int size = 0;

        // 扩容的阈值
        private int threshold; // Default to 0
    
        // 设置扩容阈值
        private void setThreshold(int len) {
            threshold = len * 2 / 3;
        }    
    
        // 第一次添加元素使用的构造器
        ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
            table = new Entry[INITIAL_CAPACITY];
            int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
            table[i] = new Entry(firstKey, firstValue);
            size = 1;
            setThreshold(INITIAL_CAPACITY);