深入理解node.js的module.export 和 export方法的區別


你肯定非常熟悉nodejs模塊中的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導出,除非你打算從原來的“實例化對象”改變成一個類型

 

 

Node.js在模塊編譯的過程中會對模塊進行包裝,最終會返回類似下面的代碼:

(function (exports, require, module, __filename, __dirname) { // module code... }); 

其中,module就是這個模塊本身,require是對Node.js實現查找模塊的模塊Module._load實例的引用,__filename__dirname是Node.js在查找該模塊后找到的模塊名稱和模塊絕對路徑,這就是官方API里頭這兩個全局變量的來歷。

關於module.exports與exorts的區別,了解了下面幾點之后應該就完全明白:

模塊內部大概是這樣:

exports = module.exports = {}; 
  • exports是module.exports的一個引用

  • require引用模塊后,返回給調用者的是module.exports而不是exports

  • exports.xxx,相當於在導出對象上掛屬性,該屬性對調用模塊直接可見

  • exports =相當於給exports對象重新賦值,調用模塊不能訪問exports對象及其屬性

  • 如果此模塊是一個類,就應該直接賦值module.exports,這樣調用者就是一個類構造器,可以直接new實例

客官如果看明白咋回事兒了下面的內容可以忽略:)

假如有模塊a.js代碼如下:

exports.str = 'a'; exports.fn = function() {}; 

對a模塊的調用:

var a = require('./a'); console.log(a.str); console.log(a.fn()); 

這樣用是對的,如果改造a如下:

exports.str = 'a'; exports = function fn() {}; 

在調用a模塊時自然沒用fn屬性了。

再改造下a模塊:

exports.str = 'a'; module.exports = function fn() {}; 

這時a模塊其實就是fn函數的引用,也就是說可以require('./a')()這樣使用,而同時不再有str屬性了。

下面直接導出一個類:

module.exports = function A() {}; 

調用:

var A = require('./a'); var a = new A(); 

總結下,有兩點:

  1. 對於要導出的屬性,可以簡單直接掛到exports對象上

  2. 對於類,為了直接使導出的內容作為類的構造器可以讓調用者使用new操作符創建實例對象,應該把構造函數掛到module.exports對象上,不要和導出屬性值混在一起

 

 

很多新手可能會迷惑於 exports 和 module.exports 的區別,為了更好的理解 exports 和 module.exports 的關系,我們先來鞏固下 js 的基礎。示例:

test.js

var a = {name: 1};
var b = a;

console.log(a);
console.log(b);

b.name = 2;
console.log(a);
console.log(b);

var b = {name: 3};
console.log(a);
console.log(b);

運行 test.js 結果為:

{ name: 1 }
{ name: 1 }
{ name: 2 }
{ name: 2 }
{ name: 2 }
{ name: 3 }

解釋:a 是一個對象,b 是對 a 的引用,即 a 和 b 指向同一塊內存,所以前兩個輸出一樣。當對 b 作修改時,即 a 和 b 指向同一塊內存地址的內容發生了改變,所以 a 也會體現出來,所以第三四個輸出一樣。當 b 被覆蓋時,b 指向了一塊新的內存,a 還是指向原來的內存,所以最后兩個輸出不一樣。

明白了上述例子后,我們只需知道三點就知道 exports 和 module.exports 的區別了:

  1. module.exports 初始值為一個空對象 {}
  2. exports 是指向的 module.exports 的引用
  3. require() 返回的是 module.exports 而不是 exports

Node.js 官方文檔的截圖證實了我們的觀點:

exports = module.exports = {...}

我們經常看到這樣的寫法:

exports = module.exports = {...}

上面的代碼等價於:

module.exports = {...}
exports = module.exports

原理很簡單:module.exports 指向新的對象時,exports 斷開了與 module.exports 的引用,那么通過 exports = module.exports 讓 exports 重新指向 module.exports。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM