Реализация Одиночки в JS

Условия выполнения

Мы воспользуемся подходом TDD и прежде чем писать реализации запишем минимальные тесты, которые должны быть выполнены. Так как это JS и этот язык сильно отличается от более “правильных” языков типа Java, C++ и прочих, в которых создание объекта реализуется через класс, а конструктор не может ничего возвращать, то мы будем так же рассматривать варианты реализации без конструктора и классического определения класса. Ведь в JS это можно делать.

И так, минимальные условия:

var errorMessage = 'Instantiation failed: use Singleton.getInstance() instead of new.';

// Test constructor
try { var obj0 = new Singleton } catch(c) { console.log(c == errorMessage) }

// Create and get object
let obj1 = Singleton.getInstance();
let obj2 = Singleton.getInstance();

obj1.foo = 456;
console.log( obj1 === obj2 );

try { var obj3 = new Singleton } catch(c) { console.log(c == errorMessage) }

console.log(obj0 === void 0);
console.log(obj3 === void 0);

Но эти тесты будут модифицированы в процессе разбора решений, так как у нас будут реализации, возвращающие ссылку на объект из конструктора.

Реализации Singleton в TypeScript

Классическая реализация на TypeScript

Все бы хорошо, но в TypeScript 1.8 нет возможности задать приватный конструктор, что приводит к добавлению логики в него. Минусы такой реализации — при первом вызове new Singleton конструктор вернет объект. Да им можно пользоваться, но это нарушает классическую реализацию. Мы можем модифицировать код и получить вот такую версию:

В такой реализации и кода меньше, и нельзя получить экземпляр объекта через new, так как первая иницализация происходит “автоматически” при объявлении класса.

Снова повторюсь: так как у нас необычный язык, то реализовать задачу можно совершенно необычными способами. Например мы можем реализовать одиночку через пространство имен (namespace):

Продолжая развивать тему, мы можем реализовать паттерн через модуль. Я покажу вариант модуля:

Вы так же можете реализовать модуль в отдельном файле:

В такой реализации у нас не то чтобы нет доступа к объекту через вызов new Singleton. У нас вообще нет возможности достучаться до конструктора (ну мы сейчас не рассматриваем цепочку прототипов и прочие возможности JS).

TypeScript 2.0

Релиз TS 2.0 еще не вышел, но он в бета и его уже можно даже попробовать. Среди новшеств добавление модификаторов для конструктора (private, protected), а это значит что можно сделать Singleton еще проще, используя классическую парадигму:

class Singleton {
 
    protected static instance = new Singleton;
 
    public foo: number = 123;
 
    private constructor() {}
 
    public static getInstance() :Singleton {
       return Singleton.instance;
    }
}

Анонимный класс

Так можНо, если нужно ;)

const Singleton = new (class {
   public foo :number = 123;
   getInstance() :this { return this }
})();

Реализации Singleton в JavaScript

А теперь вернемся к нашему любимому JavaScript со всеми его возможностями. И так, помните я говорил, что мы каждый день пользуемся объектами одиночками? Так как у нас JS , то нам вовсе не нужно создавать класс для получения объекта. Мы можем создать объект, который будет проходить наши тесты:

const Singleton = {
   foo: 123,
   getInstance() { return this }
};

let obj1 = Singleton.getInstance();
let obj2 = Singleton.getInstance();

obj1.foo = 456;
console.log( obj1 === obj2 );

В данном примере метод getInstance создан только для того, чтобы не менять наши тесты. Ведь у нас есть полный доступ ко всему объекту и мы можем делать с ним что угодно. Но если вспоминать классическое определение шаблона, то там сказано что Одиночка порождающий шаблон, гарантирующий единственный экземпляр класса с глобальной точкой доступа. Пример выше выполняет эти условия, разве что у нас не реализован механизм порождения. Хотя можно считать что он встроен в язык программирования.

А теперь рассмотрим более сложные примеры на ES5+, позволяющие создавать именно классы, которые будут порождать Singleton.

И да, мы можем возвращать из конструктора любой объект, что дает простор воображению. Поехали!

Используем arguments

function Singleton() {
   if (arguments.callee.instance) return arguments.callee.instance;
   this.foo = 123;
   return arguments.callee.instance = this;
}

let obj1 = new Singleton;
let obj2 = new Singleton;

obj1 === obj2 // true

Метод лаконичен и просто в реализации, но у него есть недостаток. В режиме “use strict” этот код не будет работать, а JSLint/JSHint в (Php|Web)Storm будет показывать ошибку.

Тогда этот же пример можно переписать так:

function Singleton() {
    if (Singleton.instance) return Singleton.instance;
    this.foo = 123;
    return Singleton.instance = this;
}

Скрываем доступ к instance

Пример на ES5 c приватными (локальными) переменными:

В этом примере используем замыкание для реализации.

Краткая запись

var Singleton = new function(){
    var instance = this;
    // Код конструктора
    return function(){ return instance }
}

console.log( new Singleton === new Singleton ); // true

ECMAScript 2015

Эпилог

Как видите способов и разнообразия для реализации логики порождающей единственный экземпляр объекта хватает в нашем любимом JavaScript.