模塊機(jī)制

CommonJS 模塊規(guī)范

模塊引用

require() 方法澈蚌,引入一個(gè)模塊的 API 到當(dāng)前上下文中

const math = require('math')

模塊定義

exports 對(duì)象用于導(dǎo)出當(dāng)前模塊的方法或者變量

module 對(duì)象代表模塊自身惰拱,而 exports 是 module 的屬性

// math.js
exports.add = function() {
  let sum = 0,
      i = 0,
      args = arguments,
      l = args.length
  while(i < l) {
    sum += args[i++]
  }
  return sum
}

模塊標(biāo)識(shí)

傳遞給 require() 方法的參數(shù)糙麦,它必須是符合小駝峰命名的字符串,或相對(duì)路徑/絕對(duì)路徑

Node 的模塊實(shí)現(xiàn)

在 Node 中引入模塊议谷, 需要經(jīng)歷如下3個(gè)步驟

  1. 路徑分析

  2. 文件定位

  3. 編譯執(zhí)行

在 Node 中, 模塊分為兩類(lèi):一類(lèi)是 Node 提供的模塊, 稱(chēng)為核心模塊极祸;另一類(lèi)是用戶(hù)編寫(xiě)的模塊,稱(chēng)為文件模塊

  • 核心模塊部分在 Node 源代碼的編譯過(guò)程中怠晴,編譯進(jìn)了二進(jìn)制執(zhí)行文件遥金。在 Node 進(jìn)程啟動(dòng)時(shí),部分核心模塊就被直接加載進(jìn)內(nèi)存中蒜田,所以這部分核心模塊引入時(shí)稿械,文件定位和編譯執(zhí)行這兩個(gè)步驟可以省略掉,并且路徑分析中優(yōu)先判斷冲粤,所以它的加載速度是最快的

  • 文件模塊則是在運(yùn)行時(shí)動(dòng)態(tài)加載美莫,需要完整的路徑分析、文件定位梯捕、編譯執(zhí)行過(guò)程厢呵,速度比核心模塊慢

優(yōu)先從緩存加載

Node 對(duì)引入過(guò)的模塊都會(huì)進(jìn)行緩存,以減少二次引入時(shí)的開(kāi)銷(xiāo)傀顾。與瀏覽器僅僅緩存文件不同襟铭,它緩存的是編譯和執(zhí)行之后的對(duì)象

路徑分析和文件定位

  1. 模塊標(biāo)識(shí)符分析
  • 核心模塊:優(yōu)先級(jí)僅次于緩存加載

  • 路徑形式的文件模塊:將路徑轉(zhuǎn)為真實(shí)路徑,并以真實(shí)路徑作為索引短曾,將編譯執(zhí)行后的結(jié)果存放到緩存中寒砖,以使二次加載時(shí)更快,其加載速度慢于核心模塊

  • 自定義模塊:非核心模塊嫉拐,也不是路徑形式的標(biāo)識(shí)符哩都。它是一種特殊的文件模塊,可能是一個(gè)文件或者包的形式婉徘。這類(lèi)模塊的查找是最費(fèi)時(shí)的茅逮,也是所有方式中最慢的一種

  1. 文件定位
  • 文件擴(kuò)展名分析:CommonJS 模塊規(guī)范允許在標(biāo)識(shí)符中不包括文件擴(kuò)展名,這種情況下判哥,Node 會(huì)按 .js献雅、.json、.node 的次序補(bǔ)足擴(kuò)展名塌计,依次嘗試

    在嘗試的過(guò)程中挺身,需要調(diào)用 fs 模塊同步阻塞式地判斷文件是否存在。因?yàn)?Node 是單線程的锌仅,所以這里是一個(gè)會(huì)引起性能問(wèn)題的地方章钾。 小訣竅是:如果是 .node 和 .json 文件墙贱,在傳遞給 require() 的標(biāo)識(shí)符中帶上擴(kuò)展名,會(huì)加快一點(diǎn)速度贱傀。另一個(gè)訣竅是:同步配合緩存惨撇,可以大幅度緩解 Node 單線程中阻塞式調(diào)用的缺陷

  • 目錄分析和包

    Node 在當(dāng)前目錄下查找 package.json,通過(guò) JSON.parse() 解析出包描述對(duì)象府寒,從中取出 main 屬性指定的文件名進(jìn)行定位魁衙。如果文件名缺失擴(kuò)展名,將會(huì)進(jìn)入擴(kuò)展名分析的步驟株搔。

    而如果 main 屬性指定的文件名錯(cuò)誤剖淀,或者壓根沒(méi)有 package.json 文件,Node 會(huì)將 index 當(dāng)做默認(rèn)文件名纤房,然后依次查找 index.js纵隔、index.json、index.node

    如果在目錄分析的過(guò)程中沒(méi)有定位成功任何文件炮姨,則自定義模塊進(jìn)入下一個(gè)模塊路徑進(jìn)行查找捌刮。如果模塊路徑數(shù)組都被遍歷完畢,依然沒(méi)有查找到目錄文件舒岸,則會(huì)拋出查找失敗的異常糊啡。

