并发安全工具类（5）：ThreadLocal

红太狼 2023-07-02 03:13 10阅读 0赞

# 1 两大使用场景 #

## 1.1 每个线程需要一个独享的对象 ##

> 典型场景1：每个线程需要一个独享的对象（通常是工具类，典型需要使用的类有SimpleDateFormat和Random）

> 每个Thread内有自己的实例副本，不共享。
> 
> 比喻：教材只有一本，一起做笔记有线程安全问题。复印后没问题。

>  [http://tutorials.jenkov.com/java-internationalization/simpledateformat.html][http_tutorials.jenkov.com_java-internationalization_simpledateformat.html]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly95dWFueXUuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70][]

/**
     * 利用ThreadLocal，给每个线程分配自己的dateFormat对象，保证了线程安全，高效利用内存
     */
    public class ThreadLocalNormalUsage05 {
        public static ExecutorService threadPool = Executors.newFixedThreadPool(10);
        public static void main(String[] args) {
            for (int i = 0; i < 1000; i++) {
                int finalI = i;
                threadPool.submit(() -> {
                    String date = ThreadLocalNormalUsage05.date(finalI);
                    System.out.println(date);
                });
            }
            threadPool.shutdown();
        }
        public static String date(int seconds) {
            //参数的单位是毫秒，从1970.1.1 00:00:00 GMT计时
            Date date = new Date(1000 * seconds);
            SimpleDateFormat dateFormat = ThreadSafeFormatter.dateFormatThreadLocal.get();
            return dateFormat.format(date);
        }
    }
    /**
     * 生产出线程安全的日期格式化工具
     */
    class ThreadSafeFormatter {
        public static ThreadLocal<SimpleDateFormat> dateFormatThreadLocal = new ThreadLocal<SimpleDateFormat>() {
            @Override
            protected SimpleDateFormat initialValue() {
                return new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
            }
        };
        //lambda简写
        public static ThreadLocal<SimpleDateFormat> dateFormatThreadLocal2 = ThreadLocal.withInitial(() -> new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
    }

## 1.2 当前用户信息需要被线程内所有方法共享  ##

> 典型场景2：每个线程内需要保存全局变量（例如在拦截器中获取用户信息），可以让不同方法直接使用，避免参数传递的麻烦

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly95dWFueXUuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 1][]

> 更好的办法是使用 ThreadLocal，这样无需 Synchronized，可以在不影响性能的情况下，也无需层层传递参数，就可达到保存当前线程对应的用户信息的目的

> 每个线程内需要保存全局变量，可以让不同方法直接使用，避免参数传递的麻烦

> 方法
> 
>  *  用 ThreadLocal保存一些业务内容（用户权限信息、从用户系统获取到的用户名、user ID等）
>  *  这些信息在同一个线程内相同，但是不同的线程使用的业务内容是不相同的
>  *  在线程生命周期内，都通过这个静态ThreadLocal实例的get()方法取得自己set过的那个对象，避免了将这个对象（例如user对象）作为参数传递的麻烦
>  *  强调的是同一个请求内（同一个线程内）不同方法间的共享
>  *  不需重写initialValue()方法，但是必须手动调用set()方法

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly95dWFueXUuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 2][]

/**
     * 演示ThreadLocal用法2：避免传递参数的麻烦
     */
    public class ThreadLocalNormalUsage06 {
        public static void main(String[] args) {
            ExecutorService threadPool = Executors.newFixedThreadPool(10);
            for (int i = 0; i < 20; i++) {
                threadPool.execute(() -> {
                    new Interceptor().preHandle("");
                });
            }
        }
    }
    class Interceptor {
        /**
         * @param userId 用户id
         */
        public void preHandle(String userId) {
            //模拟查询数据库后获取到的用户信息
            User user = new User("蔡徐坤 " + new Random().nextInt(100) + userId);
            UserContextHolder.holder.set(user);
            new Service().process();
        }
        //public void afterCompletion() {
        //    UserContextHolder.holder.remove();
        //}
    }
    class Service {
        public void process() {
            User user = UserContextHolder.holder.get();
            //ThreadSafeFormatter.dateFormatThreadLocal.get();
            System.out.println(Thread.currentThread().getName() + " Service拿到用户名：" + user.name);
            new Service2().process();
        }
    }
    class Service2 {
        public void process() {
            User user = UserContextHolder.holder.get();
            System.out.println(Thread.currentThread().getName() + " Service2拿到用户名：" + user.name);
            //!!!：记得清除
            UserContextHolder.holder.remove();
        }
    }
    class UserContextHolder {
        public static ThreadLocal<User> holder = new ThreadLocal<>();
    }
    class User {
        String name;
        public User(String name) {
            this.name = name;
        }
    }

## 1.3 总结  ##

> ThreadLocal的两个作用
> 
>  *  让某个需要用到的对象在线程间隔离（每个线程都有自己的独立的对象）
>  *  在任何方法中都可以轻松获取到该对象
> 
> --------------------
> 
> 根据共享对象的生成时机不同，选择**initialValue**或**set**来保存对象
> 
>  *  **initialValue**：在ThreadLocal第一次get的时候把对象给初始化出来，对象的初始化时机可以由我们控制。
>  *  **set**：如果需要保存到ThreadLocal里的对象的生成时机不由我们随意控制，例如拦截器生成的用户信息，用ThreadLocal.set直接放到我们的ThreadLocal中去，以便后续使用。

