ThreadLocal原理及使用示例

Java基础

浏览数:214

2019-3-24

AD:资源代下载服务

简介:本文以一个简要的代码示例介绍ThreadLocal类的基本使用,在此基础上结合图片阐述它的内部工作原理,最后分析了ThreadLocal的内存泄露问题以及解决方法。

 

欢迎探讨,如有错误敬请指正

如需转载,请注明出处 http://www.cnblogs.com/nullzx/

1. ThreadLocal<T> 简介和使用示例

ThreadLocal只有一个无参的构造方法

public ThreadLocal()

 

ThreadLocal的相关方法

public T get() 
public void set(T value) 
public void remove() 
protected T initialValue() 

initialValue方法的访问修饰符是protected,该方法为第一次调用get方法提供一个初始值。默认情况下,第一次调用get方法返回值null。在使用时,我们一般会复写ThreadLocal的initialValue方法,使第一次调用get方法时返回一个我们设定的初始值。

 

下面是一个ThreadLocal的一个简单使用示例

package javalearning;

import java.util.Random;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Semaphore;

public class ThreadLocalDemo {
    /*定义了1个ThreadLocal<Integer>对象,
     *并复写它的initialValue方法,初始值是3*/
    private ThreadLocal<Integer> tlA = new ThreadLocal<Integer>(){
        protected Integer initialValue(){
            return 3;
        }
    };
    
    /*  
    private ThreadLocal<Integer> tlB = new ThreadLocal<Integer>(){
        protected Integer initialValue(){
            return 5;
        }
    };
    */
    
    /*设置一个信号量,许可数为1,让三个线程顺序执行*/
    Semaphore semaphore = new Semaphore(1);
    
    private Random rnd = new Random();
    
    /*Worker定义为内部类实现了Runnable接口,tlA定义在外部类中,
每个线程中调用这个对象的get方法,再调用一个set方法设置一个随机值*/
    public class Worker implements Runnable{
        @Override
        public void run(){
            
            try {
                Thread.sleep(rnd.nextInt(1000)); /*随机延时1s以内的时间*/
                semaphore.acquire();/*获取许可*/
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
            
            int valA = tlA.get();
            System.out.println(Thread.currentThread().getName() +" tlA initial val : "+ valA);
            valA = rnd.nextInt();
            tlA.set(valA);
            System.out.println(Thread.currentThread().getName() +" tlA  new     val: "+ valA);
            
            /*
            int valB = tlB.get();
            System.out.println(Thread.currentThread().getName() +" tlB initial val : "+ valB);
            valB = rnd.nextInt();
            tlA.set(valB);
            System.out.println(Thread.currentThread().getName() +" tlB 2    new val: "+ valB);
            */
            
            semaphore.release();
            
            /*在线程池中,当线程退出之前一定要记得调用remove方法,因为在线程池中的线程对象是循环使用的*/
            tlA.remove();
            /*tlB.remove();*/
        }
    }
    
    /*创建三个线程,每个线程都会对ThreadLocal对象tlA进行操作*/
    public static void main(String[] args){
        ExecutorService es = Executors.newFixedThreadPool(3);
        ThreadLocalDemo tld = new ThreadLocalDemo();
        es.execute(tld.new Worker());
        es.execute(tld.new Worker());
        es.execute(tld.new Worker());
        es.shutdown();
    }
}

运行结果

pool-1-thread-1 tlA initial val : 3
pool-1-thread-1 tlA  new     val: -1288455998
pool-1-thread-3 tlA initial val : 3
pool-1-thread-3 tlA  new     val: 112537197
pool-1-thread-2 tlA initial val : 3
pool-1-thread-2 tlA  new     val: -12271334

从运行结果可以看出,每个线程第一次调用TheadLocal对象的get方法时都得到初始值3,注意我们上面的代码是让三个线程顺序执行,显然从运行结果看,pool-1-thread-1线程结束后设置的新值,对pool-1-thread-3线程是没有影响的,pool-1-thread-3线程完成后设置的新值对pool-1-thread-2线程也没有影响。这就仿佛把ThreadLocal对象当做每个线程内部的对象一样,但实际上tlA对象是个外部类对象,内部类Worker访问到的是同一个tlA对象,也就是说是被各个线程共享的。这是如何做到的呢?我们现在就来看看ThreadLocal对象的内部原理。

 

2. ThreadLocal<T>的原理

首先,在Thread类中定义了一个threadLocals,它是ThreadLocal.ThreadLocalMap对象的引用,默认值是null。ThreadLocal.ThreadLocalMap对象表示了一个以开放地址形式的散列表。当我们在线程的run方法中第一次调用ThreadLocal对象的get方法时,会为当前线程创建一个ThreadLocalMap对象。也就是每个线程都各自有一张独立的散列表,以ThreadLocal对象作为散列表的key,set方法中的值作为value(第一次调用get方法时,以initialValue方法的返回值作为value)。显然我们可以定义多个ThreadLocal对象,而我们一般将ThreadLocal对象定义为static类型或者外部类中。上面所表达的意思就是,相同的key在不同的散列表中的值必然是独立的,每个线程都是在各自的散列表中执行操作

 

TheadLocal中的get源代码

