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。
其他回答
模块系统的目的是什么?
它完成了以下任务:
使我们的文件从膨胀到真正的大尺寸。在开发过程中,通常很难处理包含5000行代码的文件。强制分离关注点。将代码拆分为多个文件可以让我们为每个文件指定适当的文件名。通过这种方式,我们可以很容易地确定每个模块都做什么以及在哪里找到它(假设我们制作了一个逻辑目录结构,这仍然是您的责任)。
拥有模块可以更容易地找到代码的某些部分,从而使代码更易于维护。
它是如何工作的?
NodejS使用CommomJS模块系统,其工作方式如下:
如果文件想要导出某些内容,则必须使用module.export语法声明它如果文件要导入某个内容,则必须使用require('file')语法声明它
例子:
测试1.js
const test2 = require('./test2'); // returns the module.exports object of a file
test2.Func1(); // logs func1
test2.Func2(); // logs func2
测试2.js
module.exports.Func1 = () => {console.log('func1')};
exports.Func2 = () => {console.log('func2')};
其他需要了解的有用信息:
正在缓存模块。当您在两个不同的文件中加载相同的模块时,该模块只需加载一次。第二次对同一模块调用require()时,将从缓存中取出。模块以同步方式加载。这个行为是必需的,如果它是异步的,我们无法立即访问从require()中检索的对象。
请注意,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模块(缓存和循环引用))
let test = function() {
return "Hello world"
};
exports.test = test;
这已经得到了回答,但我想补充一些澄清。。。
您可以使用exports和module.exports将代码导入应用程序,如下所示:
var mycode=require('./path/to/mycode');
您将看到的基本用例(例如在ExpressJS示例代码中)是在.js文件中的exports对象上设置财产,然后使用require()导入该文件
因此,在一个简单的计数示例中,您可以:
(counter.js):
var count = 1;
exports.increment = function() {
count++;
};
exports.getCount = function() {
return count;
};
…然后在您的应用程序(web.js或任何其他.js文件)中:
var counting = require('./counter.js');
console.log(counting.getCount()); // 1
counting.increment();
console.log(counting.getCount()); // 2
简单地说,您可以将所需文件视为返回单个对象的函数,并且可以通过在导出时设置它们,将财产(字符串、数字、数组、函数等)添加到返回的对象中。
有时您会希望require()调用返回的对象是可以调用的函数,而不仅仅是具有财产的对象。在这种情况下,还需要设置module.exports,如下所示:
(sayhello.js):
module.exports = exports = function() {
console.log("Hello World!");
};
(app.js):
var sayHello = require('./sayhello.js');
sayHello(); // "Hello World!"
这里的答案更好地解释了exports和module.exports之间的区别。
module.exports属性或exports对象允许模块选择应该与应用程序共享的内容
我这里有关于module_export的视频