[深さ分析] ThreadLocalのソースと原則

簡単な紹介

ThreadLocalの各スレッドは、独自のデータ構造は、互いに独立して、スレッド間の閉鎖スレッドを達成するために、ストレージ・オブジェクトを維持しました。使用される場合、ThreadLocalのオブジェクトの例は、オブジェクトを取得する方法を取得/設定と呼びます。

ソースコード解析

設定/取得は、オブジェクトを保持取得する方法ですか？どのようにオブジェクトを取得しましたか？再び構造には、どのような種類を保存するには？私たちは、セット/ getメソッド分析からスタート

public void set(T value) {
    Thread t = Thread.currentThread();
    ThreadLocalMap map = getMap(t); // 根据当前线程获得ThreadLocalMap对象
    if (map != null)
        map.set(this, value); // 如果有则set
    else
        createMap(t, value); // 否则创建ThreadLocalMap对象
}
    
ThreadLocalMap getMap(Thread t) {
    return t.threadLocals;
}
    
void createMap(Thread t, T firstValue) {
    t.threadLocals = new ThreadLocalMap(this, firstValue);
}
复制代码

getMapメソッドによって、私たちの財産threadLocalsマップの可視リターンは、実際にオブジェクトを通します。そして、これは、データを格納するためのThreadLocalMap構造です。

ThreadLocalMapプロフィール

ThreadLocalMapはThreadLocalのの中核である、ThreadLocalのクラスは内部クラスで定義されている、彼は我々がエントリを呼び出し、Enrty配列を維持しました。私たちは、ロード/ストア操作がEnrtyを実現配列によって開始されTHREADLOCAL。Enrtyアレイは、私たちは、この配列に対処するために、オープンハッシュメソッドを使用して、パッケージオブジェクトを保存、実際にはハッシュテーブルです。異なる、リンクドリスト方式のHashMapを持つハッシュマップは、オブジェクトの配列にハッシュされます。競合がある場合に開くアドレス方法は、アレイ内の次の位置をハッシュすることができるルールのいくつかの種類を見つけるために、その後、後方の可能なハッシュを見つけるためにThreadLocalMapに線形モード検出を使用し、アレイの現在の場所にハッシュされ場所。

Eneryはじめに

Eneryは、ここでは、ハッシュテーブルは、ユニット内に維持され、エントリを呼び出します。Eneryオブジェクトは、古いエントリここに呼ばれるヌルヌル単一キー入力ではありません。

// 哈希映射表中的条目使用其引用字段作为键（它始终是ThreadLocal对象）继承WeakReference。
// 注意，null键（即entry.get（）== null）表示不再引用该键，因此可以从表中删除该条目。这些条目在下面的代码中称为“旧条目”。
// 这些“旧条目”就是脏对象，因为存在引用不会被GC，为避免内存泄露需要代码里清理，将引用置为null，那么这些对象之后就会被GC清理。
// 实际上后面的代码很大程度上都是在描述如何清理“旧条目”的引用
static class Entry extends WeakReference<ThreadLocal<?>> {
    Object value;
    Entry(ThreadLocal<?> k, Object v) {
        super(k);
        value = v;
    }
}
复制代码

ここでは二つの質問があるかもしれません

コンテンツが格納されるので、1は直接スレッドオブジェクトに直接格納プロパティを設定していない理由は、独自のスレッドオブジェクトのですか？または、なぜキーとしてThreadLocalのオブジェクトにハッシュテーブルエントリへのメモリの内容を維持する必要がありますか？

：ThreadLocalのオブジェクトが一つだけのスレッドに属しているが、スレッドはThreadLocalのオブジェクトをインスタンス化することができます。アレイは、重要な標的として入力ThreadLocalのインスタンスを維持するThreadLocalMap格納されています。

2、EneryのThreadLocalMapはなぜ、および参照している場合などThreadLocalのオブジェクトへの弱い参照を継承する必要がありますか？

：それは強い参照ケースが存在しないThreadLocalの弱参照オブジェクトであり、弱参照オブジェクトは、次のGC時にクリアされます。対象とThreadLocalのオブジェクトが弱参照メモリリークを防止するためです。鍵がさえ我々のコード内の参照THREADLOCAL Enery弱参照の有効期限が切れているされていない場合、ThreadLocalのはGCではありません。そのため、現在のスレッドの参照ThreadLocalMap、現在のスレッドのアップのためのThreadLocalターゲットを保持し、GCではありません。しかし、たとえ弱い基準としてTHREADLOCAL GCをクリアされ、エントリー[]エントリオブジェクトは依然として存在するが、キーがnullである、vlueオブジェクトがまだ存在して、これらが汚れオブジェクトです。弱参照THREADLOCALオブジェクトをクリーンアップするだけでなく、それはこれの一つの要素は、その後、プログラムはこれらのエントリを特定し、クリーンアップするためにGC（ここでは、古いエントリと呼ばれる）であったされているEnery []配列を識別することができます意味の別の層です。

