javascript singleton question

Question

I just read a few threads on the discussion of singleton design in javascript. I'm 100% new to the Design Pattern stuff but as I see since a Singleton by definition won't have the need to be instantiated, conceptually if it's not to be instantiated, in my opinion it doesn't have to be treated like conventional objects which are created from a blueprint(classes). So my wonder is why not just think of a singleton just as something statically available that is wrapped in some sort of scope and that should be all.

From the threads I saw, most of them make a singleton though traditional javascript

new function(){} 

followed by making a pseudo constructor.

Well I just think an object literal is enough enough:

var singleton = {
   dothis: function(){},
   dothat: function(){}
}

right? Or anybody got better insights?

[update] : Again my point is why don't people just use a simpler way to make singletons in javascript as I showed in the second snippet, if there's an absolute reason please tell me. I'm usually afraid of this kind of situation that I simplify things to much :D

Answer 1

I agree with you, the simplest way is to use a object literal, but if you want private members, you could implement taking advantage of closures:

var myInstance = (function() {
  var privateVar;

  function privateMethod () {
    // ...
  }

  return { // public interface
    publicMethod1: function () {
      // private members can be accessed here
    },
    publicMethod2: function () {
      // ...
    }
  };
})();

About the new function(){} construct, it will simply use an anonymous function as a constructor function, the context inside that function will be a new object that will be returned.

Edit: In response to the @J5's comment, that is simple to do, actually I think that this can be a nice example for using a Lazy Function Definition pattern:

function singleton() {
  var instance = (function() {
    var privateVar;

    function privateMethod () {
      // ...
    }

    return { // public interface
      publicMethod1: function () {
          // private members can be accessed here
       },
      publicMethod2: function () {
        // ...
      }
    };
  })();

  singleton = function () { // re-define the function for subsequent calls
    return instance;
  };

  return singleton(); // call the new function
}

When the function is called the first time, I make the object instance, and reassign singleton to a new function which has that object instance in it's closure.

Before the end of the first time call I execute the re-defined singleton function that will return the created instance.

Following calls to the singleton function will simply return the instance that is stored in it's closure, because the new function is the one that will be executed.

You can prove that by comparing the object returned:

singleton() == singleton(); // true

The == operator for objects will return true only if the object reference of both operands is the same, it will return false even if the objects are identical but they are two different instances:

({}) == ({}); // false
new Object() == new Object(); // false

Answer 2

The ES5 spec lets us use Object.create():

var SingletonClass = (function() {
    var instance;
    function SingletonClass() {
        if (instance == null) {
            instance = Object.create(SingletonClass.prototype);
        }

        return instance;
    }

    return {
        getInstance: function() {
            return new SingletonClass();
        }
   };
})();

var x = SingletonClass.getInstance();
var y = SingletonClass.getInstance();
var z = new x.constructor();

This is nice, since we don't have to worry about our constructor leaking, we still always end up with the same instance.

This structure also has the advantage that our Singleton doesn't construct itself until it is required. Additionally, using the closure as we do here prevents external code from using our "instance" variable, accidentally or otherwise. We can build more private variables in the same place and we can define anything we care to export publically on our class prototype.

Answer 3

I have used the second version (var singleton = {};) for everything from Firefox extensions to websites, and it works really well. One good idea is to not define things inside the curly brackets, but outside it using the name of the object, like so:

var singleton = {};
singleton.dothis = function(){

};
singleton.someVariable = 5;

Answer 4

The singleton pattern is implemented by creating a class with a method that creates a new instance of the class if one does not exist. If an instance already exists, it simply returns a reference to that object. 1

(function (global) {

     var singleton;

     function Singleton () {
         // singleton does have a constructor that should only be used once    
         this.foo = "bar";
         delete Singleton; // disappear the constructor if you want
     }

     global.singleton = function () {
         return singleton || (singleton = new Singleton());
     };

})(window);

var s = singleton();
console.log(s.foo);

var y = singleton();
y.foo = "foo";
console.log(s.foo);

You don't just declare the singleton as an object because that instantiates it, it doesn't declare it. It also doesn't provide a mechanism for code that doesn't know about a previous reference to the singleton to retrieve it. The singleton is not the object/class that is returned by the singleton, it's a structure. This is similar to how closured variables are not closures, the function scope providing the closure is the closure.

