รูปแบบ Singleton ใน nodejs - จำเป็นหรือไม่?

ฉันเพิ่งเจอบทความนี้เกี่ยวกับวิธีการเขียนซิงเกิลตันใน Node.js ฉันรู้เอกสารของrequire รัฐที่:

โมดูลจะถูกแคชไว้หลังจากโหลดครั้งแรก การโทรหลายครั้งrequire('foo')อาจไม่ทำให้โค้ดโมดูลถูกเรียกใช้งานหลายครั้ง

ดังนั้นดูเหมือนว่าทุกโมดูลที่จำเป็นสามารถใช้เป็นซิงเกิลตันได้อย่างง่ายดายโดยไม่ต้องใช้รหัสสำเร็จรูปแบบซิงเกิลตัน

คำถาม:

บทความข้างต้นให้ข้อมูลเกี่ยวกับวิธีการสร้างซิงเกิลตันหรือไม่?

สิ่งนี้เกี่ยวข้องกับการแคช nodejs โดยทั่วไป เรียบง่าย.

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

(v 6.3.1)

เก็บเอาไว้

โมดูลจะถูกแคชไว้หลังจากโหลดครั้งแรก ซึ่งหมายความว่า (เหนือสิ่งอื่นใด) ทุกการเรียกที่ต้องการ ('foo') จะได้รับอ็อบเจ็กต์เดียวกันทั้งหมดที่ส่งคืนหากจะแก้ไขเป็นไฟล์เดียวกัน

การเรียกหลายครั้งที่ต้องการ ('foo') อาจไม่ทำให้โค้ดโมดูลถูกเรียกใช้งานหลายครั้ง นี่คือคุณสมบัติที่สำคัญ ด้วยมันสามารถส่งคืนอ็อบเจ็กต์ "เสร็จสิ้นบางส่วน" ได้ซึ่งทำให้สามารถโหลดการอ้างอิงสกรรมกริยาได้แม้ว่าจะทำให้เกิดรอบ

หากคุณต้องการให้โมดูลรันโค้ดหลายครั้งให้ส่งออกฟังก์ชันและเรียกใช้ฟังก์ชันนั้น

คำเตือนการแคชโมดูล

โมดูลจะถูกแคชตามชื่อไฟล์ที่แก้ไข เนื่องจากโมดูลอาจแก้ไขเป็นชื่อไฟล์อื่นตามตำแหน่งของโมดูลการเรียกใช้ (การโหลดจากโฟลเดอร์ node_modules) จึงไม่รับประกันว่าต้องการให้ ('foo') จะส่งคืนอ็อบเจ็กต์เดียวกันทุกครั้งหากจะแก้ไขเป็นไฟล์อื่น .

นอกจากนี้ในระบบไฟล์หรือระบบปฏิบัติการที่ไม่คำนึงถึงตัวพิมพ์เล็กและใหญ่ชื่อไฟล์ที่แก้ไขต่างกันสามารถชี้ไปที่ไฟล์เดียวกันได้ แต่แคชจะยังถือว่าเป็นโมดูลที่แตกต่างกันและจะโหลดไฟล์ซ้ำหลายครั้ง ตัวอย่างเช่นต้องใช้ ('./ foo') และกำหนดให้ ('./ FOO') ส่งคืนอ็อบเจ็กต์สองรายการที่แตกต่างกันไม่ว่า. / foo และ ./FOO จะเป็นไฟล์เดียวกันหรือไม่

พูดง่ายๆก็คือ

ถ้าคุณต้องการ Singleton; ส่งออกวัตถุ

หากคุณไม่ต้องการ Singleton ส่งออกฟังก์ชัน (และทำสิ่งของ / ส่งคืนสิ่งของ / อะไรก็ตามในฟังก์ชันนั้น)

