ThreadLocal 源码解析

 ThreadLocal.ThreadLocalMap threadLocals = null;

/**
 * 设置当前线程对应的ThreadLocal的值
 */
public void set(T value) {
        // 获取当前的线程对象
        Thread t = Thread.currentThread();
        // 获取此线程对象中维护的ThreadLocalMap对象
        ThreadLocalMap map = getMap(t);
       // 判断map是否存在
        if (map != null)
           // 设置当前线程的Entry
            map.set(this, value);
        else
            // 将当前线程t 和 value(t对应的值)作为第一个entry存放到ThreadLocalMap中
            createMap(t, value);
}
/**
 * 获取当前线程Thread对应维护的TreadLocalMap
 */
ThreadLocalMap getMap(Thread t) {
        return t.threadLocals;
}

/**
 * 创建当前线程Thread对应维护的ThreadLocalMap
 * t 当前线程
 * firstValue 存放到map中第一个entry的值
 */
void createMap(Thread t, T firstValue) {
        // this 是调用此方法的threadLocal
        t.threadLocals = new ThreadLocalMap(this, firstValue);
}

1.  首先获取当前线程,并根据当前线程获取一个Map
2. 若获取的Map 不为空, 则将参数设置到Map中 (当前ThreadLocal的引用作为key)
3. 若Map为空,则给该线程创建Map 并设置初始值

  

  返回当前线程对应此ThreadLocal的值

/**
 * 返回当前线程中保存ThreadLocal的值
 * 若当前线程没有此ThreadLocal变量,则调用 #setInitialValue() 方法进行初始化
 */
public T get() {
        // 获取当前线程对象
        Thread t = Thread.currentThread();
        // 获取当前线程中对应的ThreadLocalMap对象
        ThreadLocalMap map = getMap(t);
        // 若map存在
        if (map != null) {
            // 根据当前ThreadLocal为key,调用getEntry 获取对应存放的实体e
            ThreadLocalMap.Entry e = map.getEntry(this);
            if (e != null) {
                @SuppressWarnings("unchecked")
                // 获取存储实体e 对应的 value
                // 即 当前线程对应ThreadLocal的值
                T result = (T)e.value;
                return result;
            }
        }
        /**
         * 初始化:
         * 1. map中不存在,标识当前线程没有维护ThreadLocalMap对象
         * 2. map存在,但是没有与当前ThreadLocal关联的entry
         */
        return setInitialValue();
}

ThreadLocalMap getMap(Thread t) {
        return t.threadLocals;
}

/**
 * 初始化
 *
 */
private T setInitialValue() {
        // 调用initualValue 获取初始化的值
        // 此方法可以被子类重写,如果不重写默认返回null 
        T value = initialValue();
        // 获取当前线程对象
        Thread t = Thread.currentThread();
        // 获取当前线程对象中维护的ThreadLocalMap 对象 
        ThreadLocalMap map = getMap(t);
        // 判断map是否存在
        if (map != null)
            map.set(this, value);
        else
            /**
             * 创建Map
             * 1. 当前线程,没有ThreadLocalMap对象
             *    则调用 createMap进行ThreadLocalMap对象进行初始化 
             *    将当前线程 t 和 value (t 对应的值)作为第一个entry 存放至ThreadLocalMap中
             */
            createMap(t, value);
        return value;
}

protected T initialValue() {
    return null;
}

   先获取当前线程的ThreadLocalMap变量, 若存在则返回值, 不存在则初始化创建一个并发回值

 

/**
 * 移除当前线程中保存ThreadLocal的entry 的实体
 */ 
public void remove() {
         ThreadLocalMap m = getMap(Thread.currentThread());
         if (m != null)
             m.remove(this);
}

/**
   初始化当前线程对应的ThreadLocal的初值
   
   如果要修改ThreadLocalMap线程局部变量一个除null以外的初始值
   可以通过子类继承 ThreadLocal 的方式来重写 initialValue() 方法
   通常,可以通过匿名内部类的方式实现
 */
protected T initialValue() {
        return null;
}

该方法是用 protected (同包或不同包的子类可重写) 就行修饰的, 显然是让子类覆盖而设计的.

 

ThreadLocalMap解析: 

  
static class ThreadLocalMap {

        /**
         * Entry 继承 WeakReference, 并且用ThreadLocal作为key
         * 
         * 如果key为null  ( entry.get() == null) ,意味着key不再被引用
         * 因此这个时候的entry也可以从table中清楚
         */
        static class Entry extends WeakReference> {
            /** The value associated with this ThreadLocal. */
            Object value;

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

        /**
         * 初始化容量 -- 必须是2的整次幂
         */
        private static final int INITIAL_CAPACITY = 16;

        /**
         * 存放数据table,
         * 数组长度必须是2的整次幂
         */
        private Entry[] table;

        /**
         * The number of entries in the table.
         */
        private int size = 0;

        /**
         * 扩容的阈值, 大于threshold 的时候进行扩容
         */
        private int threshold; // Default to 0

        /**
         * Set the resize threshold to maintain at worst a 2/3 load factor.
         */
        private void setThreshold(int len) {
            threshold = len * 2 / 3;
        }

        /**
         * Increment i modulo len.
         */
        private static int nextIndex(int i, int len) {
            return ((i + 1 < len) ? i + 1 : 0);
        }

        /**
         * Decrement i modulo len.
         */
        private static int prevIndex(int i, int len) {
            return ((i - 1 >= 0) ? i - 1 : len - 1);
        }

        /**
         * Construct a new map initially containing (firstKey, firstValue).
         * ThreadLocalMaps are constructed lazily, so we only create
         * one when we have at least one entry to put in it.
         */
        ThreadLocalMap(ThreadLocal firstKey, Object firstValue) {
            table = new Entry[INITIAL_CAPACITY];
            int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
            table[i] = new Entry(firstKey, firstValue);
            size = 1;
            setThreshold(INITIAL_CAPACITY);
        }

        /**
         * Construct a new map including all Inheritable ThreadLocals
         * from given parent map. Called only by createInheritedMap.
         *
         * @param parentMap the map associated with parent thread.
         */
        private ThreadLocalMap(ThreadLocalMap parentMap) {
            Entry[] parentTable = parentMap.table;
            int len = parentTable.length;
            setThreshold(len);
            table = new Entry[len];

            for (int j = 0; j < len; j++) {
                Entry e = parentTable[j];
                if (e != null) {
                    @SuppressWarnings("unchecked")
                    ThreadLocal