Answer 5

I am just posting this answer for people who are looking for a reliable source.

according to patterns.dev by Lydia Hallie, Addy Osmani

Singletons are actually considered an anti-pattern, and can (or.. should) be avoided in JavaScript. In many programming languages, such as Java or C++, it's not possible to directly create objects the way we can in JavaScript. In those object-oriented programming languages, we need to create a class, which creates an object. That created object has the value of the instance of the class, just like the value of instance in the JavaScript example. Since we can directly create objects in JavaScript, we can simply use a regular object to achieve the exact same result.

Answer 6

I stole this from CMS / CMS' answer, and changed it so it can be invoked as:

MySingleton.getInstance().publicMethod1();

With the slight alternation:

var MySingleton = {                // These two lines

    getInstance: function() {      // These two lines

      var instance = (function() {

        var privateVar;

        function privateMethod () {
          // ...
          console.log( "b" );
        }

        return { // public interface
          publicMethod1: function () {
              // private members can be accessed here
              console.log( "a" );
           },
          publicMethod2: function () {
            // ...
            privateMethod();
          }
        };
      })();

      singleton = function () { // re-define the function for subsequent calls
        return instance;
      };

      return singleton(); // call the new function
    }
}

Answer 7

The latter code box shows what I've seen JS devs call their version of OO design in Javascript.

Singetons are meant to be singular objects that can't be constructed (except, I suppose, in the initial definition. You have one, global instance of a singleton.

Answer 8

I've wondered about this too, but just defining an object with functions in it seems reasonable to me. No sense creating a constructor that nobody's ever supposed to call, to create an object with no prototype, when you can just define the object directly.

On the other hand, if you want your singleton to be an instance of some existing "class" -- that is, you want it to have some other object as its prototype -- then you do need to use a constructor function, so that you can set its prototype property before calling it.

Answer 9

The point of using the "pseudo constructor" is that it creates a new variable scope. You can declare local variables inside the function that are available inside any nested functions but not from the global scope.

There are actually two ways of doing it. You can call the function with new like in your example, or just call the function directly. There are slight differences in how you would write the code, but they are essentially equivalent.

Your second example could be written like this:

var singleton = new function () {
    var privateVariable = 42; // This can be accessed by dothis and dothat

    this.dothis = function () {
        return privateVariable;
    };

    this.dothat = function () {};
}; // Parentheses are allowed, but not necessary unless you are passing parameters

or

var singleton = (function () {
    var privateVariable = 42; // This can be accessed by dothis and dothat

    return {
        dothis: function () {
            return privateVariable;
        },

        dothat: function () {}
    };
})(); // Parentheses are required here since we are calling the function

You could also pass arguments to either function (you would need to add parentheses to the first example).

Answer 10

Crockford (seems to) agree that the object literal is all you need for a singleton in JavaScript:

http://webcache.googleusercontent.com/search?q=cache:-j5RwC92YU8J:www.crockford.com/codecamp/The%2520Good%2520Parts%2520ppt/5%2520functional.ppt+singleton+site:www.crockford.com&cd=1&hl=en&ct=clnk

Answer 11

How about this:

function Singleton() {

    // ---------------
    // Singleton part.
    // ---------------

    var _className = null;
    var _globalScope = null;

    if ( !(this instanceof arguments.callee) ) {
        throw new Error("Constructor called as a function.");
    }

    if ( !(_className = arguments.callee.name) ) {
        throw new Error("Unable to determine class name.")
    }

    _globalScope = (function(){return this;}).call(null);

    if ( !_globalScope.singletons ) {
        _globalScope.singletons = [];
    }

    if ( _globalScope.singletons[_className] ) {
        return _globalScope.singletons[_className];
    } else {
        _globalScope.singletons[_className] = this;
    }

    // ------------
    // Normal part.
    // ------------

    var _x = null;

    this.setx = function(val) {
        _x = val;
    }; // setx()

    this.getx = function() {
        return _x;
    }; // getx()

    function _init() {
        _x = 0; // Whatever initialisation here.
    } // _init()
    _init();

} // Singleton()

    var p = new Singleton;
    var q = new Singleton;

    p.setx(15);
    q.getx(); // returns 15