乐趣区

关于javascript:精读pnpm

jiezi

pnpm 全称是“Performant NPM”，即高性能的 npm。它联合软硬链接与新的依赖组织形式，大大晋升了包治理的效率，也同时解决了“幻影依赖”的问题，让包治理更加标准，缩小潜在危险产生的可能性。

应用 pnpm 很容易，能够应用 npm 装置：

npm i pnpm -g

之后便可用 pnpm 代替 npm 命令了，比方最重要的安装包步骤，能够应用 pnpm i 代替 npm i，这样就算把 pnpm 应用起来了。

pnpm 的劣势

用一个比拟好记的词形容 pnpm 的劣势那就是“快、准、狠”：

  • 快：装置速度快。
  • 准：装置过的依赖会精确复用缓存，甚至包版本升级带来的变动都只 diff，绝不节约一点空间，逻辑上也严丝合缝。
  • 狠：间接废掉了幻影依赖，在逻辑合理性与含混的便捷性上，毫不留情的抉择了逻辑合理性。

而带来这些劣势的点子，全在官网上的这张图上：

  • 所有 npm 包都装置在全局目录 ~/.pnpm-store/v3/files 下，同一版本的包仅存储一份内容，甚至不同版本的包也仅存储 diff 内容。
  • 每个我的项目的 node_modules 下有 .pnpm 目录以打平构造治理每个版本包的源码内容，以硬链接形式指向 pnpm-store 中的文件地址。
  • 每个我的项目 node_modules 下装置的包构造为树状，合乎 node 就近查找规定，以软链接形式将内容指向 node_modules/.pnpm 中的包。

所以每个包的寻找都要通过三层构造：node_modules/package-a > 软链接 node_modules/.pnpm/package-a@1.0.0/node_modules/package-a > 硬链接 ~/.pnpm-store/v3/files/00/xxxxxx。

通过这三层寻址带来了什么益处呢？为什么是三层，而不是两层或者四层呢？

依赖文件三层寻址的目标

第一层

接着下面的例子思考，第一层寻找依赖是 nodejs 或 webpack 等运行环境 / 打包工具进行的，他们的在 node_modules 文件夹寻找依赖，并遵循就近准则，所以第一层依赖文件势必要写在 node_modules/package-a 下，一方面遵循依赖寻找门路，一方面没有将依赖都拎到下级目录，也没有将依赖打平，目标就是还原最语义化的 package.json 定义：即定义了什么包就能依赖什么包，反之则不行，同时每个包的子依赖也从该包内寻找，解决了多版本治理的问题，同时也使 node_modules 领有一个稳固的构造，即该目录组织算法仅与 package.json 定义无关，而与包装置程序无关。

如果止步于此，这就是 npm@2.x 的包治理计划，但正因为 npm@2.x 包治理计划最没有歧义，所以第一层沿用了该计划的设计。

第二层

从第二层开始，就要解决 npm@2.x 设计带来的问题了，次要是包复用的问题。所以第二层的 node_modules/package-a > 软链接 node_modules/.pnpm/package-a@1.0.0/node_modules/package-a 寻址利用软链接解决了代码反复援用的问题。相比 npm@3 将包打平的设计，软链接能够放弃包构造的稳固，同时用文件指针解决反复占用硬盘空间的问题。

若止步于此，也曾经解决了一个我的项目内的包治理问题，但我的项目不止一个，多个我的项目对于同一个包的多份拷贝还是太节约，因而要进行第三步映射。

第三层

第三层映射 node_modules/.pnpm/package-a@1.0.0/node_modules/package-a > 硬链接 ~/.pnpm-store/v3/files/00/xxxxxx 曾经脱离以后我的项目门路，指向一个全局对立治理门路了，这正是跨我的项目复用的必然选择，然而 pnpm 更进一步，没有将包的源码间接存储在 pnpm-store，而是将其拆分为一个个文件块，这在前面具体解说。

幻影依赖

幻影依赖是指，我的项目代码援用的某个包没有间接定义在 package.json 中，而是作为子依赖被某个包顺带装置了。代码里依赖幻影依赖的最大隐患是，对包的语义化管制不能穿透到其子包，也就是包 a@patch 的改变可能意味着其子依赖包 b@major 级别的 Break Change。

正因为这三层寻址的设计，使得第一层能够仅蕴含 package.json 定义的包，使 node_modules 不可能寻址到未定义在 package.json 中的包，天然就解决了幻影依赖的问题。

但还有一种更难以解决的幻影依赖问题，即用户在 Monorepo 我的项目根目录装置了某个包，这个包可能被某个子 Package 内的代码寻址到，要彻底解决这个问题，须要配合应用 Rush，在工程上通过依赖问题检测来彻底解决。

peer-dependences 装置规定

pnpm 对 peer-dependences 有一套严格的装置规定。对于定义了 peer-dependences 的包来说，意味着为 peer-dependences 内容是敏感的，潜台词是说，对于不同的 peer-dependences，这个包可能领有不同的体现，因而 pnpm 针对不同的 peer-dependences 环境，可能对同一个包创立多份拷贝。

比方包 bar peer-dependences 依赖了 baz^1.0.0 与 foo^1.0.0，那咱们在 Monorepo 环境两个 Packages 下别离装置不同版本的包会如何呢？

- foo-parent-1
  - bar@1.0.0
  - baz@1.0.0
  - foo@1.0.0
- foo-parent-2
  - bar@1.0.0
  - baz@1.1.0
  - foo@1.0.0

后果是这样（援用官网文档例子）：

