L'annotation @Asynchronous permet de définir des méthodes asynchrones dont l'exécution ne bloquera pas le code client.
Il y a deux types de méthodes asynchrones :
- Les méthodes qui ne retournent pas de valeur et pour lesquelles le code client ne voudra pas connaître le résultat d'exécution.
- Les méthodes que le client voudra connaître le résultat d'exécution.

Dans les deux cas, une méthode annotée par l'annotation @Asynchronous retourne immédiatement le contrôle au code client et ne le bloque pas jusqu'à la fin de l'exécution de la méthode.

Notes :
- L'annotation @Asynchronous doit être placée au niveau des méthodes de la session bean et non pas au niveau des méthodes des interfaces métiers.
- Si l'annotation @Asynchronous est placée au niveau de la classe alors toutes les méthodes de la session bean seront asynchrones.

Définir deux méthodes qui vont servir comme exemple d'utilisation de l'annotation @Asynchronous :
package com.mtitek.session.beans.stateless.interfaces; import java.util.concurrent.Future; import javax.ejb.Remote; @Remote public interface AsynchronousMethodsManager { public void doAsynchronousWork(String value); public Future<String> doAsynchronousWorkAndReturnResult(String value); }
Implémenter les méthodes de l'interface métier :

package com.mtitek.session.beans.stateless; import java.util.concurrent.Future; import javax.ejb.AsyncResult; import javax.ejb.Asynchronous; import javax.ejb.Stateless; import com.mtitek.session.beans.stateless.interfaces.AsynchronousMethodsManager; @Stateless public class AsynchronousMethodsManagerBean implements AsynchronousMethodsManager { @Override @Asynchronous public void doAsynchronousWork(String value) { System.out.println("AsynchronousMethodsManagerBean (" + this.toString() + ").doAsynchronousWork - Start"); try { Thread.sleep(9000); } catch (InterruptedException e) { e.printStackTrace(); } System.out.println("AsynchronousMethodsManagerBean (" + this.toString() + ").doAsynchronousWork - End"); } @Override @Asynchronous public Future<String> doAsynchronousWorkAndReturnResult(String value) { System.out.println("AsynchronousMethodsManagerBean (" + this.toString() + ").doAsynchronousWorkAndReturnResult - Start"); try { Thread.sleep(9000); } catch (InterruptedException e) { e.printStackTrace(); } System.out.println("AsynchronousMethodsManagerBean (" + this.toString() + ").doAsynchronousWorkAndReturnResult - End"); return new AsyncResult<String>("AsyncResult : " + value); } }
Invoquer les méthodes asynchrones en utilisant un client JNDI :
package com.mtitek.session.beans.client; import java.util.concurrent.ExecutionException; import java.util.concurrent.Future; import javax.naming.InitialContext; import javax.naming.NamingException; import com.mtitek.session.beans.stateless.interfaces.AsynchronousMethodsManager; public class AsynchronousMethodsManagerClientJndi { public static void main(String[] args) { InitialContext ctx; AsynchronousMethodsManager asynchronousMethodsManager; try { ctx = new InitialContext(); asynchronousMethodsManager = (AsynchronousMethodsManager) ctx.lookup("ejb:/myejb/AsynchronousMethodsManagerBean!com.mtitek.session.beans.stateless.interfaces.AsynchronousMethodsManager"); String value = "Hello, world! !"; // L'invocation de la méthode ne bloquera pas l'exécution du code. asynchronousMethodsManager.doAsynchronousWork(value); // L'invocation de la méthode ne bloquera pas l'exécution du code. // L'instance de la classe Future peut être utilisée pour connaitre l'état d'exécution de la méthode, l'annuler, … Future<String> futureResult = asynchronousMethodsManager.doAsynchronousWorkAndReturnResult(value); try { value = futureResult.get(); System.out.println(value); } catch (InterruptedException e) { e.printStackTrace(); } catch (ExecutionException e) { e.printStackTrace(); } } catch (NamingException e) { e.printStackTrace(); } } }
Voici la sortie d'exécution dans la console JBoss : 12:09:02,303 INFO [stdout] (EJB default - 10) AsynchronousMethodsManagerBean (com.mtitek.session.beans.stateless.AsynchronousMethodsManagerBean@6dad2bfb).doAsynchronousWork - Start 12:09:02,310 INFO [stdout] (EJB default - 4) AsynchronousMethodsManagerBean (com.mtitek.session.beans.stateless.AsynchronousMethodsManagerBean@453d9468).doAsynchronousWorkAndReturnResult - Start 12:09:11,307 INFO [stdout] (EJB default - 10) AsynchronousMethodsManagerBean (com.mtitek.session.beans.stateless.AsynchronousMethodsManagerBean@6dad2bfb).doAsynchronousWork - End 12:09:11,312 INFO [stdout] (EJB default - 4) AsynchronousMethodsManagerBean (com.mtitek.session.beans.stateless.AsynchronousMethodsManagerBean@453d9468).doAsynchronousWorkAndReturnResult - End
Notes :
- La classe AsyncResult est une implémentation, parmis d'autres, de l'interface Future.
- L'interface Future définit plusieurs méthodes qui peuvent être utilisées pour interagir avec les méthodes asynchrones.
- La méthode get() attend la fin d'exécution de la méthode asynchrone avant de retourner le résultat de son exécution.