今さらだけど JavaFX で非同期処理

このエントリーは、JavaFX Advent Calendar 2017 の 6 日目です。

昨日は @planet-az さんの「簡単なミュージックプレーヤーを作ってみた」でした。

明日はこの記事を書いている現時点ではまだ空いてます。(^_^; きっと誰かが素敵な記事を投稿してくれると楽しみにしています。

今さらですが JavaFX の非同期処理を復習がてら簡単にみていきたいと思います。

では、次のようなプログラムを作ってみます。

1

long result = 1;

for (int i = 0; i < repeatProcessingNumber; i++) {

result += result;

初期値 1 で10回ループするプログラムです。

計算終了後は 1024 と結果を表示します。

これだけでは時間のかかる処理とはならないので

TimeUnit.MILLISECONDS.sleep(500);

とスレッドをスリープさせています。

プログラムの状態、計算中の値の表示やキャンセルなどのメッセージ表示、プログレスバーによるプログラムの進捗状態の可視化などを実装します。

思考停止状態でギナギナっと作ったプログラムは次のようなものです。

Warning! This code will make you headache.

You do not have to read it.

package jp.yucchi.badasynchronousprocessing4javafx;

import java.util.concurrent.TimeUnit;
import java.util.logging.Level;
import java.util.logging.Logger;
import javafx.application.Application;
import javafx.geometry.Insets;
import javafx.scene.Scene;
import javafx.scene.control.Button;
import javafx.scene.control.Label;
import javafx.scene.control.ProgressBar;
import javafx.scene.layout.FlowPane;
import javafx.stage.Stage;

/**
 *
 * @author Yucchi
 */
public class BadAsynchronousProcessing4JavaFX extends Application {

    private Label statusLabel;
    private Label messageLabel;
    private Label interimResult;
    private Label resultLabel;
    private ProgressBar progressBar;
    private Button startButton;
    private Button cancelButton;
    private boolean cancelFlag;

    @Override
    public void start(Stage primaryStage) {
        System.out.println(cancelFlag);

        statusLabel = new Label("STATUS");
        statusLabel.setMinWidth(200);
        messageLabel = new Label("MESSAGE");
        messageLabel.setMinWidth(200);
        interimResult = new Label("INTERIM RESULT");
        interimResult.setMinWidth(200);
        resultLabel = new Label("RESULT");
        resultLabel.setMinWidth(200);
        progressBar = new ProgressBar(0);
        progressBar.setMinWidth(200);
        startButton = new Button("START");
        startButton.setMinWidth(200);
        cancelButton = new Button("CANCEL");
        cancelButton.setMinWidth(200);
        cancelButton.setDisable(true);

        FlowPane root = new FlowPane();
        root.setPadding(new Insets(10));
        root.setHgap(10);
        root.setVgap(10);
        root.getChildren().addAll(statusLabel, messageLabel, interimResult, resultLabel, progressBar, startButton, cancelButton);

        Scene scene = new Scene(root, 220, 225);

        primaryStage.setTitle(this.getClass().getSimpleName());
        primaryStage.setScene(scene);
        primaryStage.show();

        primaryStage.setOnCloseRequest(we -> {

        });

        startButton.setOnAction(ae -> {
            resultLabel.setText("RESULT");
            executeTask();
        });

        cancelButton.setOnAction(ae -> {
            startButton.setDisable(false);
            cancelButton.setDisable(true);
            statusLabel.setText("CANCELED");
            messageLabel.setText("Cancelled!");
            progressBar.setProgress(0.0);
            interimResult.setText("INTERIM RESULT");
            cancelFlag = true;
        });
    }

    /**
     * @param args the command line arguments
     */
    public static void main(String[] args) {
        launch(args);
    }

    private void executeTask() {

        startButton.setDisable(true);
        cancelButton.setDisable(false);

        int repeatProcessingNumber = 10;
        long result = 1;
        statusLabel.setText("RUNNING");
        messageLabel.setText("Start!");
        interimResult.setText(String.valueOf(result));
        progressBar.setProgress(0);

        for (int i = 0; i < repeatProcessingNumber; i++) {

            if (cancelFlag) {
                System.out.println("This program has been canceled.");
                break;
            }

            try {
                TimeUnit.MILLISECONDS.sleep(500);

            } catch (InterruptedException ex) {
                Logger.getLogger(BadAsynchronousProcessing4JavaFX.class.getName()).log(Level.SEVERE, null, ex);
                if (cancelFlag) {
                    System.out.println("This program has been canceled.");
                    break;
                }
            }

            result += result;
            messageLabel.setText(String.format("%d/%d", i + 1, repeatProcessingNumber));
            interimResult.setText(String.valueOf(result));
            progressBar.setProgress(i);

        }

        if (!cancelFlag) {
            statusLabel.setText("SUCCEEDED");
            resultLabel.setText(String.valueOf(result));
        } else {
            cancelFlag = false;
        }

        startButton.setDisable(false);
        cancelButton.setDisable(true);

    }

}

それではこのプログラムを実行してみましょう。

2

「START」 ボタンを押した瞬間プロブラムがフリーズしたようになりました。

そして暫くすると結果が表示されました。

3

これは駄目ですね。(>_<。)

プログラムがビジー状態で応答しなくなってしまっては使い物になりません。

進捗状態がわからないのは致命的です。

そして唐突に計算が終了してプログラムが完了する。

そう言えば遠い昔にこのような状態のプログラムが当たり前のように存在していたような気がする。

今の時代こんなのは絶対に許されません。

何がいけないのか?

それは時間のかかる処理を JavaFX アプリケーションスレッド上で行っているからです。

NetBeans のプロファイラで確認してみます。

4

JavaFX Application Thread タイムラインを見てください。

START ボタンを押した瞬間に時間のかかる処理(スレッドスリープ)が走ってます。(緑色から紫色に変わっているところ)

これでは UI の更新処理などはできませんね。

時間のかかる処理をしている間プログラムの応答は無くなり、ビジー状態のようになってしまいます。

つまり、時間のかかる処理用にスレッドをもう一つ起こせばこの問題は解決するはずです。

この問題を解決するのに最適な方法は javafx.concurrentパッケージを使用することです。

javafx.concurrent パッケージは、Worker インタフェースと、2つの具体的な実装である Task および Service クラスで構成されています。

Worker インタフェースは、バックグラウンドスレッド上の Worker オブジェクトの状態、進捗を監視可能なプロパティで公開しています。

状態は ReadOnlyObjectProperty<Worker.State> stateProperty で確認できます。

次のように Enum Worker.State で定義されています。

  • READY     Workerがまだ実行されておらず、実行の準備ができているか、またはWorkerが再初期化されたことを示します。
  • SCHEDULED   Workerの実行がスケジュールされているが、現在は実行中ではないことを示します。
  • RUNNING        このWorkerが実行中であることを示します。
  • SUCCEEDED   このWorkerが正常に完了しており、valueプロパティから読み取る準備ができている有効な結果があることを示します。
  • CANCELLED     このWorkerがWorker.cancel()メソッドによって取り消されたことを示します。
  • FAILED         通常は予期しない条件が発生したことによって、このWorkerが失敗したことを示します。

これらは JavaFX アプリケーションスレッドから使用できます。

Worker オブジェクトによって実行される処理の進捗は、totalWork、workDone、progress など、3つの異なるプロパティを通じて取得できます。

Worker オブジェクトの状態が変化するときに発生するイベントは WorkerStateEventクラスによって指定されます。

これは Task クラスと Service クラスの両方に EventTarget インタフェースが実装され状態イベントのリスニングがサポートされているからです。

今回は再利用の必要が無い Worker オブジェクトを生成するので Task クラスを利用します。

上記のように JavaFX の Task クラスは FutureTask クラスの完全に監視可能にした実装となっています。

この Task クラスを拡張しバックグラウンドスレッドで実行するロジックを実装します。

懐かしのSwingWorker クラスを思い出させてくれますね。(もう、ほとんど覚えてないけどね)

SwingWorker では doInBackground() メソッドにてバックグラウンドスレッドロジックを呼び出します。

JavaFX の場合は call() メソッドです。

doInBackground() メソッド、call() メソッドともにどちらも抽象メソッドなのでオーバーライドして使います。

call() メソッドは Task クラスが実行されるときに呼び出され、call() メソッドに実装されたバックグラウンドスレッドロジックを実行します。

つまり、仕組み的には SwingWorker とほとんど変わりはないので馴染みやすいかも知れません。

さて、JavaFX のために用意されたのにこれだけではあまり意味がありません。

この Task クラスの実行にあたり updateProgress() メソッド、updateMessage() メソッド、updateValue() メソッド、updateTitle() メソッドを呼び出すことができます。

これらを使用するとプログラムの状態、進捗状況、実行中の処理の結果の一部を返すなどを可視化できます。

ちょっと updateValue() メソッドの実装をみてみましょう。

    protected void updateValue(V value) {
        if (isFxApplicationThread()) {
            this.value.set(value);
        } else {
            // As with the workDone, it might be that the background thread
            // will update this value quite frequently, and we need
            // to throttle the updates so as not to completely clobber
            // the event dispatching system.
            if (valueUpdate.getAndSet(value) == null) {
                runLater(() -> Task.this.value.set(valueUpdate.getAndSet(null)));
            }
        }
    }

呼び出しが JavaFX アプリケーションスレッドかそうでないかで分岐処理をおこなっています。

JavaFX アプリケーションスレッドからだったらそのまま値を更新します。

    void runLater(Runnable r) {
        Platform.runLater(r);
    }

でなければ runLater()メソッドで javafx.application.Platform クラスの runLater(Runnable runnable) メソッドを呼び出して値を更新します。

何故なら、JavaFX Sceneグラフは、スレッドセーフではなく、JavaFXアプリケーションスレッドのみアクセスおよび変更できます。

これは Swing では javax.swing.SwingUtilities クラスの invokeLater(Runnable doRun) メソッドと同じようなものです。

JDK1.3 からは java.awt.EventQueue.invokeLater() を呼び出すように作られています。

このinvokeLater(Runnable doRun) メソッドはどのスレッドからも呼び出しが可能となっています。

javafx.application.Platform クラスの runLater(Runnable runnable) メソッドも任意のスレッドから呼び出し可能となっています。

updateProgress() メソッド、updateMessage() メソッド、updateValue() メソッド、updateTitle() メソッドの API ドキュメントには「このメソッドは、任意のスレッドから安全に呼び出すことができます。」と記載されています。

ちなみに updateValue() メソッドは JavaFX 8 からなので上記のようにラムダ式を使い綺麗に書かれています。

古くからある updateMessage() メソッドは次のように Java SE 7 の時代のコードのままとなっています。

    protected void updateMessage(String message) {
        if (isFxApplicationThread()) {
            this.message.set(message);
        } else {
            // As with the workDone, it might be that the background thread
            // will update this message quite frequently, and we need
            // to throttle the updates so as not to completely clobber
            // the event dispatching system.
            if (messageUpdate.getAndSet(message) == null) {
                runLater(new Runnable() {
                    @Override public void run() {
                        final String message = messageUpdate.getAndSet(null);
                        Task.this.message.set(message);
                    }
                });
            }
        }
    }

このようなのを目にすると Java は開発者のために進化し続けている言語なんだなぁって感慨深いものがありますね。

SwingWorker のように publish() メソッド、process() メソッドなんてのは JavaFX には必要なくなってます。

このようにありがたい機能を標準で実装されている Task クラスですがさらに便利なプロパティを持っています。

これから先程のプログラムを改善するのにいくつかの Task クラスのプロパティを使用します。

それらプロパティは JavaFX のバインドという機能により快適に使用することが可能です。

JSR 295 Beans Binding と同じようなものです。

実際にどのように利用するかというと Task クラスの実行状態(Worker オブジェクト)のプロパティを利用して「START」ボタン、「CANCEL」ボタンの活性化、非活性化をおこないます。

また、バックグラウンドスレッド(Worker オブジェクト)の状態、計算結果の一部を返す処理、プログレスバーによるプログラムの進捗状態の表示もおこないます。

これらの対応を施したプログラムは次のようになります。

package jp.yucchi.asynchronousprocessing4javafx;

import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.TimeUnit;
import java.util.logging.Level;
import java.util.logging.Logger;
import javafx.application.Application;
import javafx.concurrent.Task;
import static javafx.concurrent.Worker.State.RUNNING;
import javafx.geometry.Insets;
import javafx.scene.Scene;
import javafx.scene.control.Button;
import javafx.scene.control.Label;
import javafx.scene.control.ProgressBar;
import javafx.scene.layout.FlowPane;
import javafx.stage.Stage;

/**
 *
 * @author Yucchi
 */
public class AsynchronousProcessing4JavaFX extends Application {

    private final ExecutorService executorService = Executors.newSingleThreadExecutor();
    private Label statusLabel;
    private Label messageLabel;
    private Label interimResult;
    private Label resultLabel;
    private ProgressBar progressBar;
    private Button startButton;
    private Button cancelButton;

    @Override
    public void start(Stage primaryStage) {

        statusLabel = new Label("STATUS");
        statusLabel.setMinWidth(200);
        messageLabel = new Label("MESSAGE");
        messageLabel.setMinWidth(200);
        interimResult = new Label("INTERIM RESULT");
        interimResult.setMinWidth(200);
        resultLabel = new Label("RESULT");
        resultLabel.setMinWidth(200);
        progressBar = new ProgressBar(0);
        progressBar.setMinWidth(200);
        startButton = new Button("START");
        startButton.setMinWidth(200);
        cancelButton = new Button("CANCEL");
        cancelButton.setMinWidth(200);
        cancelButton.setDisable(true);

        FlowPane root = new FlowPane();
        root.setPadding(new Insets(10));
        root.setHgap(10);
        root.setVgap(10);
        root.getChildren().addAll(statusLabel, messageLabel, interimResult, resultLabel, progressBar, startButton, cancelButton);

        Scene scene = new Scene(root, 220, 225);

        primaryStage.setTitle(this.getClass().getSimpleName());
        primaryStage.setScene(scene);
        primaryStage.show();

        primaryStage.setOnCloseRequest(we -> {
            executorService.shutdownNow();
        });

        startButton.setOnAction(ae -> {
            resultLabel.setText("RESULT");
            executeBackgroundTask();
        });

    }

    public static void main(String[] args) {
        launch(args);
    }

    private void executeBackgroundTask() {

        Task<Long> task = new Task<>() {
            @Override
            public Long call() {

                int repeatProcessingNumber = 10;
                long result = 1;
                updateMessage("Start!");
                updateValue(result);
                updateProgress(0, repeatProcessingNumber);

                for (int i = 0; i < repeatProcessingNumber; i++) {
                    if (isCancelled()) {
                        System.out.println("This program has been canceled.");
                        break;
                    }

                    try {
                        TimeUnit.MILLISECONDS.sleep(500);
                    } catch (InterruptedException ex) {
                        Logger.getLogger(AsynchronousProcessing4JavaFX.class.getName()).log(Level.SEVERE, null, ex);
                        if (isCancelled()) {
                            System.out.println("Canceled by InterruptedException.");
                            break;
                        }
                    }

                    result += result;
                    updateMessage(String.format("%d/%d", i + 1, repeatProcessingNumber));;
                    updateValue(result);
                    updateProgress(i + 1, repeatProcessingNumber);
                }

                return result;

            }

            // Workerオブジェクトの状態が変化したときのコールバックメソッド(5種類)
            @Override
            protected void scheduled() {
                super.succeeded();
                updateMessage("scheduled!");
                System.out.println("Call scheduled()");
            }

            @Override
            protected void running() {
                super.running();
                updateMessage("running!");
                System.out.println("Call running()");
            }

            @Override
            protected void succeeded() {
                super.succeeded();
                updateMessage("Succeeded!");
                System.out.println("Call succeeded()");
                resultLabel.setText("RESULT: " + getValue().toString());
            }

            @Override
            protected void cancelled() {
                super.cancelled();
                updateMessage("Cancelled!");
                System.out.println("Call cancelled()");
                progressBar.progressProperty().unbind();
                progressBar.setProgress(0.0);
                interimResult.textProperty().unbind();
                interimResult.setText("INTERIM RESULT");
            }

            @Override
            protected void failed() {
                super.failed();
                updateMessage("Failed!");
                System.out.println("Call failed()");
            }
        };

        // WorkerStateEven を使ってWorkerオブジェクトの状態を監視
        task.setOnScheduled(wse -> System.out.println("setOnScheduled"));
        task.setOnRunning(wse -> System.out.println("setOnRunning"));
        task.setOnSucceeded(wse -> System.out.println("setOnSucceeded"));
        task.setOnCancelled(wse -> System.out.println("setOnCancelled"));
        task.setOnFailed(wse -> System.out.println("setOnFailed"));

        // textProperty と Workerオブジェクトの stateProperty をバインド
        statusLabel.textProperty().bind(task.stateProperty().asString());
        // textProperty と Workerオブジェクトの messageProperty をバインド
        messageLabel.textProperty().bind(task.messageProperty());
        // textProperty と Workerオブジェクトの valueProperty をバインド
        interimResult.textProperty().bind(task.valueProperty().asString());
        // progressProperty と Workerオブジェクトの progressProperty をバインド
        progressBar.progressProperty().bind(task.progressProperty());
        // disableProperty と Workerオブジェクトの stateProperty をバインド
        startButton.disableProperty().bind(task.stateProperty().isEqualTo(RUNNING));
        cancelButton.disableProperty().bind(task.stateProperty().isNotEqualTo(RUNNING));

        cancelButton.setOnAction(ae -> {
            task.cancel();
        });

        // ExecutorService を利用してバックグラウンドスレッドを開始
        executorService.submit(task);

    }

}

このプログラムの実行結果を見てみましょう。

5

ついでに NetBeans のプロファイラでバックグラウンドスレッドが生成されているのを確認しましょう。

6

pool-2-thread-1 がバックグラウンドスレッドとして起動されています。

これで JavaFX アプリケーションスレッドはイベント処理が可能となります。

画面が固まることなくバックグラウンドスレッドの状態、計算結果の一部(途中経過)、プログレスバーも表示されています。

また、「START」ボタン、「CANCEL」ボタンの活性化、非活性化もちゃんとできています。

まず、Task クラスをみていきましょう。

今回はcall() メソッドを実行するために java.util.concurrent の ExecutorService インタフェースを利用しました。

184行目です。

executorService.submit(task);

タスクをパラメータとして指定したスレッドの開始としては次の方法もあります。

Thread th = new Thread(task);
th.setDaemon(true);
th.start();

call() メソッドに時間のかかる処理を記述します。バックグラウンドスレッドロジックです。

call() メソッドが呼ばれたら初期値をセットします。

updateMessage() メソッド、updateValue() メソッド、updateProgress() メソッドはプロパティバインドを利用します。

バックグラウンドスレッドが開始されたらキャンセル操作がリクエストされたかも監視しなければいけません。

キャンセルは java.​util.​concurrent.​FutureTask クラスの isCancelled() メソッドを使います。

今回、スレッドをスリープさせているので InterruptedException をスローする場合があります。

また InterruptedException は Task のキャンセルの結果として発生する場合があるため、確実に InterruptedException を処理し、キャンセル状態を調べる必要があります。

それに対応するために 102 行目の catch 節のところにも isCancelled() メソッドを使用しています。

このようにバックグラウンドスレッドロジック内にブロッキング・コールがある場合は注意が必要となります。

バックグラウンドスレッドでの処理の結果の一部を返すために 110 行目に updateValue() メソッドを使います。

同様に 109 行目で messageLabel 、111 行目で progressBar の更新も行っています。

これらの更新は JavaFX のバインドという便利な機能を使います。

Task クラスのプロパティと Label のテキストプロパティ、ProgressBar の プログレスプロパティとバインドします。

168 行目から次のようにバインドしています。

// textProperty と Workerオブジェクトの stateProperty をバインド
statusLabel.textProperty().bind(task.stateProperty().asString());
// textProperty と Workerオブジェクトの messageProperty をバインド
messageLabel.textProperty().bind(task.messageProperty());
// textProperty と Workerオブジェクトの valueProperty をバインド
interimResult.textProperty().bind(task.valueProperty().asString());
// progressProperty と Workerオブジェクトの progressProperty をバインド
progressBar.progressProperty().bind(task.progressProperty());

これで自動的に Task クラス(Workerオブジェクト)のプロパティ updateXXX() メソッドで更新されたら Label 、ProgressBar も更新されます。

もし、キャンセル操作が実行され、プログラムの実行結果の一部が表示されたままになるのが嫌なら

141 行目の Worker オブジェクトの状態が変化したときのコールバックメソッドである cancelled() メソッドの処理でいったん unbind() メソッドによりバインドを解除して初期値を設定し直すといいでしょう。

@Override
protected void cancelled() {
    super.cancelled();
    updateMessage(“Cancelled!”);
    System.out.println(“Call cancelled()”);
    progressBar.progressProperty().unbind();
    progressBar.setProgress(0.0);
    interimResult.textProperty().unbind();
    interimResult.setText(“INTERIM RESULT”);
}

このようなコールバックメソッドはこの他にもあり、全部で5種類あります。

必要に応じて便利に使えます。

118 行目から 158 行目を参照ください。

バックグラウンドタスクが無事に終了したら 134 行目の succeeded() メソッドがコールバックされます。

@Override
protected void succeeded() {
    super.succeeded();
    updateMessage(“Succeeded!”);
    System.out.println(“Call succeeded()”);
    resultLabel.setText(“RESULT: ” + getValue().toString());
}

ここで Task クラスに戻り値がある場合それを取得します。

戻り値の型はジェネリクスの型パラーメターで指定されたものです。

今回のプログラムでは Long となっています。

必然的に Call() メソッドの戻り値も Long です。

計算結果は 138 行目で javafx.​concurrent.​Task クラスの getValue() メソッドで取得しています。

                resultLabel.setText(“RESULT: ” + getValue().toString());

そして、計算結果を Label のテキストとしてセットしています。

これらのコールバックメソッドは JavaFX アプリケションスレッド上で実行されるので RuntimeException も出ません。

コールバックメソッドを利用する以外にも WorkerStateEvent を使ってイベント処理として扱うこともできます。

160 行目から 165 行目のようにイベントハンドラを登録して使用します。

// WorkerStateEven を使ってWorkerオブジェクトの状態を監視
task.setOnScheduled(wse -> System.out.println(“setOnScheduled”));
task.setOnRunning(wse -> System.out.println(“setOnRunning”));
task.setOnSucceeded(wse -> System.out.println(“setOnSucceeded”));
task.setOnCancelled(wse -> System.out.println(“setOnCancelled”));
task.setOnFailed(wse -> System.out.println(“setOnFailed”));

では、このプログラムを動かしたときの Worker オブジェクトの state プロパティ がどのように変化するか確認します。

プログラムが完する場合次のように出力されます。

setOnScheduled
Call scheduled()
setOnRunning
Call running()
setOnSucceeded
Call succeeded()

この出力結果から

SCHEDULED
RUNNING
SUCCEEDED

と遷移しているのが解ります。

プログラムを途中でキャンセルしてみる場合も確認します。

setOnScheduled
Call scheduled()
setOnRunning
Call running()
setOnCancelled
Call cancelled()
Canceled by InterruptedException.

予想通りの結果ですね。

SCHEDULED
RUNNING
CANCELLED

上記のように遷移しています。これらの動作は想像通りでした。

コールバックメソッドより WorkerStateEvent を使ってイベントハンドラを登録したほうが早い結果となっています。

だからといってメリット、デメリットがあるかどうかは私には解りません。

さて、最後に、「START」ボタン、「CANCEL」ボタンの活性化、非活性化をみてみましょう。

175 行目から 177 行目です。

// disableProperty と Workerオブジェクトの stateProperty をバインド
startButton.disableProperty().bind(task.stateProperty().isEqualTo(RUNNING));
cancelButton.disableProperty().bind(task.stateProperty().isNotEqualTo(RUNNING));

Button の disableProperty と Workerオブジェクトの stateProperty をバインドしているだけです。

startButton は Workerオブジェクトの stateProperty が RUNNING なら非活性化となります。

cancelButton は Workerオブジェクトの stateProperty が RUNNING でなければ非活性化となります。

つまり、Workerオブジェクトの stateProperty が RUNNING の場合だけ活性化します。

これでいちいち操作を行うたびに Button を活性化、非活性化処理を記述しなくてすみます。

このように JavaFX には非同期処理を簡単に扱うことができるようになっています。

SwingWorker を使って非同期処理プログラムを組んでいるのなら JavaFX の javafx.concurrentパッケージを使ってみて時代の流れを感じ取ってみてはいかがでしょうか。

お終い!

I wish you a Merry Christmas.

Java SE 9 の予習 その4

Java SE 9 の予習 その4です。

前回のエントリーの続きでおそらく今回も必要とされない無駄なお遊びとなります。

今回は JShell API を利用してアプリケーション内でスニペットの評価や実行を試してみます。

なお、今回のエントリーには 「Java SE 9のProject Kulla、JShellの動作とJShell API (3/4)(JShell API)」の記事を参考にさせていただきました。

ほとんどプログラムは丸写し状態になっていますので元記事をまず読んで理解してこのお遊びプログラムを堪能していただければ幸いです。

下記プログラムは普通に19行目のコンストラクタ内で JShell.create() メソッドによりオブジェクトを生成します。

1

スニペットの評価実行は29行目の eval(String snipetSource) メソッドでおこなわれます。(折り畳んでいるので隠れてます。)

( 最後にいろいろゴニョゴニョ遊んだコードを載せますので行番号はずれてしまいますが参考にしてくださいませ。)

List<SnippetEvent> eval(String snipetSource) メソッドで SnippetEvent オブジェクトを取得します。

JavaDoc では 戻り値:この評価によって直接的または間接的に発生したイベントのリスト となっています。

つまり、ステータスや値です。

種類は、jdk.​jshell.​Snippet クラスの public Kind kind() メソッドで取得します。

戻り値である jdk.jshell.Snippet.Kind は jdk.​jshell.​Snippet のサブクラスを示します。

jdk.jshell.Snippet.Kind は jdk.​jshell.​Snippet クラスの public static enum Kind extends Enum<Kind> となっています。

つまり種類は jdk.​jshell.​Snippet クラスのイミュータブルプロパティです。

jdk.​jshell.​Snippetクラスには 種類を補足するための  public SubKind subKind() メソッドも用意されています。

これは jdk.​jshell.​Snippet クラスの  public static enum SubKind extends Enum<SubKind> を返します。

これはユーザーへのフィードバックに役立ちます。

これは種類の詳細な情報を取得するのに利用されます。

ステータスの取得には jdk.​jshell.​SnippetEvent クラスの public Status status() メソッドを使用します。

戻り値は jdk.​jshell.​Snippet クラスの public static enum Status extends Enum<Status> です。

これは JShell ステート内の動的プロパティです。

したがって JShell クエリで取得されます。

ステータスには次の7つの状態があります。

DROPPED:スニペットは、JShell.drop(Snippet)への明示的な呼び出しのために非アクティブです。

NONEXISTENT:スニペットはまだ存在しないため、非アクティブです。

OVERWRITTEN : 新しいスニペットに置き換えられているため、このスニペットは無効です。

RECOVERABLE_DEFINED:スニペットは、(現在のJShell状態のコンテキストで)回復可能な未解決の参照やその他の問題が本体内にある可能性のある宣言スニペットです。

RECOVERABLE_NOT_DEFINED:スニペットは、(現在のJShell状態のコンテキストで)回復可能な未解決の参照やその他の問題がある可能性のある宣言スニペットです。

REJECTED:スニペットは、初期評価時にコンパイルに失敗し、JShell状態のさらなる変更で有効になることができないため、非アクティブです。

VALID:スニペットは有効なスニペット(現在のJShell状態のコンテキスト内)です。

このプログラムではステータスが VALID でなければ jdk.​jshell.​JShell クラスの public Stream<Diag> diagnostics(Snippet snippet) メソッドでスニペットの最新評価の診断を取得します。

そして jdk.​jshell.​Diag クラスの public abstract String getMessage(Locale locale) メソッドで指定されたロケールのローカライズされたメッセージを返します。

実際のメッセージは実装依存です。 ロケールがnullの場合、デフォルトのロケールを使用します。

値の取得には、jdk.​jshell.​SnippetEvent クラスの public String value() メソッドを使います。

戻り値は成功した実行の結果値。

実行されなかった場合、または例外がスローされた場合、値はnullです。

以上、だいたいこんな感じで JShell API を楽しんでいきたいと思います。

動かすスニペットは例の「よく見かけるネタ IntegerCache 問題」です。

これだけだとさみしいので FunctionalInterface を利用した挨拶プログラムも JShell API で動かしてみましょう。

非常にシンプルなスニペットの実行となります。

Import statement、FunctionalInterface、などのステータス、値、種類などの情報を正確に取得できれば OK です。

では、このプログラムの実行結果を見てみましょう。

FunctionalInterface は、ただの Interface として識別されるようです。

IntegerCache 問題 もちゃんと false となっています。

3

これだと普通すぎて面白くないですよね。

日本ではもうすぐ Java SE 9 がリリースされようという時代に End Of Life となった Java SE 7 でプロフラムを組まなければいけない

涙無くしては語れない非常に過酷な環境に置かれているプログラマが多く存在するらしい。

そこでそういう可愛そうなプログラマのためにコンパイラオプションを JDK7 にし、

IntegerCache 問題で遊ぶために JVM オプションに -XX:AutoBoxCacheMax=128 を設定して実行してみます。

JShell オブジェクトの生成を JShell.create() メソッドから JShell.builder() メソッドに変更します。

4

5

コンパイラオプションの設定は

jdk.​jshell.​JShell.​Builder クラスの public Builder compilerOptions(String… options) メソッドと使い設定します。

可変長引数の使い方が独特で思いっきりドツボにはまったのは内緒です。

JVM オプションの設定は

jdk.​jshell.​JShell.​Builder クラスの public Builder remoteVMOptions(String… options) メソッドを使い設定します。

後は入出力の設定です。

これらは連鎖初期化で使用するため Builderインスタンスを返します。

最後に jdk.​jshell.​JShell.​Builder クラスの public JShell build() メソッドで JShell ステートエンジンを構築します。

これはすべてのJShell機能のエントリーポイントです。

これにより、実行のためのリモートプロセスが作成されます。

それではコンパイラオプションと JVM オプションが正しく機能するかプログラムを走らせてみましょう。

6

うわぁぁ!!

正しく期待通りの動作となったが何故か目から涙がこぼれそうに・・・

IntegerCache 問題の実行結果も true となり正しく JVM オプションが設定されたようです。

これだけで天の邪鬼な私のお遊びは終了です。

ここから先は思い込みでサプライズさせてもらったお話しです。

先のプログラムにコンパイラオプションと JVM オプションを設定しない元の状態に戻して下記スニペットの実行コードを追加してみました。

JShell では import 文を必要としないパッケージが何故か存在します。

java.util.Arrays もその一つだから無事にプログラムは実行されるだろうと思っていました。

7

((((;゜Д゜)))))))  なんと! ERROR! EXPRESSION [ シンボルを見つけられません・・・ ]

