Шаблон синглтона в nodejs - чи потрібен він?

Нещодавно я натрапив на цю статтю про те, як написати синглтон в Node.js. Я знаю документацію require держав, яка:

Модулі кешуються після першого завантаження. Кілька викликів до require('foo')не можуть спричинити багаторазове виконання коду модуля.

Отже, здається, що кожен необхідний модуль може бути легко використаний як синглтон без єдиного шаблонного коду.

Питання:

Чи наведена вище стаття пропонує навколо рішення щодо створення синглтона?

В основному це пов’язано з кешуванням nodejs. Простий і простий.

https://nodejs.org/api/modules.html#modules_caching

(v 6.3.1)

Кешування

Модулі кешуються після першого завантаження. Це означає (серед іншого), що при кожному виклику, щоб вимагати ('foo'), повертатиметься точно такий самий об'єкт, якщо він буде вирішуватись у тому самому файлі.

Кілька викликів, щоб вимагати ('foo'), можуть не спричиняти багаторазове виконання коду модуля. Це важлива особливість. За допомогою нього можна повернути "частково зроблені" об'єкти, що дозволяє завантажувати транзитивні залежності навіть тоді, коли вони спричинять цикли.

Якщо ви хочете, щоб модуль виконував код кілька разів, експортуйте функцію та викличте цю функцію.

Модуль кешування застережень

Модулі кешуються на основі їх дозволеного імені файлу. Оскільки модулі можуть вирішувати інше ім'я файлу залежно від місця розташування викличного модуля (завантаження з папок node_modules), це не гарантія, що вимагає ('foo') завжди повертати такий самий об'єкт, якщо він вирішить різні файли .

Крім того, у файлових системах, що не враховують регістр, або операційних системах, різні вирішені назви файлів можуть вказувати на один і той самий файл, але кеш все одно буде розглядати їх як різні модулі і перезавантажуватиме файл кілька разів. Наприклад, require ('./ foo') і require ('./ FOO') повертають два різні об'єкти, незалежно від того, є ./foo і ./FOO однаковим файлом.

Тож простими словами.

Якщо ви хочете синглтона; експортувати об’єкт .

Якщо ви не хочете синглтона; експортувати функцію (і робити речі / повертати речі / будь-що в цій функції).

Щоб бути ДУЖЕ зрозумілим, якщо ви зробите це належним чином, це повинно працювати, перегляньте https://stackoverflow.com/a/33746703/1137669 (відповідь Аллена Люса). Це пояснює в коді, що відбувається, коли кешування не вдається через різне вирішення імен файлів. Але якщо Ви ЗАВЖДИ вирішите одне і те ж ім'я файлу, це повинно працювати.

Оновлення 2016 року

створення справжнього синглтона в node.js із символами es6 Інше рішення : за цим посиланням

Оновлення 2020 року

Ця відповідь стосується CommonJS (власний спосіб імпорту / експорту модулів Node.js). Node.js, швидше за все, перейде на модулі ECMAScript : https://nodejs.org/api/esm.html (ECMAScript - справжнє ім'я JavaScript, якщо ви цього не знали)

При переході до ECMAScript на даний момент прочитайте наступне: https://nodejs.org/api/esm.html#esm_writing_dual_packages_ while_avoiding_or_minimizing_hazards

Все перераховане є надто складним. Існує школа думок, яка говорить, що шаблони дизайну демонструють недоліки фактичної мови.

Мови з OOP на основі прототипу (безкласові) взагалі не потребують єдиного шаблону. Ви просто створюєте один (тонну) об’єкт на льоту, а потім використовуєте його.

Що стосується модулів у вузлі, так, за замовчуванням вони кешуються, але їх можна налаштувати, наприклад, якщо ви хочете гаряче завантаження змін модуля.

Але так, якщо ви хочете використовувати спільний об’єкт повсюдно, помістити його в модуль експорту - це нормально. Тільки не ускладнюйте його "одностороннім шаблоном", це не потрібно в JavaScript.

Ні. Коли кешування модулів Node не вдається, не вдається виконати одиночний шаблон. Я модифікував приклад, щоб він змістовно працював на OSX:

var sg = require("./singleton.js");
var sg2 = require("./singleton.js");
sg.add(1, "test");
sg2.add(2, "test2");

console.log(sg.getSocketList(), sg2.getSocketList());

Це дає результат, який передбачав автор:

{ '1': 'test', '2': 'test2' } { '1': 'test', '2': 'test2' }

Але невелика модифікація перемагає кешування. На OSX зробіть так:

var sg = require("./singleton.js");
var sg2 = require("./SINGLETON.js");
sg.add(1, "test");
sg2.add(2, "test2");

