节点.js模块范式的基础知识

The Fundamentals of the Node.js Module Paradigm?

本文关键字:基础知识 范式 模块 js 节点      更新时间:2023-09-26

我正在努力真正掌握这里的一些基本基础知识,我觉得它不仅阻碍了我,而且导致蹩脚的代码,我不喜欢这样。

我理解将

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

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

例 1

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

模块即函数

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

不带函数的模块

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

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

例 2

我正在为我的 REST API 使用连接休息。 我的 API 的所有代码都位于一个名为"api"的单独模块中。 直到最近,这一直很好。 现在我需要从我的路由模块内部访问 api 模块中的一个函数。 目前,我的主要路由是在我的 api 之前定义的,所以我无法将我的 api 导出完全传递到我的路由函数中。 我可能会逆转它们,但这只是掩盖了一个更大的问题。

简言之,这是一个日益相互依存的问题。

随着我的代码库的增长,我发现各种模块需要相互协作的频率越来越高 - 让它们完全保持快速是不可行的。 有时这是可能的,但它是不干净的。

我觉得我缺少一些基本的Node.JS(或者只是Javascript(范式来管理所有这些。

如果有人能帮助我理解,我将不胜感激。 我是其他语言(如C++和Python(的经验丰富的开发人员,如果它有助于用其他术语来表达事情。

试图总结这个问题

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

服务器.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);

应用.js

module.exports = function(app, express) {
    var router = express.router();
    // code for routes
    app.use('/', router);
}

在上面的示例中,路由被拆分为自己的模块,但该模块需要从服务器appexpress对象.js才能运行。 所以,根据我目前的理解,将它们变成路由的唯一方法是.js创建路由.js导出一个大函数,然后使用所需的两个对象调用该函数。

但是,如果我希望路由.js导出可能在其他地方使用的多个函数,该怎么办? 根据我的理解,我现在不能。 如果我想做什么:

身份验证.js

var routes = require('routes');
// setup auth
routes.doSomethingFunction(auth);

我不能这样做,因为路由只导出一个大型函数。

每个节点模块只是一个对象。 该对象中可供外界使用的部分是包含可以是函数或数据的属性的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()返回什么。 它可以只是一个类似构造函数的函数,然后在调用时返回另一个对象。 它可以只是一个带有方法的对象,或者(因为函数是也可以具有属性的对象(,您甚至可以返回一个类似构造函数的函数,该函数上也有方法(尽管这是一种不太标准的做事方式(。

而且,构造函数可以根据传递给它的内容来决定要做什么,根据您传递给它的内容赋予它多种不同的行为。