FAQ JavaFXConsultez toutes les FAQ

JavaFX utilise trois threads principaux :

• le JavaFX Application Thread - il s'agit du thread �v�nementiel de l'interface graphique, du SceneGraph et de la sc�ne. Les n�uds graphiques qui sont attach�s � une sc�ne ne peuvent �tre manipul�s que dans ce thread. Ce thread est celui dans lequel vous travaillerez et dans lequel votre code s�ex�cutera la plupart du temps ;
• le thread de rendu Prism - il s'agit du thread qui est utilis� pour effectuer le moteur de rendu Prism qui se charge du rendu � l��cran. Ce thread n'est normalement pas directement accessible au programmeur ;
• le thread m�dia - ce thread qui tourne en t�che de fond et est utilis� pour synchroniser l�affichage en mettant � jour, par exemple, les intervalles (�tapes interm�diaires) lors d'animations et de transitions. Ce thread n'est normalement pas directement accessible au programmeur.
  

Il peut arriver que vous ayez besoin d'effectuer une t�che de longue dur�e (traitement long, lecture/�criture de fichier, vous connecter � une base de donn�es, � un web service, etc.). JavaFX met � disposition, dans le package javafx.concurrent, une API de concurrence qui permet de g�rer de telles t�ches sans pour autant bloquer le JavaFX Application Thread.

Pour utiliser cette API de concurrence, vous allez devoir utiliser des objets d'un des trois types suivants :

• Service<V> - qui est une classe service � manipuler depuis votre UI, dans le JavaFX Application Thread. Une instance de la classe Service peut �tre r�utilis�e plusieurs fois.
• ScheduledService<V> - qui est une classe service � manipuler depuis votre UI, dans le JavaFX Application Thread. Ce genre de service s�ex�cute de mani�re cyclique � intervalles r�guliers - JDK8 ou ult�rieur.
• Task<V> - qui est la classe qui se chargera d�ex�cuter la t�che de longue dur�e. Elle s�ex�cutera dans son propre thread, sans interf�rer ni bloquer le JavaFX Application Thread. Une instance de la classe Task ne peut �tre utilis�e qu'une seule et unique fois. La t�che est cr��e par le service.
  

Pour cr�er une t�che de fond, depuis notre IU (par exemple en r�ponse � un clic sur un bouton), nous allons cr�er une instance de la classe abstraite Service<V> avec le type de retour appropri�. Nous allons ensuite surcharger la m�thode createTask() de mani�re � initialiser une instance de la classe abstraite Task<V>. Dans cette t�che, nous allons surcharger la m�thode�call() pour effectuer le traitement de longue dur�e. Le r�sultat du traitement sera retourn� en fin de m�thode.

Par exemple :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
final Service<Integer> service = new Service<Integer>() { 
  
    @Override 
    protected Task<Integer> createTask() { 
        return new Task<Integer>() { 
  
            @Override 
            protected Integer call() throws Exception { 
                int result = 0; 
                // Faire le traitement ici. 
                return result; 
            }                             
        }; 
    }                     
};

1
2
3
4
5
6
7
8
9
10
11
12
13
14
final Service<Void> service = new Service<Void>() { 
  
    @Override 
    protected Task<Void> createTask() { 
        return new Task<Void>() { 
  
            @Override 
            protected Void call() throws Exception { 
                // Faire le traitement ici. 
                return null; 
            }                             
        }; 
    }                     
};

Il est possible de surveiller les changements d��tat d'un service en pla�ant un �couteur de type InvalidationListener ou ChangeListener sur sa propri�t� state.



Cette propri�t�, de type Worker.State, peut avoir les �tats suivants :

• READY - le service est pr�t � �tre lanc� : il vient d��tre cr�� ou il a �t� r�initialis� ;
• SCHEDULED - le service a �t� lanc�, mais n'a pas encore d�marr� ;
• RUNNING - le service a d�marr�, le traitement est en cours ;
• CANCELLED - le service a �t� annul� ;
• FAILED - le service a �chou� (ex. : une exception a �t� lanc�e au cours du traitement) ;
• SUCCEEDED - le service s'est termin� sans erreur. Il est possible d'acc�der au r�sultat du traitement ou de relancer le service.
  

1
2
3
4
5
service.stateProperty().addListener(observable -> { 
    switch (service.getState()) { 
        // Traiter les diff�rents cas ici. 
    } 
});

• setOnReady() - le service est pass� dans l��tat READY ;
• setOnScheduled() - le service est pass� dans l��tat SCHEDULED ;
• setOnRunning() - le service est pass� dans l��tat RUNNING ;
• setOnCancelled() - le service est pass� dans l��tat CANCELLED ;
• setOnFailed() - le service est pass� dans l��tat FAILED ;
• setOnSucceeded() - le service est pass� dans l��tat SUCCEEDED.
  