JShell API を利用する場合はおもてなしは無しなのか!?

8

しかたないから import 文を追記してみた。

9

今度は期待通りの動作で実行された。

10

ついでだから enum も試してみた。

11

ちゃんと enum 認識していた。

12

実は Linux 環境の NetBeans IDE だからちゃんと日本語対応されているのですが

Windows 環境だと日本語は文字化けしてしまいます。

13

セレブデベロッパーご愛用の IntelliJ IDEA (2017.2 EAP)でも Windows環境での JShellAPI で日本語は文字化けしてしまう。

これは Java SE 9 リリースまでに修正されるのだろうか?

14

ちなみに Windows のコマンドプロンプトからの実行は文字化けしません。

15

以上、JShell API を無駄に使って遊んでみたエントリーでした。

お終い!

おっと!JShell API と戯れた記念コードを載せておきますね。

package jp.yucchi.jshellapiexample;

import java.util.List;
import java.util.Locale;
import jdk.jshell.ErroneousSnippet;
import jdk.jshell.ExpressionSnippet;
import jdk.jshell.JShell;
import jdk.jshell.MethodSnippet;
import jdk.jshell.Snippet;
import jdk.jshell.Snippet.Status;
import jdk.jshell.SnippetEvent;
import jdk.jshell.TypeDeclSnippet;
import jdk.jshell.VarSnippet;

