ThreadLocal 那点事儿
博客专区 > 黄勇 的博客 > 博客详情
ThreadLocal 那点事儿
黄勇 发表于4年前
ThreadLocal 那点事儿
  • 发表于 4年前
  • 阅读 22356
  • 收藏 387
  • 点赞 28
  • 评论 65

标题:腾讯云 新注册用户域名抢购1元起>>>   

ThreadLocal,直译为“线程本地”或“本地线程”,如果你真的这么认为,那就错了!其实,它就是一个容器,用于存放线程的局部变量,我认为应该叫做 ThreadLocalVariable(线程局部变量)才对,真不理解为什么当初 Sun 公司的工程师这样命名。

早在 JDK 1.2 的时代,java.lang.ThreadLocal 就诞生了,它是为了解决多线程并发问题而设计的,只不过设计得有些难用,所以至今没有得到广泛使用。其实它还是挺有用的,不相信的话,我们一起来看看这个例子吧。

一个序列号生成器的程序,可能同时会有多个线程并发访问它,要保证每个线程得到的序列号都是自增的,而不能相互干扰。

先定义一个接口:

public interface Sequence {

    int getNumber();
}

每次调用 getNumber() 方法可获取一个序列号,下次再调用时,序列号会自增。

再做一个线程类:

public class ClientThread extends Thread {

    private Sequence sequence;

    public ClientThread(Sequence sequence) {
        this.sequence = sequence;
    }

    @Override
    public void run() {
        for (int i = 0; i < 3; i++) {
            System.out.println(Thread.currentThread().getName() + " => " + sequence.getNumber());
        }
    }
}

在线程中连续输出三次线程名与其对应的序列号。

我们先不用 ThreadLocal,来做一个实现类吧。

public class SequenceA implements Sequence {

    private static int number = 0;

    public int getNumber() {
        number = number + 1;
        return number;
    }

    public static void main(String[] args) {
        Sequence sequence = new SequenceA();

        ClientThread thread1 = new ClientThread(sequence);
        ClientThread thread2 = new ClientThread(sequence);
        ClientThread thread3 = new ClientThread(sequence);

        thread1.start();
        thread2.start();
        thread3.start();
    }
}

序列号初始值是0,在 main() 方法中模拟了三个线程,运行后结果如下:

Thread-0 => 1
Thread-0 => 2
Thread-0 => 3
Thread-2 => 4
Thread-2 => 5
Thread-2 => 6
Thread-1 => 7
Thread-1 => 8
Thread-1 => 9

由于线程启动顺序是随机的,所以并不是0、1、2这样的顺序,这个好理解。为什么当 Thread-0 输出了1、2、3之后,而 Thread-2 却输出了4、5、6呢?线程之间竟然共享了 static 变量!这就是所谓的“非线程安全”问题了。

那么如何来保证“线程安全”呢?对应于这个案例,就是说不同的线程可拥有自己的 static 变量,如何实现呢?下面看看另外一个实现吧。

public class SequenceB implements Sequence {

    private static ThreadLocal<Integer> numberContainer = new ThreadLocal<Integer>() {
        @Override
        protected Integer initialValue() {
            return 0;
        }
    };

    public int getNumber() {
        numberContainer.set(numberContainer.get() + 1);
        return numberContainer.get();
    }

    public static void main(String[] args) {
        Sequence sequence = new SequenceB();

        ClientThread thread1 = new ClientThread(sequence);
        ClientThread thread2 = new ClientThread(sequence);
        ClientThread thread3 = new ClientThread(sequence);

        thread1.start();
        thread2.start();
        thread3.start();
    }
}

通过 ThreadLocal 封装了一个 Integer 类型的 numberContainer 静态成员变量,并且初始值是0。再看 getNumber() 方法,首先从 numberContainer 中 get 出当前的值,加1,随后 set 到 numberContainer 中,最后将 numberContainer 中 get 出当前的值并返回。

