作為前端開發(fā)者，你是否也曾有過疑惑，為什么可以代碼中可以直接使用 require 方法加載模塊，為什么加載第三方包的時(shí)候 Node 會知道選擇哪個(gè)文件作為入口，以及常被問到的，為什么 ES6 Module export 基礎(chǔ)數(shù)據(jù)類型的時(shí)候會有【引用類型】的效果？
帶著這些疑問和好奇，希望閱讀這篇文章能解答你的疑惑。
在 ES6 之前，ECMAScript 并沒有提供代碼組織的方式，那時(shí)候通常是基于 IIFE 來實(shí)現(xiàn)“模塊化”，隨著 JavaScript 在前端大規(guī)模的應(yīng)用，以及服務(wù)端 Javascript 的推動(dòng)，原先瀏覽器端的模塊規(guī)范不利于大規(guī)模應(yīng)用。于是早期便有了 CommonJS 規(guī)范，其目標(biāo)是為了定義模塊，提供通用的模塊組織方式。
在 Commonjs 中，一個(gè)文件就是一個(gè)模塊。定義一個(gè)模塊導(dǎo)出通過 exports 或者 module.exports 掛載即可。
exports.count = 1;
導(dǎo)入一個(gè)模塊也很簡單，通過 require 對應(yīng)模塊拿到 exports 對象。
const counter = require('./counter');
console.log(counter.count);
CommonJS 的模塊主要由原生模塊 module 來實(shí)現(xiàn)，這個(gè)類上的一些屬性對我們理解模塊機(jī)制有很大幫助。
Module {
id: '.', // 如果是 mainModule id 固定為 '.'，如果不是則為模塊絕對路徑
exports: {}, // 模塊最終 exports
filename: '/absolute/path/to/entry.js', // 當(dāng)前模塊的絕對路徑
loaded: false, // 模塊是否已加載完畢
children: [], // 被該模塊引用的模塊
parent: '', // 第一個(gè)引用該模塊的模塊
paths: [ // 模塊的搜索路徑
'/absolute/path/to/node_modules', '/absolute/path/node_modules', '/absolute/node_modules', '/node_modules'
]
}
在編寫 CommonJS 模塊的時(shí)候，我們會使用 require 來加載模塊，使用 exports 來做模塊輸出，還有 module，filename, dirname 這些變量，為什么它們不需要引入就能使用？
原因是 Node 在解析 JS 模塊時(shí)，會先按文本讀取內(nèi)容，然后將模塊內(nèi)容進(jìn)行包裹，在外層裹了一個(gè) function，傳入變量。再通過 vm.runInThisContext 將字符串轉(zhuǎn)成 Function形成作用域，避免全局污染。
let wrap = function(script) { return Module.wrapper[0] + script + Module.wrapper[1];
};
const wrapper = [ '(function (exports, require, module, __filename, __dirname) { ', '\n});'
];
于是在 CommmonJS 的模塊中可以不需要 require，直接訪問到這些方法，變量。
參數(shù)中的 module 是當(dāng)前模塊的的 module 實(shí)例（盡管這個(gè)時(shí)候模塊代碼還沒編譯執(zhí)行），exports 是 module.exports 的別名，最終被 require 的時(shí)候是輸出 module.exports 的值。require 最終調(diào)用的也是 Module._load 方法。filename，dirname 則分別是當(dāng)前模塊在系統(tǒng)中的絕對路徑和當(dāng)前文件夾路徑。
開發(fā)者在使用 require 時(shí)非常簡單，但實(shí)際上為了兼顧各種寫法，不同類型的模塊，node_modules packages 等模塊的查找過程稍微有點(diǎn)麻煩。
首先，在創(chuàng)建模塊對象時(shí)，會有 paths 屬性，其值是由當(dāng)前文件路徑計(jì)算得到的，從當(dāng)前目錄一直到系統(tǒng)根目錄的 node_modules?？梢栽谀K中打印 module.paths 看看。
[ '/Users/evan/Desktop/demo/node_modules', '/Users/evan/Desktop/node_modules', '/Users/evan/node_modules', '/Users/node_modules', '/node_modules' ]
除此之外，還會查找全局路徑（如果存在的話）
[ execPath/../../lib/node_modules, // 當(dāng)前 node 執(zhí)行文件相對路徑下的 lib/node_modules NODE_PATH, // 全局變量 NODE_PATH HOME/.node_modules, // HOME 目錄下的 .node_module HOME/.node_libraries' // HOME 目錄下的 .node-libraries ]
按照官方文檔給出的查找過程已經(jīng)足夠詳細(xì)，這里只給出大概流程。
從 Y 路徑運(yùn)行 require(X)
1. 如果 X 是內(nèi)置模塊（比如 require('http'）)   a. 返回該模塊。   b. 不再繼續(xù)執(zhí)行。
2. 如果 X 是以 '/' 開頭、
a. 設(shè)置 Y 為 '/'
3. 如果 X 是以 './' 或 '/' 或 '../' 開頭
a. 依次嘗試加載文件，如果找到則不再執(zhí)行 - (Y + X) - (Y + X).js - (Y + X).json - (Y + X).node
b. 依次嘗試加載目錄，如果找到則不再執(zhí)行 - (Y + X + package.json 中的 main 字段).js - (Y + X + package.json 中的 main 字段).json - (Y + X + package.json 中的 main 字段).node   c. 拋出 "not found"
4. 遍歷 module paths 查找，如果找到則不再執(zhí)行 5. 拋出 "not found"
模塊查找過程會將軟鏈替換為系統(tǒng)中的真實(shí)路徑，例如 lib/foo/node_moduels/bar 軟鏈到 lib/bar，bar 包中又 require('quux')，最終運(yùn)行 foo module 時(shí)，require('quux') 的查找路徑是 lib/bar/node_moduels/quux 而不是 lib/foo/node_moduels/quux。
當(dāng)運(yùn)行 node index.js 時(shí)，Node 調(diào)用 Module 類上的靜態(tài)方法 _load(process.argv[1])加載這個(gè)模塊，并標(biāo)記為主模塊，賦值給 process.mainModule 和 require.main，可以通過這兩個(gè)字段判斷當(dāng)前模塊是主模塊還是被 require 進(jìn)來的。
CommonJS 規(guī)范是在代碼運(yùn)行時(shí)同步阻塞性地加載模塊，在執(zhí)行代碼過程中遇到 require(X)時(shí)會停下來等待，直到新的模塊加載完成之后再繼續(xù)執(zhí)行接下去的代碼。
雖說是同步阻塞性，但這一步實(shí)際上非?？?，和瀏覽器上阻塞性下載、解析、執(zhí)行 js 文件不是一個(gè)級別，硬盤上讀文件比網(wǎng)絡(luò)請求快得多。
文件模塊查找挺耗時(shí)的，如果每次 require 都需要重新遍歷文件夾查找，性能會比較差；還有在實(shí)際開發(fā)中，模塊可能包含副作用代碼，例如在模塊頂層執(zhí)行 addEventListener ，如果 require 過程中被重復(fù)執(zhí)行多次可能會出現(xiàn)問題。
CommonJS 中的緩存可以解決重復(fù)查找和重復(fù)執(zhí)行的問題。模塊加載過程中會以模塊絕對路徑為 key, module 對象為 value 寫入 cache。在讀取模塊的時(shí)候會優(yōu)先判斷是否已在緩存中，如果在，直接返回 module.exports；如果不在，則會進(jìn)入模塊查找的流程，找到模塊之后再寫入 cache。
// a.js
module.exports = {
foo: 1,
};
// main.js
const a1 = require('./a.js');
a1.foo = 2;
const a2 = require('./a.js');
console.log(a2.foo); // 2
console.log(a1 === a2); // true
以上例子中，require a.js 并修改其中的 foo 屬性，接著再次 require a.js 可以看到兩次 require 結(jié)果是一樣的。
模塊緩存可以打印 require.cache 進(jìn)行查看。
{
'/Users/evan/Desktop/demo/main.js':
Module {
id: '.',
exports: {},
parent: null,
filename: '/Users/evan/Desktop/demo/main.js',
loaded: false,
children: [ [Object] ],
paths:
[ '/Users/evan/Desktop/demo/node_modules', '/Users/evan/Desktop/node_modules', '/Users/evan/node_modules', '/Users/node_modules', '/node_modules'
]
}, '/Users/evan/Desktop/demo/a.js':
Module {
id: '/Users/evan/Desktop/demo/a.js',
exports: { foo: 1 },
parent:
Module {
id: '.',
exports: {},
parent: null,
filename: '/Users/evan/Desktop/demo/main.js',
loaded: false,
children: [Array],
paths: [Array] },
filename: '/Users/evan/Desktop/demo/a.js',
loaded: true,
children: [],
paths:
[ '/Users/evan/Desktop/demo/node_modules', '/Users/evan/Desktop/node_modules', '/Users/evan/node_modules', '/Users/node_modules', '/node_modules' ] } }
緩存還解決了循環(huán)引用的問題。舉個(gè)例子，現(xiàn)在有模塊 a require 模塊 b；而模塊 b 又 require 了模塊 a。
// main.js
const a = require('./a');
console.log('in main, a.a1 = %j, a.a2 = %j', a.a1, a.a2);
// a.js
exports.a1 = true;
const b = require('./b.js');
console.log('in a, b.done = %j', b.done);
exports.a2 = true;
// b.js
const a = require('./a.js');
console.log('in b, a.a1 = %j, a.a2 = %j', a.a1, a.a2);
程序執(zhí)行結(jié)果如下：
in b, a.a1 = true, a.a2 = undefined in main, a.a1 = true, a.a2 = true
實(shí)際上在模塊 a 代碼執(zhí)行之前就已經(jīng)創(chuàng)建了 Module 實(shí)例寫入了緩存，此時(shí)代碼還沒執(zhí)行，exports 是個(gè)空對象。
'/Users/evan/Desktop/module/a.js':
Module {
exports: {}, //... }
}
代碼 exports.a1 = true; 修改了 module.exports 上的 a1 為 true, 這時(shí)候 a2 代碼還沒執(zhí)行。
'/Users/evan/Desktop/module/a.js':
Module {
exports: {
a1: true
} //... }
}
進(jìn)入b模塊，require a.js 時(shí)發(fā)現(xiàn)緩存上已經(jīng)存在了，獲取 a 模塊上的 exports 。打印 a1, a2 分別是true，和 undefined。
運(yùn)行完 b 模塊，繼續(xù)執(zhí)行 a 模塊剩余的代碼，exports.a2 = true; 又往 exports 對象上增加了a2屬性，此時(shí) module a 的 export對象 a1, a2 均為 true。
exports: {
a1: true,
a2: true
}
再回到 main 模塊，由于 require('./a.js') 得到的是 module a export 對象的引用，這時(shí)候打印 a1, a2 就都為 true。
小結(jié)：
CommonJS 模塊加載過程是同步阻塞性地加載，在模塊代碼被運(yùn)行前就已經(jīng)寫入了 cache，同一個(gè)模塊被多次 require 時(shí)只會執(zhí)行一次，重復(fù)的 require 得到的是相同的 exports 引用。
值得留意：cache key 使用的是模塊在系統(tǒng)中的絕對位置，由于模塊調(diào)用位置的不同，相同的 require('foo')代碼并不能保證返回的是統(tǒng)一個(gè)對象引用。我之前恰巧就遇到過，兩次 require('egg-core')但是他們并不相等。
ES6 模塊是前端開發(fā)同學(xué)更為熟悉的方式，使用 import, export 關(guān)鍵字來進(jìn)行模塊輸入輸出。ES6 不再是使用閉包和函數(shù)封裝的方式進(jìn)行模塊化，而是從語法層面提供了模塊化的功能。
ES6 模塊中不存在 require, module.exports, __filename 等變量，CommonJS 中也不能使用 import。兩種規(guī)范是不兼容的，一般來說平日里寫的 ES6 模塊代碼最終都會經(jīng)由 Babel, Typescript 等工具處理成 CommonJS 代碼。
使用 Node 原生 ES6 模塊需要將 js 文件后綴改成 mjs，或者 package.json "type"` 字段改為 "module"，通過這種形式告知Node使用ES Module 的形式加載模塊。
ES6 模塊的加載過程分為三步：
ES6 模塊會在程序開始前先根據(jù)模塊關(guān)系查找到所有模塊，生成一個(gè)無環(huán)關(guān)系圖，并將所有模塊實(shí)例都創(chuàng)建好，這種方式天然地避免了循環(huán)引用的問題，當(dāng)然也有模塊加載緩存，重復(fù) import 同一個(gè)模塊，只會執(zhí)行一次代碼。
這一步完成的工作是 living binding import export，借助下面的例子來幫助理解。
// counter.js
let count = 1;
function increment () {
count++;
}
module.exports = {
count,
increment
}
// main.js
const counter = require('counter.cjs');
counter.increment();
console.log(counter.count); // 1
上面 CommonJS 的例子執(zhí)行結(jié)果很好理解，修改 count++` 修改的是模塊內(nèi)的基礎(chǔ)數(shù)據(jù)類型變量，不會改變exports.count，所以打印結(jié)果認(rèn)為 1。
// counter.mjs
export let count = 1;
export function increment () {
count++;
}
// main.mjs
import { increment, count } from './counter.mjs'
increment();
console.log(count); // 2
從結(jié)果上看使用 ES6 模塊的寫法，當(dāng) export 的變量被修改時(shí)，會影響 import 的結(jié)果。這個(gè)功能的實(shí)現(xiàn)就是 living binding，具體規(guī)范底層如何實(shí)現(xiàn)可以暫時(shí)不管，但是知道 living binding 比網(wǎng)上文章描述為 "ES6 模塊輸出的是值的引用" 更好理解。
更接近 ES6 模塊的 CommonJS 代碼可以是下面這樣：
exports.counter = 1;
exports.increment = function () {
exports.counter++;
}
到第三步，會基于第一步生成的無環(huán)圖進(jìn)行深度優(yōu)先后遍歷填值，如果這個(gè)過程中訪問了尚未初始化完成的空間，會拋出異常。
// a.mjs
export const a1 = true;
import * as b from './b.mjs';
export const a2 = true;
// b.mjs
import { a1, a2 } from './a.mjs'
console.log(a1, a2);
上面的例子會在運(yùn)行時(shí)拋出異常 ReferenceError: Cannot access 'a1' before initialization。如果改成 import * as a from 'a.mjs'可以看到 a 模塊中 export 的對象已經(jīng)占好坑了。
// b.mjs import * as a from './a.mjs' console.log(a);
將輸出 { a1:, a2:} 可以看出，ES6 模塊為 export 的變量預(yù)留了空間，不過尚未賦值。這里和 CommonJS 不一樣，CommonJS 到這里是知道 a1 為 true, a2 為 undefined
除此之外，我們還能推導(dǎo)出一些 ES6 模塊和 CommonJS 的差異點(diǎn)：
CommonJS 可以在運(yùn)行時(shí)使用變量進(jìn)行 require, 例如 require(path.join('xxxx', 'xxx.js'))，而靜態(tài) import 語法（還有動(dòng)態(tài) import，返回 Promise）不行，因?yàn)?ES6 模塊會先解析所有模塊再執(zhí)行代碼。
require 會將完整的 exports 對象引入，import 可以只 import 部分必要的內(nèi)容，這也是為什么使用 Tree Shaking 時(shí)必須使用 ES6 模塊 的寫法。import 另一個(gè)模塊沒有 export 的變量，在代碼執(zhí)行前就會報(bào)錯(cuò)，而 CommonJS 是在模塊運(yùn)行時(shí)才報(bào)錯(cuò)。
前面提到 ES6 模塊和 CommonJS 模塊有很大差異，不能直接混著寫。這和開發(fā)中表現(xiàn)是不一樣的，原因是開發(fā)中寫的 ES6 模塊最終都會被打包工具處理成 CommonJS 模塊，以便兼容更多環(huán)境，同時(shí)也能和當(dāng)前社區(qū)普通的 CommonJS 模塊融合。
在轉(zhuǎn)換的過程中會產(chǎn)生一些困惑，比如說：
使用轉(zhuǎn)換工具處理 ES6 模塊的時(shí)候，常看到打包之后出現(xiàn) __esModule 屬性，字面意思就是將其標(biāo)記為 ES6 Module。這個(gè)變量存在的作用是為了方便在引用模塊的時(shí)候加以處理。
例如 ES6 模塊中的 export default 在轉(zhuǎn)化成 CommonJS 時(shí)會被掛載到 exports['default'] 上，當(dāng)運(yùn)行 require('./a.js') 時(shí) 是不能直接讀取到 default 上的值的，為了和 ES6 中 import a from './a.js'的行為一致，會基于 __esModule 判斷處理。
// a.js export default 1; // main.js import a from './a'; console.log(a);
轉(zhuǎn)化后
// a.js
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = 1;
// main.js
'use strict';
var _a = require('./a');
var _a2 = _interopRequireDefault(_a);
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
console.log(_a2.default);
a 模塊 export defualt 會被轉(zhuǎn)換成 exports.default = 1;，這也是平時(shí)前端項(xiàng)目開發(fā)中使用 require 為什么還常常需要 .default 才能取到目標(biāo)值的原因。
接著當(dāng)運(yùn)行 import a from './a.js' 時(shí)，es module 預(yù)期的是返回 export 的內(nèi)容。工具會將代碼轉(zhuǎn)換為 _interopRequireDefault 包裹，在里面判斷是否為 esModule，是的話直接返回，如果是 commonjs 模塊的話則包裹一層 {default: obj}，最后獲取 a 的值時(shí)，也會被裝換成 _a1.default。
大家有什么要說的，歡迎在評論區(qū)留言
聯(lián)系客服
