Créer un singleton en JavaScript

En programmation, on connait bien le pattern Singleton où une restriction autorise l'utilisation d'une seule instance de la classe. Mais comment l'implémenter en JavaScript ?

L'objectif d'un singleton, c'est de ne pas pouvoir instancier la classe, ce qui nous permettrait d'avoir différentes copies. C'est pourquoi on demandera à l'objet de nous retourner l'instance unique à utiliser, et ce, sans utiliser la notation "new". L'utilisation de ce pattern est justifié par le fait que deux objets du même type ne devraient pas coexister dans l'application. Un autre exemple se trouve dans un système d'exploitation, où plusieurs logiciels roulent comme des singletons : on s'assure que le processus est lancé une seule fois.

Ici, je ferai en sorte d'obtenir un objet de configuration unique pour mon application web. Ainsi, on veut restreindre le programmeur à faire ceci :

// erreur!
var obj = new AppConfiguration();

Voici un gabarit de base en JavaScript pour implémenter un singleton.

function AppConfiguration() {

  // quelques propriétés
  this.language = 'fr';
  this.currency = 'CAD';
  this.currencySymbol = '$';
  this.dateFormat = 'yyyy-mm-dd';

  if ( AppConfiguration.caller != AppConfiguration.getInstance ) {
      throw new Error("This object cannot be instanciated");
  }
}

// propriété statique qui contient l'instance unique
AppConfiguration.instance = null;

AppConfiguration.getInstance = function() {
  if (this.instance == null) {
      this.instance = new AppConfiguration();
  }

  return this.instance;
}

Dans le constructeur, c'est là que la magie s'opère. On vérifie la propriété caller qui retourne une référence à la fonction qui a appelé la fonction courante. Autrement dit, on retourne un objet seulement et seulement si ça a été demandé par la méthode getInstance.

Bien sûr, on peut appeler plusieurs fois getInstance() mais les propriétés de l'objet seront les mêmes pour les deux "objets" puisqu'en réalité, il s'agit du même comme le démontre le test ci-dessous :

var obj1 = AppConfiguration.getInstance();

// valeur par défaut: fr
console.log(obj1.language);

// changer la langue pour anglais
obj1.language = 'en';

// récupérer l'instance dans une autre variable
var obj2 = AppConfiguration.getInstance();

// la propriété language de obj2 vaut "en"!
console.log(obj2.language);

// changer la langue du 2ème objet
obj2.language = 'klingon';

// klingon
console.log(obj1.language);

// klingon
console.log(obj2.language);

Au final, même si l'objet est référencé par deux variables, elles pointent vers la même instance. Changer la propriété à une ou l'autre des variables se répercutera à l'objet unique.