是不是很恶心?但是很强大!确实稍微饶了一下,我们不妨把 ThreadLocal 看成是一个容器,这样理解就简单了。所以,这里故意用 Container 这个单词作为后缀来命名 ThreadLocal 变量。

运行结果如何呢?看看吧。

Thread-0 => 1
Thread-0 => 2
Thread-0 => 3
Thread-2 => 1
Thread-2 => 2
Thread-2 => 3
Thread-1 => 1
Thread-1 => 2
Thread-1 => 3

每个线程相互独立了,同样是 static 变量,对于不同的线程而言,它没有被共享,而是每个线程各一份,这样也就保证了线程安全。 也就是说,TheadLocal 为每一个线程提供了一个独立的副本!

搞清楚 ThreadLocal 的原理之后,有必要总结一下 ThreadLocal 的 API,其实很简单。

  1. public void set(T value):将值放入线程局部变量中
  2. public T get():从线程局部变量中获取值
  3. public void remove():从线程局部变量中移除值(有助于 JVM 垃圾回收)
  4. protected T initialValue():返回线程局部变量中的初始值(默认为 null) 

为什么 initialValue() 方法是 protected 的呢?就是为了提醒程序员们,这个方法是要你们来实现的,请给这个线程局部变量一个初始值吧。

了解了原理与这些 API,其实想想 ThreadLocal 里面不就是封装了一个 Map 吗?自己都可以写一个 ThreadLocal 了,尝试一下吧。

public class MyThreadLocal<T> {

    private Map<Thread, T> container = Collections.synchronizedMap(new HashMap<Thread, T>());

    public void set(T value) {
        container.put(Thread.currentThread(), value);
    }

    public T get() {
        Thread thread = Thread.currentThread();
        T value = container.get(thread);
        if (value == null && !container.containsKey(thread)) {
            value = initialValue();
            container.put(thread, value);
        }
        return value;
    }

    public void remove() {
        container.remove(Thread.currentThread());
    }

    protected T initialValue() {
        return null;
    }
}
以上完全山寨了一个 ThreadLocal,其中中定义了一个同步 Map(为什么要这样?请读者自行思考),代码应该非常容易读懂。

下面用这 MyThreadLocal 再来实现一把看看。

public class SequenceC implements Sequence {

    private static MyThreadLocal<Integer> numberContainer = new MyThreadLocal<Integer>() {
        @Override
        protected Integer initialValue() {
            return 0;
        }
    };

    public int getNumber() {
        numberContainer.set(numberContainer.get() + 1);
        return numberContainer.get();
    }

    public static void main(String[] args) {
        Sequence sequence = new SequenceC();

        ClientThread thread1 = new ClientThread(sequence);
        ClientThread thread2 = new ClientThread(sequence);
        ClientThread thread3 = new ClientThread(sequence);

        thread1.start();
        thread2.start();
        thread3.start();
    }
}

以上代码其实就是将 ThreadLocal 替换成了 MyThreadLocal,仅此而已,运行效果和之前的一样,也是正确的。

其实 ThreadLocal 可以单独成为一种设计模式,就看你怎么看了。 

ThreadLocal 具体有哪些使用案例呢?

我想首先要说的就是:通过 ThreadLocal 存放 JDBC Connection,以达到事务控制的能力。

如何实现呢?下回分解!

ThreadLocal 那点事儿(续集)

注意:当您在一个类中使用了 static 成员变量的时候,一定要多问问自己,这个 static 成员变量需要考虑“线程安全”吗?(也就是说,多个线程需要独享自己的 static 成员变量吗?)如果需要考虑,那就请用 ThreadLocal 吧!

共有 人打赏支持
黄勇
粉丝 5704
博文 114
码字总数 196279
作品 1
评论 (65)
贺路的路
不错,例子觉得很好 ~~
小白小霸王
期待类似Spring的事务嵌套

https://github.com/nutzam/nutz/blob/master/src/org/nutz/trans/Trans.java
黄勇