ThreadLocalMap.set方法

マップはThreadLocalMapがsetメソッドを呼び出しますnullでないときに戻る前のセット方法に、それはハッシュテーブルにハッシュ値を設定する方法について説明します。リニア一方向ハッシュで検出方法を開いてアドレスです。設定値の後、裁判官は、ハッシュテーブルは、拡張のために必要十分な大きさであるかどうかを判断するために古いエントリしきい値を見つけられませんでした場合は、いくつかの古いエントリをクリーンアップしてみてください。ハッシュテーブルがあまりにも混雑している場合は、取得/望ましくない状況である、頻繁に紛争の値を設定します。コードおよびThreadLocalMapの詳細な注釈として設定方法

private void set(ThreadLocal<?> key, Object value) {
    // We do not use a fast path as with get() because it is at
    // least as common to use set() to create new entries as
    // it is to replace existing ones, in which case, a fast
    // path would fail more often than not.
    // 我们不像get（）那样先使用快速路径（直接散列）判断
    // 因为使用set（）创建新条目至少与替换现有条目一样频繁，在这种情况下，快速路径会更频繁地失败。
    // 所以直接先线性探测
    Entry[] tab = table;
    int len = tab.length;

    // 根据hashcode散列到数组位置
    int i = key.threadLocalHashCode & (len-1);
    // 开放地址法处理散列冲突，线性探测找到可以存放位置
    // 遍历数组找到下一个可以存放条目的位置，这种位置包含三种情况
    // 1.条目的key已存在，直接赋值value
    // 2.条目的key位null，说明k作为弱引用被GC清理，该位置为旧数据，需要被替换
    // 3.遍历到一个数组位置为null的位置赋值
    for (Entry e = tab[i];
         e != null;
         e = tab[i = nextIndex(i, len)]) {
        ThreadLocal<?> k = e.get();

        if (k == key) {//key已存在则直接更新
            e.value = value;
            return;
        }
        if (k == null) { //e不为null但k为null说明k作为弱引用被GC，是旧数据需要被清理
            // i为旧数据位置，清理该位置并依据key/value合理地散列或替换到数组中，重新散列i后面的元素，并顺便清理i位置附近的其他旧条目
            replaceStaleEntry(key, value, i);
            return;
        }
    }
    // 遍历到一个数组位置为null的位置赋值
    tab[i] = new Entry(key, value);
    int sz = ++size;
    // 调用cleanSomeSlots尝试性发现并清理旧条目，如果没有发现且旧条目当前容量超过阈值，则调用rehash
    if (!cleanSomeSlots(i, sz) && sz >= threshold)
        // 此时认为表空间不足，全量遍历清理旧条目，清理后判断容量若大于阈值的3/4，若是则扩容并从新散列
        rehash();
}
复制代码

replaceStaleEntry方法

あなたは、実装上の古いエントリが発生した場合、我々は線形replaceStaleEntry方法は、プロービング。より行うための方法は、我々はstaleSlot位置にある古いエントリを見つけて、位置をstaleSlotとstaleSlotの近くに古いエントリをクリーンアップするために新しい価値をカバーします要約することができます。コードと以下の詳細なメモ

