nodeJS/commonJS module.exports 应该返回什么

Question

我知道我可以将module.exports 设置为对象或函数 （在某些情况下，函数会返回一个对象）。

我也知道使用 exports 与 module.exports 的区别和方法，因此无需对此发表评论。

我还了解到，返回的任何内容都会被缓存，并将在任何连续调用require 时返回。因此，如果我选择返回一个函数而不是一个对象，那么这可能意味着在每个 require 上都必须实际运行这个函数。

我想知道是否应该使用这两者中的哪一个有任何事实上的标准。或者，如果没有这样的标准——在决定我的模块是否应该返回一个对象、一个函数或更复杂的东西时，需要考虑哪些因素......

如果重要的话，我打算编写的模块有望用作 express 应用程序的一部分（也许 express/connect 模块有一个“本地事实标准”）。

Answer 1

如果require'd 代码是独立的，并且不需要从父代码访问任何对象，我将export 一个对象。

edit - 以上是我的首选方式。只有当我需要将东西传递到模块中时，我才执行以下操作，例如配置数据或我的数据库对象。我还没有找到一种更优雅的方式来让模块访问父级范围内的变量。

所以要将对象从父级传递到模块中，我使用了一个函数：

//parent.js
var config = { DBname:'bar' };
var child = require('./child.js')(config);

//child.js
module.exports = function(cfg){
  var innerchild = {};
  innerchild.blah = function(){
    console.log(cfg.DBname); // this is out of scope unless you pass it in
  }
  return innerchild;
};

Answer 2

"这样如果我选择返回一个函数而不是一个对象，那么 可能这意味着在每一个需要它是必要的 实际运行这个函数。”

返回一个单独的函数还是一个对象都没有关系。在这两种情况下都不会运行一个（或多个）函数。除非你明确地这样做。

例如，考虑一个模块hello.js：

exports = function () { return 'Hello'; };

您可以使用 require 来获取该功能：

var hello = require('hello');

如果要运行该函数，则需要显式调用它，如下所示：

var hello = require('hello')();

你写道你想确保你的函数只执行一次。直观地说，这可能会导致您将hello.js 编写如下：

var hello = function () { return 'Hello'; };
exports = hello();

在这种情况下，您可以通过 require 存储来自 hello 的结果：

var hello = require('hello');

但是：如果你这样做the export system may cache your module。在这种情况下，您不会从 hello 获得新结果，而是从缓存值中获得。这可能是也可能不是您想要的。如果你想确保一个函数在每次需要时都被调用，你需要导出一个函数并在 require 之后调用它。