マルチスレッド - ThreadLocal

ThreadLocal 定義

ThreadLocal はスレッドのローカル変数であり、スレッドのプライベート情報を保存するためのメカニズムです。

ThreadLocal を通じて、各スレッドにスレッドの一意の変数コピーを提供して、各スレッド間でアクセスされる変数が相互に影響を及ぼさないようにすることができます。この変数はスレッドのライフサイクル内でのみ機能し、このスレッド内のどこでも使用して、同じスレッド内の複数の関数間の変数転送の複雑さを軽減できます。

ThreadLocal は Java マルチスレッド プログラムの同時実行性の問題を解決する方法です。ThreadLocal に加えて、ロックのメカニズム (例: synchronized  ) を通じて変数のスレッドの安全性を確保することもできますが、ロックはプログラムの実行効率に影響します。このとき、ThradLocal が役に立ちます。

2 つの使用シナリオ

1. Spring トランザクション分離は、ThreadLocal および AOP に基づいて実装されます。特定のソース コードについては、TransactionSynchronizationManager を参照してください。

2. Spring は ThreadLocal を使用して、単一スレッドでのデータベース操作が同じデータベース接続を使用することを保証します。

3. セッション管理。

4. ビジネスに複数のメソッドとマルチレベルの呼び出しが含まれる場合、ユーザー ID をコントローラーから dao 層に透過的に送信するなど、一時的なパラメーターの受け渡しを防ぐために、リクエスト パラメーターを ThreadLocal に置きます。

5. ThreadLocal に基づいて SimpleDateFormat スレッド セーフを実装します。

6、……

3 つの API

// 获取当前线程中的共享变量的副本
public T get() {}

// 设置当前线程中变量的副本值
public void set(T value) {}

// 移除当前线程中变量的副本，回收内存；
// 其实这个不是必须要调用的，因为当线程失效之后，这些内存会自动释放
// 未避免出现内存泄露问题，建议在线程结束前手动调用该方法清空数据
public void remove() {}

// get调用时的默认值，默认返回null
// protected方法；方便实际业务中根据实际需要重写方法
protected T initialValue() {}

呼び出し例:

        ThreadLocal<String> tl = new ThreadLocal<>();
        
        tl.set("zhangsan");
        
        System.out.println(tl.get());
        
        tl.remove();

設定（）

ソースコードの例:

    public void set(T value) {
        Thread t = Thread.currentThread();  // 获取当前线程
        ThreadLocal.ThreadLocalMap map = getMap(t);  // 获取当前线程 ThreadLocalMap 对象
        if (map != null)
            map.set(this, value);  // 不为空则set
        else
            createMap(t, value);  // 为空则初始化当前线程 ThreadLocalMap
    }

set() メソッドの実装は比較的単純で、主に ThreadLocalMap オブジェクトに焦点を当てています。ThradLocalMap オブジェクトは、現在のスレッドから取得される threadLocals 変数です。

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

public class Thread implements Runnable {

    ... ... 

    /* ThreadLocal values pertaining to this thread. This map is maintained
     * by the ThreadLocal class. */
    ThreadLocal.ThreadLocalMap threadLocals = null;

    /*
     * InheritableThreadLocal values pertaining to this thread. This map is
     * maintained by the InheritableThreadLocal class.
     */
    ThreadLocal.ThreadLocalMap inheritableThreadLocals = null;

各スレッドは独自の threadLocals を保持します。スレッドが TreadLocal を作成して変数を保存すると、その変数は実際には現在のスレッド自体の threadLocals 変数に存在します。当然、他のスレッドは現在のスレッドの変数を取得できず、データの分離が実現されます。

ThreadLocalMap をもう一度見てみましょう。

static class ThreadLocalMap {

        // 基于弱引用的Entry对象
        static class Entry extends WeakReference<ThreadLocal<?>> {
            /** The value associated with this ThreadLocal. */
            Object value;

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

        // 初始容量 默认16
        private static final int INITIAL_CAPACITY = 16;

        // 数组结构存储数据
        private Entry[] table;

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

        /** The next size value at which to resize. */
        private int threshold; // Default to 0

