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