Node.js module.exports的用途是什么?您如何使用它?
我似乎找不到关于这个的任何信息,但它似乎是Node.js的一个相当重要的部分,因为我经常在源代码中看到它。
根据Node.js文档:
单元参考电流单元特别是module.exports与导出对象相同。看见src/node.js获取更多信息。
但这并没有真正的帮助。
module.exports到底做什么?一个简单的例子是什么?
Node.js module.exports的用途是什么?您如何使用它?
我似乎找不到关于这个的任何信息,但它似乎是Node.js的一个相当重要的部分,因为我经常在源代码中看到它。
根据Node.js文档:
单元参考电流单元特别是module.exports与导出对象相同。看见src/node.js获取更多信息。
但这并没有真正的帮助。
module.exports到底做什么?一个简单的例子是什么?
当前回答
目的是:
模块化编程是一种强调将程序的功能分离成独立的,可互换的模块,每个模块都包含所有必要的内容以仅执行期望功能的一个方面。
维基百科
我想,如果没有模块化/可重用代码,编写大型程序会变得困难。在nodejs中,我们可以使用module.exports创建模块化程序,该模块定义了我们公开的内容,并使用require编写程序。
请尝试以下示例:
文件日志.js
function log(string) { require('fs').appendFileSync('log.txt',string); }
module.exports = log;
标准输出日志.js
function log(string) { console.log(string); }
module.exports = log;
程序.js
const log = require('./stdoutLog.js')
log('hello world!');
处决
$node程序.js你好,世界!
现在尝试交换/的stdoutLog.js/fileLog.js。
其他回答
参考链接如下:
exports = module.exports = function(){
//....
}
导出或模块的财产。导出,例如函数或变量,将在外部公开
有一点你必须更加注意:不要覆盖导出。
为什么?
因为导出只是module.exports的引用,所以可以将财产添加到导出中,但如果覆盖导出,引用链接将断开。
很好的例子:
exports.name = 'william';
exports.getName = function(){
console.log(this.name);
}
坏例子:
exports = 'william';
exports = function(){
//...
}
如果您只想公开一个函数或变量,如下所示:
// test.js
var name = 'william';
module.exports = function(){
console.log(name);
}
// index.js
var test = require('./test');
test();
这个模块只公开了一个函数,name的属性对外是私有的。
下载和安装node.js时,node.js中有一些默认或现有的模块,如http、sys等。
由于它们已经在node.js中,所以当我们想要使用这些模块时,我们基本上喜欢导入模块,但为什么呢?因为它们已经存在于node.js中。导入就像从node.js获取它们并将它们放入程序中。然后使用它们。
而Exports正好相反,您正在创建所需的模块,比如模块addition.js,并将该模块放入node.js,您可以通过导出它来实现。
在这里写任何东西之前,请记住,module.exports.additionTwo与exports.additionTwo相同
嗯,这就是原因,我们确实喜欢
exports.additionTwo = function(x)
{return x+2;};
小心道路
假设您创建了addition.js模块,
exports.additionTwo = function(x){
return x + 2;
};
在NODE.JS命令提示符下运行此命令时:
node
var run = require('addition.js');
这将导致错误
错误:找不到模块addition.js
这是因为node.js进程无法执行addition.js,因为我们没有提到路径。因此,我们可以使用NODE_path设置路径
set NODE_PATH = path/to/your/additon.js
现在,这应该可以成功运行,没有任何错误!!
还有一件事,您也可以通过不设置NODE_PATH来运行addition.js文件,返回nodejs命令提示符:
node
var run = require('./addition.js');
因为我们在这里提供的路径是在当前目录中。/这也应该成功运行。
请注意,NodeJS模块机制基于CommonJS模块,这些模块在许多其他实现中都受支持,如RequireJS,但也包括SproutCore、CouchDB、Wakanda、OrientDB、ArangoDB、RingoJS、TeaJS、SilkJS、curl.js,甚至Adobe Photoshop(通过PSLib)。您可以在这里找到已知实现的完整列表。
除非您的模块使用特定于节点的特性或模块,否则我强烈建议您使用导出,而不是不属于CommonJS标准的module.exports,并且其他实现通常不支持。
另一个特定于NodeJS的特性是,当您将一个引用分配给一个要导出的新对象时,而不是像Jed Watson在这个线程中提供的最后一个示例那样向其添加财产和方法。我个人不赞成这种做法,因为这打破了CommonJS模块机制的循环引用支持。它不是所有实现都支持的,Jed示例应该以这种方式(或类似的方式)编写,以提供更通用的模块:
(sayhello.js):
exports.run = function() {
console.log("Hello World!");
}
(app.js):
var sayHello = require('./sayhello');
sayHello.run(); // "Hello World!"
或使用ES6功能
(sayhello.js):
Object.assign(exports, {
// Put all your public API here
sayhello() {
console.log("Hello World!");
}
});
(app.js):
const { sayHello } = require('./sayhello');
sayHello(); // "Hello World!"
PS:看起来Appcelerator也实现了CommonJS模块,但没有循环引用支持(参见:Appcelerater和CommonJS模块(缓存和循环引用))
如果将对新对象的引用分配给exports和/或modules.exports,则必须注意以下几点:
1.以前附加到原始导出或模块的所有财产/方法都会丢失。导出当然会丢失,因为导出的对象现在将引用另一个新的对象
这一点很明显,但如果在现有模块的开头添加导出方法,请确保本机导出对象在末尾没有引用另一个对象
exports.method1 = function () {}; // exposed to the original exported object
exports.method2 = function () {}; // exposed to the original exported object
module.exports.method3 = function () {}; // exposed with method1 & method2
var otherAPI = {
// some properties and/or methods
}
exports = otherAPI; // replace the original API (works also with module.exports)
2.如果exports或module.exports中的一个引用新值,则它们不再引用同一对象
exports = function AConstructor() {}; // override the original exported object
exports.method2 = function () {}; // exposed to the new exported object
// method added to the original exports object which not exposed any more
module.exports.method3 = function () {};
3.狡猾的后果。如果同时更改了对exports和module.exports的引用,很难说哪个API是公开的(看起来module.export获胜)
// override the original exported object
module.exports = function AConstructor() {};
// try to override the original exported object
// but module.exports will be exposed instead
exports = function AnotherConstructor() {};
目的是:
模块化编程是一种强调将程序的功能分离成独立的,可互换的模块,每个模块都包含所有必要的内容以仅执行期望功能的一个方面。
维基百科
我想,如果没有模块化/可重用代码,编写大型程序会变得困难。在nodejs中,我们可以使用module.exports创建模块化程序,该模块定义了我们公开的内容,并使用require编写程序。
请尝试以下示例:
文件日志.js
function log(string) { require('fs').appendFileSync('log.txt',string); }
module.exports = log;
标准输出日志.js
function log(string) { console.log(string); }
module.exports = log;
程序.js
const log = require('./stdoutLog.js')
log('hello world!');
处决
$node程序.js你好,世界!
现在尝试交换/的stdoutLog.js/fileLog.js。