ThreadLocal 学习总结

什么是ThreadLocal

ThreadLocal是Therad的局部变量的维护类，在Java中是作为一个特殊的变量存储在。当使用ThreadLocal维护变量时，ThreadLocal为每个使用该变量的线程提供独立的变量副本，所以每一个线程都可以独立地改变自己的副本，而不会影响其它线程所对应的副本。

因为每个Thread内有自己的实例副本，且该副本只能由当前Thread使用，也就不存在多线程间共享的问题。

总的来说，ThreadLocal适用于每个线程需要自己独立的实例且该实例需要在多个方法中被使用，也即变量在线程间隔离而在方法或类间共享的场景。

一个线程内可以存多个ThreadLocal对象，存储的位置位于Thread的ThreadLocal.ThreadLocalMap变量

泄露原因分析

正常来说，当Thread执行完，会被销毁，Thread.threadLocals指向的ThreadLocalMap实例也随之变为垃圾，它里面存放的Entity也会被回收。这种情况是不会发生内存泄漏的。

发生内存泄露的场景一般存在于线程池的情况下。此时，Thread生命周期比较长（存在循环使用），threadLocals引用一直存在，当其存放的ThreadLocal被回收（弱引用生命周期比较短）后，对应的Entity就成了key为null的实例，但value值不会被回收。如果此Entity一直不被get()、set()、remove()，就一直不会被回收，也就发生了内存泄漏。

所以，通常在使用完ThreadLocal后需要调用remove()方法进行内存的清除。

线程池如何传递ThreadLocal

1、JDK对跨线程传递ThreadLocal的支持

首先看一个最简单场景，也是一个错误的例子。

    void testThreadLocal(){
        ThreadLocal<Object> threadLocal = new ThreadLocal<>();
        threadLocal.set("not ok");
        new Thread(()->{
            System.out.println(threadLocal.get());
        }).start();
    }

复制

java中的threadlocal，是绑定在线程上的。你在一个线程中set的值，在另外一个线程是拿不到的。

上面的输出是:

null

1.1 InheritableThreadLocal 例子

JDK考虑了这种场景，实现了InheritableThreadLocal ,不要高兴太早,这个只是支持父子线程，线程池会有问题。

我们看下InheritableThreadLocal的例子：

        InheritableThreadLocal<String> itl = new InheritableThreadLocal<>();
        itl.set("father");
        new Thread(()->{
            System.out.println("subThread:" + itl.get());
            itl.set("son");
            System.out.println(itl.get());
        }).start();

        Thread.sleep(500);//等待子线程执行完

        System.out.println("thread:" + itl.get());

复制

上面的输出是：

subThread:father //子线程可以拿到父线程的变量

son

thread:father //子线程修改不影响父线程的变量

1.2、真正的解决方案：阿里的TransmittableThreadLocal了解一下

提供了增强的InheritableThreadLocal，即使使用线程池组件也可以在线程之间传输值。

ThreadLocal应用场景

最后，我们再来回顾一下ThreadLocal的应用场景：

• 线程间数据隔离，各线程的ThreadLocal互不影响；
• 方便同一个线程使用某一对象，避免不必要的参数传递；
• 全链路追踪中的traceId或者流程引擎中上下文的传递一般采用ThreadLocal；
• Spring事务管理器采用了ThreadLocal；
• Spring MVC的RequestContextHolder的实现使用了ThreadLocal；

具体的使用例子：

使用ThreadLocal在线程间传递参数
使用场景
用户参数透传，如租户ID，tid，userID，Token等。这些参数与具体业务无关，但是又是必须的（如：租户ID，在数据落库时需要传入，但是在其他业务代码中基本用不到）如果作为方法的参数一层一层向下传递，必然造成代码的冗余和扩展性查等影响。

1.使用ThreadLocal结合过滤器
大致思路：在请求接口时，租户ID往往可以从Token或用户信息中取出，这时，在请求拦截器中，将用户TenantID取出，放入线程中。后面在需要TenantID时，直接从线程中取出，这样，既保证了简洁性也增加了易用性。

2.Pom依赖

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>transmittable-thread-local</artifactId>
    <version>2.11.4</version>
</dependency>

3.RequestFilter
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
import org.springframework.web.filter.GenericFilterBean;

import javax.servlet.FilterChain;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Slf4j
@Component
@Order(Ordered.HIGHEST_PRECEDENCE)
public class TenantContextHolderFilter extends GenericFilterBean {

    @Override
    @SneakyThrows
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) {
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        HttpServletResponse response = (HttpServletResponse) servletResponse;
    // 从Token/Header/param中获取租户ID
        String headerTenantId = request.getHeader("TENANT_ID");

        log.debug("TenantContextHolderFilter|header中的TENANT_ID为:{}", headerTenantId);

    // 判断逻辑，自行定义
        if (headerTenantId != null && headerTenantId != "" && !headerTenantId.equals("null")) {
            TenantContextHolder.setTenantId(Integer.parseInt(headerTenantId));
    } else {
      // 默认值
            TenantContextHolder.setTenantId(0);
        }
        filterChain.doFilter(request, response);
    // 请求结束，一定要清除线程中自己设置的参数。
        TenantContextHolder.clear();
    }

}

4.TenantContextHolder
@UtilityClass
public class TenantContextHolder {

    private final ThreadLocal<Integer> THREAD_LOCAL_TENANT = new TransmittableThreadLocal<>();

    /**
     * TTL 设置租户ID<br/>
     * @param tenantId
     */
    public void setTenantId(Integer tenantId) {
        THREAD_LOCAL_TENANT.set(tenantId);
    }

    /**
     * 获取TTL中的租户ID
     * @return
     */
    public Integer getTenantId() {
        return THREAD_LOCAL_TENANT.get();
    }

    /**
     * 清除当前线程中的租户
     * 慎用
     */
    public void clear() {
        THREAD_LOCAL_TENANT.remove();
    }

}

5.使用

在具体的Controller，Service，Mapper中，只要是当前请求的线程，都是可以直接使用TenantContextHolder.getTenantId()获取租户ID的。