public class JShellAPIExample {

    private final JShell shell;

    public JShellAPIExample() {
	shell = JShell.create();
//        shell = JShell.builder()
//                .compilerOptions("-source", "1.7", "-target", "1.7",
//                        "-bootclasspath", "/home/yucchi/Sun/jdk1.7.0_80/jre/lib/rt.jar",
//                        "-extdirs", "")
//                .remoteVMOptions("-XX:AutoBoxCacheMax=128")
//                .in(System.in)
//                .err(System.err)
//                .out(System.out)
//                .build();
    }

    public void close() {
        if (shell != null) {
            shell.close();
        }
    }

    public void eval(String snippetSource) {

        System.out.println(snippetSource);

        List<SnippetEvent> se = shell.eval(snippetSource);

        se.forEach(e -> {
            if (e.causeSnippet() == null) {
                Snippet snippet = e.snippet();
                switch (snippet.kind()) {
                    case IMPORT:
                        switch (snippet.subKind()) {
                            case SINGLE_TYPE_IMPORT_SUBKIND:
                                System.out.println("<< Single-Type-Import Declaration. >>");
                                break;
                            case SINGLE_STATIC_IMPORT_SUBKIND:
                                System.out.println("<< Single-Static-Import Declaration. >>");
                                break;
                            case TYPE_IMPORT_ON_DEMAND_SUBKIND:
                                System.out.println("<< Type-Import-on-Demand Declaration. >>");
                                break;
                            case STATIC_IMPORT_ON_DEMAND_SUBKIND:
                                System.out.println("<< Static-Import-on-Demand Declaration. >>");
                                break;
                            default:
                                break;
                        }
                        break;

                    case ERRONEOUS:
                        System.out.println("ERROR! " + ((ErroneousSnippet) snippet).probableKind() + ":");
                        break;
                    case TYPE_DECL:
                        TypeDeclSnippet type = (TypeDeclSnippet) snippet;
                        System.out.print("<< Created ");

                        switch (snippet.subKind()) {
                            case CLASS_SUBKIND:
                                System.out.print("Class: ");
                                break;
                            case INTERFACE_SUBKIND:
                                System.out.print("Interface: ");
                                break;
                            case ENUM_SUBKIND:
                                System.out.print("Enum: ");
                                break;
                            case ANNOTATION_TYPE_SUBKIND:
                                System.out.print("Annotation: ");
                                break;
                            default:
                                break;
                        }
                        System.out.println(type.name() + " >>");
                        break;
                    case METHOD:
                        MethodSnippet method = (MethodSnippet) snippet;
                        System.out.println("<< Created Method: "
                                + method.name() + "("
                                + method.parameterTypes() + ")" + " >>");
                        break;
                    case VAR:
                        switch (snippet.subKind()) {
                            case VAR_DECLARATION_SUBKIND:
                                System.out.println("<< A variable declaration without initializer. >>");
                                System.out.println(((VarSnippet) snippet).name() + " ==> " + e.value());
                                break;
                            case TEMP_VAR_EXPRESSION_SUBKIND:
                                System.out.println("<< An expression whose value has been stored in a temporary variable. >>");
                                System.out.println(((VarSnippet) snippet).name() + " ==> " + e.value());
                                break;
                            case VAR_DECLARATION_WITH_INITIALIZER_SUBKIND:
                                System.out.println("<< A variable declaration with an initializer expression. >>");
                                System.out.println(((VarSnippet) snippet).name() + " ==> " + e.value());
                                break;
                            default:
                                break;
                        }
                        break;
                    case EXPRESSION:
                        switch (snippet.subKind()) {
                            case VAR_VALUE_SUBKIND:
                                System.out.println("<< A simple variable reference expression. >>");
                                System.out.println(((ExpressionSnippet) snippet).name() + " ==> " + e.value());
                                break;
                            case ASSIGNMENT_SUBKIND:
                                System.out.println("<< An assignment expression. >>");
                                System.out.println(((ExpressionSnippet) snippet).name() + " ==> " + e.value());
                                break;
                            default:
                                break;
                        }
                        break;
                    case STATEMENT:
                        System.out.println("<< " + "Statement: " + e.snippet() + " >>");
                        break;
                    default:
                        System.out.println("<< " + e.getClass().getCanonicalName() + " >>");
                        break;
                }

                if (e.status() != Status.VALID) {
                    this.shell.diagnostics(e.snippet()).forEach(i -> {
                        System.out.println("[ " + i.getMessage(Locale.getDefault()) + " ]");
                    });
                }

            }
        });

    }

