深入浅出ThreadLocal

一、ThreadLocal概述

       学习JDK中的类，首先看下JDK API对此类的描述，描述如下：

JDK API 写道

该类提供了线程局部 (thread-local) 变量。这些变量不同于它们的普通对应物，因为访问某个变量（通过其 get 或 set 方法）的每个线程都有自己的局部变量，它独立于变量的初始化副本。ThreadLocal 实例通常是类中的 private static 字段，它们希望将状态与某一个线程（例如，用户 ID 或事务 ID）相关联。

    API表达了下面几种观点：

1、ThreadLocal不是线程，是线程的一个变量，你可以先简单理解为线程类的属性变量。

2、ThreadLocal 在类中通常定义为静态类变量。

3、每个线程有自己的一个ThreadLocal，它是变量的一个‘拷贝’，修改它不影响其他线程。

 

    既然定义为类变量，为何为每个线程维护一个副本（姑且成为‘拷贝’容易理解），让每个线程独立访问？多线程编程的经验告诉我们，对于线程共享资源（你可以理解为属性），资源是否被所有线程共享，也就是说这个资源被一个线程修改是否影响另一个线程的运行，如果影响我们需要使用synchronized同步，让线程顺序访问。

 

   ThreadLocal适用于资源共享但不需要维护状态的情况，也就是一个线程对资源的修改，不影响另一个线程的运行；这种设计是‘空间换时间’，synchronized顺序执行是‘时间换取空间’。

 

二、ThreadLocal方法介绍

 

 

T	get()           返回此线程局部变量的当前线程副本中的值。
protected  T	initialValue()           返回此线程局部变量的当前线程的“初始值”。
void	remove()           移除此线程局部变量当前线程的值。
void	set(T value)           将此线程局部变量的当前线程副本中的值设置为指定值。

 

三、深入源码

    ThreadLocal有一个ThreadLocalMap静态内部类，你可以简单理解为一个MAP，这个‘Map’为每个线程复制一个变量的‘拷贝’存储其中。

    当线程调用ThreadLocal.get()方法获取变量时,首先获取当前线程引用，以此为key去获取响应的ThreadLocalMap，如果此‘Map’不存在则初始化一个，否则返回其中的变量，代码如下：

    

 public T get() {
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        if (map != null) {
            ThreadLocalMap.Entry e = map.getEntry(this);
            if (e != null)
                return (T)e.value;
        }
        return setInitialValue();
 }

    调用get方法如果此Map不存在首先初始化，创建此map，将线程为key，初始化的vlaue存入其中，注意此处的initialValue，我们可以覆盖此方法，在首次调用时初始化一个适当的值。setInitialValue代码如下：

    private T setInitialValue() {
        T value = initialValue();
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        if (map != null)
            map.set(this, value);
        else
            createMap(t, value);
        return value;
    }

 

    set方法相对比较简单如果理解以上俩个方法，获取当前线程的引用，从map中获取该线程对应的map，如果map存在更新缓存值，否则创建并存储，代码如下：

    public void set(T value) {
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        if (map != null)
            map.set(this, value);
        else
            createMap(t, value);
    }

 

    对于ThreadLocal在何处存储变量副本，我们看getMap方法：获取的是当前线程的ThreadLocal类型的threadLocals属性。显然变量副本存储在每一个线程中。

  

/**
 * 获取线程的ThreadLocalMap 属性实例
 */
ThreadLocalMap getMap(Thread t) {
        return t.threadLocals;
  }

 

    上面我们知道变量副本存放于何处，这里我们简单说下如何被java的垃圾收集机制收集，当我们不在使用是调用set(null)，此时不在将引用指向该‘map’，而线程退出时会执行资源回收操作，将申请的资源进行回收，其实就是将属性的引用设置为null。这时已经不在有任何引用指向该map，故而会被垃圾收集。

 

 四、ThreadLocal应用示例

   

      在我的另一篇文章，对ThreadLocal的使用做了一个实例，此示例也可以用作生产环境，请参见：http://ari.iteye.com/blog/757641

 

 

如有问题请留言讨论，谢谢

