javascript - Node.js 模块范式的基础知识？

Question

我正在努力真正掌握一些基本知识，我觉得这不仅阻碍了我，而且导致了糟糕的代码，我不喜欢这样。

我理解将功能代码块分解为单独模块的概念，例如路由、数据库模型等，但我很难理解如何正确编排所有这些单独模块的相互依赖的功能。

让我举几个例子来说明我的挣扎所在。

示例 1

我的 ExpressJS“应用程序”是在我的主程序模块中设置的，就像您在每个教程中看到的那样。但是我还需要访问其他模块中的应用程序实例。我怎么做？我从各种教程中学到的一种方法是让整个模块导出一个函数，该函数将应用程序作为参数，然后在函数中执行我需要的操作。但在我看来，这给事情增加了很多复杂性。我现在不仅将整个模块封装在一个函数中，而且似乎失去了从该模块中实际导出多个函数、对象或其他变量的能力。

模块即函数

module.exports = function(app) {
   blah;
};

没有功能的模块

exports.func1 = function() {
}
exports.func2 = function() {
}

在我看来，后者给了我更大的灵活性，但我似乎经常被迫使用前者，因为我需要从其他地方传递应用程序之类的东西。

示例 2

我正在为我的 REST API 使用 connect-rest。我的 API 的所有代码都位于一个名为“api”的单独模块中。直到最近这一切都还好。现在我需要从路由模块内部访问 api 模块中的函数。目前，我的主要路由是在 api 之前定义的，因此我无法将 api 导出准确地传递到路由函数中。我可能可以逆转它们，但这只是掩盖了一个更大的问题。

简而言之，问题是相互依赖性日益增强

随着我的代码库的增长，我发现各种模块需要彼此协作的频率越来越高 - 让它们完全独立是不可行的。有时这是可能的，但它是不干净的。

我觉得我缺少一些用于管理所有这些的基本 Node.JS(或者可能只是 Javascript)范例。

如果有人能帮助我理解，我将不胜感激。我是一名经验丰富的其他语言(例如 C++ 和 Python)开发人员，如果这有助于用其他术语表达事物的话。

尝试总结问题

我觉得我没有充分传达我的发帖意图，所以让我尝试用一​​个工作问题来总结我的问题。

server.js

var http = require('http'),
    express = require('express'),
    app = express();

// Bunch of stuff done with app to get it set up

var routes = require('routes.js')(app);

app.js

module.exports = function(app, express) {
    var router = express.router();

    // code for routes

    app.use('/', router);
}

在上面的示例中，路由被分成自己的模块，但该模块需要 server.js 中的 app 和 express 对象才能运行。因此，根据我目前的理解，将这些内容传递到routes.js 中的唯一方法是让routes.js 导出一个大函数，然后用您需要的两个对象调用该函数。

但是，如果我希望routes.js导出多个可能在其他地方使用的函数怎么办？据我了解，我现在不能。如果我想做怎么办:

authentication.js

var routes = require('routes');

// setup auth

routes.doSomethingFunction(auth);

我不能这样做，因为路由仅导出一个大型功能。

Answer 1

每个 Node 模块只是一个对象。该对象中可供外界使用的部分是 module.exports 对象，其中包含可以是函数或数据的属性。

require("xxx") 命令获取该模块的 exports 对象(从中央缓存或从 .js 文件加载它(如果没有))尚未加载)。

所以，代码共享很简单。只需让每个模块对其想要共享代码的任何其他模块执行 require() ，并让这些模块确保可以通过其自己的 exports 对象访问共享函数。这使得每个模块基本上都是独立的。它加载它需要的任何其他代码，并使重用代码变得更加容易。模块被缓存，因此从许多其他模块对同一模块执行大量 require() 操作只不过是缓存查找，无需担心。

数据共享(例如您的app对象)可以通过多种不同的方式完成。最常见的方法是当您加载模块时，仅调用模块的某种初始化函数并向其传递可能需要的任何数据。这就是推送模型。或者，您也可以执行拉模型，其中一个模块向另一个模块请求某些数据。

通过正确的代码组织，所有这一切都会变得容易得多。如果您开始感觉自己像意大利面条或相互依赖，那么也许您没有正确的代码组织，或者您只是有点羞于使用 require() 来引入所有内容给定的模块需要。请记住，每个模块都会加载它自己需要的任何内容，因此您只需担心您需要的内容。加载这些模块，它们就会加载它们需要的内容。

您可能还想更多地考虑对象，因此您将大多数属性放在某种对象上，而不是许多松散的、单独共享的变量上。然后，您可以共享一个对象，它会自动使该变量的所有属性可供您与之共享的任何人使用。

---

关于与另一个模块共享 app 对象的问题，您可以这样做:

// in your app module
var express = require('express');
var app = express();

var otherModule = require('otherModule');
otherModule.setApp(app);
// now otherModule has the singleton `app` object that it can use
// in this case, otherModule must be initialized this way before it can do its job

在此示例中，我仅使用单个方法 .setApp() 来设置应用程序对象。这意味着所有其他方法都可用于对该模块的其他访问。

---

这也可以通过类似构造函数的方法来完成:

// in your app module
var express = require('express');
var app = express();

var otherModule = require('otherModule')(app);

这也是有效的，因为如果需要的话，构造函数可以返回一个带有其他方法的对象。如果您希望能够从其他模块内访问 otherModule，但显然您只想初始化一次，而不是在其他地方，那么您可以这样做:

var otherModule = require('otherModule')();

来自其他模块并让构造函数检查是否没有任何内容传递给它，那么它不会从此构造函数调用中获取 app 对象，因此它应该只使用其他方法返回一个对象。或者，您可以使用上面的第一个代码块，该代码块返回初始 require() 中的所有方法。您完全可以自由决定从 require() 返回什么内容。它可以只是一个类似构造函数的函数，然后在调用它时返回另一个对象。它可以只是一个具有方法的对象，或者(因为函数是也可以具有属性的对象)，您甚至可以返回一个类似构造函数的函数，该函数也具有方法(尽管这是一种不太标准的方法)事物)。

并且，您的构造函数可以根据传递给它的内容决定要做什么，因为它根据您传递给它的内容而具有多种不同的行为。