ThreadLocal--使用、原理

ThreadLocal

ThreadLocal，即线程变量，是一个以ThreadLocal为键、任意对象为值得存储结构。这个结构被附带在线程上，也就是说一个线程可以根据一个ThreadLocal对象查询到绑定在这个线程上的一个值。

可以通过set(T)方法来设置一个值，在当前线程下再通过get()方法获取到原先设置的值。

public class ThreadLocal_Test implements Runnable {

    private static final AtomicInteger nextId = new AtomicInteger(0);

    private static final ThreadLocal<Integer> threadId = ThreadLocal.withInitial(
            () -> nextId.getAndIncrement());

    public static void main(String[] args) {
        for (int i = 0; i < 5; i++) {
            ThreadLocal_Test t = new ThreadLocal_Test();
            new Thread(t).start();
        }
    }

    @Override
    public void run() {
        System.out.println(threadId.get());
        threadId.set(10);
        System.out.println(threadId.get());
    }
}

常用方法

• protected T initialValue()
  返回此线程局部变量的当前线程的“初始值”。 该方法将在第一次使用get()方法访问变量时被调用，除非线程先前调用了set(T)方法，在这种情况下， initialValue方法将不会被调用。 通常情况下，这种方法最多每个线程调用一次，但如果调用了remove()方法删除了值，再次调用get()方法获取值，则会重新调用initialValue()初始化一个值 。
  该方法默认实现返回null，如果不希望初始值为null，则必须重写该方法。

• public static <S> ThreadLocal<S> withInitial(Supplier<? extends S> supplier)
  创建线程局部变量。 变量的初始值是通过调用Suppier的get()方法来构建。

• ublic T get()
  返回当前线程的线程变量的值。 如果没有值，则首先将其初始化为调用initialValue()方法返回的值。

• public void set(T value)
  将当前线程的线程变量设置为指定的值。

• public void remove()
  删除当前线程的线程变量的值，如果随后的操作为get()，则会通过initialValue()方法重新初始化值。

原理

因为一个线程内存在多个ThreadLocal对象，所以其实是ThreadLocal内部维护了一个Map，这个Map是ThreadLocal实现的一个叫做ThreadLocalMap的静态内部类。

• SuppliedThreadLocal：ThreadLocal子类，重写了initialValue()方法，用于支持withInitial()方法。
• ThreadLocalMap：即为上文所说的存储线程变量映射的Map。
• Entry：ThreadLocalMap使用Entry数组来存储映射，Entry继承了WeakReference。

而Thread类中存在如下字段：

ThreadLocal.ThreadLocalMap threadLocals = null;

ThreadLocal的get(),set(),remove()方法都是通过调用底层ThreadLocalMap的相应方法实现的。

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

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


public void remove() {
         ThreadLocalMap m = getMap(Thread.currentThread());
         if (m != null)
             m.remove(this);
     }

实际应用：解决SimpleDateFormat非线程安全问题

public class DateUtil {
    private static ThreadLocal<SimpleDateFormat> format1 = new ThreadLocal<SimpleDateFormat>() {
        @Override
        protected SimpleDateFormat initialValue() {
            return new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        }
    };

    public static String formatDate(Date date) {
        return format1.get().format(date);
    }
}

ThreadLocal的内存泄漏问题

实际上 ThreadLocalMap 中使用的 key 为 ThreadLocal 的弱引用，弱引用的特点是，如果这个对象只存在弱引用，那么在下一次垃圾回收的时候必然会被清理掉。

所以如果 ThreadLocal 没有被外部强引用的情况下，在垃圾回收的时候会被清理掉的，这样一来 ThreadLocalMap中使用这个 ThreadLocal 的 key 也会被清理掉。但是，value 是强引用，不会被清理，这样一来就会出现 key 为 null 的 value。

ThreadLocalMap实现中已经考虑了这种情况，在调用 set()、get()、remove() 方法的时候，会清理掉 key 为 null 的记录。如果说会出现内存泄漏，那只有在出现了 key 为 null 的记录后，没有手动调用 remove() 方法，并且之后也不再调用 get()、set()、remove() 方法的情况下。

详细原理