评论

22 楼 sdh5724 2010-09-15  

srdrm 写道

ThreadLocal 使用时确实要注意回收。否则可能会导致一些对象无法GC。

ThreadLocal最好不要做成static的

ThreadLocal最好不要做成static的 ：  你。。。说反了吧

21 楼 srdrm 2010-09-14  

ThreadLocal 使用时确实要注意回收。否则可能会导致一些对象无法GC。

ThreadLocal最好不要做成static的

20 楼 Joo 2010-09-13  

<div class="quote_title">pxlfxl2 写道</div>
<div class="quote_div">
<div class="quote_title">snake1987 写道</div>
<div class="quote_div">其实哪有这么复杂，就一个2层的map<br>第一层是Thread.currentThreand()为key，存的map<br>第二层是ThreadLocal.this为key，存的值，不就取出来了</div>
<p>   这样说也不对，你所说的第一层map是不存在的，你所说的第二层Map实际上是Thread的一个属性，仔细读读<span>niumd</span>的这个这个帖子你就明白了。看看Thread中的一小段代码：</p>
<p> </p>
<pre name="code" class="java">    /* ThreadLocal values pertaining to this thread. This map is maintained
     * by the ThreadLocal class. */
    ThreadLocal.ThreadLocalMap threadLocals = null;</pre>
<p>   上面的代码来自JDK源码，给Thread定义了一个<span style="font-size: 14.4px; white-space: pre;">ThreadLocal.ThreadLocalMap类型的属性，用于存线程变量。你再看看ThreadLocal中的get和set方法你就明白了！</span></p>
<p> </p>
<p> </p>
</div>
<p><br>这个两层的Map<br>ThreadLocal对象本身存放在线程栈上,他用来存储线程的变量, 可自身也是线程的一个变量? </p>
<p>上一层的大MAP存在堆上?</p>

19 楼 qn_lf 2010-09-10  

看robbin的 http://robbin.iteye.com/blog/602354 就知道robbin是谁了

18 楼 01404421 2010-09-10  

推荐一篇老帖，分析的非常透彻：
ThreadLocal不是用来解决对象共享访问问题的，而主要是提供了保持对象的方法和避免参数传递的方便的对象访问方式。
http://www.iteye.com/topic/617368

17 楼 linliangyi2007 2010-09-09  

holly2k 写道

pouyang 写道

ThreadLocal适用于资源共享 ？？
robbin曾说过

robbin 写道

ThreadLocal和多线程并发没有什么关系。ThreadLocal模式是为了解决单线程内的跨类跨方法调用的，有点AOP的味道。前面已经讲了很多了，还是搜索一下吧。

robbin是谁??

robbin 你都不知道，你就不算来过javaeye

