ThreadLocal

最新推荐文章于 2022-04-04 19:33:48 发布

javashareauthor

最新推荐文章于 2022-04-04 19:33:48 发布

阅读量597

点赞数 1

分类专栏： ThreadLocal 文章标签： ThreadLocal

本文链接：https://blog.youkuaiyun.com/javashareauthor/article/details/105367974

版权

ThreadLocal 专栏收录该内容

0 篇文章

订阅专栏

本文通过一个线上遇到的ThreadLocal问题，阐述了在Tomcat线程池环境中，ThreadLocal可能出现的线程安全问题和内存泄漏。当线程被重用时，未清除的ThreadLocal可能导致不同用户间数据串扰。为了解决这个问题，建议在finally块中显式清除ThreadLocal数据，以避免内存泄露和数据错乱。同时，讨论了在需要线程间共享资源时，应使用线程安全的容器。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

在线上的时候遇到一个关于ThreadLocal的问题，伪代码如下：


private static final ThreadLocal<Integer> currentUser = ThreadLocal.withInitial(() -> null);


@GetMapping("wrong")
public Map wrong(@RequestParam("userId") Integer userId) {
    //设置用户信息之前先查询一次ThreadLocal中的用户信息
    String before  = Thread.currentThread().getName() + ":" + currentUser.get();
    //设置用户信息到ThreadLocal
    currentUser.set(userId);
    //设置用户信息之后再查询一次ThreadLocal中的用户信息
    String after  = Thread.currentThread().getName() + ":" + currentUser.get();
    //汇总输出两次查询结果
    Map result = new HashMap();
    result.put("before", before);
    result.put("after", after);
    return result;
}

按理说，在设置用户信息之前第一次获取的值始终应该是 null，但我们要意识到，程序运行在 Tomcat 中，执行程序的线程是 Tomcat 的工作线程，而 Tomcat 的工作线程是基于线程池的。

顾名思义，线程池会重用固定的几个线程，一旦线程重用，那么很可能首次从 ThreadLocal 获取的值是之前其他用户的请求遗留的值。这时，ThreadLocal 中的用户信息就是其他用户的信息。

为了更快地重现这个问题，我在配置文件中设置一下 Tomcat 的参数，把工作线程池最大线程数设置为 1，这样始终是同一个线程在处理请求：


server.tomcat.max-threads=1

运行程序后先让用户 1 来请求接口，可以看到第一和第二次获取到用户 ID 分别是 null 和 1，符合预期：随后用户 2 来请求接口，这次就出现了 Bug，第一和第二次获取到用户 ID 分别是 1 和 2，显然第一次获取到了用户 1 的信息，原因就是 Tomcat 的线程池重用了线程。两次请求的线程都是同一个线程：http-nio-8080-exec-1。这个例子告诉我们，在写业务代码时，首先要理解代码会跑在什么线程上：

我们可能会抱怨学多线程没用，因为代码里没有开启使用多线程。但其实，可能只是我们没有意识到，在 Tomcat 这种 Web 服务器下跑的业务代码，本来就运行在一个多线程环境（否则接口也不可能支持这么高的并发），并不能认为没有显式开启多线程就不会有线程安全问题。
因为线程的创建比较昂贵，所以 Web 服务器往往会使用线程池来处理请求，这就意味着线程会被重用。这时，使用类似 ThreadLocal 工具来存放一些数据时，需要特别注意在代码运行完后，显式地去清空设置的数据。如果在代码中使用了自定义的线程池，也同样会遇到这个问题。

理解了这个知识点后，我们修正这段代码的方案是，在代码的 finally 代码块中，显式清除 ThreadLocal 中的数据。这样一来，新的请求过来即使使用了之前的线程也不会获取到错误的用户信息了。修正后的代码如下：


@GetMapping("right")
public Map right(@RequestParam("userId") Integer userId) {
    String before  = Thread.currentThread().getName() + ":" + currentUser.get();
    currentUser.set(userId);
    try {
        String after = Thread.currentThread().getName() + ":" + currentUser.get();
        Map result = new HashMap();
        result.put("before", before);
        result.put("after", after);
        return result;
    } finally {
        //在finally代码块中删除ThreadLocal中的数据，确保数据不串
        currentUser.remove();
    }
}

ThreadLocal 是利用独占资源的方式，来解决线程安全问题，那如果我们确实需要有资源在线程之间共享，应该怎么办呢？这时，我们可能就需要用到线程安全的容器了。

那么可能你会有疑问，在使用完后ThreadLocal后，又去清空ThreadLocal，这样做的意义是什么呢？原因有两点：

1、防止内存泄露(如果在这里不清空TreadLocal，那么该线程一直持有一个本线程的ThreadLocalMap,并且不会被回收，所以需要在使用完TreadLocal后，将其清空)。

2、防止出现数据错乱（就是上面的案例）。