web-dev-qa-db-fra.com

Contrôleur JavaFX FXML - constructeur vs méthode d'initialisation

Ma classe Application ressemble à ceci:

public class Test extends Application {

    private static Logger logger = LogManager.getRootLogger();

    @Override
    public void start(Stage primaryStage) throws Exception {

        String resourcePath = "/resources/fxml/MainView.fxml";
        URL location = getClass().getResource(resourcePath);
        FXMLLoader fxmlLoader = new FXMLLoader(location);

        Scene scene = new Scene(fxmlLoader.load(), 500, 500);

        primaryStage.setScene(scene);
        primaryStage.show();
    }

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

FXMLLoader crée une instance du contrôleur correspondant (indiquée dans le fichier FXML via fx:controller) en appelant d'abord le constructeur par défaut, puis la méthode initialize:

public class MainViewController {

    public MainViewController() {
        System.out.println("first");
    }

    @FXML
    public void initialize() {
        System.out.println("second");
    }
}

La sortie est:

first
second

Alors, pourquoi la méthode initialize existe-t-elle? Quelle est la différence entre l’utilisation d’un constructeur et la méthode initialize pour initialiser les éléments requis par le contrôleur?

Merci pour vos suggestions!

javajavafx
59
mrbela

En quelques mots: Le constructeur est appelé en premier, puis tous les champs annotés @FXML sont renseignés, puis initialize() est appelé. Par conséquent, le constructeur n'a PAS accès aux champs @FXML faisant référence aux composants définis dans le fichier .fxml, alors que initialize() y a accès.

Citant le Introduction à FXML :

[...] le contrôleur peut définir une méthode initialize (), qui sera appelée une fois sur le contrôleur d'implémentation lorsque le contenu de son document associé sera complètement chargé [...] -traitement sur le contenu.

79
Nikos Paraskevopoulos

La méthode initialize est appelée après que tous les membres annotés @FXML ont été injectés. Supposons que vous souhaitiez renseigner une vue sous forme de tableau: 

class MyController { 
    @FXML
    TableView<MyModel> tableView; 

    public MyController() {
        tableView.getItems().addAll(getDataFromSource()); // results in NullPointerException, as tableView is null at this point. 
    }

    @FXML
    public void initialize() {
        tableView.getItems().addAll(getDataFromSource()); // Perfectly Ok here, as FXMLLoader already populated all @FXML annotated members. 
    }
}
70
Itai

Outre les réponses ci-dessus, il convient de noter qu’il existe un meilleur moyen de mettre en œuvre l’initialisation. Il existe une interface appelée Initializable de la bibliothèque fxml.

import javafx.fxml.Initializable;

class MyController implements Initializable {
    @FXML private TableView<MyModel> tableView;

    @Override
    public void initialize(URL location, ResourceBundle resources) {
        tableView.getItems().addAll(getDataFromSource());
    }
}

Paramètres:

location - The location used to resolve relative paths for the root object, or null if the location is not known.
resources - The resources used to localize the root object, or null if the root object was not localized.

Et la note de la documentation expliquant pourquoi la méthode simple d’utiliser @FXML public void initialize() fonctionne:

NOTE Cette interface a été remplacée par l'injection automatique des propriétés d'emplacement et de ressources dans le contrôleur. FXMLLoader appellera maintenant automatiquement toute méthode no-arg initialize () annotée de manière appropriée définie par le contrôleur. Il est recommandé d'utiliser l'approche d'injection chaque fois que possible.

2
moneydhaze