模塊編譯

  1. JavaScript 模塊的編譯

    在編譯的過(guò)程中,Node 對(duì)獲取的 JavaScript 文件內(nèi)容進(jìn)行了頭尾包裝吁津。在頭部添加了 (function(exports, require, module, ____filename, ____dirname)) {\n 在尾部添加了 \n}

    為何存在 exports 情況下,還存在 module.exports堕扶,其原因在于碍脏,exports 對(duì)象是通過(guò)形參的方式傳入的,直接賦值形參會(huì)改變形參的引用稍算,如果要達(dá)到 require 引入一個(gè)類(lèi)的效果典尾,請(qǐng)賦值給 module.exports 對(duì)象。這個(gè)迂回的方案不改變形參的引用糊探。

  2. C/C++ 模塊的編譯

    Node 調(diào)用 process.dlopen() 方法進(jìn)行加載和執(zhí)行

  3. JSON 文件的編譯

    Node 利用 fs 模塊同步讀取 JSON 文件的內(nèi)容之后钾埂,調(diào)用 JSON.parse() 方法得到對(duì)象,然后將它賦給模塊對(duì)象的 exports科平,以供外部調(diào)用褥紫。JSON 文件在用做項(xiàng)目的配置文件時(shí)比較有用。如果你定義了一個(gè) JSON 文件作為配置瞪慧,那就不必調(diào)用 fs 模塊去異步讀取和解析髓考,直接調(diào)用 require() 引入即可。此外弃酌,你還可以享受到模塊緩存的遍歷氨菇,并且二次引入時(shí)頁(yè)沒(méi)有性能影響儡炼。

    核心模塊

    核心模塊其實(shí)分為 C/C++ 編寫(xiě)和 JavaScript 編寫(xiě)的兩部分,其中 C/C++ 文件存放在 Node 項(xiàng)目的 src 目錄下

    JavaScript 核心模塊的編譯過(guò)程

    1. 轉(zhuǎn)存為 C/C++ 代碼

    2. 編譯 JavaScript 核心模塊:也經(jīng)歷頭尾包裝的過(guò)程查蓉,然后才執(zhí)行和道出了 exports 對(duì)象乌询。不同于文件模塊是,獲取源代碼的方式(核心模塊是從內(nèi)存中加載的)以及緩存執(zhí)行結(jié)果的位置

    C/C++ 核心模塊的編譯過(guò)程

    在核心模塊中豌研,有些模塊全部由 C/C++ 編寫(xiě)妹田,有些模塊則由 C/C++ 完成核心部分,其他部分則由 JavaScript 實(shí)現(xiàn)包裝或向外導(dǎo)出聂沙,以滿(mǎn)足性能需求秆麸。

    1. 內(nèi)建模塊的組織形式

    2. 內(nèi)建模塊的導(dǎo)出

      文件模塊可能會(huì)依賴(lài)核心模塊,核心模塊可能會(huì)依賴(lài)內(nèi)建模塊

