JavaFX button に setText を行うとエラーが発生する Exception in thread "JavaFX Application Thread"

Question

スレッド内でボタンに対しsetText()を行うとエラーが発生します。
（エラー内容等はソースコード内に記述）

ただし以下の場合はボタンのテキストを正常に変更が可能でした。

@FXML
protected void aButtonClicked(ActionEvent event) {
aButton.setText("Changed");
}

JavaFXのコントローラーに対する根本的な理解がない事は承知していまして色々調べましたが分かりませんでした。
すいませんが教えて頂けますと幸いです。よろしくお願い致します。

Form.fxml

<?xml version="1.0" encoding="UTF-8"?>

<?import javafx.scene.control.Button?>
<?import javafx.scene.layout.AnchorPane?>

<AnchorPane prefHeight="400.0" prefWidth="600.0" xmlns="http://javafx.com/javafx/8.0.111" xmlns:fx="http://javafx.com/fxml/1" fx:controller="xy.Entry">
   <children>
      <Button fx:id="aButton" layoutX="14.0" layoutY="18.0" mnemonicParsing="false" onAction="#aButtonClicked" prefHeight="31.0" prefWidth="81.0" text="---" />
   </children>
</AnchorPane>

Entry.java

package xy;

import javafx.application.Platform;
import javafx.fxml.FXML;
import javafx.fxml.FXMLLoader;
import javafx.application.Application;
import javafx.concurrent.ScheduledService;
import javafx.concurrent.Task;
import javafx.scene.Node;
import javafx.scene.Parent;
import javafx.scene.Scene;
import javafx.scene.control.Button;
import javafx.scene.layout.HBox;
import javafx.scene.layout.VBox;
import javafx.stage.Stage;
import javafx.event.ActionEvent;

import java.util.concurrent.TimeUnit;

public class Entry extends Application {
    // 参照先
    @FXML public Button aButton;

    // メインウィンドウの描画
    @Override
    public void start(Stage primaryStage) throws Exception {
        try {
            Parent parent = FXMLLoader.load(getClass().getResource("Form.fxml"));

            VBox root = new VBox();
            Node taskMainNode = createMainService(); // スレッドの作成
            root.getChildren().addAll(parent, taskMainNode); // fxml & thread を add

            primaryStage.setScene(new Scene(root, 600, 400));
            primaryStage.show();
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    // メイン処理(スレッド)
    public Node createMainService() {
        HBox root = new HBox();

        ScheduledService<Boolean> tradingOperation = new ScheduledService<Boolean>() {
            @Override
            protected Task<Boolean> createTask() {
                Task<Boolean> task = new Task<Boolean>() {

                    @Override
                    protected Boolean call() throws Exception {
                        // 通常モード
                        // 描画したボタンのテキストを Hello に変更
                        // しかし反応なし
                        aButton.setText("Changed");
                        
                        // Platform.RunLaterモード
                        // 描画したボタンのテキストを Hello に変更
                        // 次のエラーが発生 Exception in thread "JavaFX Application Thread" java.lang.NullPointerException
                        Platform.runLater(
                                ()-> aButton.setText("Changed")
                        );

                        Thread.sleep( 3000 );
                        return null;
                    }
                };
                return task;
            }
        };

        tradingOperation.start();

        return root;
    }

    @FXML
    protected void aButtonClicked(ActionEvent event) {

    }

    /*
        スレッドの待機
    */
    private void threadSleep(int intTime) {
        try {
            Thread.sleep(intTime);
        } catch (InterruptedException e) {
        }
    }

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

Answer 1

NPEが発生する原因は、端的に言えば「EntryクラスがJavaFXアプリケーションクラスでもあり、かつコントローラークラスとしても用いられているため」となるかと思います。

###NPEの原因の詳細

アプリケーションの開始時点でEntryのインスタンスがJavaFXランタイムによって生成されstartメソッドが動き出します。このインスタンスを仮にentry1と呼ぶことにします。startメソッドの中でFXMLLoader#loadを呼び出すと、今度はEntryクラスがコントローラークラスとして用いられloadメソッドはさらにもう一つのEntryのインスタンスを生成します。このインスタンスを仮にentry2と呼ぶことにします。

さて、createTaskメソッドの中で参照しているaButtonですがcreateTaskはアプリケーションインスタンスであるentry1の文脈として動作するためentry1.aButtonを参照します。しかしFXMLLoader#loadが自動設定するaButtonはコントローラーインスタンス、即ちentry2の方へ設定されますのでentry1.aButtonはnullのままです。このためcreateTaskの中でaButtonを参照するとNPEが発生するわけです。

###対処
アプリケーションクラスとコントローラークラスは別のクラスとして定義するのが自然だと思います。仮にコントローラークラスをMyControllerに分離したとすると、以下のようなコードになると思います。

public class Entry extends Application {
  MyController controller;

  @Override
  public void start(Stage primaryStage) throws Exception {
    try {
      FXMLLoader loader = new FXMLLoader(getClass().getResource("Form.fxml"));
      Parent parent = loader.load();
      controller = loader.getController();

      VBox root = new VBox();
      Node taskMainNode = createMainService(controller); // スレッドの作成
      root.getChildren().addAll(parent, taskMainNode); // fxml & thread を add

      primaryStage.setScene(new Scene(root, 600, 400));
      primaryStage.show();
    } catch (Exception e) {
      e.printStackTrace();
    }
  }

  public Node createMainService() {
    HBox root = new HBox();

    ScheduledService<Boolean> tradingOperation = new ScheduledService<Boolean>() {
      @Override
      protected Task<Boolean> createTask() {
        Task<Boolean> task = new Task<Boolean>() {
          @Override
          protected Boolean call() throws Exception {
            // 通常モード
            // 描画したボタンのテキストを Hello に変更
            // しかし反応なし
            // -> Platform.runLaterを用いなければなりません。以下のように
            //    アプリケーションスレッド以外からノードに直接アクセスするのは
            //    間違いです。
            //aButton.setText("Changed");

            // Platform.RunLaterモード
            // 描画したボタンのテキストを Hello に変更
            Platform.runLater(
              ()-> controller.aButton.setText("Changed")
            );

            Thread.sleep( 3000 );
            return null;
          }
        };
        return task;
      }
    };

    tradingOperation.start();

    return root;
  }
}

public class MyController implements Initializable {
  @FXML Button aButton;

  @Override public void initialize(URL location, ResourceBundle resources) {
    ...
  }
}

---

余談：
上のコード例では修正を最小限にするためServiceの処理の中でコントローラーのフィールド(aButton)をアプリケーションクラスから直接参照する形にしました。しかし、カプセル化に配慮するならこのServiceはMyController側に定義があったほうが(aButtonを直接アクセスするという点においては)自然に思えます。このServiceの中で実際にどのようなことをしようとしているのかによって一概には言えませんが・・・

Comments

[Clover]

凄いです！ありがとうございます。早速検証してみます。