Apache Adobe Flex TutorialTutoriaux Adobe Flex & AIR en Français

Flex Modules – L'Event ModuleEvent.READY n'est jamais envoyé [Résolu]

Ce billet est consacré à la résolution d'un bug Flex qui se produit pendant le chargement des modules. Il est plutôt étrange et difficile à débugger. Ce problème est du au Garbage Collector qui va un peu trop vite en besogne lorsque l'on charge des modules Flex avec la classe IModuleInfo.

Voici un exemple de code qui permet de charger un module:

public function initApp():void {
 var moduleInfo:IModuleInfo = ModuleManager.getModule("SimpleModule.swf");
 moduleInfo.addEventListener(ModuleEvent.READY, onModuleLoaded);
 moduleInfo.load();
}

Dans l'esprit, ce code fonctionne bien et une fois le module chargé, la méthode onModuleLoaded devrait être appelée. Et bien à cause du GC, l'évènement ModuleEvent.READY ("ready") n'est jamais renvoyé. Apparemment, ce bug se produit sur Windows mais pas sous Unix, surement à cause d'une différence de Garbage Collector. Le problème est en fait un problème de scope. Même si la variable "moduleInfo" a des références vers elle (ne serait-ce que par l'évènement ModuleEvent.READY qui crée une back reference), la variable moduleInfo va aléatoirement être supprimée de la mémoire. l'évènement "ready" ne sera donc jamais envoyé.

Résolution du problème

Pour résoudre ce problème, il suffit de mettre la variable dans un scope au niveau de la classe et pas de la méthode:

private var moduleInfo:IModuleInfo=null;

 public function initApp():void {
 moduleInfo=ModuleManager.getModule("SimpleModule.swf");
 moduleInfo.addEventListener(ModuleEvent.READY, onModuleLoaded);
 moduleInfo.load();
 }

De cette manière, la variable ne sera pas détruite et l'évènement READY sera bien envoyé dans tous les cas.

D'autres bugs possibles…

Le fait que l'évènement READY ne soit jamais dispatché est un des effets de ce problème de scope. Il se peut que vous ayez les problèmes suivants:

• Le module ne se charge pas la première fois mais se charge bien la deuxième fois
• La méthode ModuleInfo.clearLoader() lance une Error #2029: This URLStream object does not have a stream opened when calling loader.close().

La cause interne du problème

Si vous êtes curieux, cet article explique bien la cause de ce problème. Le problème se passe lorsque le Loader finit de charger le SWF La liste interne de listeners du ModuleInfo (les listeners ajoutés pendant la construction du ModuleInfoProxy) est perdue (null) quand le ModuleInfo atteint sa méthode readyHandler(). A la fin de la méthode readyHandler(), un évènement ModuleEvent.READY est dispatché:

dispatchEvent(new ModuleEvent(ModuleEvent.READY));

Lorsque la liste de listener est null, l'évènement n'est jamais récupéré par le ModuleInfoProxy et le chargement échoue.

Lors des prochains chargements (la deuxième fois au moins), la méthode load() du ModuleInfoProxy regarde si la variable "info" a déjà été chargée et propage directement l'évènement ModuleEvent.READY:

else if (info.loaded){
 //trace("Module[", url, "] load is already loaded");
 if (info.setup){
 ...
 if (info.ready){
 ...
 dispatchEvent(new ModuleEvent(ModuleEvent.READY));
 }
 }
}

Voilà pourquoi le module se charge bien la seconde fois.