如何在快速路由中引用模块答案

【问题标题】：How to reference modules within express routes如何在快速路由中引用模块
【发布时间】：2016-11-06 11:14:38
【问题描述】：

我想将我的快速路由放在单独的文件中，但我很难确定在路由中引用模块的最佳做法是什么。

这是我在下面看到的各种方法。哪一个是最佳实践？这是否会根据您尝试执行的操作（日志记录、配置、数据源等）而发生变化？

请注意，为了缩短帖子的篇幅，这些地方缺少了很大的空白。

在应用程序和路由中都“需要”。

//app.js
var cfg = require('./config.js');

//router.js
var cfg = require('./config.js');

module.exports = function () {

    var router = new express.Router();

    router.get('/search', function(req, res) {
        console.log('cfg', cfg);
    });

    return router;
};

传入模块

//app.js
var cfg = require('./config.js');
app.use(require('./router')(cfg));

//router.js
module.exports = function (cfg) {

    var router = new express.Router();

    router.get('/search', function(req, res) {
        console.log('cfg', cfg);
    });

    return router;
};

使用 express app.set/get

//app.js
var cfg = require('./config.js');
app.set('cfg', cfg);

//router.js
module.exports = function () {

    var router = new express.Router();

    router.get('/search', function(req, res) {
        console.log('cfg', app.get('cfg'));
    });

    return router;
};

使用 express 中间件并添加到 req

//app.js
var cfg = require('./config.js');

app.use(function (req, res, next) {
  req.cfg = cfg;
  next();
});

//router.js
module.exports = function () {

    var router = new express.Router();

    router.get('/search', function(req, res) {
        console.log('cfg', req.cfg);
    });

    return router;
};

【问题讨论】：

global.cfg = require('./config.js'); 怎么样？

标签： node.js express

【解决方案1】：

我肯定会说“这取决于”您想要传递到路线中的具体内容。

我会将此方法用于实用程序或全局模块（例如 lodash 或类似模块，或提供应用程序配置的模块）。这允许路由只需要模块，如果它实际用于此路由。
我会对在应用程序级别创建的某些对象使用这种方法，并且您需要确保在整个应用程序中使用相同的实例（例如，数据库连接提供程序对象或类似对象）。这会影响您在添加更多对象时必须在路由文件中导出的函数的签名，因此您可能希望使此列表相对较短，并确保所有或至少大多数路由都使用这些对象。
这个我自己其实没用过，不过好像是用来设置express相关配置的。
我会使用这种方法来设置与一个特定请求相关的属性（例如，如果您有一个身份验证中间件，您可以像这样将当前登录的用户设置到请求上，以便后面的中间件可以访问它）。这会添加一个为每个请求执行的中间件，一旦应用程序增长并且您想要传递到路由中的对象越来越多，这可能会增加一些不必要的开销。

【讨论】：

【解决方案2】：

node.js 中的模块设计实际上取决于您对模块的目标。

我通常开始认为模块应该尽可能可重用，而不会使设计扭曲或复杂化超出可能需要的范围。有时只需以可重用的方式组织代码就不需要额外的工作。有时您会发现可重用的通用方案需要更多的工作或复杂性。如果它最终需要做更多的工作并且您重用该模块的可能性很低，那么如果您不尝试使其一般可重用，您的代码实际上可能会更简单更好。所以，无论如何，这里的重点是您必须弄清楚模块的目标是什么，然后您可以根据该目标做出设计决策。

如果模块被设计成可以在其他应用程序中独立使用，那么模块应该尽可能地独立。这意味着它应该在它需要的所有内容中使用require()（您的选项 1），或者它应该清楚地记录需要传递给模块构造函数的内容（您的选项 2）。这将允许该模块在其他项目中使用，而不必成为复杂环境（全局、应用程序配置等）的一部分。

模块可重用性的核心原则是使它们尽可能独立且尽可能易于使用。无论您是在配置模块中需要还是将配置对象传递给构造函数，实际上都取决于您设想一种情况，即您希望调用者能够管理配置对象本身，而不是让模块从其自己的位置加载配置对象。这是一个取决于您的设计目标的设计决策。

如果出于某种原因，该模块不打算在其他应用程序中使用，并且您在计划中并没有真正看到任何好处，那么设计您的模块以假设某个正在运行的环境是非常好的出现在您的应用程序中。这可能包括您的选项 3 (app.set/get) 或 4 (middleware cfg)。就个人而言，我会避免中间件方案，因为我试图避免添加适用于每个请求的工作，而只有某些路由可能需要该信息。这里的工作并不多，但从概念上讲，我不喜欢让req 对象成为每个可能的请求处理程序可能需要的一切的联合。而且我希望代码更具体，其中路由使用app.get() 在需要时获取配置。但是，两者都可以正常工作。

附：我不会使用评论中的global.cfg 建议。这与任何其他也决定将global.cfg 用于其自身目的的模块立即不兼容，这正是我们避免使用全局变量的原因。

app.get/set 类似于全局变量，但是如果您拥有 app 对象，那么您可以控制它的命名空间，并且您不应该随机找到使用相同命名空间的其他模块，因此它比实际的全局变量更好。而且，事实上，除非您首先给它们app 对象（这就是它们实际上不是全局对象的原因），否则没有其他代码可以使用它。

【讨论】：