module.exports与exports区别

Posted 2021-02-03 ring1992

CommonJS模块规范

Node应用由模块组成，采用CommonJS模块规范。

根据这个规范，每个文件就是一个模块，有自己的作用域。在一个文件里面定义的变量、函数、类，都是私有的，对其他文件不可见。

CommonJS规范规定，每个模块内部，module变量代表当前模块。这个变量是一个对象，它的exports属性（即module.exports）是对外的接口。加载某个模块，其实是加载该模块的module.exports属性。

var x = 5;
var addX = function (value) {
  return value + x;
};
module.exports.x = x;
module.exports.addX = addX;

上面代码通过module.exports输出变量x和函数addX。

require方法用于加载模块。

var example = require(‘./example.js‘);

console.log(example.x); // 5
console.log(example.addX(1)); // 6

exports 与 module.exports

为了方便，Node为每个模块提供一个exports变量，指向module.exports。这等同在每个模块头部，有一行这样的命令。

var exports = module.exports;

于是我们可以直接在 exports 对象上添加方法，表示对外输出的接口，如同在module.exports上添加一样。注意，不能直接将exports变量指向一个值，因为这样等于切断了exports与module.exports的联系。

module.exports

module.exports 对象是由模块系统创建的。 有时这是难以接受的；许多人希望他们的模块成为某个类的实例。 为了实现这个，需要将期望导出的对象赋值给 module.exports。 注意，将期望的对象赋值给 exports 会简单地重新绑定本地 exports 变量，这可能不是期望的。

例子，假设创建了一个名为 a.js 的模块：

const EventEmitter = require(‘events‘);

module.exports = new EventEmitter();

// 处理一些工作，并在一段时间后从模块自身触发 ‘ready‘ 事件。
setTimeout(() => {
  module.exports.emit(‘ready‘);
}, 1000);

然后，在另一个文件中可以这么做：

const a = require(‘./a‘);
a.on(‘ready‘, () => {
  console.log(‘模块 a 已准备好‘);
});

注意，对 module.exports 的赋值必须立即完成。 不能在任何回调中完成。 以下是无效的：

x.js:

setTimeout(() => {
  module.exports = { a: ‘hello‘ };
}, 0);

y.js:

const x = require(‘./x‘);
console.log(x.a);

exports

exports 变量是在模块的文件级别作用域内有效的，它在模块被执行前被赋予 module.exports 的值。

它有一个快捷方式，以便 module.exports.f = ... 可以被更简洁地写成 exports.f = ...。 注意，就像任何变量，如果一个新的值被赋值给 exports，它就不再绑定到 module.exports：

module.exports.hello = true; // 从对模块的引用中导出
exports = { hello: false };  // 不导出，只在模块内有效

当 module.exports 属性被一个新的对象完全替代时，也会重新赋值 exports，例如：

module.exports = exports = function Constructor() {
  // ... 及其他
};

为了解释这个行为，想象对 require() 的假设实现，它跟 require() 的实际实现相当类似：

function require(/* ... */) {
  const module = { exports: {} };
  ((module, exports) => {
    // 模块代码在这。在这个例子中，定义了一个函数。
    function someFunc() {}
    exports = someFunc;
    // 此时，exports 不再是一个 module.exports 的快捷方式，
    // 且这个模块依然导出一个空的默认对象。
    module.exports = someFunc;
    // 此时，该模块导出 someFunc，而不是默认对象。
  })(module, module.exports);
  return module.exports;
}

demo.js:

console.log(exports); // {}
console.log(module.exports); // {}
console.log(exports === module.exports); // true
console.log(exports == module.exports); // true
console.log(module);
/**
Module {
id: ‘.‘,
exports: {},
parent: null,
filename: ‘/Users/ring/Desktop/demo.js‘,
loaded: false,
children: [],
paths:
[ ‘/Users/ring/Desktop/node_modules‘,
‘/Users/ring/node_modules‘,
‘/Users/node_modules‘,
‘/node_modules‘ ] }
*/

注意

每个js文件一创建，都有一个var exports = module.exports = {} , 使exports和module.exports都指向一个空对象。

module.exports和exports所指向的内存地址相同