S-JIS[2023-09-24/2024-03-22] 変更履歴

ScopedValue（Java21〜22）

Java21〜22のScopedValue（プレビュー版）について。

概要

Java20でインキュベーター版だったScopedValueが、2023/9/19にリリースされたJava21でプレビュー版になった。

ScopedValueは、マルチスレッドで呼ばれるメソッドがサブルーチンのメソッドとオブジェクトを共有できる仕組みを提供する。

サブルーチンを呼び出す際にオブジェクトを共有しようと思ったら、普通はサブルーチンの引数で渡すが、大量にあるといちいち書くのも大変になる。
オブジェクトをフィールドで保持して共有しようと思っても、マルチスレッドで呼ばれる場合はインスタンスフィールドでは保持できないので、従来ならThreadLocalを使うことになる。
しかしThreadLocalは「インスタンスが生きている間は値を保持し続けるような大きなスコープ」で使われるものなので、メソッド呼び出しの間だけ共有するような目的には重い。（特に仮想スレッドで使おうとすると、ThreadLocalの問題点が大きくなってくるらしい）
そこで、軽量なScopedValueが用意された。

ScopedValueはJava21〜22ではプレビュー版の機能なので、この機能を使いたい場合はコンパイル時にjavacコマンドに--enable-previewを付ける必要があり、
また、実行時にjavaコマンドに--enable-previewを付ける必要がある。
JShellで試す場合もjshellコマンドに--enable-previewを付ける。

> javac --enable-preview --release 21 Example.java
> java --enable-preview Example

> java --enable-preview --source 21 Example.java

例

ScopedValueクラスの使用例。

ScopedValueオブジェクトは、まずstaticフィールドで定義しておく。
（ScopedValueはjava.langパッケージなので、import無しで使える）

public class ScopedValueExample {

    private static final ScopedValue<StringBuilder> SB = ScopedValue.newInstance();

    void main() {
        var sb = new StringBuilder();

        ScopedValue.where(SB, sb)	// whereで、ScopedValueに値をマッピングする
            .run(() -> {	// runで、関数を実行する
                sub1();
                sub2();
            });

        System.out.println(sb);
    }

    private void sub1() {
        StringBuilder sb = SB.get(); // マッピングされている値が取得できる
        sb.append("sub1.");
    }

    private void sub2() {
        StringBuilder sb = SB.get(); // マッピングされている値が取得できる
        sb.append("sub2.");
    }
}

ScopedValueのwhereメソッドで、「staticフィールドのScopedValueオブジェクト」と値（この例ではStringBuilder）を指定する。
その後のrunメソッドで関数を実行する。
この関数が実行されている間は、ScopedValueオブジェクトから値（この例ではStringBuilder）が取得できる。

なお、ScopedValueのwhereメソッドを呼び出さずにScopedValueオブジェクトからgetしようとすると、NoSuchElementExceptionが発生する。

2つ以上のScopedValueを使いたい場合は、whereメソッドを複数呼び出す。

import java.util.*;

public class ScopedValueExample {

    private static final ScopedValue<StringBuilder> SB = ScopedValue.newInstance();
    private static final ScopedValue<List<String>> LIST = ScopedValue.newInstance();

    void main() {
        var sb = new StringBuilder();
        var list = new ArrayList<String>();

        ScopedValue.where(SB, sb).where(LIST, list).run(() -> {
            sub1();
            sub2();
        });

        System.out.println(sb);
        System.out.println(list);
    }

    private void sub1() {
        StringBuilder sb = SB.get();
        sb.append("sub1.");

        List<String> list = LIST.get();
        list.add("sub1");
    }

    private void sub2() {
        StringBuilder sb = SB.get();
        sb.append("sub2.");

        List<String> list = LIST.get();
        list.add("sub2");
    }
}

staticなwhereメソッドでなくSB.where(sb)みたいにして値をバインドすればいいのにと思ったんだけど、そうすると複数の値をバインドできないから、現在のような方法になってるんだろう。

ScopedValue関連のメソッド

ScopedValueのstaticメソッド

ScopedValue.Carrierのメソッド

ScopedValue.Carrierは、ScopedValueのwhereメソッドから返されるクラス。

ScopedValueのインスタンスメソッド

ScopedValueのインスタンスメソッド（get等）は、主にrunメソッド等の関数内で使用する。