引用来自“贺路的路”的评论

不错,例子觉得很好 ~~

谢谢!现在我在学习 JDBC 事务控制,所以不得不分享一下有关 ThreadLocal 这个好东西。希望对大家有帮助。
要命科技技术有限公司
感觉第一个例子和ThreadLocal 无关
黄勇

引用来自“光头程序员”的评论

期待类似Spring的事务嵌套

https://github.com/nutzam/nutz/blob/master/src/org/nutz/trans/Trans.java

Spring 太强悍,恐怕本人水品有限,不过还是要努力啊!
黄勇

引用来自“Gelopa”的评论

感觉第一个例子和ThreadLocal 无关

你指的第一个例子是 SequenceA 吗?这是一个反面教材,故意没有用 ThreadLocal 的,结果证明这样做是错误的。
贺路的路
百度得到 “如果每次运行结果和单线程运行的结果是一样的,而且其他的变量的值也和预期的是一样的,就是线程安全的。” 按照这个说法,第一个例子才是线程安全的,是吗?
黄勇
刚刚更新了博文,山寨了一个 TheadLocal。
@贺路的路 @光头程序员 @Gelopa
黄勇

引用来自“贺路的路”的评论

百度得到 “如果每次运行结果和单线程运行的结果是一样的,而且其他的变量的值也和预期的是一样的,就是线程安全的。” 按照这个说法,第一个例子才是线程安全的,是吗?

第一个例子显然是不对的啦,同一个 static 变量,在这里被多个线程共享了,线程1修改了 static 变量,会影响到线程2。只能说对于这个案例而言,是不合理的。这个案例必须要保证线程安全!
吴下阿吉

引用来自“贺路的路”的评论

百度得到 “如果每次运行结果和单线程运行的结果是一样的,而且其他的变量的值也和预期的是一样的,就是线程安全的。” 按照这个说法,第一个例子才是线程安全的,是吗?

我觉得你对于你所引用的那句话的理解有误。
Echo_me
ThreadLocal在开源框架中都有运用...我的理解是一个Map容器,视作其key是当前线程,value就是我们想保证数据安全一致的某对象
在云端-看世间变幻
ThreadLocal就像是超市全部的寄包柜,每个线程只有拿着自己的钥匙才能打开属于自己的空间。
黄开源中国
关注下楼主。最近几篇文章都有留意。加油~!
hawkyoung

引用来自“在云端-看世间变幻”的评论

ThreadLocal就像是超市全部的寄包柜,每个线程只有拿着自己的钥匙才能打开属于自己的空间。

恩,我也是这么理解的。网上还有一些误导的文章说ThreadLocal是用来解决并发或者共享资源的,ThreadLocal保存的东西大家各拿各的,压根就不共享。
hawkyoung
不同的线程可拥有自己的 static 变量 这例子举的很好
shinwell
写得相当赞!
sjack
0 、 0 ~ 写得简洁思米大
黄勇

引用来自“Echo_陌上婲開”的评论

ThreadLocal在开源框架中都有运用...我的理解是一个Map容器,视作其key是当前线程,value就是我们想保证数据安全一致的某对象

理解非常准确!
黄勇

引用来自“在云端-看世间变幻”的评论

ThreadLocal就像是超市全部的寄包柜,每个线程只有拿着自己的钥匙才能打开属于自己的空间。

这个比喻太精辟了!和超市寄包柜不一样的是,ThreadLocal 永远都不会告诉你“包柜已满”,哈!
徒伤悲
MyThreadLocal类中的map岂不是越来越大?何时释放内存是我特别关心的。
×
黄勇
如果觉得我的文章对您有用,请随意打赏。您的支持将鼓励我继续创作!
* 金额(元)
¥1 ¥5 ¥10 ¥20 其他金额
打赏人
留言
* 支付类型
微信扫码支付
打赏金额:
已支付成功
打赏金额: