วิธีจัดการกับการพึ่งพาแบบวนซ้ำใน Node.js

ฉันได้ทำงานกับ nodejs เมื่อเร็ว ๆ นี้และยังคงจับกับระบบโมดูลดังนั้นขอโทษถ้านี่เป็นคำถามที่ชัดเจน ฉันต้องการรหัสคร่าวๆดังต่อไปนี้:

a.js (ไฟล์หลักทำงานกับโหนด)

var ClassB = require("./b");

var ClassA = function() {
    this.thing = new ClassB();
    this.property = 5;
}

var a = new ClassA();

module.exports = a;

b.js

var a = require("./a");

var ClassB = function() {
}

ClassB.prototype.doSomethingLater() {
    util.log(a.property);
}

module.exports = ClassB;

ปัญหาของฉันดูเหมือนว่าฉันไม่สามารถเข้าถึงอินสแตนซ์ของ ClassA จากภายในอินสแตนซ์ของ ClassB

มีวิธีที่ถูกต้อง / ดีกว่าในการจัดโครงสร้างโมดูลเพื่อให้บรรลุสิ่งที่ฉันต้องการหรือไม่? มีวิธีที่ดีกว่าในการแบ่งปันตัวแปรระหว่างโมดูลหรือไม่

แม้ว่า node.js จะอนุญาตให้มีการrequireขึ้นต่อกันแบบวนรอบแต่คุณอาจพบว่ามันยุ่งเหยิงและคุณควรปรับโครงสร้างโค้ดของคุณให้ดีขึ้นโดยไม่ต้องการมัน อาจสร้างคลาสที่สามที่ใช้อีกสองประเภทเพื่อบรรลุสิ่งที่คุณต้องการ

ลองตั้งค่าคุณสมบัติบนmodule.exportsแทนการแทนที่โดยสมบูรณ์ เช่นmodule.exports.instance = new ClassA()ในa.js, ในmodule.exports.ClassB = ClassB b.jsเมื่อคุณทำการอ้างอิงโมดูลแบบวงกลมโมดูลที่ต้องการจะได้รับการอ้างอิงถึงความไม่สมบูรณ์module.exportsจากโมดูลที่ต้องการซึ่งคุณสามารถเพิ่มคุณสมบัติอื่น ๆ ได้ แต่เมื่อคุณตั้งค่าทั้งหมดmodule.exportsคุณจะสร้างวัตถุใหม่ซึ่งโมดูลที่ต้องการไม่มี วิธีการเข้าถึง

[แก้ไข] ไม่ใช่ปี 2015 และห้องสมุดส่วนใหญ่ (เช่นด่วน) ได้ทำการอัปเดตด้วยรูปแบบที่ดีขึ้นดังนั้นการพึ่งพาแบบวนรอบจึงไม่จำเป็นอีกต่อไป ผมขอแนะนำให้ก็ไม่ได้ใช้พวกเขา

ตรวจสอบให้แน่ใจว่ามีการกำหนดเอ็กซ์พอร์ตที่จำเป็นก่อนที่คุณต้องการไฟล์ที่มีการขึ้นต่อกันแบบวนซ้ำ

สิ่งนี้จะทำลาย:

var ClassA = function(){};
var ClassB = require('classB'); //will require ClassA, which has no exports yet

module.exports = ClassA;

สิ่งนี้จะได้ผล:

var ClassA = module.exports = function(){};
var ClassB = require('classB');

ฉันใช้รูปแบบนี้ตลอดเวลาเพื่อเข้าถึง express.js appในไฟล์อื่น ๆ :

var express = require('express');
var app = module.exports = express();
// load in other dependencies, which can now require this file and use app

บางครั้งมันเป็นเรื่องเทียมที่จะแนะนำคลาสที่สาม (ตามที่ JohnnyHK แนะนำ) ดังนั้นนอกเหนือจาก Ianzz: หากคุณต้องการแทนที่ module.exports ตัวอย่างเช่นถ้าคุณกำลังสร้างคลาส (เช่นไฟล์ b.js ใน ตัวอย่างข้างต้น) สิ่งนี้เป็นไปได้เช่นกันเพียงตรวจสอบให้แน่ใจว่าในไฟล์ที่เริ่มต้นวงกลมจำเป็นต้องมีคำสั่ง 'module.exports = ... ' เกิดขึ้นก่อนที่คำสั่ง require

a.js (ไฟล์หลักทำงานกับโหนด)

var ClassB = require("./b");

var ClassA = function() {
    this.thing = new ClassB();
    this.property = 5;
}

var a = new ClassA();

module.exports = a;

b.js

var ClassB = function() {
}

ClassB.prototype.doSomethingLater() {
    util.log(a.property);
}

module.exports = ClassB;

var a = require("./a"); // <------ this is the only necessary change

การแก้ปัญหาคือ 'ส่งต่อประกาศ' วัตถุส่งออกของคุณก่อนที่จะต้องมีตัวควบคุมอื่น ๆ ดังนั้นหากคุณจัดโครงสร้างโมดูลทั้งหมดของคุณเช่นนี้และคุณจะไม่พบปัญหาใด ๆ เช่นนั้น:

// Module exports forward declaration:
module.exports = {

};

// Controllers:
var other_module = require('./other_module');

// Functions:
var foo = function () {

};

// Module exports injects:
module.exports.foo = foo;

ทางออกที่ต้องมีการเปลี่ยนแปลงน้อยที่สุดคือการขยายmodule.exportsแทนการเอาชนะมัน

a.js - จุดเข้าใช้งานแอพและโมดูลที่ใช้วิธีการทำจาก b.js *

_ = require('underscore'); //underscore provides extend() for shallow extend
b = require('./b'); //module `a` uses module `b`
_.extend(module.exports, {
    do: function () {
        console.log('doing a');
    }
});
b.do();//call `b.do()` which in turn will circularly call `a.do()`

b.js - โมดูลที่ใช้วิธีการทำจาก a.js

_ = require('underscore');
a = require('./a');

_.extend(module.exports, {
    do: function(){
        console.log('doing b');
        a.do();//Call `b.do()` from `a.do()` when `a` just initalized 
    }
})

มันจะทำงานและผลิต:

doing b
doing a

ในขณะที่รหัสนี้จะไม่ทำงาน:

a.js

b = require('./b');
module.exports = {
    do: function () {
        console.log('doing a');
    }
};
b.do();

b.js

a = require('./a');
module.exports = {
    do: function () {
        console.log('doing b');
    }
};
a.do();

เอาท์พุท:

node a.js
b.js:7
a.do();
    ^    
TypeError: a.do is not a function

ขี้เกียจต้องการอะไรเมื่อคุณต้องการ? ดังนั้น b.js ของคุณจะมีลักษณะดังนี้

var ClassB = function() {
}
ClassB.prototype.doSomethingLater() {
    var a = require("./a");    //a.js has finished by now
    util.log(a.property);
}
module.exports = ClassB;

แน่นอนว่าเป็นวิธีปฏิบัติที่ดีที่จะต้องใส่คำสั่งทั้งหมดที่ด้านบนของไฟล์ แต่มีอยู่ครั้งที่ฉันให้อภัยตัวเองสำหรับการเลือกสิ่งที่ออกจากโมดูลที่ไม่เกี่ยวข้องเป็นอย่างอื่น เรียกว่าแฮ็ค แต่บางครั้งสิ่งนี้ดีกว่าการแนะนำการพึ่งพาเพิ่มเติมหรือเพิ่มโมดูลพิเศษหรือเพิ่มโครงสร้างใหม่ (EventEmitter ฯลฯ )

อีกวิธีที่ฉันเห็นคนทำคือส่งออกที่บรรทัดแรกและบันทึกเป็นตัวแปรท้องถิ่นเช่นนี้

let self = module.exports = {};

