package java.lang;
import java.lang.ref.*;
import java.util.Objects;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.function.Supplier;
/**
* 该类提供线程局部变量.
* 这种变量在多线程环境下访问(通过get或set方法访问)时能保证各个线程里的变量相对独立于其他线程内的变量。
* 该实例通常是在类中定义为 private static fields，用于关联线程和线程的上下文。(例如：a user ID or Transaction ID).
* 例如： 下面的类生成每个线程本地的唯一标识符。
* 线程的id在第一次调用时被分配 {@code ThreadId.get()}，并在随后的调用中保持不变 .
*
* import java.util.concurrent.atomic.AtomicInteger;
*
* public class ThreadId {
* // 包含要分配的下一个线程id的原子整数
* private static final AtomicInteger nextId = new AtomicInteger(0);
*
* // 包含每个线程id的线程局部变量
* private static final ThreadLocal threadId =
* new ThreadLocal() {
@Override
protected Integer initialValue() {
* return nextId.getAndIncrement();
* }
* };
*
* // 返回当前线程的唯一ID
* public static int get() {
* return threadId.get();
* }
* }
*
* 只要线程{@code ThreadLocal}是活动的且实例是可访问的，则每个线程都保持对线程本地变量的副本的隐式引用。
* 一个线程结束后，所有线程本地实例的副本都受垃圾回收的影响。（除非存在对这些副本的其他引用）
*/
public class ThreadLocal {
/**
* ThreadLocals rely on per-thread linear-probe hash maps attached
to each thread (Thread.threadLocals and
* inheritableThreadLocals).
* ThreadLocal 对象充当键，通过threadLocalHashCode搜索。（将会用于在ThreadLocalMap中找到ThreadLocal对应的value值）
* 这是一种自定义的 hash code(仅仅在ThreadLocalMaps中使用)，
* 为了排除在相同线程下连续使用构造器实例化ThreadLocals出现的hashcode碰撞冲突，在较少情况下也能保持良好的表现
*/
private final int threadLocalHashCode = nextHashCode();
/**
* 下个hasCode，从0开始，原子级更新
*/
private static AtomicInteger nextHashCode =
new AtomicInteger();
/**
* 在一个 AtomicInteger 变量（初始值为0）的基础上每次累加 0x61c88647，使用 AtomicInteger 为了保证每次的加法是原子操作。
* 而 0x61c88647 这个就比较神奇了，它可以使 hashcode 均匀的分布在大小为 2 的 N 次方的数组里。
*/
private static final int HASH_INCREMENT = 0x61c88647;
/**
* 返回下一个hash code.
*/
private static int nextHashCode() {
return nextHashCode.getAndAdd(HASH_INCREMENT);
}
/**
*
* 当线程第一次访问变量时 {@link #get}，将调用此方法，
* 除非线程先前调用了该方法{@link #set},在这种情况下，将不会为线程调用该方法。
*
* 通常，每个线程最多调用一次此方法，但在后续调用了{@link #remove} 的情况下，可以再次调用该方法{@link #get}。
*
*
* 此实现只是返回{@code null};
* 如果程序员希望线程局部变量有一个初始值而不是{@code null}，{@code ThreadLocal}必须被子类化 ,然后重写此方法.
* 通常，会使用匿名内部类。
*/
protected T initialValue() {
return null;
}
/**
* 创建 ThreadLocal 局部变量。
* 变量的初始值是通过调用{@code get}上的{@code Supplier}方法来确定的。
*
* @param thread local 类型
* @param supplier 用于确定初始值的 supplier
* @return 一个新的 thread local
* @throws NullPointerException 如果 supplier 是null
* @since 1.8
*/
public static ThreadLocal withInitial(Supplier supplier) {
return new SuppliedThreadLocal<>(supplier);
}
/**
* 默认构造器
*/
public ThreadLocal() {
}
/**
* 返回当前ThreadLocal变量中的 thread 副本。
* 如果对于当前 thread，ThreadLocalMap没有值，那么将调用{@link #initialValue} 方法初始化值
*
* @return thread-local中当前thread的值
*/
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();
}
/**
* 创建 初始值的方法 set()。
* 如果 开发者 重写set()，将使用此set()
*
* @return 初始值
*/
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;
}
/**
* 大多数子类并不需要重写此方法，只依赖于{@link #initialValue}方法设置 thread-locals 的值
*
* @param value 值将会被存储在当前ThreadLocal中
*/
public void set(T value) {
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null)
map.set(this, value);
else
createMap(t, value);
}
/**
* 清除 ThreadLocalMap 中当前thread的值。
* 如果此 thread-local 被当前 thread 读取{@linkplain #get read}，且这期间当前线程没有设置其值，则调用其{@link #initialValue}方法重新初始化其值。
* 这将导致在当前线程中多次调用 {@link #initialValue}方法
* If this thread-local variable is subsequently
*
* @since 1.5
*/
public void remove() {
ThreadLocalMap m = getMap(Thread.currentThread());
if (m != null)
m.remove(this);
}
/**
* 通过ThreadLocal获取关联的map。
* 在InheritableThreadLocal中重写。
*
* @param t 当前线程
* @return ThreadLocalMap
*/
ThreadLocalMap getMap(Thread t) {
return t.threadLocals;
}
/**
* 根据currentThread 和 fistValue 创建 当前线程的 ThreadLocalMap
*
* @param t 当前线程
* @param firstValue map中的第一个entry
*/
void createMap(Thread t, T firstValue) {
t.threadLocals = new ThreadLocalMap(this, firstValue);
}
/**
* 通过 parentMap 创建对应的 ThreadLocalMap
* 设计为 只被 Thread 构造器。
*
* @param parentMap 与parent thread关联的ThreadLocalMap
* @return 与包含parentMap的map
*/
static ThreadLocalMap createInheritedMap(ThreadLocalMap parentMap) {
return new ThreadLocalMap(parentMap);
}
/**
* childValue() 显然是定义在 可继承ThradLocal 的子类中，
* 但这里是内部定义的，目的是提供 createInheritedMap 工厂方法，而不需要在InheritableThreadLocal的子类中映射类。
*
* 这种技巧比在方法中嵌入测试实例更好。
*/
T childValue(T parentValue) {
throw new UnsupportedOperationException();
}
/**
* ThreadLocal的扩展，从具体的 {@code Supplier} 获得初始值
*/
static final class SuppliedThreadLocal extends ThreadLocal {
private final Supplier supplier;
SuppliedThreadLocal(Supplier supplier) {
this.supplier = Objects.requireNonNull(supplier);
}
@Override
protected T initialValue() {
return supplier.get();
}
}
/**
ThreadLocalMap是一个定制的 hash map，只适合于维护 thread local。
在ThreadLocal类之外不导出任何操作。
这个类是 package private，允许声明类 Thread 中的 fields。
为了帮助处理非常大的和long-lived usages，哈希表条目使用WeakReferences作为键。
To help deal with
* very large and long-lived usages, the hash table entries use
* WeakReferences for keys. However, since reference queues are not
* used, stale entries are guaranteed to be removed only when
* the table starts running out of space.
*/
static class ThreadLocalMap {
/**
* The entries in this hash map extend WeakReference, using
* its main ref field as the key (which is always a
* ThreadLocal object).
在当前 ThreadLocalMap 中
如果 key
Note that null keys (i.e. entry.get()
* == null) mean that the key is no longer referenced, so the
* entry can be expunged from table. Such entries are referred to
* as "stale entries" in the code that follows.
*/
static class Entry extends WeakReference> {
/** 与ThreadLocal关联的值 */
Object value;
Entry(ThreadLocal k, Object v) {
super(k);
value = v;
}
}
/**
* 初始容量-- MUST be a power of two.
*/
private static final int INITIAL_CAPACITY = 16;
/**
* table,如果需要调整大小，通常会是原来的2倍
*/
private Entry[] table;
/**
* table中 entryies 的数量
*/
private int size = 0;
/**
* 要调整的下一个 size value。
*/
private int threshold; // 默认为 0
/**
* 最坏情况下 设置容量的调整阈值为 2/3 负载因子，不再以倍数增长
*/
private void setThreshold(int len) {
threshold = len * 2 / 3;
}
/**
* 轮询下一个
*/
private static int nextIndex(int i, int len) {
return ((i + 1 < len) ? i + 1 : 0);
}
/**
* 轮询上一个
*/
private static int prevIndex(int i, int len) {
return ((i - 1 >= 0) ? i - 1 : len - 1);
}
/**
* 构造器，包含（firstKey, firstValue）。
* ThreadLocalMaps 是延迟初始化的，只有在 最少一个 entry 放入其才会初始化
*/
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);
}
/**
* 从已给的 parentMap 构造新的 map 包含所有可继承的 ThreadLocals
* 私有，只被 createInheritedMap() 调用。
*
* @param parentMap 与 parent thread 关联的map.
*/
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