node_modules
└── .pnpm
    ├── foo@1.0.0_bar@1.0.0+baz@1.0.0
    │   └── node_modules
    │       ├── foo
    │       ├── bar   -> ../../bar@1.0.0/node_modules/bar
    │       ├── baz   -> ../../baz@1.0.0/node_modules/baz
    │       ├── qux   -> ../../qux@1.0.0/node_modules/qux
    │       └── plugh -> ../../plugh@1.0.0/node_modules/plugh
    ├── foo@1.0.0_bar@1.0.0+baz@1.1.0
    │   └── node_modules
    │       ├── foo
    │       ├── bar   -> ../../bar@1.0.0/node_modules/bar
    │       ├── baz   -> ../../baz@1.1.0/node_modules/baz
    │       ├── qux   -> ../../qux@1.0.0/node_modules/qux
    │       └── plugh -> ../../plugh@1.0.0/node_modules/plugh
    ├── bar@1.0.0
    ├── baz@1.0.0
    ├── baz@1.1.0
    ├── qux@1.0.0
    ├── plugh@1.0.0

能够看到，装置了两个雷同版本的 foo，尽管内容齐全一样，但却别离领有不同的名称：foo@1.0.0_bar@1.0.0+baz@1.0.0、foo@1.0.0_bar@1.0.0+baz@1.1.0。这也是 pnpm 规定严格的体现，任何包都不应该有全局副作用，或者思考好单例实现，否则可能会被 pnpm 装屡次。

硬连贯与软链接的原理

要了解 pnpm 软硬链接的设计，首先要温习一下操作系统文件子系统对软硬链接的实现。

硬链接通过 ln originFilePath newFilePath 创立，如 ln ./my.txt ./hard.txt，这样创立进去的 hard.txt 文件与 my.txt 都指向同一个文件存储地址，因而无论批改哪个文件，都因为间接批改了原始地址的内容，导致这两个文件内容同时变动。进一步说，通过硬链接创立的 N 个文件都是等效的，通过 ls -li ./ 查看文件属性时，能够看到通过硬链接创立的两个文件领有雷同的 inode 索引：

ls -li ./
84976912 -rw-r--r-- 2 author staff 489 Jun 9 15:41 my.txt
84976912 -rw-r--r-- 2 author staff 489 Jun 9 15:41 hard.txt

其中第三个参数 2 示意该文件指向的存储地址有两个硬链接援用。硬链接如果要指向目录就麻烦多了，第一个问题是这样会导致文件的父目录有歧义，同时还要将所有子文件都创立硬链接，实现复杂度较高，因而 Linux 并没有提供这种能力。

软链接通过 ln -s originFilePath newFilePath 创立，能够认为是指向文件地址指针的指针，即它自身领有一个新的 inode 索引，但文件内容仅蕴含指向的文件门路，如：

84976913 -rw-r--r-- 2 author staff 489 Jun 9 15:41 soft.txt -> my.txt

源文件被删除时，软链接也会生效，但硬链接不会，软链接能够对文件夹失效。因而 pnpm 尽管采纳了软硬联合的形式实现代码复用，但软链接自身也简直不会占用多少额定的存储空间，硬链接模式更是零额定内存空间占用，所以对于雷同的包，pnpm 额定占用的存储空间能够约等于零。

全局装置目录 pnpm-store 的组织形式

pnpm 在第三层寻址时采纳了硬链接形式，但同时还留下了一个问题没有讲，即这个硬链接指标文件并不是一般的 NPM 包源码，而是一个哈希文件，这种文件组织形式叫做 content-addressable（基于内容的寻址）。

简略来说，基于内容的寻址比基于文件名寻址的益处是，即使包版本升级了，也仅需存储改变 Diff，而不须要存储新版本的残缺文件内容，在版本治理上进一步节约了存储空间。

pnpm-store 的组织形式大略是这样的：

~/.pnpm-store
- v3
  - files
    - 00
      - e4e13870602ad2922bfc7..
      - e99f6ffa679b846dfcbb1..
      ..
    - 01
      ..
    - ..
      ..
    - ff
      ..

也就是采纳文件内容寻址，而非文件地位寻址的存储形式。之所以能采纳这种存储形式，是因为 NPM 包一经公布内容就不会再扭转，因而适宜内容寻址这种内容固定的场景，同时内容寻址也疏忽了包的构造关系，当一个新包下载下来解压后，遇到雷同文件 Hash 值时就能够摈弃，仅存储 Hash 值不存在的文件，这样就天然实现了结尾说的，pnpm 对于同一个包不同的版本也仅存储其增量改变的能力。

总结

pnpm 通过三层寻址，既贴合了 node_modules 默认寻址形式，又解决了反复文件装置的问题，顺便解决了幻影依赖问题，能够说是包治理的目前最好的翻新，没有之一。

但其刻薄的包治理逻辑，使咱们独自应用 pnpm 治理大型 Monorepo 时容易遇到一些合乎逻辑但又感觉顺当的中央，比方如果每个 Package 对于同一个包的援用版本产生了分化，可能会导致 Peer Deps 了这些包的包产生多份实例，而这些包版本的分化可能是不小心导致的，咱们可能须要应用 Rush 等 Monorepo 管理工具来保障版本的一致性。

探讨地址是：精读《pnpm》· Issue #435 · dt-fe/weekly

如果你想参加探讨，请 点击这里，每周都有新的主题，周末或周一公布。前端精读 – 帮你筛选靠谱的内容。

关注 前端精读微信公众号

<img width=200 src=”https://img.alicdn.com/tfs/TB165W0MCzqK1RjSZFLXXcn2XXa-258-258.jpg”>

版权申明：自在转载 - 非商用 - 非衍生 - 放弃署名（创意共享 3.0 许可证）

退出移动版