    public static void main(String[] args) throws Exception {

        JShellAPIExample example = new JShellAPIExample();

        example.eval("import java.time.LocalTime;");
        example.eval("@FunctionalInterface \n"
                + "interface Greeting<T, R> {\n"
                + "R apply(T time, R message);\n"
                + "\n"
                + "        default void sayGreeting(String greeting) {\n"
                + "            greeting(greeting);\n"
                + "        }\n"
                + "\n"
                + "        private void greeting(String greeting) {\n"
                + "            System.out.println(greeting + \" from JShellAPI.\");\n"
                + "        };\n"
                + "}");
        example.eval("LocalTime now = LocalTime.now();");
        example.eval("int hour = now.getHour();");
        example.eval("Greeting<Integer, String> greeting\n"
                + "                = (time, message) -> 4 <= time && time < 11 ? \"Good morning!\"\n"
                + "                        : 11 <= time && time < 18 ? \"Good afternoon!\"\n"
                + "                                : \"Good evening!\";");
        example.eval("String message = null;");
        example.eval("greeting.sayGreeting(greeting.apply(hour, message));");
        example.eval("");
        System.out.println("(○・ω・)ノ----------------------------------------------------------)\n");

        example.eval("Integer x = 128;");
        example.eval("Integer y = 128;");
        example.eval("void equivalenceTest(Integer x, Integer y) { System.out.println(x == y); }");
        example.eval("equivalenceTest(x, y);");
        System.out.println("(○・ω・)ノ----------------------------------------------------------)\n");

        example.eval("import java.util.Arrays;"); // 省略不可
        example.eval("String str;");
        example.eval("str = \"Java\";");
        example.eval("String[] elems = str.split(\"\");");
        example.eval("System.out.println(Arrays.toString(elems));");
        example.eval("Arrays.stream(elems).forEach(System.out::println);");
        System.out.println("(○・ω・)ノ----------------------------------------------------------)\n");

        example.eval("public enum JavaPlusYou {\n"
                + "\n"
                + "    Japanese(\"あなたとJAVA,今すぐダウンロード\"),\n"
                + "    English(\"JAVA+YOU, DOWNLOAD TODAY!\");\n"
                + "\n"
                + "    private final String downloadNow;\n"
                + "\n"
                + "    private JavaPlusYou(final String downloadNow) {\n"
                + "        this.downloadNow = downloadNow;\n"
                + "    }\n"
                + "\n"
                + "    public String getDownloadNow() {\n"
                + "        return downloadNow;\n"
                + "    }\n"
                + "\n"
                + "}");
        example.eval("for (JavaPlusYou jpy : JavaPlusYou.values()) {\n"
                + "            System.out.println(jpy + \": \" + jpy.getDownloadNow());\n"
                + "        }");
        System.out.println("(○・ω・)ノ----------------------------------------------------------)\n");

        example.eval("System.out.println(System.getProperty(\"java.vm.version\"));");
        example.eval("System.out.println(System.getProperty(\"java.class.version\"));");
        System.out.println("(○・ω・)ノ----------------------------------------------------------)\n");

        example.close();

    }

}