เพื่อความชัดเจนมากหากคุณทำอย่างถูกต้องควรได้ผลโปรดดูที่https://stackoverflow.com/a/33746703/1137669 (คำตอบของ Allen Luce) มันอธิบายในโค้ดว่าจะเกิดอะไรขึ้นเมื่อการแคชล้มเหลวเนื่องจากชื่อไฟล์ที่แก้ไขต่างกัน แต่ถ้าคุณมักจะแก้ไขเป็นชื่อไฟล์เดียวกันควรใช้งานได้

อัปเดต 2016

การสร้าง singleton ที่แท้จริงใน 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

ไม่ เมื่อการแคชโมดูลของโหนดล้มเหลวรูปแบบซิงเกิลตันนั้นจะล้มเหลว ฉันแก้ไขตัวอย่างเพื่อให้ทำงานอย่างมีความหมายบน 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

ดูเพิ่มเติมอีกเล็กน้อยที่Module Caching Caveatsในเอกสาร Modules:

โมดูลจะถูกแคชตามชื่อไฟล์ที่แก้ไข เนื่องจากโมดูลอาจแก้ไขเป็นชื่อไฟล์อื่นตามตำแหน่งของโมดูลการเรียกใช้ (การโหลดจากโฟลเดอร์ node_modules) จึงไม่รับประกันว่าต้องการให้ ('foo') จะส่งคืนอ็อบเจ็กต์เดียวกันทุกครั้งหากจะแก้ไขเป็นไฟล์อื่น .

ดังนั้นขึ้นอยู่กับว่าคุณอยู่ที่ไหนเมื่อคุณต้องการโมดูลคุณสามารถรับอินสแตนซ์ที่แตกต่างกันของโมดูลได้

ดูเหมือนว่าโมดูลไม่ใช่วิธีง่ายๆในการสร้างเสื้อกล้าม

แก้ไข:หรือบางทีพวกเขามี เช่น @mkoryak ฉันไม่สามารถหากรณีที่ไฟล์เดียวอาจแก้ไขเป็นชื่อไฟล์ที่แตกต่างกัน (โดยไม่ใช้ symlinks) แต่ (ตามความคิดเห็นของ @JohnnyHK) สำเนาไฟล์หลายชุดในnode_modulesไดเรกทอรีต่างๆจะถูกโหลดและจัดเก็บแยกกัน

Singleton ใน 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

คุณไม่ต้องการอะไรเป็นพิเศษในการทำ singleton ใน js โค้ดในบทความอาจเป็น:

var socketList = {};

module.exports = {
      add: function() {

      },

      ...
};

ภายนอก node.js (เช่นในเบราว์เซอร์ js) คุณต้องเพิ่มฟังก์ชัน wrapper ด้วยตนเอง (จะทำโดยอัตโนมัติใน node.js):

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

คำตอบเดียวที่นี่ที่ใช้คลาส ES6

// SummaryModule.js
class Summary {

  init(summary) {
    this.summary = summary
  }

  anotherMethod() {
    // do something
  }
}

module.exports = new Summary()

ต้องการ singleton นี้ด้วย:

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

ปัญหาเดียวที่นี่คือคุณไม่สามารถส่งพารามิเตอร์ไปยังตัวสร้างคลาสได้ แต่สามารถหลีกเลี่ยงได้โดยการเรียกใช้initเมธอดด้วยตนเอง

Singletons นั้นใช้ได้ดีใน JS พวกเขาไม่จำเป็นต้องละเอียดมากนัก

ในโหนดหากคุณต้องการซิงเกิลตันตัวอย่างเช่นในการใช้อินสแตนซ์ ORM / DB เดียวกันกับไฟล์ต่างๆในเลเยอร์เซิร์ฟเวอร์ของคุณคุณสามารถใส่ข้อมูลอ้างอิงลงในตัวแปรส่วนกลางได้

เพียงแค่เขียนโมดูลที่สร้าง global 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 ฯลฯ จะใช้งานได้ - ไม่มี OOP วูดูเกิดขึ้นที่นี่

คะแนนโบนัสหากคุณปิด 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); });