Nodejs中exports与module.exports的区别

Node.js 的 exports 和 module.exports 两者很容易给新手造成疑惑。这里希望能讲清楚它们的异同。

原文:http://www.hacksparrow.com/node-js-exports-vs-module-exports.html

相同之处

exports 和 module.exports 并不是全局变量,而只是对各自的 module 可见。

它们指向同一个对象,其缺省初始值为空 {}。

如果 exports 和 module.exports 没有被重新赋值,这个对象就是将要输出的对象。

不同之处

module 是对当前模块的一个引用。真正输出的是 module.exports。

所以对 exports 直接赋值没有作用。而对 module.exports 直接赋值后,module.exports 就指向新的对象了,这个新的对象成为将要被输出的对象。

详细说明

exports 和 module.exports 指向的是同一个对象,所以给他们任何一个添加属性或方法,另外一个都会接收到变化,因为他们指向的是同一个对象。例如:

exports.afunc = function(){};
module.exports.name = "Wang";
console.log(exports);
console.log(module.exports);
后面两条语句的输出都是: { afunc: [Function], name: ‘Wang’ }
举个exports对象 例子

例如:
rocker.js文件

exports.name = function() {
    console.log('My name is Lemmy Kilmister');
};

在另一个文件中你这样引用

var rocker = require('./rocker.js');
rocker.name(); // 'My name is Lemmy Kilmister'
那到底Module.exports是什么呢?它是否合法呢?

其实,Module.exports才是真正的接口,exports只不过是它的一个辅助工具。 最终返回给调用的是Module.exports而不是exports。

所有的exports收集到的属性和方法,都赋值给了Module.exports。当然,这有个前提,就是Module.exports本身不具备任何属性和方法。如果,Module.exports已经具备一些属性和方法,那么exports收集来的信息将被忽略。

修改rocker.js如下:
module.exports = 'ROCK IT!';
exports.name = function() {
    console.log('My name is Lemmy Kilmister');
};
再次引用执行rocker.js
var rocker = require('./rocker.js');
rocker.name(); // TypeError: Object ROCK IT! has no method 'name'
发现报错:对象“ROCK IT!”没有name方法

rocker模块忽略了exports收集的name方法,返回了一个字符串“ROCK IT!”。由此可知,你的模块并不一定非得返回“实例化对象”。你的模块可以是任何合法的javascript对象--boolean, number, date, JSON, string, function, array等等。

你的模块可以是任何你设置给它的东西。如果你没有显式的给Module.exports设置任何属性和方法,那么你的模块就是exports设置给Module.exports的属性。

下面例子中,你的模块是一个类:
module.exports = function(name, age) {
    this.name = name;
    this.age = age;
    this.about = function() {
        console.log(this.name +' is '+ this.age +' years old');
    };
};
可以这样应用它:
var Rocker = require('./rocker.js');
var r = new Rocker('Ozzy', 62);
r.about(); // Ozzy is 62 years old
下面例子中,你的模块是一个数组:
module.exports = ['Lemmy Kilmister', 'Ozzy Osbourne', 'Ronnie James Dio', 'Steven Tyler', 'Mick Jagger'];
可以这样应用它:
var rocker = require('./rocker.js');
console.log('Rockin in heaven: ' + rocker[2]); //Rockin in heaven: Ronnie James Dio

现在你明白了,如果你想你的模块是一个特定的类型就用Module.exports。如果你想的模块是一个典型的“实例化对象”就用exports。

给Module.exports添加属性类似于给exports添加属性。例如:

module.exports.name = function() {
    console.log('My name is Lemmy Kilmister');
};
同样,exports是这样的
exports.name = function() {
    console.log('My name is Lemmy Kilmister');
};

请注意,这两种结果并不想同。前面已经提到module.exports是真正的接口,exports只不过是它的辅助工具。推荐使用exports导出,除非你打算从原来的“实例化对象”改变成一个类型。

总结

真正输出总是 module.exports。如果两者同时出现或被修改,只有 module.exports 返回,exports 被忽略。
exports = module.exports = {};

  • exports 是 module.exports 的一个引用
  • module.exports 初始值为一个空对象 {},所以 exports 初始值也是 {}
  • require 引用模块后,返回的是 module.exports 而不是 exports!!!!!
  • exports.xxx 相当于在导出对象上挂属性,该属性对调用模块直接可见
  • exports = 相当于给 exports 对象重新赋值,调用模块不能访问 exports 对象及其属性
    如果此模块是一个类,就应该直接赋值 module.exports,这样调用者就是一个类构造器,可以直接 new 实例。

你可能感兴趣的:(Nodejs中exports与module.exports的区别)