Android多线程：手把手带你深入了解线程变量ThreadLocal

淡淡的烟草味﹌ 2022-05-14 04:52 276阅读 0赞

![fedcf827170b012c679b233fbf30c8bb.png][]

# 前言 #

*  在 `Java`多线程中，线程变量`ThreadLocal`非常重要，但对于很多开发者来说，这并不容易理解，甚至觉得有点神秘
 *  今天，我将献上一份 **`ThreadLocal`的介绍 & 实战攻略**，希望你们会喜欢。

> **Carson带你学多线程系列**  
> 基础汇总  
> [Android多线程：基础知识汇总][Android]  
> 基础使用  
> [Android多线程：继承Thread类使用(含实例教程)][Android_Thread]  
> [Android多线程：实现Runnable接口使用(含实例教程)][Android_Thread]  
> 复合使用  
> [Android多线程：AsyncTask使用教程(含实例讲解)][Android_AsyncTask]  
> [Android多线程：AsyncTask的原理及源码分析][Android_AsyncTask 1]  
> [Android多线程：HandlerThread使用教程(含实例讲解)][Android_HandlerThread]  
> [Android多线程：HandlerThread原理及源码分析][Android_HandlerThread 1]  
> [Android多线程：IntentService使用教程(含实例讲解)][Android_IntentService]  
> [Android多线程：IntentService的原理及源码分析][Android_IntentService 1]  
> [Android多线程：线程池ThreadPool全方位教学][Android_ThreadPool]  
> 相关使用  
> [Android异步通信：这是一份全面&详细的Handler机制学习攻略][Android_Handler]  
> [Android多线程：手把手教你全面学习神秘的Synchronized关键字][Android_Synchronized]  
> [Android多线程：带你了解神秘的线程变量 ThreadLocal][Android_ ThreadLocal]

--------------------

# 目录 #

![示意图][d332a1a0fc2d4c300544b014f218f243.png]

--------------------

# 1. 简介 #

![示意图][b6f657a8aa4158c25f50b22013cca492.png]

--------------------

# 2. 使用流程 #

主要是创建`ThreadLocal`变量 & 访问`ThreadLocal`变量

### 2.1 创建ThreadLocal变量 ###

共有3种方式，具体如下

// 1. 直接创建对象
    private ThreadLocal myThreadLocal = new ThreadLocal()
    
    // 2. 创建泛型对象
    private ThreadLocal myThreadLocal = new ThreadLocal<String>();
    
    // 3. 创建泛型对象 & 初始化值
    // 指定泛型的好处：不需要每次对使用get()方法返回的值作强制类型转换
    private ThreadLocal myThreadLocal = new ThreadLocal<String>() {
        @Override
        protected String initialValue() {
            return "This is the initial value";
        }
    };
    
    // 特别注意：
    // 1. ThreadLocal实例 = 类中的private、static字段
    // 2. 只需实例化对象一次 & 不需知道它是被哪个线程实例化
    // 3. 每个线程都保持 对其线程局部变量副本 的隐式引用
    // 4. 线程消失后，其线程局部实例的所有副本都会被垃圾回收（除非存在对这些副本的其他引用）
    // 5. 虽然所有的线程都能访问到这个ThreadLocal实例，但是每个线程只能访问到自己通过调用ThreadLocal的set（）设置的值
     // 即 哪怕2个不同的线程在同一个`ThreadLocal`对象上设置了不同的值，他们仍然无法访问到对方的值

#### 2.2 访问ThreadLocal变量 ####

