之前 ECMAScript 的問(wèn)題:
沒(méi)有模塊系統(tǒng),標(biāo)準(zhǔn)庫(kù)較少(如文件系統(tǒng)等缺失API)挤巡,沒(méi)有標(biāo)準(zhǔn)接口,無(wú)包管理系統(tǒng)
CommonJS
CommonJS 規(guī)范涵蓋:模塊坦弟、二進(jìn)制走诞、Buffer势决、字符編碼熔恢、I/O流轻姿、進(jìn)程環(huán)境筑累、文件系統(tǒng)袱蜡、套接字、單元測(cè)試慢宗、Web 服務(wù)器網(wǎng)關(guān)接口坪蚁、包管理。
Node借鑒CommonJS的Modules規(guī)范實(shí)現(xiàn)了一套模塊系統(tǒng)镜沽。
CommonJS 的模塊規(guī)范
包括:模塊引用淘邻、模塊定義茵典、模塊標(biāo)識(shí)3部分。
- 模塊引用
示例:
var math = require('math');
- 模塊定義
被引用模塊的上下文提供 exports 對(duì)象用于導(dǎo)出當(dāng)前模塊的方法與變量宾舅,這是該模塊唯一的導(dǎo)出出口统阿。在模塊中還包括一個(gè)標(biāo)識(shí)模塊本身的 module 對(duì)象。exports 正是 module 對(duì)象的一個(gè)屬性的引用筹我。
示例:
// math.js
let count = 0;
exports.incr = function () {
count += 1;
return count;
};
// program.js
var incr = require('match');
console.log(incr()); // 1
console.log(incr()); // 2
- 模塊標(biāo)識(shí)
其實(shí)就是傳遞給 require() 方法的參數(shù)扶平,它必須是符合小駝峰命名的字符串,或者一個(gè)相對(duì)路徑蔬蕊,或者一個(gè)絕對(duì)路徑结澄。
模塊加載的具體實(shí)現(xiàn)
Node 引入一個(gè)模塊包括如下步驟:
- 路徑分析
- 文件定位
- 編譯執(zhí)行
Node 中的模塊分為:核心模塊(Node本身提供的模塊)、文件模塊(用戶(hù)編寫(xiě)的模塊)岸夯。
核心模塊在Node源碼編譯過(guò)程中被編譯成二進(jìn)制執(zhí)行文件麻献。在Node進(jìn)程啟動(dòng)過(guò)程中部分核心模塊會(huì)直接被加載進(jìn)內(nèi)存,故這部分核心模塊在引入時(shí)猜扮,不需文件定位和編譯執(zhí)行勉吻,且在路徑分析中優(yōu)先判斷,所以它們的加載速度是最快的旅赢。
文件模塊是在運(yùn)行時(shí)動(dòng)態(tài)加載齿桃,需要完整經(jīng)歷模塊引入的流程惑惶,加載速度較慢。
模塊加載步驟:
優(yōu)先從緩存加載
Node對(duì)引入過(guò)的模塊都會(huì)進(jìn)行緩存(緩存的是編譯和執(zhí)行后的對(duì)象)短纵,以避免二次引入時(shí)的開(kāi)銷(xiāo)带污。所以對(duì)于二次加載的模塊,Node會(huì)優(yōu)先從緩存中引入香到。另外核心模塊的緩存檢測(cè)優(yōu)先于文件模塊鱼冀。
路徑分析
即對(duì)模塊標(biāo)識(shí)符的分析。
- 核心模塊:如
http
养渴、fs
等雷绢,優(yōu)先加載,不可以加載與核心模塊標(biāo)識(shí)符相同的自定義模塊理卑。 - 路徑形式的文件模塊:相對(duì)路徑或絕對(duì)路徑翘紊,分析文件模塊時(shí),require() 方法會(huì)將該路徑轉(zhuǎn)為真實(shí)路徑藐唠,并以此為真實(shí)路徑作為該模塊的索引來(lái)緩存被編譯執(zhí)行后的模塊對(duì)象帆疟。
- 自定義模塊:不是核心模塊也不以路徑作為標(biāo)識(shí)符的模塊,可以是一個(gè)包或者文件宇立,這類(lèi)模塊加載最慢踪宠。
Node 自定義模塊的查找策略(類(lèi)似于JavaScript的原型鏈或者作用域的查找方式):
- 當(dāng)前文件目錄下的 node_modules 目錄
- 父目錄下的 node_modules 目錄
- 逐級(jí)向上遞歸查找,直至根目錄下的 node_modules 目錄
文件定位
- 文件拓展名分析:模塊的標(biāo)識(shí)符可不包含文件拓展名妈嘹。Node 會(huì)按照 .js柳琢、.json、.node 的次序不足拓展名一次嘗試润脸。這里需注意的是:在嘗試過(guò)程中柬脸,會(huì)調(diào)用 fs 模塊同步阻塞式的判斷文件是否存在,故在調(diào)用 .json .node 文件是最好帶上拓展名毙驯,已提升文件定位的速度倒堕。
- 目錄分析:在分析模塊標(biāo)識(shí)符的過(guò)程中,發(fā)現(xiàn)是一個(gè)目錄時(shí)會(huì)以包的形式來(lái)處理爆价。 Node 會(huì)查找并解析
package.json
文件垦巴,從其 main 屬性來(lái)定位該模塊入口文件。如果無(wú)法通過(guò) main 屬性獲取入口文件铭段,則Node 默認(rèn)以 index 作為入口文件名骤宣,依次查找 index.js、index.json序愚、index.node涯雅;若未找到則進(jìn)入下一個(gè)查找路徑繼續(xù)上述步驟,直至路徑遍歷完畢仍未找到拋出異常展运。
模塊編譯(文件模塊)
定位到模塊后便會(huì)編譯執(zhí)行該模塊活逆。每個(gè)文件模塊都是一個(gè)對(duì)象,其定義如下:
function Module(id, parent) {
this.id = id;
this.exports = {};
if (parent && parent.chidren) {
parent.children.push(this);
}
this.filename = null;
this.loaded = false;
this.children = [];
}
Node 對(duì)于不同類(lèi)型的文件模塊執(zhí)行不同的加載方法拗胜。
- .js 文件:
fs 模塊同步讀取文件內(nèi)容蔗候,wrap 模塊內(nèi)容,vm 編譯模塊內(nèi)容返回包含上下文的function埂软,傳入之前 wrap 的參數(shù)锈遥,執(zhí)行該函數(shù)。
wrap 內(nèi)容:
(function (exports, require, module, __filename, __dirname) {
/* 實(shí)際文件內(nèi)容 */
})
.node 文件
Node 調(diào)用 process.dlopen() 方法來(lái)加載和執(zhí)行 .node 文件勘畔。dlopen() 方法通過(guò) libuv 兼容層封裝了 Windows 和 *nix 平臺(tái)下的不同實(shí)現(xiàn)所灸。實(shí)際上,.node模塊并不需要編譯炫七,它已經(jīng)是C/C++模塊編譯生成好的二進(jìn)制文件了爬立,執(zhí)行的過(guò)程中,會(huì)將模塊的 exports 對(duì)象與.node 模塊產(chǎn)生聯(lián)系万哪,返回給調(diào)用者侠驯。.json 文件
調(diào)用 fs 模塊通過(guò)讀取文件內(nèi)容,調(diào)用 JSON.parse() 解析奕巍,將其賦給模塊對(duì)象的exports吟策。
Module._extensions['.json'] = function(module, filename) {
var content = fs.readFileSync(filename, 'utf8');
try {
module.exports = JSON.parse(internalModule.stripBOM(content));
} catch (err) {
err.message = filename + ': ' + err.message;
throw err;
}
};
注:文件模塊加載的具體代碼實(shí)現(xiàn)可以參考這里
核心模塊包括:c/c++ 編寫(xiě)的模塊、js 編寫(xiě)的模塊
JavaScript 核心模塊的編譯過(guò)程
- 通過(guò) v8 附帶的 js2c.py 工具將 js 代碼以字符串的形式存儲(chǔ)到 node 的命名空間中的止;
- 通過(guò) process.binding('natives') 取出代碼檩坚,存放到 NativeModule._cache 對(duì)象中;
- 當(dāng) require() 方法調(diào)用時(shí)诅福,從 NativeModule._cache 中取出對(duì)應(yīng) id(模塊標(biāo)識(shí)符) 的代碼匾委,通過(guò) NativeModule.compile() 方法 wrap、執(zhí)行相應(yīng)的代碼权谁。
C/C++ 核心模塊的編譯過(guò)程
這里分為:純 C/C++ 編寫(xiě)的模塊剩檀、核心部分由 C/C++ 編寫(xiě),對(duì)外封裝由 JS 完成的模塊旺芽。其中純 C/C++ 編寫(xiě)的部分稱(chēng)為內(nèi)建模塊
沪猴。
內(nèi)建模塊
Node 內(nèi)建模塊的結(jié)構(gòu)體定義:
struct node_module {
int nm_version;
unsigned int nm_flags;
void* nm_dso_handle;
const char* nm_filename;
node::addon_register_func nm_register_func;
node::addon_context_register_func nm_context_register_func;
const char* nm_modname;
void* nm_priv;
struct node_module* nm_link;
};
可通過(guò) get_builtin_module() 方法取出該模塊。內(nèi)建模塊在編譯 Node 源代碼時(shí)會(huì)被編譯成二進(jìn)制文件采章,在 Node 進(jìn)程啟動(dòng)時(shí)运嗜,直接加載進(jìn)內(nèi)存中,可直接被外部(核心模塊悯舟、C/C++拓展模塊-但不建議直接調(diào)用)調(diào)用担租。這里同 JS 核心文件加載一樣通過(guò) process.binding() 方法加載,但它將 exports 對(duì)象緩存到 binding_cache_object 中抵怎。
C/C++ 拓展模塊
C/C++ 拓展模塊的編寫(xiě)基本同內(nèi)建模塊一致奋救,可借助 node-gyp 進(jìn)行編譯岭参,只是不需要注冊(cè)到 node builtin 模塊中,而是通過(guò) process.dlopen() 動(dòng)態(tài)加載進(jìn)來(lái)尝艘。由于 .node 文件已是編譯后的二進(jìn)制文件演侯,所以被加載進(jìn)來(lái)后不需編譯直接執(zhí)行,相較于 JavaScript 模塊會(huì)略快一點(diǎn)背亥。
包與 NPM
包實(shí)際被打包成一個(gè)存檔文件(zip 或 tar.gz 格式)秒际。CommonJS 規(guī)范的包結(jié)構(gòu):
- package.json: 包描述文件
- bin: 可執(zhí)行文件
- lib: JavaScript 文件
- doc: 項(xiàng)目文檔
- test: 單元測(cè)試
NPM
依賴(lài)安裝:
- 全局安裝:只是將包描述文件中 bin 字段下的可執(zhí)行腳本以軟連接的方式鏈接到 node 執(zhí)行目錄下的 ../../lib/node_module 中。
path.resolve(process.execPath, '..', '..', 'lib', 'node_modules')
- 本地安裝:
npm install <package.json 文件所在目錄 or url>
一些鉤子: package.json 文件的scripts 中定義狡汉。
scripts: {
"preinstall": "install 該包之前執(zhí)行的腳本",
install: "install 該包時(shí)執(zhí)行的腳本",
uninstall: "卸載該包時(shí)執(zhí)行的腳本",
test: "單元測(cè)試腳本",
}