--------------------

# 2 使用ThreadLocal带来的好处 #

>  *  达到线程安全
>  *  不需要加锁，提高执行效率
>  *  更高效地利用内存、节省开销：相比于每个任务都新建一个SimpleDateFormat，显然用ThreadLocal可以节省内存和开销
>  *  免去传参的繁琐：无论是场景一的工具类，还是场景二的用户名，都可以在任何地方直接通过ThreadLocal拿到，再也不需要每次都传同样的参数。ThreadLocal使得代码耦合度更低，更优雅

--------------------

# 3 ThreadLocal原理 #

>  *  搞清楚 Thread，ThreadLocal以及ThreadLocalMap三者之间的关系
>  *  每个Thread对象中都持有一个ThreadLocalMap成员变量

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly95dWFueXUuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 3][]

//java.lang.Thread#threadLocals
    ThreadLocal.ThreadLocalMap threadLocals = null;

--------------------

# 4 主要方法介绍 #

> T initialValue()：初始化
> 
>  *  该方法会返回当前线程对应的“初始值”，这是一个延迟加载的方法，只有在调用get的时候，才会触发
>  *  当线程第一次使用get方法访问变量时，将调用此方法，除非线程先前调用了set方法，在这种情况下，不会为线程调用本initialValue方法
>  *  通常，每个线程最多调用一次此方法，但如果已经调用了remove()后，再调用get()，则可以再次调用此方法
>  *  如果不重写本方法，这个方法会返回null。一般使用匿名内部类的方法来重写initialValue()方法，以便在后续使用中可以初始化副本对象。
>  *  initialValue方法：是没有默认实现的，如果我们要用initialValue方法，需要自己实现，通常是匿名内部类的方式。
> 
> --------------------
> 
> void set(T t)：为这个线程设置一个新值
> 
>  *  setInitialValue方法很类似
> 
> --------------------
> 
> T get()：得到这个线程对应的value。如果是首次调用get()，则会调用initialValue来得到这个值
> 
>  *  get方法是先取出当前线程的ThreadLocalMap，然后调用map.getEntry方法，把本ThreadLocal的引用作为参数传入，取出map中属于本ThreadLocal的value
>  *  注意，这个map以及map中的key和value都是保存在**线程**中的，而不是保存在ThreadLocal中
> 
> --------------------
> 
> void remove()：删除对应这个线程的值

//java.lang.ThreadLocal#get
    public T get() {
    	Thread t = Thread.currentThread();
    	ThreadLocalMap map = getMap(t);
    	if (map != null) {
    		ThreadLocalMap.Entry e = map.getEntry(this);
    		if (e != null) {
    			T result = (T)e.value;
    			return result;
    		}
    	}
    	return setInitialValue();
    }
    //java.lang.ThreadLocal#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;
    }

//java.lang.ThreadLocal#remove
    public void remove() {
     ThreadLocalMap m = getMap(Thread.currentThread());
     if (m != null)
    	 m.remove(this);
    }

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

//java.lang.ThreadLocal#initialValue
    protected T initialValue() {
    	return null;
    }

--------------------

# 5 ThreadLocalMap类 #

> ThreadLocalMap类：也就是ThreadLocal.ThreadLocalMap threadLocals
> 
> --------------------
> 
> ThreadLocalMap类是每个线程Thread类里面的变量，里面最重要的是一个键值对数组Entry\[\] table，可以认为是一个map，键值对：
> 
>  *  键：这个ThreadLocal
>  *  值：实际需要的成员变量，比如user或者simpleDateFormat对象
> 
> --------------------
> 
> 冲突：HashMap
> 
> ![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly95dWFueXUuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 4][]
> 
> ThreadLocalMap这里采用的是线性探测法，也就是如果发生冲突，就继续找下一个空位置，而**不是用链表拉链**

> 两种使用场景殊途同归
> 
>  *  通过源码分析可以看出，setInitialValue和直接set最后都是利用map.set()方法来设置值，也就是说最后都会对应到ThreadLocalMap的一个Entry，只不过是起点和入口不一样

--------------------

# 6 ThreadLocal注意点 #

## 6.1 内存泄漏 ##