実行結果は次のようになります。

run:
import java.time.LocalTime;
<< Single-Type-Import Declaration. >>
@FunctionalInterface
interface Greeting<T, R> {
R apply(T time, R message);

        default void sayGreeting(String greeting) {
            greeting(greeting);
        }

        private void greeting(String greeting) {
            System.out.println(greeting + ” from JShellAPI.”);
        };
}
<< Created Interface: Greeting >>
LocalTime now = LocalTime.now();
<< A variable declaration with an initializer expression. >>
now ==> 17:28:24.474604
int hour = now.getHour();
<< A variable declaration with an initializer expression. >>
hour ==> 17
Greeting<Integer, String> greeting
                = (time, message) -> 4 <= time && time < 11 ? “Good morning!”
                        : 11 <= time && time < 18 ? “Good afternoon!”
                                : “Good evening!”;
<< A variable declaration with an initializer expression. >>
greeting ==> $Lambda$17/555826066@a67c67e
String message = null;
<< A variable declaration with an initializer expression. >>
message ==> null
greeting.sayGreeting(greeting.apply(hour, message));
Good afternoon! from JShellAPI.
<< Statement: Snippet:StatementKey#7-greeting.sayGreeting(greeting.apply(hour, message)); >>

(○・ω・)ノ———————————————————-)

