CompletableFuture

Future インターフェース

Future インターフェース（JDK 1.5）は非同期ひどうきタスク実行じっこうを操作そうさするメソッドを定義ていぎする：

• 非同期ひどうきタスク実行じっこう結果けっかの取得しゅとく
• 非同期ひどうきタスク実行じっこうの取消とりけし
• 非同期ひどうきタスクが取消とりけされたかの判定はんてい
• 非同期ひどうきタスクが完了かんりょうしたかの判定はんてい

FutureTask

FutureTask は Callable と Runnable の特性とくせいを組くみ合あわせている。

  classDiagram
	class FutureTask{
		Callable
	}
	class Callable
	<<interface>> Callable
	class Runnable
	<<interface>> Runnable

	Callable --o FutureTask
	Runnable <|.. FutureTask

FutureTask の欠点

public static void main(String[] args) throws Exception {
    FutureTask<String> ft1 = new FutureTask<>(() -> {
        TimeUnit.SECONDS.sleep(3);
        System.out.println("Thread Name: " + Thread.currentThread().getName());
        return "Task1 Over";
    });
    Thread t1 = new Thread(ft1, "t1");
    t1.start();
    System.out.println("Future Task Done = " + ft1.get()); // ブロッキング

    System.out.println(Thread.currentThread().getName() + ": Compute other tasks");
}
// Output:
// Thread Name: t1
// Future Task Done = Task1 Over
// main: Compute other tasks

public static void main(String[] args) throws Exception {
    FutureTask<String> ft1 = new FutureTask<>(() -> {
        System.out.println("Thread Name: " + Thread.currentThread().getName() + " Start");
        TimeUnit.SECONDS.sleep(7);
        return "Task1 Over";
    });
    Thread t1 = new Thread(ft1, "t1");
    t1.start();
    System.out.println(Thread.currentThread().getName() + ": Compute other tasks");

    // 3秒を超えると TimeoutException がスローされる
    System.out.println("Future Task Done = " + ft1.get(3, TimeUnit.SECONDS));
}
// Output:
// main: Compute other tasks
// Thread Name: t1 Start
// Exception: java.util.concurrent.TimeoutException

CompletableFuture

CompletableFuture（JDK 8）は FutureTask の改良版かいりょうばん：

• Callback：whenComplete などのコールバックメソッドを対応たいおう
• 非同期ひどうきタスクの組くみ合あわせ：複数ふくすうの非同期ひどうきタスクを組くみ合あわせて処理しょりできる
• 最速さいそくタスクの選択せんたく：applyToEither などのメソッド
• Observer Pattern：タスク完了かんりょう後ごにリスナーに通知つうちできる

CompletionStage

CompletionStage は非同期ひどうき計算けいさん過程かていの特定とくていの段階だんかいを表あらわし、一ひとつの段階だんかいが完了かんりょうすると次つぎの段階だんかいがトリガーされる可能性かのうせいがある。Linux の Pipe (|) シンボルに類似るいじ。

stage.thenApply(x -> square(x))
    .thenAccept(x -> System.out.println(x))
    .thenRun(() -> System.out.println("Done"))

非同期タスクの作成

結果の取得

結果処理メソッド

thenApply

タスク A が完了かんりょうしたら、タスク B を実行じっこう。タスク B は A の結果けっかを必要ひつようとし、B には戻もどり値ちがある。

CompletableFuture<String> future = CompletableFuture
    .supplyAsync(() -> "Hello")
    .thenApply(s -> s + " World");

thenAccept

タスク A が完了かんりょうしたら、タスク B を実行じっこう。タスク B は A の結果けっかを必要ひつようとするが、B には戻もどり値ちがない。

CompletableFuture.supplyAsync(() -> "Hello")
    .thenAccept(System.out::println);

thenRun

タスク A が完了かんりょうしたら、タスク B を実行じっこう。タスク B は A の結果けっかを必要ひつようとしない。

CompletableFuture.supplyAsync(() -> "Hello")
    .thenRun(() -> System.out.println("Done"));

例外処理

whenComplete

前まえのスレッドの結果けっかを取得しゅとくして消費しょうひし、前まえのスレッドの戻もどり値ちに影響えいきょうしない。

exceptionally

前まえのスレッドで例外れいがいが発生はっせいした時ときに実行じっこう。例外れいがいキャプチャ範囲はんいは前まえの全すべての非同期ひどうきスレッドを含ふくむ。

handle

whenComplete() + exceptionally() に相当そうとう。例外れいがいの有無うむに応おうじて if-else 分岐ぶんき処理しょりを行おこなう。

マルチタスク組み合わせ

二つのタスク完了待ち

いずれかのタスク完了

マルチタスク待機

// いずれか完了で即返却
Object result = CompletableFuture.anyOf(cf1, cf2, cf3).join();

// 全完了で返却
CompletableFuture.allOf(cf1, cf2, cf3).join();

スレッドプールの注意事項

thenRun vs thenRunAsync

• thenRun：前まえのタスクのスレッドを使用しよう
• thenRunAsync：新あたらしいスレッドプールを指定してい可能かのう

参考リソース

• Java Thread Practices Collection