node.js - 如何在快速 route 引用模块

Question

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

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

请注意，为了使帖子更短，这些内容缺少很大的空白。

1. 在应用和路由中“需要”。

//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;
};

1. 传入模块

//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;
};

1. 使用 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;
};

1. 使用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;
};

Answer 1

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

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

---

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

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

---

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

---

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

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