【JUC】二十四、线程局部变量ThreadLocal

1、ThreadLocal

ThreadLocal提供线程局部变量，这些变量与正常的变量不同，因为每一个线程在访问ThreadLocal实例的时候（通过其get或set方法），都有自己的、独立初始化的变量副本。ThreadLocal实例通常是类中的私有静态字段，使用它的目的是希望将某些状态（例如用户ID或事务ID）与线程关联起来。

实现每一个线程都有自己专属的本地变量副本（自己用自己的变量不麻烦别人，不和其他人共享，人人有份，人各一份），主要解决了让每个线程绑定自己的值，通过使用get和set方法，获取默认值或将其值更改为当前线程所存的副本的值，从而避免了线程安全问题，比如之前synchronized的8种case，资源类是使用同一部手机，多个线程抢夺同一部手机使用，假如每个线程人手一份不就天下太平了。

对于线程T，有些信息，没必要写回主内存，也不需要和别的线程共享。比如下面这个游戏里，三个玩家，对应三个线程，玩家的生命值、攻击值等值就属于这类数据。

一句话，记录只属于线程t自身的一些东西。

2、常用方法

• 构造方法

ThreadLocal()

• 返回当前线程的ThreadLocal中的值

T get()

• 返回此ThreadLocal的当前线程的初始值

protected T initialValue();

• 删除此ThreadLocal的当前线程的初始值

void remove();

• 设置ThreadLocal的当前线程副本值

void set(T value)

• 创建一个ThreadLocal

static <S> ThreadLocal<S> withInitial(Supplier<? extends S> supplier)

创建ThreadLocal对象的方式：

使用构造方法创建时，建议重写写initialValue方法，给一个ThreadLocal的初始值，因为源码中return的是null，用起来可能导致空指针。

ThreadLocal<Integer> saleValue = new ThreadLocal<Integer>(){
        @Override
        protected Integer initialValue() {
            return 0;   //指定ThreadLocal的初始值
        }
};

也可使用上面的静态方法，传入一个供给式函数接口，指定初始值：

ThreadLocal<Integer> saleValue = ThreadLocal.withInitial(() -> 0);

以上两种方法一个意思，后者更清爽。

3、案例

需求：5个销售卖房子，集团高层只关心销售总量的准确统计数，按照总销售额统计，方便集团公司给部门发送奖金。

//资源类
public class House {

    int saleCount = 0;
    public synchronized void saleHouse(){
        ++saleCount;
    }

}

@Slf4j
public class ThreadLocalDemo {
    public static void main(String[] args) throws InterruptedException {
        House house = new House();
        CountDownLatch countDownLatch = new CountDownLatch(5);
        for (int i = 1; i <= 5; i++) {
            new Thread(() -> {
                //随机数模拟每个销售卖出房子的数量
                int number = new Random().nextInt(6) + 1;
                log.info("销售{}卖出{}套", Thread.currentThread().getName(), number);
                for (int j = 1; j <= number; j++) {
                    house.saleHouse();
                }
                countDownLatch.countDown();
            }, String.valueOf(i)).start();

        }
        countDownLatch.await();
        log.info("该部门总共卖出房子数量：{}", house.saleCount);
    }
}

现在需求变更，希望部门里的所有销售各自分灶吃饭，即各凭销售本事提成，按照出单数各自统计每个人的销售额：

//资源类
public class House {

    int saleCount = 0;
    public synchronized void saleHouse(){
        ++saleCount;
    }
    ThreadLocal<Integer> saleValue = ThreadLocal.withInitial(() -> 0);
    //操作的是ThreadLocal变量，每个线程一份，无安全问题一说，自然无关synchronized
    public void saveValueByThreadLocal(){
        saleValue.set(saleValue.get() + 1);
    }
    

}

上面操作的是共享资源类的ThreadLocal变量，每个线程一份，因此无安全问题一说，自然无关synchronized。

运行：

可以看到ThreadLocal计算线程自身的属性值，不加锁，结果依然正确。

4、线程池下必须remove掉线程的LocalThread值

必须回收自定义的 ThreadLocal变量的值，尤其在线程池场景下，线程经常会被复用，==如果不清理自定义的 ThreadLocal 变量，可能会影响后续业务逻辑结果，以及造成内存泄露等问题。==可使用try-finally 块进行回收。

PS：内存泄漏，即已经申请的内存空间无法释放，就会造成内存泄漏，例如线程死循环、资源不关闭等，大量的内存泄漏堆积就会造成内存不够，从而发生内存溢出。

//正例
myThreadLocal.set(xxx);
try{

	//...
	
}finally{

	myThreadLocal.remove();
	
}

比如，上面案例可改为：

以上Demo里的线程每次都是新建的，所以这个无影响。如果是线程池，则remove是必须的。先看不加remove：

//错误写法，不remove
@Slf4j
public class ThreadLocalDemo2 {
    public static void main(String[] args) {
        ExecutorService pool = Executors.newFixedThreadPool(3);
        MyData myData = new MyData();
        for (int i = 1; i <= 10; i++) {
            System.out.println(pool.submit(() -> {
                log.warn("线程==> {}", Thread.currentThread().getName());
                log.info("初始数据：{}", myData.threadLocal.get());
                myData.add();
                log.info("改完后数据：{}", myData.threadLocal.get());
            }, String.valueOf(i)));

        }
    }
}

结果累加：

加了remove：

5、Thread、ThreadLocal、ThreadLocalMap

大致看下三者的关系：

即：

ThreadLocalMap实际就是一个以ThreadLocal为key，传入的值为value的Entry对象。当给ThreadLocal类型变量赋值，就是以当前ThreadLocal实例对象为key，值为value的Entry放入这个ThreadLocalMap中。

资源类中有一个ThreadLocal类型的属性，即每个线程Thread过来，都会有

Thread、ThreadLocal、ThreadLocalMap可类比成：人、人的身份证、身份证上的信息，更确切的说，ThreadLocalMap是身份证为key：名字为value的键值对（ThreadLocal为key，赋的值为value）

ThreadLocalMap从字面上就可以看出这是一个保存ThreadLoca对象的map(其实是以ThreadLocal为Key)，不过是经过了两层包装的ThreadLocal对象：

而JVM内部，则是维护了一个线程版的Map<ThreadLocal,Value>(通过ThreadLocal对象的set方法，结果把ThreadLocal对象自己当做key放进了ThreadLoalMap中)，每个线程要用到这个T的时候，用当前的线程去Map里面获取，如此，每个线程都拥有了自己独立的变量，人手一份，竞争条件被彻底消除，没有竞争一说，在并发模式下是绝对安全的变量。

6、Thread、ThreadLocal、ThreadLocalMap的关系

Thread 中持有一个ThreadLocalMap ，这里你可以简单理解为就是持有一个数组，这个数组是Entry 类型的。 Entry 的key 是ThreadLocal 类型的，value 是Object 类型。 也就是一个ThreadLocalMap 可以持有多个ThreadLocal。