logo陈三

区别 module.exports 与 exports

by 陈三 on 
主题:  node.js

既生瑜,何生亮

Node.js 模块里,我们经常见着 module.exportsexports。二者区别在哪?

来新建一个 module.js 文件:

console.log(exports === module.exports);

console.log(exports);

然后在命令行下运行 node module.js

$ node module.js
true
{}

=== 判断结果为 true。这说明二者是一样的,指向同一个空对象 {}

那,什么时候只能用 module.exports?什么时候只能用 exports?从模块编写者的角度出发,并没有什么区别,二者都能用;若非要说个区别,大概是 exportsmodule.exports 少打 7 个字符,省点时间:

exports.pi = 3.14;
// vs
module.exports.pi = 3.14;

但是从模块使用者角度说,则二者是有区别的。

不具名数据

假设我作为模块使用者,要在我的代码中导入一个函数:

const func = require('./module');

则编写者只能使用 module.exports 来定义:

module.exports = function () {}

如果编写者使用 exports 来定义:

exports.func = function () {}

则使用者必须知道该函数的名称才能使用:

const { func } = require('./module');

把函数换成变量、常量或其它,也是一样道理。

注意对象

前面说,module.exportsexports 指向同一个空对象 {} - 且叫它 M。也就是说,不管是 exports.pi = 3.14 还是 module.exports.pi = 3.14,都是在操作 M 对象 - 在 Node/JavaScript 下,对象是可变的,可以任意修改。

因此我们可以直接给 exports 赋值:

exports = 3.14;

但这时,exports 就失去存在意义了。因为赋值以后,它不再指向对象 M,也就无法操作 M 对象,也就无法控制模块要导出的数据。所以上述写法是错误的,应该避免。

那么,给 module.exports 赋值对象以外的值呢?

module.exports = 3.14;

这是没问题的,这说明模块默认导出一个数值,而不是 M 对象。

总结一下,在 Node.js 模块里,真正控制模块导出的是 module.exportsexports 只是 module.exports 决定导出一个对象时的一个快捷方式,假如 module.exports 导出其它类型的数据,比如字符串、数值、函数等等,则 exports 的存在没有意义。这是 Node.js 模块与 CommonJS 差异的一点,在 CommonJS 规范里,是只有 exports,没有 module.exports 的。