依賴(lài)層級(jí)關(guān)系.png

通常及汉,不推薦文件模塊直接調(diào)用內(nèi)建模塊沮趣。如需調(diào)用,直接調(diào)用核心模塊即可坷随,因?yàn)楹诵哪K中基本都封裝了內(nèi)建模塊房铭。

核心模塊的引入流程

os原生模塊的引入流程.png

編寫(xiě)核心模塊

編寫(xiě)頭文件和編寫(xiě) C/C++ 文件

C/C++ 擴(kuò)展模塊

JavaScript 的一個(gè)典型弱點(diǎn)就是位運(yùn)算。JavaScript 的位運(yùn)算參照 Java 的位運(yùn)算實(shí)現(xiàn)温眉,但是 Java 位運(yùn)算是在 int 型數(shù)字的基礎(chǔ)上進(jìn)行的缸匪, 而 JavaScript 中只有 double 型的數(shù)據(jù)類(lèi)型,在進(jìn)行位運(yùn)算的過(guò)程中类溢,需要將 double 型轉(zhuǎn)換為 int 型凌蔬,然后再進(jìn)行。所以闯冷,在 JavaScript 層面上作位運(yùn)算的效率不高砂心。

在應(yīng)用中,會(huì)頻繁出現(xiàn)效率低的操作(如上面提到的位運(yùn)算)蛇耀,如果通過(guò) JavaScript 來(lái)實(shí)現(xiàn)辩诞,CPU 資源將會(huì)耗費(fèi)好多,這時(shí)編寫(xiě) C/C++ 擴(kuò)展模塊來(lái)提升性能的機(jī)會(huì)來(lái)了纺涤。

擴(kuò)展模塊不同平臺(tái)上的編譯和加載過(guò)程.png

前提條件

  • GYP 項(xiàng)目生成工具

  • V8引擎 C++ 庫(kù)

  • libuv 庫(kù)

  • Node 內(nèi)部庫(kù)

  • 其他庫(kù)

C/C++ 擴(kuò)展模塊的編寫(xiě)

普通的擴(kuò)展模塊與內(nèi)建模塊的區(qū)別在于無(wú)須將源代碼編譯進(jìn) Node译暂,而是通過(guò) dlopen() 方法動(dòng)態(tài)加載。所以在編寫(xiě)普通模塊時(shí)撩炊,無(wú)須將源代碼寫(xiě)進(jìn) node 命名空間外永,也不需要提供頭文件。

C/C++ 擴(kuò)展模塊的編譯

寫(xiě)好 .gyp 項(xiàng)目文件拧咳,node-gyp 約定 .gyp 文件為 binding.gyp

C/C++擴(kuò)展模塊的加載

require() 方法通過(guò)間隙標(biāo)識(shí)符象迎、路徑分析、文件定位,然后加載執(zhí)行即可

require()引入.node文件的過(guò)程.png

C/C++ 擴(kuò)展模塊與 JavaScript 模塊的區(qū)別在于加載之后不需要編譯砾淌,直接執(zhí)行之后就可以被外部調(diào)用了啦撮,其加載速度比 JavaScript 模塊略快

使用 C/C++ 擴(kuò)展模塊的一個(gè)好處在于可以更靈活和動(dòng)態(tài)地加載他們,保持 Node 模塊自身簡(jiǎn)單性的同時(shí)汪厨,給予 Node 無(wú)線的可擴(kuò)展性

模塊調(diào)用棧

模塊之間的調(diào)用關(guān)系.png

包與 NPM

CommonJS 的包規(guī)范的定義其實(shí)十分簡(jiǎn)單赃春,它由包結(jié)構(gòu)和包描述文件兩個(gè)部分組成,前者用于組織包中的各種文件劫乱,后者則用于描述包的相關(guān)信息化漆,以供外部讀取分析

