ThreadLocal总结与使用

目录

概述

ThreadLocal常用方法

ThreadLocal内部结构

​编辑为什么要用ThreadLocal作key?

ThreadLocalMap如何查找数据

父子线程如何共享数据

ThreadLocal如何避免内存泄露

ThreadLocal应用场景

---

概述

ThreadLocal被称为线程局部变量,用于在线程中保存共享变量(不同的线程中保存的值不同)。由于在ThreadLocal中保存的数据仅在当前线程中,所以对于其他线程来说是隔离起来的,也就是说该变量是当前线程独有的变量。

ThreadLocal用于在同一个线程间，在不同的类和方法之间共享数据的的场景，也可以用于在不同线程间隔离数据的场景,下面的代码示例中就很好的体现了ThreadLocal的一些使用场景:

public class Test {
    // 线程局部变量
    public static ThreadLocal<String> threadLocal = new ThreadLocal<String>();
    public static void main(String[] args) {
        Thread t1 = new Thread(new Runnable() {
            @Override
            public void run() {
                threadLocal.set("妲己");
                show();
                Sample.dosth();
            }
        },"线程1");
        Thread t2 = new Thread(new Runnable() {
            @Override
            public void run() {
                threadLocal.set("后羿");
                show();
                Sample.dosth();
            }
        },"线程2");
        t1.start();
        t2.start();
    }
    public static void show() {
        String role = threadLocal.get();
        System.out.println("show:"+Thread.currentThread().getName()+"分配角色:" + role);
    }
}
class Sample {
    public static void dosth() {
        String role = Test.threadLocal.get();
        System.out.println("dosth:"+Thread.currentThread().getName()+"分配角色:" + role);
    }
}

ThreadLocal常用方法

1. 存储数据至当前线程的ThreadLocalMap：public void set(T value),部分源码如下:

注意,这是ThreadLocal类中的方法,而不是Thread类中的方法,this表示当前ThreadLocal类型的对象,这里给为什么要用ThreadLocal作键做了铺垫,下文中会有详细解释。

public void set(T value) {
        // 获取当前线程
        Thread t = Thread.currentThread();

        // 获取当前线程的ThreadLocalMap
        ThreadLocalMap map = getMap(t);

        // 存储数据至当前线程的ThreadLocalMap中
        // 使用ThreadLocal对象做key，保存数据value
        if (map != null)
            map.set(this, value);
        else
            createMap(t, value);
}

2.  从当前线程的ThreadLocalMap中获取数据：public T get(),部分源码如下: 

public T get() {
        // 获取当前线程的ThreadLocalMap
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        // 使用ThreadLocal对象做key，获取数据(Entry类型)
        if (map != null) {
            ThreadLocalMap.Entry e = map.getEntry(this);
            if (e != null) {
                @SuppressWarnings("unchecked")
                T result = (T)e.value;
                return result;
            }
         }
         return setInitialValue();
}

3.  从当前线程的ThreadLocalMap中删除数据：public void remove()

在线程池的线程复用场景中，线程执行完毕时一定要调用remove()，避免在线程被重新放入线程池中时被本地变量的旧状态仍然被保存。

下面是部分源码:

public void remove() {
 // 获取当前线程的ThreadLocalMap
 ThreadLocalMap m = getMap(Thread.currentThread());
 // 使用当前ThreadLocal对象做key，删除数据
 if (m != null)
 m.remove(this);
}

 ThreadLocal的get()方法、set()方法和remove()方法，其实最终操作的都是ThreadLocalMap类中的数据。

ThreadLocal内部结构

ThreadLocal利用Thread中的ThreadLocalMap来进行数据存储。

ThreadLocalMap内部数据结构是一个Entry类型的数组。每个Entry对象的key为ThreadLocal对象，value为存储的数据。

static class ThreadLocalMap {
     static class Entry extends WeakReference<ThreadLocal<?>> {
         Object value;
         Entry(ThreadLocal<?> k, Object v) {
             super(k);
             value = v;
     }
 }
 ...
 private Entry[] table;
 ...
}

为什么要用ThreadLocal作key?

• 如果在应用中，一个线程中只使用了一个ThreadLocal对象，那么使用Thread做key也是可以的，代表每个Thread线程对应一个value。
• 可是在实际开发过程中,一个线程很有可能会用到不止一个ThreadLocal对象。这个时候,如果还用当前线程作key的话,那么一个key就会对应多个值,想要得到某个值的话,就必须进行遍历,这也就失去了键值对的意义。
• 所以,当使用多个ThreadLocal时,每个ThreadLocal都是不同的,那么使用ThreadLocal作key就可以保证key的唯一性,才能通过get()方法,获取某一个ThreadLocal对应的值。

