深挖 NPM 机制
使用NPM安裝的時候會經常出現包沖突(比如多個主模塊的子模塊版本不一致等),導致在開發過程中會遇到各種或大或小的問題。所有在這會介紹以下內容:
安裝&查詢命令
NPM 各種安裝方式
-
npm install packageName[@next | @versionNumber]
- 在 node_modules 中沒有指定模塊時安裝,(不檢查~/.npm目錄)
-
npm install packageName --f | -- force
- 一個模塊不管是否安裝過,npm都要 強制重新安裝
-
npm update packageName
- 如果遠程版本較新、或者本地版本不存在時安裝
NPM 查詢服務
- NPM通過registry的查詢服務,從而知道每個模塊的最新版本。
- 可以通過 npm view packageName [version] 查詢對映模塊的信息
NPM 安裝機制
輸入 npm install 命令并敲下回車后,會經歷如下幾個階段(以 npm 5.5.1 為例):
1. 執行工程自身 preinstall
當前 npm 工程如果定義了 preinstall 鉤子此時會被執行。
2. 確定首層依賴模塊
首先需要做的是確定工程中的首層依賴,也就是 dependencies 和 devDependencies 屬性中直接指定的模塊(假設此時沒有添加 npm install 參數)。
工程本身是整棵依賴樹的根節點,每個首層依賴模塊都是根節點下面的一棵子樹,npm 會開啟多進程從每個首層依賴模塊開始逐步尋找更深層級的節點。
如果查詢node_modules目錄之中已經存在指定模塊,那么不再重新安裝
3. 獲取模塊
獲取模塊是一個遞歸的過程,分為以下幾步:
- 獲取模塊信息
- 在下載一個模塊之前,首先要確定其版本,這是因為 package.json 中往往是 semantic version(semver,語義化版本)
- 此時如果版本描述文件(npm-shrinkwrap.json 或 package-lock.json)中有該模塊信息直接拿即可
- 如果沒有則從倉庫獲取(向registry查詢)。如 packaeg.json 中某個包的版本是 ^1.1.0,npm 就會去倉庫中獲取符合 1.x.x 形式的最新版本。
- 獲取模塊實體。
- 上一步會獲取到模塊的壓縮包地址(resolved 字段),npm 會用此地址檢查本地緩存,緩存中有就直接拿,如果沒有則從倉庫下載。
- 查找該模塊依賴
- 如果有依賴則回到第1步,如果沒有則停止。
4. 模塊扁平化(dedupe)
一步獲取到的是一棵完整的依賴樹,其中可能包含大量重復模塊。比如 A 模塊依賴于 loadsh,B 模塊同樣依賴于 lodash。在 npm3 以前會嚴格按照依賴樹的結構進行安裝,因此會造成模塊冗余。
從 npm3 版本 開始默認加入了一個 dedupe 的過程。它會遍歷所有節點,逐個將模塊放在根節點下面,也就是 node-modules 的第一層。當發現有重復模塊時,則將其丟棄。
這里需要對重復模塊進行一個定義,它指的是模塊名相同且 semver 兼容。每個 semver 都對應一段版本允許范圍,如果兩個模塊的版本允許范圍存在交集,那么就可以得到一個兼容版本,而不必版本號完全一致,這可以使更多冗余模塊在 dedupe 過程中被去掉。
比如
- node-modules 下 foo 模塊依賴 lodash@^1.0.0,bar 模塊依賴 lodash@^1.1.0,則 ^1.1.0 為兼容版本。
- 而當 foo 依賴 lodash@^2.0.0,bar 依賴 lodash@^1.1.0,則依據 semver 的規則,二者不存在兼容版本。會將一個版本放在 node_modules 中,另一個仍保留在依賴樹里。
舉個例子,假設一個依賴樹原本是這樣:
node_modules -- foo ---- lodash@version1
-- bar ---- lodash@version2
假設 version1 和 version2 是兼容版本,則經過 dedupe 會成為下面的形式:
node_modules -- foo
-- bar
-- lodash(保留的版本為兼容版本)
假設 version1 和 version2 為非兼容版本,則后面的版本保留在依賴樹中:
node_modules -- foo -- lodash@version1
-- bar ---- lodash@version2
5. 安裝模塊
這一步將會更新工程中的 node_modules,并執行模塊中的生命周期函數(按照 preinstall、install、postinstall 的順序)。
6. 執行工程自身生命周期
當前 npm 工程如果定義了鉤子此時會被執行(按照 install、postinstall、prepublish、prepare 的順序)。
最后一步是生成或更新版本描述文件,npm install 過程完成。
End
文章分享同步于: github.com/zhongmeizhi…
參考
- 阮一峰的個人博客
- npm實現原理
總結
- 上一篇: PPT幻灯片转换成word的软件
- 下一篇: shell脚本编程规范与变量