ThreadLocal 的核心方法源码解读

x33g5p2x  于2021-12-25 转载在 其他  
字(2.9k)|赞(0)|评价(0)|浏览(261)

一 ThreadLocal 的核心方法

| <br>方法申明<br> | <br>描述<br> |
| <br>protected T initialValue()<br> | <br>返回当前线程局部变量的初始值<br> |
| <br>public T get()<br> | 获取当前线程绑定的局部变量 |
| <br>public void set(T value)<br> | <br>设置当前线程绑定的局部变量<br> |
| <br>public void remove()<br> | <br>移除当前线程绑定的局部变量<br> |

二 源码解读

/**
* 返回当前线程对应的 ThreadLocal 的初始值
* 此方法的第一次调用发生在,当线程通过 get 方法访问此线程的 ThreadLocal 值时
* 除非线程先调用 set 方法,在这种情况下,initialValue 才不会被这个线程调用 
* 这个方法仅仅简单的返回 null
* 如果程序员想 ThreadLocal 线程局部变量有一个除 null 以外的初始值,
* 必须通过子类继承的方式重写此方法
* 通常,可以通过匿名内部内的方式实现
*
* @return 当前 ThreadLocal 的初始值
* 作用:
* 1 这个方法是一个延迟调用方法,在 set 方法还未调用先调用 get 方法时才执行,并且仅执行1次
* 2 这个方法缺省实现直接返回一个 null
* 3 如果想要一个除 null 之外的初始值,可以重写此方法
*/
protected T initialValue() {
    return null;
}

/**
* 获取当前线程中 ThreadLocal 对应的值
* 如果当前线程没有此 ThreadLocal变量,则会调用 setInitialValue 方法设置初始值
*
* 获取当前线程中 ThreadLocal 对应的值
* 1 首先获取当前线程,根据当前线程获取一个 map
* 2 如果获取 map 不为空,则在 map 中以 ThreaLocal 的引用作为 key 在 map 中获取对应的 entry,否则跳转到第4步
* 3 如果 entry 不为 null ,则返回 entry 对应的值,否则跳转到第4步
* 4 map 为空或 entry 为空,则通过 initialValue 函数获取初始值 value,然后以 ThreadLoca 的引用作为 key,value 作为值保存到 map 中,作为第一个值。
* 小结:先获取当前线程的 ThreadLocalMap 变量,如果存在则返回值,不存在则创建并返回初始值
*/
public T get() {
    // 获取当前线程对象
    Thread t = Thread.currentThread();
    // 获取此线程对象中维护的 ThreadLocalMap 对象
    ThreadLocalMap map = getMap(t);
    // 如果 map 存在
    if (map != null) {
        // 以当前 ThreadLocal 为 key,调用 getEntry 获取对应的 entry
        ThreadLocalMap.Entry e = map.getEntry(this);
        // 如果 entry 不为空
        if (e != null) {
            @SuppressWarnings("unchecked")
            // 获取 entry 中的 vaule 值
            // 即为当前线程中 ThreadLocal 对应的值
            T result = (T)e.value;
            return result;
        }
    }
    // 初始化:有两张情况会执行下面代码
    // 第1种情况:map 不存在,表示此线程没有维护的 ThreadLocalMap 对象 
    // 第2种情况:map 存在在,但 map 中找不到当前 ThreadLocal 对应的 entry
    return setInitialValue();
}

/**
* 初始化.
*
* @return 初始化后的值
*/
private T setInitialValue() {
    // 此方法可以被子类覆盖,如果不覆盖,返回 null
    T value = initialValue();
    // 获取当前线程对象
    Thread t = Thread.currentThread();
    // 获取此线程对象中维护的 ThreadLocalMap 对象
    ThreadLocalMap map = getMap(t);
    // 判断 map 是否存在
    if (map != null)
        // 存在则设置 map
        map.set(this, value);
    else
        // 创建map,并存放在 map 中第一个entry 的值,如果不重写,这里的 value 为 null
        createMap(t, value);
    return value;
}

/**
* 设置当前线程绑定的局部变量
* @param value 将药保存在当下线程对应的 ThreadLocal 的值
* 1 首先获得当前线程,并根据当前线程获取一个 map
* 2 如果获取 map 不为空,则将参数设置到 map 中(当前 ThreadLocal 的引用作为 key)
* 3 如果 Map 为空,则给该线程创建 map,然后将参数设置到 map 中
*/
public void set(T value) {
    // 获取当前线程对象
    Thread t = Thread.currentThread();
    // 获取此此案吃对象中维护的 ThreadLocalMap 对象
    ThreadLocalMap map = getMap(t);
    // 判断 map 是否存在
    if (map != null)
        // 存在,则设置实体 entry
        map.set(this, value);
    else
        // 1 当前线程不存在 ThreadLocalMap 对象
        // 2 调用 createMap 进行 ThreadLocalMap 对象的初始化
        // 3 并将 t (当前线程)和 value (t对应的值)作为第一个 entry 存放到 ThreadLocalMap 中
        createMap(t, value);
}

/**
* 获取当前线程对应维护的 ThreadLocalMap
*
* @param  t 当前线程
* @return 对应维护的 ThreadLocalMap
*/
ThreadLocalMap getMap(Thread t) {
    return t.threadLocals;
}

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

/**
* 删除当前线程中保存的 ThreadLocal 对应的实体 entry
*/
public void remove() {
    // 获取当前线程对象维护的 ThreadLocalMap对象
    ThreadLocalMap m = getMap(Thread.currentThread());
    // 如果 map 存在
    if (m != null)
        // 以当前 ThreadLocal 为 key,删除对应实体 entry
        m.remove(this);
}

相关文章

微信公众号

最新文章

更多