16 楼 hommy8 2010-09-09  

 static class ThreadLocalMap {

        /**
         * The entries in this hash map extend WeakReference, using
         * its main ref field as the key (which is always a
         * ThreadLocal object).  Note that null keys (i.e. entry.get()
         * == null) mean that the key is no longer referenced, so the
         * entry can be expunged from table.  Such entries are referred to
         * as "stale entries" in the code that follows.
         */
        static class Entry extends WeakReference<ThreadLocal> {
            /** The value associated with this ThreadLocal. */
            Object value;

            Entry(ThreadLocal k, Object v) {
                super(k);
                value = v;
            }
        }

请看以上的源代码，在ThreadLocalMap 内部的Entry 是WeakReference。  请问这个entry定义为弱类型，不是会很快随机的被GC回收吗？  不过通常一个 Thread的生存时间可能更小，所以应该没有问题，是吧？请GS解答一下

15 楼 sunjun 2010-09-09  

每个线程Thread有一个ThreadLocalMap变量threadLocals，类似一个map，
Thread t = Thread.currentThread();
ThreadLocalMap map = t.threadLocals;

这个map的Key为ThreadLocal对象，Value为当前设置的值

设置值：
map.set(ThreadLocal对象, Value);

取值：
map.get(ThreadLocal对象)

14 楼 pxlfxl2 2010-09-09  

<div class="quote_title">snake1987 写道</div>
<div class="quote_div">其实哪有这么复杂，就一个2层的map<br>第一层是Thread.currentThreand()为key，存的map<br>第二层是ThreadLocal.this为key，存的值，不就取出来了</div>
<p>   这样说也不对，你所说的第一层map是不存在的，你所说的第二层Map实际上是Thread的一个属性，仔细读读<span style="">niumd</span>的这个这个帖子你就明白了。看看Thread中的一小段代码：</p>
<p>
</p>
<pre name="code" class="java">    /* ThreadLocal values pertaining to this thread. This map is maintained
     * by the ThreadLocal class. */
    ThreadLocal.ThreadLocalMap threadLocals = null;</pre>

<p>   上面的代码来自JDK源码，给Thread定义了一个<span style="font-size: 14.4px; white-space: pre;">ThreadLocal.ThreadLocalMap类型的属性，用于存线程变量。你再看看ThreadLocal中的get和set方法你就明白了！</span></p>
<p> </p>
<p> </p>

13 楼 esena 2010-09-08  

这个有什么好深入浅出的，看看API不就全明白了，最初我想走捷径google没找到能说清楚的，
自己看看API反而是最好的捷径

12 楼 holly2k 2010-09-08  

pouyang 写道

ThreadLocal适用于资源共享 ？？
robbin曾说过

robbin 写道

ThreadLocal和多线程并发没有什么关系。ThreadLocal模式是为了解决单线程内的跨类跨方法调用的，有点AOP的味道。前面已经讲了很多了，还是搜索一下吧。

robbin是谁??

11 楼 pouyang 2010-09-08  

ThreadLocal适用于资源共享 ？？
robbin曾说过

robbin 写道

ThreadLocal和多线程并发没有什么关系。ThreadLocal模式是为了解决单线程内的跨类跨方法调用的，有点AOP的味道。前面已经讲了很多了，还是搜索一下吧。

10 楼 笑我痴狂 2010-09-08  

楼主说到了用空间来换取时间   对这个观点  本人还是非常同意的

在信息化时代  对于网页开发 我们平常所说的性能  不就是指的时间吗？

不禁让我想到索引  索引就是用空间换时间的典型应用  如果大家熟悉lucence的话 大家

应该都深有同感

9 楼 niumd 2010-09-08  

徐风子 写道

需要写一个帖子专门翻译jdk的文档吗？

主要讨论ThreadLocal内部是实现细节，并非简单的JDK翻译；

8 楼 徐风子 2010-09-08  

需要写一个帖子专门翻译jdk的文档吗？

7 楼 snake1987 2010-09-08  

其实哪有这么复杂，就一个2层的map
第一层是Thread.currentThreand()为key，存的map
第二层是ThreadLocal.this为key，存的值，不就取出来了

6 楼 jeff.key 2010-09-08  

pouyang 写道

ThreadLocal.set(T)一个对象的时候，ThreadLocal.get();是拿出这一个对象，
如果在set一次，再get的时候，拿出来的是第二次的吧，第一个对象自动销毁？

ThreadLocal利用系统的WeakReferences进行对象的维护，
理论上说不需要显式的remove，
但要注意WeakReferences有时也会带起Memory Leaks。
比如inner class的情况下采用ThreadLocal
http://crazybob.org/2006/02/threadlocal-memory-leak.html

5 楼 qchong 2010-09-08  

pouyang 写道

hoorace 写道

ThreadLocal 系统是不会GC的，你到remove方法在神马地方？

等到ThreadLocal set对象到当前的Thread的这个Thread结束了，对象就自动销毁，是吧？

可以set(null);

4 楼 pouyang 2010-09-08  

hoorace 写道

ThreadLocal 系统是不会GC的，你到remove方法在神马地方？

等到ThreadLocal set对象到当前的Thread的这个Thread结束了，对象就自动销毁，是吧？

3 楼 pouyang 2010-09-08  

ThreadLocal.set(T)一个对象的时候，ThreadLocal.get();是拿出这一个对象，
如果在set一次，再get的时候，拿出来的是第二次的吧，第一个对象自动销毁？