        // resize门限 2/3
        private void setThreshold(int len) {
            threshold = len * 2 / 3;
        }

上記のソース コードから、ThreadLocal は値を格納せず、スレッドが対応する値を取得できるように ThreadLocalMap のキーとしてのみ使用されることもわかります。

ThreadLocalMap には Entry 配列があります。データが使用される理由は、スレッド内に異なるオブジェクトを格納するために複数の異なる ThreadLocal が存在する可能性があるためです。そのため、ここでは格納するために配列が使用されます。

ThreadLocalMap のデータ構造は HashMap に似ていますが、Map インターフェイスが実装されておらず、Entry が WeakReference の弱参照を継承しており、HashMap には次がないためリンク リストがありません。そのため、ハッシュの競合がある場合、ThreadLocalMap は線形検出を使用してハッシュの競合を解決します。ソースコードを参照してください:

private void set(ThreadLocal<?> key, Object value) {

            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)]) {
                ThreadLocal<?> k = e.get();

                // 如果当前位置不为空，且key即为当前threadlocal，则刷新value
                if (k == key) {
                    e.value = value;
                    return;
                }

                // 如果当前位置为空，则初始化一个Entry对象
                if (k == null) {
                    replaceStaleEntry(key, value, i);
                    return;
                }
            }

            tab[i] = new Entry(key, value);
            int sz = ++size;
            if (!cleanSomeSlots(i, sz) && sz >= threshold)
                rehash();
        }

要素を設定するとき、ThreadlocalMap はまずキー (現在の ThreadLocal の threadLocalHashCode) を取得し、threadLocalHashCode の値に従ってテーブル内の要素を見つけます。

    1. 現在の場所が空の場合は、Entry オブジェクトを初期化して、現在の場所に配置します。

    2. 現在の場所が空ではなく、キーが現在のスレッドローカルである場合は、値を更新します。

    3. 現在空かどうか、そしてキーが現在のスレッドローカルではない場合は、テーブルの反復を続けて次の空の位置を見つけます。

得る（）

ソースコードの例:

    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();
    }

    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
             return getEntryAfterMiss(key, i, e);
    }

    private Entry getEntryAfterMiss(ThreadLocal<?> key, int i, Entry e) {
        Entry[] tab = table;
        int len = tab.length;

        // 根据key的hashcode获取在table中的下标值，循环查找元素对比key是否相等
        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;
    }

set() と同様に、この関数も最初に現在のスレッドの ThreadLocalMap を取得し、次に threadlocal の threadLocalHashCode を使用して、map.getEntry() のテーブル内の現在の threadlocal を見つけます。その後、要素をループしてキーを比較し、データを取得します。 

メモリリークの問題

ThreadLocalMap の Entry オブジェクトに戻ります。Entry オブジェクトは WeakReference 弱参照を継承すると前述しました。弱参照の定義を参照してください。

弱引用（Weak Reference）：弱引用的对象拥有更短暂的生命周期。
在垃圾回收器线程扫描它所管辖的内存区域的过程中，一旦发现了只具有弱引用的对象，
不管当前内存空间足够与否，都会回收它的内存

これは問題を引き起こします。つまり、現在のスレッドローカルに外部参照がない場合、この時点で GC がトリガーされると、エントリのキー、つまりスレッドローカルがリサイクルされ、現在の Theadlocal を作成したスレッドが実行されている場合、エントリの値オブジェクトがリサイクルされず、時間の経過とともにメモリ リークが発生する可能性があります。

したがって、上記のメモリ オーバーフローの問題を回避するには、threadlocal を使用する場合、スレッド コードの最後で ThreadLocal の Remove() メソッドを呼び出して値をクリアすることを忘れないでください。これにより、メモリ リークを避けるために GC がトリガーされたときに値がリサイクルされます。

親スレッドと子スレッドは ThreaLocal を共有します

親スレッドのスレッド変数の取得をサポートするために、java.lang.Thread に継承可能なThreadLocals 属性が提供されています。

    /*
     * InheritableThreadLocal values pertaining to this thread. This map is
     * maintained by the InheritableThreadLocal class.
     */
    ThreadLocal.ThreadLocalMap inheritableThreadLocals = null;

コード例:

    public static void main(String[] args) {
        ThreadLocal<String> tl = new InheritableThreadLocal<>();
        tl.set("zhangsan");

        Thread child = new Thread() {
            @Override
            public void run() {
                super.run();
                System.out.println(tl.get());
            }
        };

        child.start();
    }

実装原理については、Thread クラスの init メソッドを参照してください。

    private void init(ThreadGroup g, Runnable target, String name,
                      long stackSize, AccessControlContext acc) {
 
        ... ...

        if (parent.inheritableThreadLocals != null)
            this.inheritableThreadLocals =
                ThreadLocal.createInheritedMap(parent.inheritableThreadLocals);

        ... ...
    }

親スレッドのheritableThreadLocals属性が空でない場合は、親スレッドのinheritableThreadLocals属性を子スレッドに割り当てて、親スレッドと子スレッド間の共有スレッドローカルを実現します。