第二章 模塊機(jī)制

之前 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)镜沽。

Node 與瀏覽器以及W3C組織敏晤、CommonJS組織、ECMAScript之間的關(guān)系

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è)模塊包括如下步驟:

  1. 路徑分析
  2. 文件定位
  3. 編譯執(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ò)程

  1. 通過(guò) v8 附帶的 js2c.py 工具將 js 代碼以字符串的形式存儲(chǔ)到 node 的命名空間中的止;
  2. 通過(guò) process.binding('natives') 取出代碼檩坚,存放到 NativeModule._cache 對(duì)象中;
  3. 當(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 中抵怎。

os 原生模塊引入流程

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)背亥。

.node 文件引入流程

包與 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è)試腳本",
}
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末娄徊,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子盾戴,更是在濱河造成了極大的恐慌寄锐,老刑警劉巖,帶你破解...
    沈念sama閱讀 210,914評(píng)論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件捻脖,死亡現(xiàn)場(chǎng)離奇詭異锐峭,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)可婶,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 89,935評(píng)論 2 383
  • 文/潘曉璐 我一進(jìn)店門(mén)沿癞,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人矛渴,你說(shuō)我怎么就攤上這事椎扬。” “怎么了具温?”我有些...
    開(kāi)封第一講書(shū)人閱讀 156,531評(píng)論 0 345
  • 文/不壞的土叔 我叫張陵蚕涤,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我铣猩,道長(zhǎng)揖铜,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 56,309評(píng)論 1 282
  • 正文 為了忘掉前任达皿,我火速辦了婚禮天吓,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘峦椰。我一直安慰自己龄寞,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,381評(píng)論 5 384
  • 文/花漫 我一把揭開(kāi)白布汤功。 她就那樣靜靜地躺著物邑,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上色解,一...
    開(kāi)封第一講書(shū)人閱讀 49,730評(píng)論 1 289
  • 那天茂嗓,我揣著相機(jī)與錄音,去河邊找鬼科阎。 笑死在抛,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的萧恕。 我是一名探鬼主播,決...
    沈念sama閱讀 38,882評(píng)論 3 404
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼肠阱,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼票唆!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起屹徘,我...
    開(kāi)封第一講書(shū)人閱讀 37,643評(píng)論 0 266
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤走趋,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后噪伊,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體簿煌,經(jīng)...
    沈念sama閱讀 44,095評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,448評(píng)論 2 325
  • 正文 我和宋清朗相戀三年鉴吹,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了姨伟。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,566評(píng)論 1 339
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡豆励,死狀恐怖夺荒,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情良蒸,我是刑警寧澤技扼,帶...
    沈念sama閱讀 34,253評(píng)論 4 328
  • 正文 年R本政府宣布,位于F島的核電站嫩痰,受9級(jí)特大地震影響剿吻,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜串纺,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,829評(píng)論 3 312
  • 文/蒙蒙 一丽旅、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧造垛,春花似錦魔招、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,715評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至,卻和暖如春乡翅,著一層夾襖步出監(jiān)牢的瞬間鳞疲,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 31,945評(píng)論 1 264
  • 我被黑心中介騙來(lái)泰國(guó)打工蠕蚜, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留尚洽,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 46,248評(píng)論 2 360
  • 正文 我出身青樓靶累,卻偏偏與公主長(zhǎng)得像腺毫,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子挣柬,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,440評(píng)論 2 348

推薦閱讀更多精彩內(nèi)容