包結(jié)構(gòu)

完全符合 CommonJS 規(guī)范的包目錄應(yīng)該包含如下這些文件

  • package.json:包描述文件

  • bin:用于存放可執(zhí)行二進(jìn)制文件的目錄

  • lib:用于存放 JavaScript 代碼的目錄

  • doc:用于存放文檔的目錄

  • test:用于存放單元測(cè)試用例的代碼

包描述文件與 NPM

包描述文件用于表達(dá)非代碼相關(guān)的信息相赁,它是一個(gè) JSON 格式的文件——package.json请琳, 位于包的根目錄下稠通,是包的重要組成部分

NPM 常用功能

  1. 查看幫助
$ npm help <command>
  1. 安裝依賴(lài)包
# 全局模式安裝
$ npm install <package> -g
# 從本地安裝
$ npm install <tarball file>
$ npm install <tarball url>
$ npm install <folder>
# 從非官方源安裝
$ npm install underscore --registry=http://registry.url
# 指定默認(rèn)源
$ npm config set registry http://registry.url
  1. npm 鉤子命令
"scripts": {
  "preinstall": "preinstall.js",
  "install": "install.js",
  "uninstall": "uninstall.js",
  "test": "test.js"
}

在以上字段中執(zhí)行 npm install <package> 時(shí),preinstall 指向的腳本將會(huì)被加載執(zhí)行殖妇,然后 install 指向的腳本會(huì)被執(zhí)行刁笙。在執(zhí)行 npm uninstall <package> 時(shí),uninstall 指向的腳本也許會(huì)做一些清理工作等谦趣。當(dāng)在一個(gè)具體的包目錄下執(zhí)行 npm test 時(shí)疲吸,將會(huì)運(yùn)行 test 指向的腳本

  1. 發(fā)布包

    • 編寫(xiě)模塊

    • 初始化包描述文件

    • 注冊(cè)包倉(cāng)庫(kù)賬號(hào)

    • 上傳包

    • 安裝包

    • 管理包權(quán)限

    • 分析包

局域 NPM

搭建自己的 NPM 倉(cāng)庫(kù)

NPM 潛在問(wèn)題

潛在問(wèn)題在于,鑒于開(kāi)發(fā)者水平不一前鹅,上面的包質(zhì)量也良莠不齊摘悴。另一個(gè)問(wèn)題則是,Node 代碼可以運(yùn)行在服務(wù)器端舰绘,需要考慮安全問(wèn)題

前后端公用模塊

模塊的側(cè)重點(diǎn)

客戶(hù)端的瓶頸在于帶寬蹂喻,服務(wù)端的瓶頸在于 CPU 和內(nèi)存等資源

鑒于網(wǎng)絡(luò)的原因,CommonJS 為后端 JavaScript 指定的規(guī)范并不完全是個(gè)前端的應(yīng)用場(chǎng)景

AMD 規(guī)范

CMD 規(guī)范

兼容多種模塊規(guī)范

