[譯] node.js 中的 module.exports 與 exports

sunsmell 發(fā)布于2019-08-22 10:37 / 3554人閱讀

摘要：接下來(lái)我們將對(duì)和在中的使用有一個(gè)更好地了解。這篇文章包括了中的使用。這看起來(lái)似乎有些困惑，請(qǐng)記住和引用的是同一對(duì)象。重點(diǎn)返回一個(gè)，該對(duì)象引用了的值。我們將中公開(kāi)的方法賦值給變量。總結(jié)和模塊在中是一個(gè)隨處可見(jiàn)的任務(wù)。

理解 node.js 中的 module.exports 與 exports

原文鏈接

作為一個(gè)開(kāi)發(fā)者，我們經(jīng)常會(huì)遇到需要使用不熟悉的代碼的情況。
在這個(gè)過(guò)程中遇到一個(gè)問(wèn)題：我需要花費(fèi)多少時(shí)間去理解這些代碼，明白如何使用?
一個(gè)典型的回答就是：先讓我可以開(kāi)始coding，等到時(shí)間允許再去做深入研究。
接下來(lái)我們將對(duì) module.exports 和 exports 在 node.js中的使用有一個(gè)更好地了解。

Note: 這篇文章包括了 node 中 module 的使用。如果你想了解瀏覽器內(nèi)部 modules 的使用，可以參考這面這篇文章：
Understanding JavaScript Modules: Bundling & Transpiling

What is a Module？

一個(gè)模塊就是將文件中相關(guān)的代碼封裝為一個(gè)代碼塊。
創(chuàng)建一個(gè)module,可以理解為將所有相關(guān)的方法挪到一個(gè)文件中。
我們使用一個(gè)node.js的應(yīng)用程序來(lái)說(shuō)明一下這個(gè)觀點(diǎn)。
創(chuàng)建一個(gè)名叫 greetings.js 的文件，其中包含下面兩個(gè)方法：

// greetings.js
sayHelloInEnglish = function() {
  return "Hello";
};

sayHelloInSpanish = function() {
  return "Hola";
};

Exporting a Module

為了 greetings.js 公共邏輯增加的時(shí)候，其封裝的代碼可以在其他文件中使用。所以我們
重構(gòu)一下 greetings.js 來(lái)達(dá)到這個(gè)目的。為了更好地理解這個(gè)過(guò)程，我們分為3步：

1）想象一下有這么一行代碼在 greetings.js 的第一行：

// greetings.js
var exports = module.exports = {};

2）把greetings.js中的方法賦值給exports對(duì)象在其他文件中使用：

// greetings.js
// var exports = module.exports = {};
        
exports.sayHelloInEnglish = function() {
  return "HELLO";
};
   
exports.sayHelloInSpanish = function() {
  return "Hola";
};

在上面的代碼中，我們可以使用 module.exports 替換 exports達(dá)到相同的結(jié)果。
這看起來(lái)似乎有些困惑，請(qǐng)記住：exports 和 module.exports引用的是同一對(duì)象。

3）此時(shí) module.exports 是這樣的：

module.exports = {
  sayHelloInEnglish: function() {
    return "HELLO";
  },
       
  sayHelloInSpanish: function() {
    return "Hola";
  }
};

Importing a Module

我們?cè)?main.js 中 require greetings.js 的公開(kāi)接口。這個(gè)過(guò)程有以下三個(gè)步驟：

1）關(guān)鍵詞 require 在 node.js 中用于導(dǎo)入模塊，即所獲取模塊的 exports 對(duì)象。
我們可以想到它是這么定義的：

var require = function(path) {

  // ...

  return module.exports;
};

2) 在 main.js 中 require greetings.js

// main.js
var greetings = require("./greetings.js");

上面的代碼等同于：

// main.js
var greetings = {
  sayHelloInEnglish: function() {
    return "HELLO";
  },
       
  sayHelloInSpanish: function() {
    return "Hola";
  }
};

3) 現(xiàn)在我們可以在 main.js 中使用greetings訪問(wèn) greetings.js 中公開(kāi)的方法就像獲取它的屬性一樣。

// main.js
var greetings = require("./greetings.js");

// "Hello"
greetings.sayHelloInEnglish();
        
// "Hola"  
greetings.sayHelloInSpanish();

Salient Points 重點(diǎn)

require 返回一個(gè) object ，該對(duì)象引用了 module.exports 的值。
如果開(kāi)發(fā)者無(wú)意或有意的將 module.exports 賦值給另外一個(gè)對(duì)象，
或者賦予不同的數(shù)據(jù)結(jié)構(gòu)，這樣會(huì)導(dǎo)致原來(lái)的 module.exports 對(duì)象
所包含的屬性失效。

看一個(gè)復(fù)雜的示例去說(shuō)明這個(gè)觀點(diǎn)。

// greetings.js
// var exports = module.exports = {};

exports.sayHelloInEnglish = function() {
  return "HELLO";
};

exports.sayHelloInSpanish = function() {
  return "Hola";
};

/* 
 * this line of code re-assigns  
 * module.exports
 */
module.exports = "Bonjour";

在 main.js 中require greetings.js

// main.js
var greetings = require("./greetings.js");

此時(shí)，和之前并沒(méi)有任何變化。我們將greetings.js中公開(kāi)的方法
賦值給greetings變量。

當(dāng)我們?cè)噲D調(diào)用sayHelloInEnglish和sayHelloInSpanish結(jié)果顯示為
module.exports 重新賦值給一個(gè)新的不同于默認(rèn)值的數(shù)據(jù)格式。

// main.js
// var greetings = require("./greetings.js");
    
/*
 * TypeError: object Bonjour has no 
 * method "sayHelloInEnglish"
 */
greetings.sayHelloInEnglish();
        
/* 
 * TypeError: object Bonjour has no 
 * method "sayHelloInSpanish"
 */
greetings.sayHelloInSpanish();

為了清楚地知道這個(gè)錯(cuò)誤原因，我們將greetings的結(jié)果打印出來(lái)：

// "Bonjour"
console.log(greetings);

在這個(gè)點(diǎn)上，我們?cè)囍?module.exports 拋出來(lái)的字符串"Bonjour" 去調(diào)用 sayHelloInEnglish 和 sayHelloInSpanish
方法，換句話說(shuō)，我們永遠(yuǎn)也不會(huì)引用到 module.exports 默認(rèn)輸出object里面的方法。

Conclusion 總結(jié)

importing 和 exporting 模塊在 node.js 中是一個(gè)隨處可見(jiàn)的任務(wù)。
我希望 exports 和 module.exports之間的差異更加清晰。
此外，如果將來(lái)你遇到調(diào)用公共方法錯(cuò)誤的時(shí)候，我希望你可以對(duì)這些
錯(cuò)誤的原因有一個(gè)更好地理解。