1
2
3
4
5
6
7
service.setOnSucceeded(new EventHandler<WorkerStateEvent>() { 
  
    @Override 
    public void handle(WorkerStateEvent workerStateEvent) { 
        System.out.println("Traitement termin� !"); 
    } 
});

service.setOnSucceeded(workerStateEvent -> System.out.println("Traitement termin� !"));

Il est possible de surveiller les changements d��tat d'une t�che en pla�ant un �couteur de type InvalidationListener ou ChangeListener sur sa propri�t� state.



Cette propri�t�, de type Worker.State, peut avoir les �tats suivants :

• READY - la t�che est pr�te � �tre lanc�e : elle vient d��tre cr��e ;
• SCHEDULED - la t�che a �t� lanc�e, mais n'a pas encore d�marr� ;
• RUNNING - la t�che a d�marr�, le traitement est en cours ;
• CANCELLED - la t�che a �t� annul�e ;
• FAILED - la t�che a �chou� (ex. : une exception a �t� lanc�e au cours du traitement) ;
• SUCCEEDED - la t�che s'est termin�e sans erreur. Il est possible d'acc�der au r�sultat du traitement.
  

1
2
3
4
5
task.stateProperty().addListener(observable -> { 
    switch (task.getState()) { 
        // Traiter les diff�rents cas ici. 
    } 
});

• setOnScheduled() - le service est pass� dans l��tat SCHEDULED ;
• setOnRunning() - le service est pass� dans l��tat RUNNING ;
• setOnCancelled() - le service est pass� dans l��tat CANCELLED ;
• setOnFailed() - le service est pass� dans l��tat FAILED ;
• setOnSucceeded() - le service est pass� dans l��tat SUCCEEDED.
  

1
2
3
4
5
6
7
task.setOnSucceeded(new EventHandler<WorkerStateEvent>() { 
  
    @Override 
    public void handle(WorkerStateEvent workerStateEvent) { 
        System.out.println("Traitement termin� !"); 
    } 
});

task.setOnSucceeded(workerStateEvent -> System.out.println("Traitement termin� !"));

Pour d�marrer un service, il suffit d'invoquer la m�thode start() de ce service.

Par exemple :

service.start();

Pour annuler un service, il suffit d'invoquer la m�thode cancel() de ce service.

Par exemple :

service.cancel();

Pour savoir si une t�che a �t� annul�e, le programmeur doit r�guli�rement tester la valeur de retour de la m�thode isCancelled() de la t�che durant son traitement. Si cette m�thode retourne true, c'est que la t�che a �t� annul�e et que le traitement doit �tre interrompu.

Par exemple, le code suivant est une t�che qui teste si un nombre donn� est premier :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
public class PrimeTestTask extends Task<Boolean> { 
  
    private final int value; 
  
    public PrimeTestTask(final int value) { 
        this.value = Math.abs(value); 
    } 
  
    @Override 
    protected Boolean call() throws Exception { 
        Boolean result = Boolean.TRUE; 
        if (value == 0 || value == 1 || (value > 2 && value % 2 == 0)) { 
            result = Boolean.FALSE; 
        } else if (value > 2) { 
            for (int test = 3; test * test < value; test += 2) { 
                // Le traitement a �t� annul�. 
                if (isCancelled()) { 
                    return null; 
                } 
                if (value % test == 0) { 
                    result = Boolean.FALSE; 
                    break; 
                } 
            } 
        } 
        return result; 
    } 
}

Pour pouvoir red�marrer un service, il faut que ce dernier soit � nouveau dans un �tat READY. Il est possible de r�initialiser la valeur de cet �tat en appelant la m�thode reset() du service.



Par exemple :

service.reset();

service.restart();

1
2
3
service.cancel(); 
service.reset(); 
service.start();

Il est possible d'envoyer des notifications durant un traitement long. La classe Task<V> dispose de quatre m�thodes destin�es � cet effet, et qui peuvent �tre invoqu�es directement depuis le code s�ex�cutant dans la m�thode call() de la t�che :

• updateMessage() - permet de faire remonter un message textuel ;
• updateProgress() - permet d'indiquer l��tat d'avancement du traitement. Cette m�thode prend deux valeurs en param�tres, l'avancement actuel et l'avancement total. Un avancement n�gatif ou invalide (infinit� ou NaN) r�sultera en une valeur de progression ind�termin�e ;
• updateTitle() - permet de modifier l�intitul� du traitement ;
• updateValue() - permet de modifier la valeur de retour de la t�che pour sp�cifier une valeur interm�diaire - JDK8 ou ult�rieur.
  

• message - le dernier message post�.
• progress - le dernier �tat d'avancement du traitement. Cette valeur est initialement � 0. Une valeur de 1 indique normalement que le traitement est termin�. Une valeur de -1 indique que l'avancement est ind�termin�.
• title - le dernier intitul� du traitement.
• value - la derni�re valeur du traitement. Cette propri�t� sera �galement affect�e � la valeur de retour de la t�che � la fin du traitement.
  