// 1. 设置值：set()
    // 需要传入一个Object类型的参数
    myThreadLocal.set("初始值”);
    
    // 2. 读取ThreadLocal变量中的值：get()
    // 返回一个Object对象
    String threadLocalValue = (String) myThreadLocal.get();

--------------------

# 3. 具体使用 #

以下则是测试代码

public class ThreadLocalTest {
    
            // 测试代码
            public static void main(String[] args){
                // 新开2个线程用于设置 & 获取 ThreadLoacl的值
                MyRunnable runnable = new MyRunnable();
                new Thread(runnable, "线程1").start();
                new Thread(runnable, "线程2").start();
            }
    
            // 线程类
            public static class MyRunnable implements Runnable {
    
                // 创建ThreadLocal & 初始化
                private ThreadLocal<String> threadLocal = new ThreadLocal<String>(){
                    @Override
                    protected String initialValue() {
                        return "初始化值";
                    }
                };
    
                @Override
                public void run() {
    
                    // 运行线程时，分别设置 & 获取 ThreadLoacl的值
                    String name = Thread.currentThread().getName();
                    threadLocal.set(name + "的threadLocal"); // 设置值 = 线程名
                    try {
                        Thread.sleep(1000);
                    } catch (InterruptedException e) {
                        e.printStackTrace();
                    }
                    System.out.println(name + "：" + threadLocal.get());
                }
            }
        }

*  测试结果

线程1：线程1的threadLocal
    线程2：线程2的threadLocal
    
    // 从上述结果看出，在2个线程分别设置ThreadLocal值 & 分别获取，结果并未互相干扰

--------------------

# 4. 实现原理 #

*  核心原理  
    `ThreadLocal`类中有1个`Map`（称：`ThreadLocalMap`）：用于存储每个线程 & 该线程设置的存储在`ThreadLocal`变量的值

> 1.  `ThreadLocalMap`的键`Key` = 当前`ThreadLocal`实例、值`value` = 该线程设置的存储在`ThreadLocal`变量的值
> 2.  该`key`是 `ThreadLocal`对象的弱引用；当要抛弃掉`ThreadLocal`对象时，垃圾收集器会忽略该 `key`的引用而清理掉`ThreadLocal`对象

*  关于如何设置 & 获取 `ThreadLocal`变量里的值，具体请看下面的源码分析

> 请直接看代码注释

// ThreadLocal的源码
    
    public class ThreadLocal<T> {
    
    	...
    
      /** 
        * 设置ThreadLocal变量引用的值
        *  ThreadLocal变量引用 指向 ThreadLocalMap对象，即设置ThreadLocalMap的值 = 该线程设置的存储在ThreadLocal变量的值
        *  ThreadLocalMap的键Key = 当前ThreadLocal实例
        *  ThreadLocalMap的值 = 该线程设置的存储在ThreadLocal变量的值
        **/  
        public void set(T value) {
          
            // 1. 获得当前线程
            Thread t = Thread.currentThread();
    
            // 2. 获取该线程的ThreadLocalMap对象 ->>分析1
            ThreadLocalMap map = getMap(t);
    
            // 3. 若该线程的ThreadLocalMap对象已存在，则替换该Map里的值；否则创建1个ThreadLocalMap对象
            if (map != null)
                map.set(this, value);// 替换
            else
                createMap(t, value);// 创建->>分析2
        }
    
      /** 
        * 获取ThreadLocal变量里的值
        * 由于ThreadLocal变量引用 指向 ThreadLocalMap对象，即获取ThreadLocalMap对象的值 = 该线程设置的存储在ThreadLocal变量的值
        **/ 
        public T get() {
    
            // 1. 获得当前线程
            Thread t = Thread.currentThread();
    
            // 2. 获取该线程的ThreadLocalMap对象
            ThreadLocalMap map = getMap(t);
    
            // 3. 若该线程的ThreadLocalMap对象已存在，则直接获取该Map里的值；否则则通过初始化函数创建1个ThreadLocalMap对象
            if (map != null) {
                ThreadLocalMap.Entry e = map.getEntry(this);
                if (e != null)
                    return (T)e.value; // 直接获取值
            }
            return setInitialValue(); // 初始化
        }
    
      /** 
        * 初始化ThreadLocal的值
        **/ 
        private T setInitialValue() {
    
            T value = initialValue();
    
            // 1. 获得当前线程
            Thread t = Thread.currentThread();
    
            // 2. 获取该线程的ThreadLocalMap对象
            ThreadLocalMap map = getMap(t);
    
             // 3. 若该线程的ThreadLocalMap对象已存在，则直接替换该值；否则则创建
            if (map != null)
                map.set(this, value); // 替换
            else
                createMap(t, value); // 创建->>分析2
            return value;
        }
    
    
      /** 
        * 分析1：获取当前线程的threadLocals变量引用
        **/ 
        ThreadLocalMap getMap(Thread t) {
            return t.threadLocals;
        }
    
      /** 
        * 分析2：创建当前线程的ThreadLocalMap对象
        **/ 
        void createMap(Thread t, T firstValue) {
        // 新创建1个ThreadLocalMap对象 放入到 Thread类的threadLocals变量引用中：
            // a. ThreadLocalMap的键Key = 当前ThreadLocal实例
            // b. ThreadLocalMap的值 = 该线程设置的存储在ThreadLocal变量的值
            t.threadLocals = new ThreadLocalMap(this, firstValue);
            // 即 threadLocals变量 属于 Thread类中 ->> 分析3
        }
    
      
        ...
    }
    
      /** 
        * 分析3：Thread类 源码分析
        **/ 
    
        public class Thread implements Runnable {
           ...
    
           ThreadLocal.ThreadLocalMap threadLocals = null;
           // 即 Thread类持有threadLocals变量
           // 线程类实例化后，每个线程对象拥有独立的threadLocals变量变量
           // threadLocals变量在 ThreadLocal对象中 通过set（） 或 get（）进行操作
    
           ...
    }

--------------------

# 5. 额外补充 #

### 5.1 ThreadLocal如何做到线程安全 ###

*  每个线程拥有自己独立的`ThreadLocals`变量（指向`ThreadLocalMap`对象 ）
 *  每当线程 访问 `ThreadLocals`变量时，访问的都是各自线程自己的`ThreadLocalMap`变量（键 - 值）
 *  `ThreadLocalMap`变量的键 `key` = 唯一 = 当前`ThreadLocal`实例

上述3点 保证了线程间的数据访问隔离，即线程安全

*  测试代码

*  测试结果

线程1：线程1的threadLocal
    线程2：线程2的threadLocal
    
    // 从上述结果看出，在2个线程分别设置ThreadLocal值 & 分别获取，结果并未互相干扰

### 5.2 与同步机制的区别 ###

![示意图][3e17e81a035a5a369c23357a12e3c8ed.png]

--------------------

# 6. 总结 #

*  本文全面讲解了`Java`多线程`ThreadLocal`的相关知识
 *  **Carson带你学多线程系列**

> 基础汇总  
> [Android多线程：多线程基础知识汇总][Android]  
> 基础使用  
> [Android多线程：继承Thread类使用(含实例教程)][Android_Thread]  
> [Android多线程：实现Runnable接口使用(含实例教程)][Android_Thread]  
> 复合使用  
> [Android多线程：AsyncTask使用教程(含实例讲解)][Android_AsyncTask]  
> [Android多线程：AsyncTask的原理及源码分析][Android_AsyncTask 1]  
> [Android多线程：HandlerThread使用教程(含实例讲解)][Android_HandlerThread]  
> [Android多线程：HandlerThread的原理及源码分析][Android_HandlerThread 1]  
> [Android多线程：IntentService使用教程(含实例讲解)][Android_IntentService]  
> [Android多线程：IntentService的原理及源码分析][Android_IntentService 1]  
> [Android多线程：线程池ThreadPool全方位教学][Android_ThreadPool]  
> 相关使用  
> [Android异步通信：这是一份全面&详细的Handler机制学习攻略][Android_Handler]  
> [Android多线程：手把手教你全面学习神秘的Synchronized关键字][Android_Synchronized]  
> [Android多线程：带你了解神秘的线程变量 ThreadLocal][Android_ ThreadLocal]

--------------------

# 欢迎关注Carson\_Ho的[CSDN博客][CSDN] 与 公众号！ #

博客链接：https://carsonho.blog.csdn.net/  
![06b2ed0fbb8979f0aba34c14ede04b59.png][]

--------------------

# 请帮顶 / 评论点赞！因为你的鼓励是我写作的最大动力！ #

[fedcf827170b012c679b233fbf30c8bb.png]: /images/20220514/85ff147c6b1e4de59b148465f63dad72.png
[Android]: https://carsonho.blog.csdn.net/article/details/90166487
[Android_Thread]: https://carsonho.blog.csdn.net/article/details/80506008
[Android_AsyncTask]: https://carsonho.blog.csdn.net/article/details/79314325
[Android_AsyncTask 1]: https://carsonho.blog.csdn.net/article/details/79314326
[Android_HandlerThread]: https://carsonho.blog.csdn.net/article/details/79285760
[Android_HandlerThread 1]: https://carsonho.blog.csdn.net/article/details/52693418
[Android_IntentService]: https://carsonho.blog.csdn.net/article/details/90437126
[Android_IntentService 1]: https://carsonho.blog.csdn.net/article/details/53407806
[Android_ThreadPool]: https://carsonho.blog.csdn.net/article/details/80060201
[Android_Handler]: https://carsonho.blog.csdn.net/article/details/51290360
[Android_Synchronized]: https://blog.csdn.net/carson_ho/article/details/82992269?ops_request_misc=%257B%2522request%255Fid%2522%253A%2522163210663616780271522004%2522%252C%2522scm%2522%253A%252220140713.130102334.pc%255Fblog.%2522%257D&request_id=163210663616780271522004&biz_id=0&utm_medium=distribute.pc_search_result.none-task-blog-2~blog~first_rank_v2~rank_v29-1-82992269.pc_v2_rank_blog_default&utm_term=Synchronized&spm=1018.2226.3001.4450
[Android_ ThreadLocal]: https://blog.csdn.net/carson_ho/article/details/82344011?ops_request_misc=%257B%2522request%255Fid%2522%253A%2522163210666516780261991412%2522%252C%2522scm%2522%253A%252220140713.130102334.pc%255Fblog.%2522%257D&request_id=163210666516780261991412&biz_id=0&utm_medium=distribute.pc_search_result.none-task-blog-2~blog~first_rank_v2~rank_v29-1-82344011.pc_v2_rank_blog_default&utm_term=%E7%BA%BF%E7%A8%8B%E5%8F%98%E9%87%8F&spm=1018.2226.3001.4450
[d332a1a0fc2d4c300544b014f218f243.png]: /images/20220514/fd1d1bc4a2194e6285f4eb4f9ec7660d.png
[b6f657a8aa4158c25f50b22013cca492.png]: /images/20220514/38f416df4529423fa4f5c5897761e7c3.png
[3e17e81a035a5a369c23357a12e3c8ed.png]: /images/20220514/421bebca9ade4c4a81f9d5e5f343539f.png
[CSDN]: https://carsonho.blog.csdn.net/
[06b2ed0fbb8979f0aba34c14ede04b59.png]: /images/20220514/17782cfe9d7846bd84bafa9fa88e3c64.png