> 内存泄漏
> 
>  *  什么是内存泄漏：某个对象不再有用，但是占用的内存却不能被回收
>  *  弱引用的特点是，如果这个对象只被弱引用关联（没有任何强引用关联），那么这个对象就可以被回收
>  *  所以弱引用不会阻止GC，因为这个弱引用的机制
>  *  ThreadLocalMap的每个Entry都是一个对key的弱引用，同时每个Entry都包含了一个对value的强引用
>  *  正常情况下，当线程终止，保存在ThreadLocal里的value会被垃圾回收，因为没有任何强引用了
>  *  但是，如果线程不终止（比如线程需要保持很久），那么key对应的value就不能被回收，因为有以下的调用链：Thread  ---> ThreadLocalMap ---> Entry(key为null) ---> value
>  *  因为value和Thread之间还存在这个强引用链路，所以导致value无法回收，就可能会出现OOM
>  *  JDK已经考虑到了这个问题，所以在set，remove，rehash方法中会扫描key为null的Entry，并把对应的value设置为null，这样value对象就可以被回收
>  *  但是如果一个ThreadLocal不被使用，那么实际上set，remove，rehash方法也不会被调用，如果同时线程又不停止，那么调用链就一直存在，那么就导致了value的内存泄漏
> 
> --------------------
> 
> 如何避免内存泄露（阿里规约）
> 
>  *  调用remove方法，就会删除对应的Entry对象，可以避兔内存泄漏，所以使用完ThreadLocal之后，应该调用remove方法

//java.lang.ThreadLocal.ThreadLocalMap
    static class ThreadLocalMap {
    	static class Entry extends WeakReference<ThreadLocal<?>> 
    		Object value;
    		Entry(ThreadLocal<?> k, Object v) {
    			//若引用
    			super(k);
    			//强引用
    			value = v;
    		}
    	}
    	
    public WeakReference(T referent) {
    	super(referent);
    }

//java.lang.ThreadLocal.ThreadLocalMap#resize
    private void resize() {
    	Entry[] oldTab = table;
    	int oldLen = oldTab.length;
    	int newLen = oldLen * 2;
    	Entry[] newTab = new Entry[newLen];
    	int count = 0;
    	for (int j = 0; j < oldLen; ++j) {
    		Entry e = oldTab[j];
    		if (e != null) {
    			ThreadLocal<?> k = e.get();
    			if (k == null) {
    				//！！！
    				e.value = null; // Help the GC
    			} else {
    				int h = k.threadLocalHashCode & (newLen - 1);
    				while (newTab[h] != null)
    					h = nextIndex(h, newLen);
    				newTab[h] = e;
    				count++;
    			}
    		}
    	}
    	setThreshold(newLen);
    	size = count;
    	table = newTab;
    }

## 6.2 空指针异常 ##

public class ThreadLocalNPE {
        ThreadLocal<Long> longThreadLocal = new ThreadLocal<>();
        public void set() {
            longThreadLocal.set(Thread.currentThread().getId());
        }
        //拆装箱问题
        public Long get() {//long：NullPointerException
            Long res = longThreadLocal.get();
            return res;
        }
    
        public static void main(String[] args) {
            ThreadLocalNPE threadLocalNPE = new ThreadLocalNPE();
            System.out.println(threadLocalNPE.get());//NullPointerException
            Thread thread1 = new Thread(() -> {
                threadLocalNPE.set();
                System.out.println(threadLocalNPE.get());
            });
            thread1.start();
        }
    }

## 6.3 共享对象 ##

> 如果在每个线程中ThreadLocal.set()进去的东西本来就是多线程共享的同一个对象，比如static对象，那么多个线程的 ThreadLocal.get()取得的还是这个共享对象本身，还是有并发访问问题

> 如果可以不使用ThreadLocal就解决问题，那么不要强行使用
> 
>  *  例如在任务数很少的时候，在局部变量中可以新建对象就可以解决问题，那么就不需要使用到ThreadLocal
> 
> --------------------
> 
> 优先使用框架的支持，而不是自己创造
> 
>  *  例如在Spring中，如果可以使用RequestContextHolder，那么就不需要自己维护ThreadLocal，因为自己可能会忘记调用remove()方法等，造成内存泄漏

--------------------

# 7 Spring中的ThreadLocal #

> DateTimeContextHolder类，看到里面用了ThreadLocal

package org.springframework.format.datetime.standard;
    public final class DateTimeContextHolder {
        private static final ThreadLocal<DateTimeContext> dateTimeContextHolder = new NamedThreadLocal("DateTimeContext");

package org.springframework.web.context.request;
    public abstract class RequestContextHolder {
        private static final boolean jsfPresent = ClassUtils.isPresent("javax.faces.context.FacesContext", RequestContextHolder.class.getClassLoader());
        private static final ThreadLocal<RequestAttributes> requestAttributesHolder = new NamedThreadLocal("Request attributes");
        private static final ThreadLocal<RequestAttributes> inheritableRequestAttributesHolder = new NamedInheritableThreadLocal("Request context");

[http_tutorials.jenkov.com_java-internationalization_simpledateformat.html]: http://tutorials.jenkov.com/java-internationalization/simpledateformat.html
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly95dWFueXUuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200124162522454.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly95dWFueXUuYmxvZy5jc2RuLm5ldA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly95dWFueXUuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200124164238406.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly95dWFueXUuYmxvZy5jc2RuLm5ldA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly95dWFueXUuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200124171027438.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly95dWFueXUuYmxvZy5jc2RuLm5ldA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly95dWFueXUuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20200124174736655.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly95dWFueXUuYmxvZy5jc2RuLm5ldA==,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly95dWFueXUuYmxvZy5jc2RuLm5ldA_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20200124215213296.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly95dWFueXUuYmxvZy5jc2RuLm5ldA==,size_16,color_FFFFFF,t_70