public class ThreadLocalService {
 private static final ThreadLocal<Integer> threadLocal1 = new ThreadLocal<>();
 private static final ThreadLocal<Integer> threadLocal2 = new ThreadLocal<>();
 private static final ThreadLocal<Integer> threadLocal3 = new ThreadLocal<>();
}

ThreadLocalMap如何查找数据

 当我们使用ThreadLocal获取当前线程中保存的Value数据时，是以ThreadLocal对象作为Key，通过访问Thread当前线程对象的内部ThreadLocalMap集合来获取到Value。

ThreadLocalMap集合的底层数据结构使用Entry[]数组保存Key-Value键值对数据。所以，当通过ThreadLocal的get、set()、remove()等方法，访问ThreadLocalMap时，最终都会通过一个下标，来完成对数组中的元素访问。

int i = key.threadLocalHashCode & (len-1);

通过key的“hashCode值”跟"数组的长度减1" 做“&按位与”运算。其中key就是ThreadLocal对象。这种计算方式，相当于用“hashCode值”跟“数组的长度”进行“%取余”运算。
        假设：len=16，key.threadLocalHashCode=31
hash & len-1的计算结果与hash % len的计算结果一直，均为15，但是“&按位与”运算的效率更高。

这和HashMap的存储元素的过程很相似!!!

父子线程如何共享数据

在实际工作中，有可能需要在父子线程中共享数据的。即：在父线程中往ThreadLocal设置了值，在子线程中能够获取到。

public class ThreadLocalTest {
 public static void main(String[] args) {
 ThreadLocal<String> threadLocal = new ThreadLocal<String>();
threadLocal.set("天王盖地虎");
System.out.println("main主线程:"+threadLocal.get());
Thread thread = new Thread(new Runnable() {
@Override
public void run() {
System.out.println("子线程:"+threadLocal.get());
}
});
thread.start();
 }
}

这种情况下假设我们继续使用ThreadLocal,因为父线程和子线程毕竟是两个不同的线程,所以ThreadLocal还是会起到隔离的作用,二者的ThreadLocalMap是不同的。

运行结果: 

main: 天王盖地虎
thread: null

这种情景应该使用InheritableThreadLocal，它是JDK自带的类，继承了ThreadLocal类。

public class ThreadLocalTest {
 public static void main(String[] args) {
 InheritableThreadLocal<String> threadLocal = new InheritableThreadLocal<String>();
threadLocal.set("天王盖地虎");
System.out.println("main主线程:"+threadLocal.get()); // 天王盖地虎
Thread thread = new Thread(new Runnable() {
@Override
public void run() {
System.out.println("子线程:"+threadLocal.get()); // 天王盖地虎
}
});
thread.start();
 }
}

ThreadLocal如何避免内存泄露

使用完毕后，在finally块中调用ThreadLocal对象的remove()方法。

public class test {
    private static final ThreadLocal<String> THREAD_LOCAL = new ThreadLocal<>();
    public static void main(String[] args) {
        try {
            THREAD_LOCAL.set(value);
            THREAD_LOCAL.get();
        }finally {
            THREAD_LOCAL.remove();
        }
    }
}

 需要特别注意的地方是：一定要在finally代码块中，调用remove()方法清理没用的数据。如果业务代码出现异常，也能及时清理没用的数据。

remove()方法中会把Entry中的key和value都设置成null，这样就能被GC及时回收，无需触发额外的清理机制，所以它能解决内存泄露问题。

ThreadLocal应用场景

1. 线程数据隔离

ThreadLocal的主要价值在于线程隔离，ThreadLocal中的数据只属于当前线程，该数据对别的线程是不可见的，起到隔离作用。这样操作，可以在多线程环境下，可以防止当前线程的数据被其他线程修改。另外，由于各个线程之间的数据相互隔离，避免了同步加锁带来的性能损失，大大提升了并发性的性能。

例如：SqlSession会话对象绑定，避免多个线程使用同一个SqlSession对象，由于关闭导致异常。

private static final ThreadLocal threadSession= new ThreadLocal();
public static SqlSession getSession(){
 SqlSession s = (SqlSession)threadSession.get();
 if(s==null){
 s = getSqlSessionFactory().openSqlSession();
 threadSession.set(s);
 }
}

2. 跨函数传递

数据通常用于同一个线程内，跨类、跨方法传递数据时，如果不用ThreadLocal，那么相互之间的数据传递势必要靠返回值和参数，这样无形之中增加了这些类或者方法之间的耦合度。

使用ThreadLocal就可以有效改善这种问题,同时也降低类或方法之间的耦合度。