浅谈 npm/yarn/pnpm

npm /yarn 原理

依赖地狱

早期的 npm 会直接安装依赖,如果依赖存在依赖,则在依赖里加入 node_modules。

假如有两个依赖 A, BA 依赖于 C D,而 B 依赖于 C E。则依赖目录是这样的:

node_modules
├─ A
│  └─ node_modules
│     └─ C
│     └─ D
├─ B
│  └─ node_modules
│     └─ C
└─    └─ E

从依赖目录可以看出,假如A依赖于C@1.0.0, B也依赖于C@1.0.0。则会同时安装两份C@1.0.0。很明显,有一份C@1.0.0是重复的。

对于大型项目,依赖会特别多,个别依赖也会嵌套比较深。这样就会导致不同的依赖分支里会有大量的重复依赖,且依赖嵌套过深的话会导致 windows 目录路径过长问题。由于是嵌套导致的,这个时期的依赖安装被称为依赖地狱

依赖扁平化

为了解决依赖嵌套的问题, npm3.x 开始(yarn 也是这个时期出现的),开始依赖扁平化。也就是把依赖的依赖提升到 node_modules 根目录下,重复的依赖不再安装。这样就可以实现依赖共享。

比如上面这个例子,依赖目录如下:

node_modules
├─ A
├─ B
├─ C@1.0.0
├─ D
└─ E

这样好像解决了重复依赖的问题?只能说是解决了,但没有完全解决

假如 A 依赖于 C@1.0.0DB 依赖于 C@2.0.0E ,同时 E 又依赖于 C@2.0.0。则依赖扁平化的安装如下:

node_modules
├─ A
├─ C@1.0.0
├─ D
├─ B
│  └─ node_modules
│     └─ C@2.0.0
│─ E
│  └─ node_modules
└─    └─ C@2.0.0

安装的时候,C@1.0.0 D E 会被提升到 node_modules 根目录。但是由于版本不一致,BE 依赖的 C@2.0.0就只能放到自身的 node_modules 下,而不能共享提升的 C@1.0.0。这样一来 C@2.0.0 就被安装了两份。

C@2.0.0被叫做分身依赖分身依赖就是相同版本的依赖被重复安装。

除了分身依赖之外,依赖扁平化还引入了新的问题。

不确定性

第一个问题就是不确定性。

假如A依赖于C@1.0.0, B依赖于C@2.0.0。那么依赖安装会提升的是C@1.0.0还是C@2.0.0呢?也就是下面这两种结构:

node_modules
├─ A
│─ C@1.0.0
├─ B
│  └─ node_modules
└─    └─ C@2.0.0

还是

node_modules
├─ A
│  └─ node_modules
│     └─ C@1.0.0
├─ B
└─ C@2.0.0

网上大部分说法是会根据 package.json 里面的顺序决定谁会被提升,放在前面的包依赖的内容会被优先提升。

看了下最新版本的 npm 源码,发现 npm 其实会先调用 localeCompare 来对依赖进行排序,也就是字典序在前面的包依赖的内容会被优先提升。这样即使修改package.json里依赖的顺序,也不会影响依赖提升,解决了不确定性。

幽灵依赖

第二个问题就是幽灵依赖。

package.json中不存在却可以直接使用的依赖就是幽灵依赖。 在依赖扁平化后,被提升的依赖就是幽灵依赖。

假如A依赖于C@1.0.0

node_modules
├─ A
└─ C@1.0.0

C@1.0.0就是幽灵依赖。我们可以在项目中直接使用C@1.0.0,但是package.json中并没有这个依赖项。

这看上去好像没什么问题,但是设想这种情况:有人发现依赖 A 不再使用,于是删除了 A。但是幽灵依赖C@1.0.0依然在项目被使用着,这就会引起报错。

pnpm 的破局之法

pnpm 的出现解决了分身依赖幽灵依赖的问题。那 pnpm 是如何解决的呢?

假如 A 依赖于 C@1.0.0,那么通过 pnpm 安装后的依赖目录如下:

node_modules
├─ .pnpm
│  └─ node_modules // 非直接依赖的包, 都是符号连接
│
│  └─ A@1.0.0
│     └─ node_modules
│        └─ A -> <store>/A
│        └─ C -> ../../C@1.0.0/node_modules/C
│
│  └─ C@1.0.0
│     └─ node_modules
│        └─ C -> <store>/C
│
└─ A  -> ./.pnpm/A@1.0.0/node_modules/A

node_modules 根目录下有一个 .pnpm文件夹和 A。这里的 A 是个软连接,指向它的硬连接

可以简单理解为:

硬连接是指向实际存储位置的一个指针文件。

软连接是指向硬连接的一个指针文件。

所有的依赖都会在 .pnpm 文件夹罗列出来(不同版本可以看做是不同的依赖)。每个依赖有个 node_modules 文件夹,里面存放的是自身的硬连接和自身所依赖的依赖的软连接

用图片来表示如下:

link.jpg

这样 pnpm 就保证了同一个版本的依赖只安装一份。依赖根目录存放的是所有的直接依赖的软连接。至于依赖之间的关系则同样是通过软连接来构建。

lock 文件

npm 的 package-lock.json,yarn 的 yarn.lock,以及 pnpm 的 pnpm-lock.yaml 都是 lock 文件,用于锁定依赖项的版本和下载源。

如果项目里存在 lock 文件,则安装依赖时候会按照 lock 文件里的版本安装。如果不存在,则会按照 package.json 里的版本安装,且根据你所安装的依赖生成一份 lock 文件。

很多人倾向于直接写死 package.json 里的版本。但是 package.json 里只能锁定直接依赖的版本,不能保证依赖的依赖版本不变。

lock 文件不仅能够锁定直接依赖版本还能锁定依赖的依赖版本。 个人比较建议上传 lock 文件到 git,这样能够保证团队的依赖一致。

参考文档

浅谈 NPM 怎样处理处理依赖和冲突

📓 聊聊依赖管理

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,732评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,496评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,264评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,807评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,806评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,675评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,029评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,683评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,704评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,666评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,773评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,413评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,016评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,204评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,083评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,503评论 2 343

推荐阅读更多精彩内容