console.log(sg.getSocketList(), sg2.getSocketList());

Або в Linux:

% ln singleton.js singleton2.js

Потім змініть sg2рядок вимоги на:

var sg2 = require("./singleton2.js");

І бам , сингл переможений:

{ '1': 'test' } { '2': 'test2' }

Я не знаю прийнятного способу обійти це. Якщо ви дійсно відчуваєте необхідність зробити щось подібне до одиночного, і у вас все гаразд із забрудненням глобального простору імен (і багатьох проблем, які можуть виникнути в результаті), ви можете змінити автора getInstance()та exportsрядки на:

singleton.getInstance = function(){
  if(global.singleton_instance === undefined)
    global.singleton_instance = new singleton();
  return global.singleton_instance;
}

module.exports = singleton.getInstance();

Це означає, що я ніколи не стикався з ситуацією у виробничій системі, де мені потрібно було робити щось подібне. Я також ніколи не відчував необхідності використовувати однотонний візерунок у Javascript.

Ознайомившись трохи далі із застереженнями щодо кешування модулів у документації до модулів:

Модулі кешуються на основі їх дозволеного імені файлу. Оскільки модулі можуть перейти до іншого імені файлу залежно від розташування викликаючого модуля (завантаження з папок node_modules), це не гарантія того, що вимагатиме ('foo') завжди повертатиме той самий об'єкт, якщо це буде вирішувати різні файли .

Отже, залежно від того, де ви знаходитесь, коли вам потрібен модуль, можливо отримати інший примірник модуля.

Звучить, що модулі - це не просте рішення для створення одиночних кнопок.

Редагувати: А може, вони і є . Як і @mkoryak, я не можу придумати, щоб один файл міг перейти до різних імен файлів (без використання символьних посилань). Але (як коментує @JohnnyHK), кілька копій файлу в різних node_modulesкаталогах завантажуватимуться і зберігатимуться окремо.

Такий сингл в node.js (або в браузері JS), подібний, абсолютно непотрібний.

Оскільки модулі кешовані та мають статус, приклад, наведений за посиланням, яке ви надали, можна легко переписати набагато простіше:

var socketList = {};

exports.add = function (userId, socket) {
    if (!socketList[userId]) {
        socketList[userId] = socket;
    }
};

exports.remove = function (userId) {
    delete socketList[userId];
};

exports.getSocketList = function () {
    return socketList;
};
// or
// exports.socketList = socketList

Єдина відповідь тут - використання класів ES6

// SummaryModule.js
class Summary {

  init(summary) {
    this.summary = summary
  }

  anotherMethod() {
    // do something
  }
}

module.exports = new Summary()

потрібен цей синглтон із:

const summary = require('./SummaryModule')
summary.init(true)
summary.anotherMethod()

Єдина проблема тут полягає в тому, що ви не можете передавати параметри конструктору класу, але це можна обійти ручним викликом initметоду.

Вам не потрібно нічого особливого робити синглтон в js, код у статті може так само бути:

var socketList = {};

module.exports = {
      add: function() {

      },

      ...
};

Поза node.js (наприклад, у браузері js) вам потрібно додати функцію обгортки вручну (це робиться автоматично в node.js):

var singleton = function() {
    var socketList = {};
    return {
        add: function() {},
        ...
    };
}();

Одиночні люди добре в JS, їм просто не потрібно бути такими багатослівними.

У вузлі, якщо вам потрібен синглтон, наприклад, щоб використовувати один і той же екземпляр ORM / DB у різних файлах на серверному рівні, ви можете вкласти посилання в глобальну змінну.

Просто напишіть модуль, який створює глобальний var, якщо він не існує, а потім повертає посилання на нього.

@ allen-luce це правильно зробив, скопіювавши тут приклад коду виноски:

singleton.getInstance = function(){
  if(global.singleton_instance === undefined)
    global.singleton_instance = new singleton();
  return global.singleton_instance;
};

module.exports = singleton.getInstance();

але важливо зазначити, що використовувати newключове слово не потрібно. Буде працювати будь-який старий об’єкт, функція, iife тощо - тут не відбувається вуду ООП.

бонусні бали, якщо ви закриваєте деякий obj всередині функції, яка повертає посилання на неї, і робите цю функцію глобальною - тоді навіть перепризначення глобальної змінної не призведе до збиття вже створених з неї екземплярів - хоча це сумнівно корисно.

Зберігаючи це просто.

foo.js

function foo() {

  bar: {
    doSomething: function(arg, callback) {
      return callback('Echo ' + arg);
    };
  }

  return bar;
};

module.exports = foo();

Тоді просто

var foo = require(__dirname + 'foo');
foo.doSomething('Hello', function(result){ console.log(result); });