private void replaceStaleEntry(ThreadLocal<?> key, Object value, int staleSlot) {
    Entry[] tab = table;
    int len = tab.length;
    Entry e;
    // Back up to check for prior stale entry in current run.
    // We clean out whole runs at a time to avoid continual
    // incremental rehashing due to garbage collector freeing
    // up refs in bunches (i.e., whenever the collector runs).
    // 向前检查是否存在旧条目，一次性彻底清理由于GC清除的弱引用key导致的旧数据，避免多次执行
    int slotToExpunge = staleSlot;
    // 向前遍历找到entry不为空且key为null的位置赋值给slotToExpunge
    for (int i = prevIndex(staleSlot, len);
         (e = tab[i]) != null;
         i = prevIndex(i, len))
        if (e.get() == null)
            slotToExpunge = i;

    // Find either the key or trailing null slot of run, whichever
    // occurs first
    // staleSlot位置向后遍历如果位置不为空，判断key是否已经存在
    // 回想前面我们是set实例的时候，碰到旧条目的情况下调用该方法，所以很可能在staleSlot后面key是已经存在的
    for (int i = nextIndex(staleSlot, len);
         (e = tab[i]) != null;
         i = nextIndex(i, len)) {
        ThreadLocal<?> k = e.get();

        // If we find key, then we need to swap it
        // with the stale entry to maintain hash table order.
        // The newly stale slot, or any other stale slot
        // encountered above it, can then be sent to expungeStaleEntry
        // to remove or rehash all of the other entries in run.
        // 如果我们找到键，那么我们需要将它与旧条目交换以维护哈希表顺序。
        // 然后可以将交换后得到的旧索引位置或其上方遇到的任何其他旧索引位置传给expungeStaleEntry清理旧条
        // 如果碰到key相同的值则覆盖value
        if (k == key) {
            e.value = value;
            // i位置与staleSlot旧数据位置做交换，将数组条目位置规范化，维护哈希表顺序
            // 这里维护哈希表顺序是必要的，举例来说，回想前面threadLocal.set实例的判断，是线性探测找到可以赋值的位置
            // 如果哈希顺序不维护，可能造成同一个实例被赋值多次的情况
            // 包括后面清理旧条目的地方都要重新维护哈希表顺序
            tab[i] = tab[staleSlot];
            tab[staleSlot] = e;
            // Start expunge at preceding stale entry if it exists
            // 开始清理前面的旧条目
            // 如果前面向前或向后查找的旧条目不存在，也就是slotToExpunge == staleSlot
            //此时slotToExpunge = i，此时位置i的条目是旧条目，需要被清理
            // slotToExpunge用来存储第一个需要被清理的旧条目位置
            if (slotToExpunge == staleSlot)
                slotToExpunge = i;
            // 清理完slotToExpunge位置及其后面非空连续位置后，通过调用cleanSomeSlots尝试性清理一些其他位置的旧条目
            // cleanSomeSlots不保证清理全部旧条目，它的时间复杂度O(log2n)，他只是全量清理旧条目或不清理的折中
            cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
            return;
        }

        // If we do not find stale entry on backward scan, the
        // first stale entry seen while scanning for key is the
        // first still present in the run.
        // 如果前面向前查找的旧条目不存在，也就是slotToExpunge == staleSlot,而此时位置i为旧条目，所以将i赋值给slotToExpunge
        // slotToExpunge用来存储第一个需要被清理的旧条目位置
        if (k == null && slotToExpunge == staleSlot)
            slotToExpunge = i;
    }

    // If key not found, put new entry in stale slot
    // 如果向后遍历非空entry都没有找到key，则直接赋值给当前staleSlot旧条目位置
    tab[staleSlot].value = null;
    tab[staleSlot] = new Entry(key, value);

    // If there are any other stale entries in run, expunge them
    // 通过前面根据staleSlot向前/向后遍历，如果发现有旧条目则清理
    if (slotToExpunge != staleSlot)
        // 清理完slotToExpunge位置及其后面非空连续位置后，通过调用cleanSomeSlots尝试性清理一些其他位置的旧条目
        // cleanSomeSlots不保证清理全部旧条目，它的时间复杂度O(log2n)，他只是全量清理旧条目或不清理的折中
        cleanSomeSlots(expungeStaleEntry(slotToExpunge), len);
}
复制代码

expungeStaleEntry方法

検索古いエントリはexpungeStaleEntryメソッドを実行されます。expungeStaleEntryが頻繁に使用される、古いエントリをクリーンアップするために、セル方式です。行のクリーンアップ位置、空のエントリは、すべての古いエントリを再ハッシュとstaleSlot最初の空の位置を戻らバックstaleSlot含む：ある観光名所。コードと以下の詳細なメモ

private int expungeStaleEntry(int staleSlot) {
    Entry[] tab = table;
    int len = tab.length;

    // expunge entry at staleSlot
    // 清空staleSlot位置的条目
    tab[staleSlot].value = null;
    tab[staleSlot] = null;
    size--;

    // Rehash until we encounter null
    // 旧位置清理后，后面的条目需要重新散列到数组里，直到遇到数组位置为null。即维护哈希顺序。
    Entry e;
    int i;
    for (i = nextIndex(staleSlot, len);
         (e = tab[i]) != null;
         i = nextIndex(i, len)) {
        ThreadLocal<?> k = e.get();
        if (k == null) { // k == null说明此位置也是旧数据，需要清理
            e.value = null;
            tab[i] = null;
            size--;
        } else {
            int h = k.threadLocalHashCode & (len - 1);
            // 将staleSlot后面不为空位置重新散列，如果与当前位置不同，则向前移动到h位置后面（包括h）的首个空位置
            if (h != i) {
                tab[i] = null;
                // Unlike Knuth 6.4 Algorithm R, we must scan until
                // null because multiple entries could have been stale.
                while (tab[h] != null)
                    h = nextIndex(h, len);
                tab[h] = e;
            }
        }
    }
    return i;
}
复制代码

cleanSomeSlots方法

