8

我正在通过个人项目玩耍并学习誓言。这是一个小型客户端库，在 vows 中完成了测试。因此，我必须构建和测试这样编写的文件：

(function(exports) { 
    var module = export.module = { "version":"0.0.1" }; 
    //more stuff
})(this);

在我的测试中（基于science.js、d3 等）需要这样的模块：

require("../module");

尝试运行测试时，我继续收到“模块未定义错误”，所以我去了一个 repl 并运行：

require("../module")

它返回：

{ module: { version: "0.0.1" } }

我意识到我可以做类似的事情：

var module = require("../module").module;

但感觉我这样做是在制造一个问题，特别是因为我基于这个项目的库是以我描述的格式来做的。

我希望我的项目的行为类似于我所基于的项目，其中：

require("../module");

在此命名空间中创建一个变量：

module.version; //is valid.

我已经在各种库中看到了这一点，并且我正在遵循 T 的格式和思考过程，但我相信我可能会遗漏一些我不知道的 require 行为。

4

1 回答 1

16

以这种方式创建它没有问题。模块定义了它们在module.exports对象中返回的内容。顺便说一句，您实际上并不需要自执行函数 (SEF)，没有像浏览器中那样的全局泄漏:-)

例子

模块1.js：

module.exports = {
    module: { 'version': '0.1.1' }
};

主.js：

var module1 = require( './module1.js' );
// module1 has what is exported in module1.js

一旦您了解了它的工作原理，您可以轻松地立即导出版本号，如果您愿意：

模块1.js：

module.exports = '0.1.1';

主.js：

var module1 = require( './module1.js' );
console.log( module1 === '0.1.1' ); // true

或者如果你想要一些逻辑，你可以module1.js像这样轻松地扩展你的文件：

module.exports = ( function() {
    // some code
    return version;
} () ); // note the self executing part :-)
// since it's self executed, the exported part
// is what's returned in the SEF

或者，正如许多模块所做的那样，如果您想导出一些实用功能（并保持其他“私有”），您可以这样做：

module.exports = {
    func1: function() {
        return someFunc();
    },

    func2: function() {},

    prop: '1.0.0'
};

// This function is local to this file, it's not exported
function someFunc() {
}

所以，在 main.js 中：

var module1 = require( './module1.js' );
module1.func1(); // works
module1.func2(); // works
module1.prop; // "1.0.0"
module1.someFunc(); // Reference error, the function doesn't exist

你的特殊情况

关于您的特殊情况，我不建议您像他们那样做。

如果你看这里：https ://github.com/jasondavies/science.js/blob/master/science.v1.js

您会看到他们没有使用var关键字。所以，他们正在创建一个全局变量。

这就是为什么一旦他们require定义了全局变量的模块就可以访问它的原因。

顺便说一句，exports在他们的情况下，这个论点是没有用的。它甚至具有误导性，因为它实际上是global对象（相当于window在浏览器中），而不是module.exports对象（this在函数中是全局对象，undefined如果启用了严格模式则为）。

结论

不要像他们那样做，这是个坏主意。全局变量是一个坏主意，最好使用节点的理念，并将所需的模块存储在您重用的变量中。

如果你想拥有一个可以在客户端使用并在 node.js 中测试的对象，这里有一种方法：

你的模块.js：

// Use either node's export or the global object in browsers
var global = module ? module.exports : window.yourModule;

( function( exports ) {
    var yourModule = {};
    // do some stuff
    exports = yourModule;
} ( global ) );

您可以将其缩短为避免创建global变量：

( function( exports ) {
    var yourModule = {};
    // do some stuff
    exports = yourModule;
} ( module ? module.exports : window.yourModule ) );

这样，您可以在客户端像这样使用它：

yourModule.someMethod(); // global object, "namespace"

在服务器端：

var yourModule = require( '../yourModule.js' );
yourModule.someMethod(); // local variable :-)

仅供参考，..意思是“父目录”。这是获取模块的相对路径。如果文件在同一目录中，您将使用..

于 2012-07-22T17:04:42.673 回答