1
2
3
titleLabel.textProperty().bind(service.titleProperty()); 
progressLabel.textProperty().bind(service.messageProperty()); 
progressBar.progressProperty().bind(service.progressProperty());

Pour r�cup�rer le r�sultat final d'un service, il suffit de r�cup�rer la valeur de sa propri�t� en lecture seule value lorsque le service est dans l��tat SUCCEEDED.

Par exemple :

1
2
3
4
service.setOnSucceeded(workerStateEvent -> { 
    final V result = service.getValue(); 
    System.out.printf("Traitement termin� %s !", result).println(); 
});

Pour connaitre les causes de l��chec d'un service, il faut r�cup�rer la valeur de sa propri�t� en lecture seule exception lorsque le service est dans l��tat FAILED. Cette propri�t� contient une valeur de type java.lang.Throwable.

Par exemple :

1
2
3
4
service.setOnFailed(workerStateEvent -> { 
     System.err.println("�chec du service !"); 
     service.getException().printStackTrace(); 
});

Depuis le JDK 8, pour cr�er une t�che de fond r�p�table, depuis notre IU (par exemple en r�ponse � un clic sur un bouton), nous allons cr�er une instance de la classe abstraite ScheduledService<V> avec le type de retour appropri�. Nous allons ensuite surcharger la m�thode createTask() de mani�re � initialiser une instance de la classe abstraite Task<V>. Dans cette t�che, nous allons surcharger la m�thode call() pour effectuer le traitement de longue dur�e. Le r�sultat du traitement sera retourn� en fin de m�thode.

Par exemple :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
final ScheduledService<Integer> service = new ScheduledService<Integer>() { 
  
    @Override 
    protected Task<Integer> createTask() { 
        return new Task<Integer>() { 
  
            @Override 
            protected Integer call() throws Exception { 
                int result = 0; 
                // Faire le traitement ici. 
                return result; 
            }                             
        }; 
    }                     
};

1
2
3
4
5
6
7
8
9
10
11
12
13
14
final ScheduledService<Void> service = new ScheduledService<Void>() { 
  
    @Override 
    protected Task<Void> createTask() { 
        return new Task<Void>() { 
  
            @Override 
            protected Void call() throws Exception { 
                // Faire le traitement ici. 
                return null; 
            }                             
        }; 
    }                     
};

Pour diff�rer le lancement d'une t�che de fond r�p�table, vous devez sp�cifier une valeur de type javafx.util.Duration dans la propri�t� delay de votre instance de la classe ScheduledService<V>.

Par exemple :

1
2
service.setDelay(Duration.seconds(5)); 
service.start();

Pour autoriser une t�che de fond r�p�table � se relancer en cas d��chec, vous devez modifier la valeur de la propri�t� restartOnFailure de l'instance de la classe ScheduledService<V> et lui donner la valeur true.

Par exemple :

service.setRestartOnFailure(true);

Pour limiter le nombre de r�p�titions d'une t�che de fond r�p�table en cas d��chec, vous devez modifier la valeur de sa propri�t� maxFailureCount.

Par exemple :

service.setMaxFailureCount(100);

Pour connaitre le nombre d��checs d'une t�che de fond r�p�table, vous pouvez interroger sa propri�t� en lecture seule currentFailureCount. Cette propri�t� contient le nombre d��checs du service depuis son lancement initial. Ce nombre sera r�initialis� � z�ro si le service est manuellement red�marr�.

Par exemple :

final int failureNumber = service.getCurrentFailureCount();

Pour sp�cifier la p�riode d'une t�che de fond r�p�table, vous devez sp�cifier une valeur de type javafx.util.Duration dans la propri�t� period de votre instance de la classe ScheduledService<V>. Il s'agit de la p�riode de temps qui s��coule entre deux moments durant lesquels le service passe dans un �tat RUNNING lors d'une ex�cution couronn�e de succ�s.

service.setPeriod(Duration.seconds(1));

1
2
3
4
5
6
service.setBackoffStrategy(new Callback<ScheduledService<?>, Duration>() { 
  
    public Duration call(ScheduledService<?> service) { 
        return Duration.seconds(service.getCurrentFailureCount() * 5); 
    } 
});

service.setBackoffStrategy(service -> Duration.seconds(service.getCurrentFailureCount() * 5));

service.setMaximumCumulativePeriod(Duration.minutes(10));

Lorsqu'une t�che de fond r�p�table se relance, sa propri�t� value est r�initialis�e avec la valeur null. Cependant la propri�t� en lecture seule lastValue conserve le r�sultat de la derni�re bonne ex�cution du service.

Par exemple :

final Integer lastResult = service.getLastValue();