cleanSomeSlotsはもっと賢い方法です。彼の名前は、「いくつかの」とおり。このメソッドは、暫定的に、いくつかの古いエントリを探しています。このメソッドは、新しい要素を追加したり、古いエントリを削除するときに呼び出されます。その実装の複雑さLOG2（n）は、彼が「クリーンアップされません」されており、妥協の「クリーンアップの全額」。古いエントリを見つけた場合はtrueを返します。コードと以下の詳細なメモ

private boolean cleanSomeSlots(int i, int n) {
    boolean removed = false;
    Entry[] tab = table;
    int len = tab.length;
    do {
        i = nextIndex(i, len);
        Entry e = tab[i];
        if (e != null && e.get() == null) {
            n = len;
            removed = true;
            i = expungeStaleEntry(i);
        }
    } while ( (n >>>= 1) != 0);// 无符号右移，即执行次数以n的二进制最高位的1的位置为基准，所以时间复杂度log2(n)
    return removed;
}
复制代码

焼き直し/ expungeStaleEntries /サイズ変更する方法

私たちは、しきい値決意して値を設定した後、プログラムが不十分なテーブルスペースと見なされた場合、焼き直し法と呼ばれます。焼き直しでは、2つのことを行うすべての最初は、クリーンアップ古いエントリの全額を横断して、容量を判断した後にクリーンアップする確立が2倍拡大であるとexpungeStaleEntriesを焼き直した場合、十分ですクリーンアップ古いエントリの合計量である、サイズを変更するには、二回の拡張です。

// rehash全量地遍历清理旧条目，然后判断容量若大于阈值的3/4，则扩容并从新散列
// 程序认为表空间不足时会调用该方法
private void rehash() {
    // 全量遍历清理旧条目
    expungeStaleEntries();
    // Use lower threshold for doubling to avoid hysteresis
    // 适当的扩容，以避免hash散列到数组时过多的位置冲突
    if (size >= threshold - threshold / 4)
        // 2倍扩容并重新散列
        resize();
}

// 全量遍历清理旧条目
private void expungeStaleEntries() {
    Entry[] tab = table;
    int len = tab.length;
    for (int j = 0; j < len; j++) {
        Entry e = tab[j];
        if (e != null && e.get() == null)
            expungeStaleEntry(j);
    }
}

// 二倍扩容
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;
}
复制代码

getメソッドのThreadLocal

設定のThreadLocalの取得論理比較ははるかに簡単です。彼は単に配列にThreadLocalのオブジェクトをハッシュし、線形検出の方法により求めた値が一致しました。コードと以下の詳細なメモ

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;
        }
    }
    // 如果map不为null初始化一个key为当前threadLocal值为null的ThreadLocalMap对象
    return setInitialValue();
}

private Entry getEntry(ThreadLocal<?> key) {
    int i = key.threadLocalHashCode & (table.length - 1);
    Entry e = table[i];
    if (e != null && e.get() == key)
        return e;
    else // 直接散列找不到的情况，调用getEntryAfterMiss线性探测查找期望条目
        return getEntryAfterMiss(key, i, e);
}

private Entry getEntryAfterMiss(ThreadLocal<?> key, int i, Entry e) {
    Entry[] tab = table;
    int len = tab.length;
    // 线性探测找到符合的元素，若遇到旧条目则进行清理
    while (e != null) {
        ThreadLocal<?> k = e.get();
        if (k == key)
            return e;
        if (k == null)
            expungeStaleEntry(i);
        else
            i = nextIndex(i, len);
        e = tab[i];
    }
    return null;
}
复制代码

メソッドを削除します

空に参照を削除し、約古いエントリの方法をクリーンアップするために呼び出します。削除する必要があるものをクリーンアップするremoveメソッドを使用しているとき、我々は優先順位を確認するときだから、エントリを削除しません。

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

private void remove(ThreadLocal<?> key) {
    Entry[] tab = table;
    int len = tab.length;
    int i = key.threadLocalHashCode & (len-1);
    for (Entry e = tab[i];
         e != null;
         e = tab[i = nextIndex(i, len)]) {
        if (e.get() == key) {
            e.clear();
            expungeStaleEntry(i);
            return;
        }
    }
}
复制代码

概要

ThreadLocalの最大の複雑さは、目的がメモリリークを回避するためである、古いエントリに対処する方法です。古いの場合には、可能な限りその少しの時間を見つけるためにエントリを設定して、コールcleanSomeSlotsが古いエントリの一部をクリーンアップするためにいくつかの試みの後に、古いエントリをクリーンアップの効率はクリーンアップと心のバランスの全量をクリーンアップすることはありません。expungeStaleEntryが自分の位置に古いエントリをクリーンアップだけでなく、古いエントリ周辺のクリーンアップ、エントリーの状況の両方を減少させることがわかりました。そうであっても、時に余剰能力のハッシュテーブル全額は再び古いエントリと拡張をクリーンアップします。