;(function (name, definition) {
 // 檢測(cè)上下文環(huán)境是否為AMD或CMD
 var hasDefine = typeof define === 'function',
 // 檢查上下文環(huán)境是否為Node
 hasExports = typeof module !== 'undefined' && module.exports;
 if (hasDefine) {
 // AMD環(huán)境或CMD環(huán)境
 define(definition);
 } else if (hasExports) {
 // 定義為普通Node模塊
 module.exports = definition();
 } else {
 // 將模塊的執(zhí)行結(jié)果掛在window變量中捂寿,在瀏覽器中this指向window對(duì)象
 this[name] = definition();
 }
})('hello', function () {
 var hello = function () {};
 return hello;
}); 
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末口四,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子者蠕,更是在濱河造成了極大的恐慌,老刑警劉巖掐松,帶你破解...
    沈念sama閱讀 218,858評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件踱侣,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡大磺,警方通過(guò)查閱死者的電腦和手機(jī)抡句,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,372評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)杠愧,“玉大人待榔,你說(shuō)我怎么就攤上這事。” “怎么了锐锣?”我有些...
    開(kāi)封第一講書(shū)人閱讀 165,282評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵腌闯,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我雕憔,道長(zhǎng)姿骏,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,842評(píng)論 1 295
  • 正文 為了忘掉前任斤彼,我火速辦了婚禮分瘦,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘琉苇。我一直安慰自己嘲玫,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,857評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布并扇。 她就那樣靜靜地躺著去团,像睡著了一般。 火紅的嫁衣襯著肌膚如雪拜马。 梳的紋絲不亂的頭發(fā)上渗勘,一...
    開(kāi)封第一講書(shū)人閱讀 51,679評(píng)論 1 305
  • 那天,我揣著相機(jī)與錄音俩莽,去河邊找鬼旺坠。 笑死,一個(gè)胖子當(dāng)著我的面吹牛扮超,可吹牛的內(nèi)容都是我干的取刃。 我是一名探鬼主播,決...
    沈念sama閱讀 40,406評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼出刷,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼璧疗!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起馁龟,我...
    開(kāi)封第一講書(shū)人閱讀 39,311評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤崩侠,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后坷檩,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體却音,經(jīng)...
    沈念sama閱讀 45,767評(píng)論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,945評(píng)論 3 336
  • 正文 我和宋清朗相戀三年矢炼,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了系瓢。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 40,090評(píng)論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡句灌,死狀恐怖夷陋,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤骗绕,帶...
    沈念sama閱讀 35,785評(píng)論 5 346
  • 正文 年R本政府宣布藐窄,位于F島的核電站,受9級(jí)特大地震影響爹谭,放射性物質(zhì)發(fā)生泄漏枷邪。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,420評(píng)論 3 331
  • 文/蒙蒙 一诺凡、第九天 我趴在偏房一處隱蔽的房頂上張望东揣。 院中可真熱鬧,春花似錦腹泌、人聲如沸嘶卧。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,988評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)芥吟。三九已至,卻和暖如春专甩,著一層夾襖步出監(jiān)牢的瞬間钟鸵,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,101評(píng)論 1 271
  • 我被黑心中介騙來(lái)泰國(guó)打工涤躲, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留棺耍,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,298評(píng)論 3 372
  • 正文 我出身青樓种樱,卻偏偏與公主長(zhǎng)得像蒙袍,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子嫩挤,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,033評(píng)論 2 355

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

  • 1 Node.js模塊的實(shí)現(xiàn) 之前在網(wǎng)上查閱了許多介紹Node.js的文章,可惜對(duì)于Node.js的模塊機(jī)制大都著...
    zlx_2017閱讀 1,245評(píng)論 0 1
  • 1 Node.js模塊的實(shí)現(xiàn)# 之前在網(wǎng)上查閱了許多介紹Node.js的文章,可惜對(duì)于Node.js的模塊機(jī)制大都...
    七寸知架構(gòu)閱讀 2,062評(píng)論 1 50
  • 1.為什么要CommonJS規(guī)范 javascript存在的缺點(diǎn) 沒(méi)有模塊系統(tǒng) 標(biāo)準(zhǔn)庫(kù)比較少 沒(méi)有標(biāo)準(zhǔn)接口 缺乏包...
    maikuraki閱讀 188評(píng)論 0 1
  • 之前 ECMAScript 的問(wèn)題: 沒(méi)有模塊系統(tǒng)害幅,標(biāo)準(zhǔn)庫(kù)較少(如文件系統(tǒng)等缺失API),沒(méi)有標(biāo)準(zhǔn)接口岂昭,無(wú)包管理系...
    Air_cc閱讀 330評(píng)論 0 0
  • 前言 java有類(lèi)文件以现,Python有import機(jī)制,Ruby有require等约啊,而Javascript 通過(guò) ...
    RayLeo閱讀 795評(píng)論 0 4