const a = require('./a');

// Exporting the necessary functions
self.func = function() { ... }

ฉันมักจะใช้วิธีนี้คุณรู้เกี่ยวกับข้อเสียของมันหรือไม่?

คุณสามารถแก้ปัญหานี้ได้อย่างง่ายดายเพียงแค่ส่งออกข้อมูลของคุณก่อนที่คุณจะต้องการสิ่งใดในโมดูลที่คุณใช้ module.exports:

classA.js

class ClassA {

    constructor(){
        ClassB.someMethod();
        ClassB.anotherMethod();
    };

    static someMethod () {
        console.log( 'Class A Doing someMethod' );
    };

    static anotherMethod () {
        console.log( 'Class A Doing anotherMethod' );
    };

};

module.exports = ClassA;
var ClassB = require( "./classB.js" );

let classX = new ClassA();

classB.js

class ClassB {

    constructor(){
        ClassA.someMethod();
        ClassA.anotherMethod();
    };

    static someMethod () {
        console.log( 'Class B Doing someMethod' );
    };

    static anotherMethod () {
        console.log( 'Class A Doing anotherMethod' );
    };

};

module.exports = ClassB;
var ClassA = require( "./classA.js" );

let classX = new ClassB();

คล้ายกับคำตอบของ lanzz และ setect ฉันใช้รูปแบบต่อไปนี้:

module.exports = Object.assign(module.exports, {
    firstMember: ___,
    secondMember: ___,
});

การObject.assign()คัดลอกสมาชิกไปยังexportsวัตถุที่ได้มอบให้กับโมดูลอื่นแล้ว

การ=มอบหมายนั้นซ้ำซ้อนอย่างมีเหตุผลเนื่องจากเป็นเพียงการตั้งค่าmodule.exportsให้กับตัวเอง แต่ฉันใช้มันเพราะช่วยให้ IDE ของฉัน (WebStorm) รับรู้ว่าfirstMemberเป็นคุณสมบัติของโมดูลนี้ดังนั้น "ไปที่ -> ประกาศ" (Cmd-B) และเครื่องมืออื่น ๆ จะทำงานจากไฟล์อื่น ๆ

รูปแบบนี้ไม่สวยมากดังนั้นฉันจะใช้เฉพาะเมื่อปัญหาการพึ่งพาแบบวนรอบต้องได้รับการแก้ไข

นี่เป็นวิธีแก้ปัญหาด่วนที่ฉันพบว่าใช้เต็ม

ในไฟล์ 'a.js'

let B;
class A{
  constructor(){
    process.nextTick(()=>{
      B = require('./b')
    })
  } 
}
module.exports = new A();

ในไฟล์ 'b.js' เขียนดังต่อไปนี้

let A;
class B{
  constructor(){
    process.nextTick(()=>{
      A = require('./a')
    })
  } 
}
module.exports = new B();

วิธีนี้ในการวนซ้ำครั้งถัดไปของคลาสลูปเหตุการณ์จะถูกกำหนดอย่างถูกต้องและคำสั่งที่ต้องการจะทำงานตามที่คาดไว้

จริง ๆ แล้วฉันต้องการการพึ่งพากับ

 var a = null;
 process.nextTick(()=>a=require("./a")); //Circular reference!

ไม่สวย แต่ใช้งานได้ เป็นที่เข้าใจและซื่อสัตย์มากกว่าการเปลี่ยน b.js (เช่นเพิ่มโมดูล modules.export เท่านั้น) ซึ่งเป็นอย่างอื่นที่สมบูรณ์แบบ

วิธีหนึ่งในการหลีกเลี่ยงคือการไม่ต้องการไฟล์หนึ่งในอีกไฟล์เพียงแค่ส่งเป็นอาร์กิวเมนต์ให้กับฟังก์ชั่นที่คุณต้องการในไฟล์อื่น ด้วยวิธีนี้การพึ่งพาแบบวนรอบจะไม่เกิดขึ้น