Integer x = 128;
<< A variable declaration with an initializer expression. >>
x ==> 128
Integer y = 128;
<< A variable declaration with an initializer expression. >>
y ==> 128
void equivalenceTest(Integer x, Integer y) { System.out.println(x == y); }
<< Created Method: equivalenceTest(Integer,Integer) >>
equivalenceTest(x, y);
false
<< Statement: Snippet:StatementKey#11-equivalenceTest(x, y); >>
(○・ω・)ノ———————————————————-)

import java.util.Arrays;
<< Single-Type-Import Declaration. >>
String str;
<< A variable declaration without initializer. >>
str ==> null
str = “Java”;
<< An assignment expression. >>
str ==> “Java”
String[] elems = str.split(“”);
<< A variable declaration with an initializer expression. >>
elems ==> String[4] { “J”, “a”, “v”, “a” }
System.out.println(Arrays.toString(elems));
[J, a, v, a]
<< Statement: Snippet:StatementKey#16-System.out.println(Arrays.toString(elems)); >>
Arrays.stream(elems).forEach(System.out::println);
J
a
v
a
<< Statement: Snippet:StatementKey#17-Arrays.stream(elems).forEach(System.out::println); >>
(○・ω・)ノ———————————————————-)

public enum JavaPlusYou {

    Japanese(“あなたとJAVA,今すぐダウンロード”),
    English(“JAVA+YOU, DOWNLOAD TODAY!”);

    private final String downloadNow;

    private JavaPlusYou(final String downloadNow) {
        this.downloadNow = downloadNow;
    }

    public String getDownloadNow() {
        return downloadNow;
    }

}
<< Created Enum: JavaPlusYou >>
for (JavaPlusYou jpy : JavaPlusYou.values()) {
            System.out.println(jpy + “: ” + jpy.getDownloadNow());
        }
Japanese: あなたとJAVA,今すぐダウンロード
English: JAVA+YOU, DOWNLOAD TODAY!
<< Statement: Snippet:StatementKey#19-for (JavaPlusYou jpy : JavaPlusYou.values()) {
            System.out.println(jpy + “: ” + jpy.getDownloadNow());
        } >>
(○・ω・)ノ———————————————————-)

System.out.println(System.getProperty(“java.vm.version”));
9-ea+169
<< Statement: Snippet:StatementKey#20-System.out.println(System.getProperty(“java.vm.version”)); >>
System.out.println(System.getProperty(“java.class.version”));
53.0
<< Statement: Snippet:StatementKey#21-System.out.println(System.getProperty(“java.class.version”)); >>
(○・ω・)ノ———————————————————-)

ビルド成功(合計時間: 4秒)

Hatena タグ: ,