Node
應(yīng)用由模塊組成,其模塊系統(tǒng)借鑒了CommonJS
模塊規(guī)范,但是并未完全按照規(guī)范實現(xiàn),而是根據(jù)自身需求增加了一些特性,算是CommonJS
模塊規(guī)范的一個變種。
CommonJS概述
CommonJS
是社區(qū)提出的一種JavaScript
模塊化規(guī)范,可以說是JS
模塊化歷程中最重要的一塊里程碑,它構(gòu)造了一個美好的愿景——JS
能夠在任何地方運行,但其實由于它的模塊是同步加載的,只適合在服務(wù)端等其他本地環(huán)境,并不適合瀏覽器端等需要異步加載資源的地方。
為了能讓JS
能夠在任何地方運行,CommonJS
制定了一些接口規(guī)范,這些接口覆蓋了模塊、二進制、Buffer
、字符集編碼、I/O
流、進程環(huán)境、文件系統(tǒng)、socket
、單元測試、web服務(wù)器、網(wǎng)關(guān)、包管理等等,雖然大部分都處于草案階段,但是其深深影響了Node
的發(fā)展。
下圖表示了Node
與瀏覽器、W3C
、CommonJS
以及ECMAScript
之間的關(guān)系,摘自 《深入淺出NodeJS》
CommonJS的模塊規(guī)范
CommonJS
的模塊主要由模塊引用、模塊定義和模塊標(biāo)識三部分組成。
模塊標(biāo)識
模塊標(biāo)識對于每個模塊來說是唯一的,是它被引用時的依據(jù),它必須是符合小駝峰命名的字符串,或者是文件的相對路徑或絕對路徑。
require('fs')// fs是內(nèi)建模塊,執(zhí)行時會被直接載入內(nèi)存,無須路徑標(biāo)識 require('./moduleA')//導(dǎo)入當(dāng)前目錄的moduleA require('../moduleB')// 導(dǎo)入上一個目錄的moduleB require('C://moduleC')// 絕對路徑導(dǎo)入moduleC
模塊引用
使用require()
來引用一個模塊,這個方法接受一個模塊標(biāo)識作為參數(shù),以此引入一個模塊的API到當(dāng)前上下文中。
const fs = require('fs')// 引入內(nèi)建的fs模塊
模塊定義
有導(dǎo)入自然也有導(dǎo)出,要將當(dāng)前上下文中的方法或變量作為模塊導(dǎo)出,需要使用內(nèi)建的module.exports
對象,它是模塊導(dǎo)出的唯一出口。
CommonJS
規(guī)范規(guī)定,每個模塊內(nèi)部,module
變量代表當(dāng)前模塊。這個變量是一個對象,它的exports
屬性(即module.exports
)是對外的接口。加載某個模塊,其實是加載該模塊的module.exports
屬性。
// moduleA.js模塊 let moduleA = { name:"moduleA" } module.exports = { moduleA } // moduleB.js模塊 // 導(dǎo)入moduleA const {moduleA} = require('./moduleA')
CommonJS
模塊的特點如下:
- 每個模塊具有獨立的上下文,模塊內(nèi)的代碼獨立執(zhí)行,不會污染全局作用域。
- 模塊可以被多次加載,但是只會在第一次加載時運行,運行結(jié)果會被緩存,后續(xù)再加載相同模塊會直接讀取緩存結(jié)果,緩存存儲在
module.cache
中 - 模塊的加載按代碼順序執(zhí)行。
Node的模塊實現(xiàn)
Node
導(dǎo)入模塊需要經(jīng)歷3
個步驟:路徑分析 -> 文件定位 -> 編譯執(zhí)行:
-
路徑分析:根據(jù)模塊標(biāo)識分析模塊類型。
-
文件定位:根據(jù)模塊類型和模塊標(biāo)識符找到模塊所處位置。
-
編譯執(zhí)行:將文件編譯成機器碼執(zhí)行,中間需要經(jīng)過一系列轉(zhuǎn)化。
模塊類型分為內(nèi)建模塊和用戶模塊:
-
內(nèi)建模塊:內(nèi)建模塊由
Node
提供,已經(jīng)被編譯成二進制執(zhí)行文件,在node
執(zhí)行時,內(nèi)建模塊會被直接載入內(nèi)存,因此我們可以直接引入,它的加載速度很快,因為它不需要經(jīng)過文件定位和編譯執(zhí)行這2
個步驟。 -
文件模塊:使用
js
或C++
等編寫的擴展模塊,執(zhí)行時需要先被編譯成二進制機器碼。需要經(jīng)過上述三大步驟。
模塊緩存
不管是內(nèi)建模塊還是文件模塊,node
在第一次加載后都會將結(jié)果緩存起來,下次加載相同模塊時,會先從緩存中查找,如果能查找到則直接從緩存中讀取,緩存的結(jié)果是模塊編譯和執(zhí)行后的對象,是所有模塊中加載最快的。
路徑分析
路徑分析依據(jù)的是模塊標(biāo)識符,模塊標(biāo)識符有以下幾種類型:
- 內(nèi)建模塊標(biāo)識,例如
fs
,path
等,不需要編譯,node
運行時被直接載入內(nèi)存等待導(dǎo)入。 - 相對路徑模塊標(biāo)識:使用相對路徑描述的文件模塊
- 絕對路徑模塊標(biāo)識:使用絕對路徑描述的文件模塊
- 自定義模塊標(biāo)識:通常是
node_modules
中的包,引入時也不需要寫路徑描述,node
有一套算法來尋找,是所有模塊標(biāo)識中分析速度最慢的。
文件定位
文件定位主要包括文件擴展名分析、目錄和包的處理。如果文件定位結(jié)束時都沒找到任何文件,則會拋出文件查找失敗的異常。
文件擴展名分析
由于模塊標(biāo)識可以不添加文件擴展名,因此Node
會按.js
、.json
、.node
的次序依次補足擴展名來嘗試加載,嘗試加載的過程需要調(diào)用fs
模塊同步阻塞式地判斷文件是否存在,因此為了提高性能,可以在使用require()
導(dǎo)入模塊時,參數(shù)帶上文件擴展名,這樣會加快文件定位速度。
目錄、包的處理
在分析文件擴展名時,可能得到的是一個目錄,此時Node
會將其作為一個包處理,用查找包的規(guī)則來查找:在當(dāng)前目錄下查找package.json
,獲得其中定義的main
屬性指定的文件名,以它來作為查找的入口,如果沒有package.json
,則默認(rèn)將目錄下的index
當(dāng)前默認(rèn)文件名,然后依次查找index.js
、index.json
、index.node
。
編譯執(zhí)行
編譯和執(zhí)行是模塊導(dǎo)入的最后一個步驟,node
會先創(chuàng)建一個Module
實例,代表當(dāng)前模塊。它有以下屬性:
module.id
模塊的識別符,通常是帶有絕對路徑的模塊文件名。module.filename
模塊的文件名,帶有絕對路徑。module.loaded
返回一個布爾值,表示模塊是否已經(jīng)完成加載。module.parent
返回一個對象,表示調(diào)用該模塊的模塊。module.children
返回一個數(shù)組,表示該模塊要用到的其他模塊。module.exports
表示模塊對外輸出的值。
通過文件定位得到的信息,Node
再載入文件并編譯。對于不同的文件擴展名,其載入方法也有所不同:
.js
文件:通過fs
模塊同步讀取文件后編譯執(zhí)行。.node
文件:這是C/C++
編寫的擴展文件,通過dlopen()
方法加載。.json
文件:通過fs
模塊讀取后,用JSON.parse()
解析返回結(jié)果。- 其余擴展名一律當(dāng)
.js
文件載入
每一個載入的模塊都會被緩存,可以通過require.cache
來查看。
使用ES-Module
目前,在node
中使用ES-Module
屬于實驗性功能,從8.5
開始支持,執(zhí)行時需要加上--experimental-modules
參數(shù)。從12.17.0 LTS
開始,去掉了--experimental-modules
,現(xiàn)在可以通過使用.mjs
文件代替.js
文件或在package.json
中指定 type
為 module
兩種方式使用。
// package.json { "name": "esm-project", "version": "1.0.0", "main": "index.js", "type": "module", ... }
ES-Module
相比于CommonJS
的Module
機制,最大不同是ES-Module
對導(dǎo)出模塊的變量、對象是動態(tài)引用,而且是在編譯階段暴露模塊的導(dǎo)入接口,因此可以進行靜態(tài)分析;而CommonJS-Module
是運行時同步加載,且輸出的是導(dǎo)出模塊的淺拷貝。除此之外,ES-Module
支持加載CommonJS-Module
,而反過來則不行。
其次,Node
規(guī)定 ES6
模塊之中不能使用 CommonJS
模塊的特有的一些內(nèi)部變量,這是因為ES-Module
頂層this
指向undefined
,CommonJS
模塊的頂層this
指向當(dāng)前模塊,而這些內(nèi)部變量作為頂層變量能被直接使用。
CommonJS
的內(nèi)部變量有:
arguments
require
module
exports
m__filename
__dirname
總結(jié)
-
Node
模塊的加載是同步的,只有加載完成,才能執(zhí)行后面的操作。 -
每一個文件就是一個模塊,有自己的作用域。每個模塊內(nèi)部,
module
對象代表了當(dāng)前模塊,它的exports
屬性作為當(dāng)前模塊的導(dǎo)出接口。 -
導(dǎo)入的模塊是導(dǎo)出模塊的一個淺拷貝。