    public T get() {
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        if (map != null) {
            ThreadLocalMap.Entry e = map.getEntry(this);//这里的this是指当前的ThreadLocal对象
            if (e != null) {
                @SuppressWarnings("unchecked")
                T result = (T)e.value;
                return result;
            }
        }
        return setInitialValue();
    }

 3. 由ThreadLocal造成的内存泄露和相应解决办法

ThreadLocalMap 中用内部静态类Entry表示了散列表中的每一个条目,下面是它的代码

        static class Entry extends WeakReference<ThreadLocal<?>> {
            /** The value associated with this ThreadLocal. */
            Object value;

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

可以看出Entry类继承了WeakRefrence类,所以一个条目就是一个弱引用类型的对象(要搞清楚,持有weakRefrence对象的引用是个强引用),那么这个weakRefrence对象保存了谁的弱引用呢?我们看到构造函数中有个supe(k),k是ThreadLocal类型对象,super表示是调用父类的构造函数(父类是谁你要想清楚哦?),所以说一个entry对象中存储了ThreadLocal对象的弱引用和这个ThreadLocal对应的value对象的强引用。有关弱引用的相关内容请参考我的另一篇博客《Java中的四种引用以及ReferenceQueue和WeakHashMap的使用示例》

我们现在假设一种情况,假设我们在线程的run方法中调用了一个方法,并在这个方法中创建了ThreadLocal对象,并使用了他,内存结构示意图如下。

当这个方法结束时,这个方法中创建的ThreadLocal对象本身(图中绿色区域)就被垃圾回收器回收了,但是线程还没有结束,所以ThreadLocalMap中还存在这个entry。由于entry中的key(即ThreadLocal对象)是弱引用类型,所以此时调用entry.get()方法时就会返回null,内部结构如下图所示。

从图中我们可以看到value对象(红色区域)始终不能被回收,而我们再也不会使用它了,这就造成了内存泄露。

那Entry中为什么保存的是key的弱引用呢?其实这是为了最大程度上减少内存泄露,副作用是同时减少哈希表中的冲突。当ThreadLocal对象被回收时,对应entry中的key就自动变成null(entry对象本身不为null)。若此后我们调用get,set或remove方法时,就会尝试删除key为null的entry,以释放value对象所占用的内存。

我们现在来看看get方法(上面有get方法的源代码)中调用的getEntry方法。

        private Entry getEntry(ThreadLocal<?> key) {
            int i = key.threadLocalHashCode & (table.length - 1);
            Entry e = table[i];
            if (e != null && e.get() == key)
                return e;
            else
                return getEntryAfterMiss(key, i, e);
        }

 

从源代码中我们可以看出,有可能会调用getEntryAfterMiss方法,而在这个方法中,删除key为null的Entry对象。同理set方法也有类似的行为,而remove方法不仅仅删除掉参数ThreadLocal对象对应的entry,而且也会尝试删除其它key为null的entry。

        private Entry getEntryAfterMiss(ThreadLocal<?> key, int i, Entry e) {
            Entry[] tab = table;
            int len = tab.length;

            while (e != null) {
                ThreadLocal<?> k = e.get();
                if (k == key)
                    return e;
                if (k == null)
                    expungeStaleEntry(i);
                else
                    i = nextIndex(i, len);
                e = tab[i];
            }
            return null;
        }

 

 

但是上述的方式并不能完全解决内存泄露问题,因为我们在这个方法结束的时候逻辑上不一定必须调用get方法,而get方法也不一定执行getEntryAfterMiss方法。所以类本身是没有这个能力的,我们只能在不再使用某个ThreadLocal对象后,手动调用remoev方法来删除它,各自线程中调用共享的ThreadLocal对象的remove方法,这对其它线程是没有影响的,这个应该不难理解。在线程池中这就操作是必须的,不仅仅是内存泄露的问题。因为线程池中的线程是重复使用的,意味着这个线程的ThreadLocalMap对象也是重复使用的,如果我们不手动调用remove方法,那么后面的线程就有可能获取到上个线程遗留下来的value值,造成bug。

4. 参考内容

[1]. Java并发编程:深入剖析ThreadLocal

[2]. [Java并发包学习七]解密ThreadLocal

[3]. 深入分析 ThreadLocal 内存泄漏问题