Node 工程的依賴包管理方式

來源 | OSCHINA 社區

作者 | 京東雲開發者—京東零售 陳震

原文鏈接：https://my.oschina.net/u/4090830/blog/8685856

在前端工程化中，JavaScript 依賴包管理是非常重要的一環。依賴包通常是項目所依賴的第三方庫、工具和框架等資源，它們能夠幫助我們減少重複開發、提高效率並且確保項目可以正確的運行。

目前比較常見的前端包管理器有 npm 和 Yarn，npm 是 Node.js 自帶的包管理器，它可以安裝、共享和分發 node.js 模塊。最近 pnpm 也挺火的，通過並行下載和安裝依賴項，在執行安裝、更新、刪除等操作時也更快。

但無論使用哪個包管理器，都要通過 package.json 文件的版本控制功能，保證在不同開發環境中的一致性。那麼，package.json 是如何進行依賴包管理的呢？我們來一起深入瞭解一下 package.json 的配置方式。

一、分類管理

根據 package.json 規範，依賴包被大致分爲以下幾種：dependencies、devDependencies、optionalDependencies、peerDependencies 和 bundledDependencies 總共 5 種。dependencies 和 devDependencies 這兩項是我們使用較爲頻繁的。

1、dependencies

工程在生產環境下也需要使用的依賴，例如 react、antd 等，使用 npm 安裝插件時，會默認寫入 dependencies，也可以使用 - P 或 --save-prod 後綴。

2、devDependencies

工程只有開發環境需要，生產環境不需要的依賴，例如 eslint、babel 等，使用 - D 或 --save-dev 來寫入 devDependencies。

3、optionalDependencies

顧名思義，依賴是可選的，它們只有在運行時需要使用某些功能時纔會被引入。通常用於實現某些可選的功能或優化。例如，一個包可能依賴於某個庫來實現某種高級功能，但是這個庫在某些環境下不存在或不可用。在這種情況下，可以將該庫聲明爲可選依賴項，並在代碼中檢查該依賴項是否存在，然後根據情況來決定是否使用該高級功能。使用這個功能的工程比較少，使用 - O 或 --save-optional 來寫入 optionalDependencies。

4、peerDependencies

工程需要和這個依賴配套使用，一般用於解決插件依賴的核心庫的版本和主項目依賴的核心庫的版本不一致的問題，常見於開發配套插件。例如 vuex@4.1.0 聲明瞭：

"peerDependencies": {
   "vue": "^3.2.0"
}

表明 vuex@4.1.0 需要和 vue@^ 3.2.0 一起安裝和使用，否則可能會出現異常。使用 - O 或 --save-optional 來寫入 optionalDependencies。

5、bundledDependencies

工程依賴於某些特定的依賴項，並且希望在運行時不必再次下載它們，則可以使用該選項。npm pack 會將這些依賴一同放入生成的包中，並且在 npm install 時本工程，這些依賴項也會被一同安裝。使用 - B 或 --save-bundle 來寫入 bundledDependencies。

看到這裏你可能會有點疑問，爲什麼 npm 沒有提供類似 --save-peer 的指令來寫入 peerDependencies 呢？原因是 peerDependencies 暗示本工程將會被其他主模塊使用，但是主模塊本身並不需要在項目代碼中顯式使用。因此官方沒有支持這一指令。

二、版本管理

一般情況下，以上依賴配置（除了 bundledDependencies）都需要指定依賴的版本號，版本號遵循 semver 語義化版本規範（Semantic Versioning）命名規則，可以用下圖表示，如 2.1.0、3.1.4-beta.2 等。

可選的 - tags 即先行版本號，可以作爲發佈正式版之前的版本，格式是在修訂版本號後面加上一個連接號（-），再加上一連串以點（.）分割的標識符，標識符可以由英文、數字和連接號（[0-9A-Za-z-]）組成。

在 npm 的依賴的規則中，還有 ~、>、<、=、>=、<=、-、||、x、X、* 等符號來描述適用的版本範圍；

默認情況下，若指定了一個版本範圍，npm 會在範圍內安裝最新版本的依賴。當使用 npm install XX 時，會安裝當前最新版本，並在版本號前默認加上 ^ 符號。因此在安裝運行老項目時，很容易出現安裝依賴後，項目啓動報錯的情況，原因就是某些依賴沒有做到很好的向下兼容，導致重新安裝的版本太高造成兼容性錯誤，此時需要定位錯誤依賴並回退版本。

三、npm install 加載機制

npm install 核心流程大致分爲以下 5 步：

1、npm 向 registry 查詢依賴壓縮包的網址。
2、下載壓縮包，存放在cache目錄，供下次安裝時使用。
3、解壓壓縮包到當前項目的node_modules目錄。
4、把所有安裝的包信息寫入package-lock.json，供下次安裝時使用。
5、繼續處理依賴的依賴。

install 的過程速度也和每一個步驟息息相關：
（1）共享工程 package-lock.json，可以避免向 registry 查詢的步驟，並且保證不同環境下安裝包的一致性。
（2）使用下載速度快的 registry 鏡像（例如 jd 鏡像）。
（3）預先進行依賴關係分析構建依賴關係，然後最後再並行下載（例如 yarn）。

希望以上的介紹能夠幫助你更好的理解 npm 的依賴管理。

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/6-6YxjGh7LSX_IcLcZqyjA

猜你喜歡