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 指向的是同一個對象,所以給他們?nèi)魏我粋€添加屬性或方法,另外一個都會接收到變化,因為他們指向的是同一個對象。例如:
exports.afunc = function(){};
module.exports.name = "Wang";
console.log(exports);
console.log(module.exports);
后面兩條語句的輸出都是: <code> { afunc: [Function], name: ‘Wang’ } </code>
舉個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只不過是它的一個輔助工具?!∽罱K返回給調(diào)用的是Module.exports而不是exports。
所有的exports收集到的屬性和方法,都賦值給了Module.exports。當然,這有個前提,就是Module.exports本身不具備任何屬性和方法。如果,Module.exports已經(jīng)具備一些屬性和方法,那么exports收集來的信息將被忽略。
修改rocker.js如下:
module.exports = 'ROCK IT!';
exports.name = function() {
console.log('My name is Lemmy Kilmister');
};
再次引用執(zhí)行rocker.js
var rocker = require('./rocker.js');
rocker.name(); // TypeError: Object ROCK IT! has no method 'name'
發(fā)現(xiàn)報錯:對象“ROCK IT!”沒有name方法
rocker模塊忽略了exports收集的name方法,返回了一個字符串“ROCK IT!”。由此可知,你的模塊并不一定非得返回“實例化對象”。你的模塊可以是任何合法的javascript對象--boolean, number, date, JSON, string, function, array等等。
你的模塊可以是任何你設(shè)置給它的東西。如果你沒有顯式的給Module.exports設(shè)置任何屬性和方法,那么你的模塊就是exports設(shè)置給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');
};
};
可以這樣應(yīng)用它:
var Rocker = require('./rocker.js');
var r = new Rocker('Ozzy', 62);
r.about(); // Ozzy is 62 years old
下面例子中,你的模塊是一個數(shù)組:
module.exports = ['Lemmy Kilmister', 'Ozzy Osbourne', 'Ronnie James Dio', 'Steven Tyler', 'Mick Jagger'];
可以這樣應(yīng)用它:
var rocker = require('./rocker.js');
console.log('Rockin in heaven: ' + rocker[2]); //Rockin in heaven: Ronnie James Dio
現(xiàn)在你明白了,如果你想你的模塊是一個特定的類型就用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');
};
請注意,這兩種結(jié)果并不想同。前面已經(jīng)提到module.exports是真正的接口,exports只不過是它的輔助工具。推薦使用exports導(dǎo)出,除非你打算從原來的“實例化對象”改變成一個類型。
總結(jié)
真正輸出總是 module.exports。如果兩者同時出現(xiàn)或被修改,只有 module.exports 返回,exports 被忽略。
exports = module.exports = {};
- exports 是 module.exports 的一個引用
- module.exports 初始值為一個空對象 {},所以 exports 初始值也是 {}
- require 引用模塊后,返回的是 module.exports 而不是 exports!!!!!
- exports.xxx 相當于在導(dǎo)出對象上掛屬性,該屬性對調(diào)用模塊直接可見
- exports = 相當于給 exports 對象重新賦值,調(diào)用模塊不能訪問 exports 對象及其屬性
如果此模塊是一個類,就應(yīng)該直接賦值 module.exports,這樣調(diào)用者就是一個類構(gòu)造器,可以直接 new 實例。