npm内部机制与核心原理

news2024/12/30 1:38:01

npm 的核心目标：
Bring the best of open source to you, your team and your company.
npm 最重要的任务是安装和维护开源库。

npm 安装机制与背后思想

npm 的安装机制非常值得探究。Ruby 的 Gem，Python的pip都是全局安装机制，但是npm的安装机制秉承了不同的设计哲学。

它会优先安装依赖包到当前目录，使得不同应用项目的依赖各成体系，同时还能减轻包作者的API兼容性压力，但这样的缺陷也很明显：如果项目A和项目B都依赖的公共库C，那么C一般会在项目A和项目B中各被安装一次。

当然，对于一些工具模块，比如supervisor和gulp，仍然可以使用全局安装模式，这样方便注册path变量，利用我们在任何地方直接使用supervisor、gulp命令。不过，一般建议不同项目维护自己局部的gulp开发工具以适配不同的项目需求。

下面的流程图体现了npm的安装机制：
在这里插入图片描述构建依赖树时，当前依赖项目无论是直接依赖还是子依赖，我们都应该遵循扁平化原则优先将其放置在node_modules根目录下。在这个过程中，遇到相同模块应先判断已放置在依赖树中的模块版本是否符合对新模块版本的要求，如果符合就跳过，不符合则在当前模块的node_modules下放置该模块。

npm 缓存机制

对于一个依赖包的同一版本进行本地化缓存，这是当代依赖包管理工具的常见设计。使用时要先执行以下命令：

npm config get cache
// C:\Users\xxxxxx\AppData\Local\npm-cache

cd命令进入缓存目录可以看到_cacache文件夹。在npm v5版本之后，缓存数据均放在根目录的_cacache中请添加图片描述
content-v2: 存放一些二进制文件。为了使这些二进制文件可读，将文件的扩展名改为.tgz，然后进行解压，得到的结果其实就是npm包资源。
index-v5：存放一些描述性文件，事实上就是content-v2中文件的索引。
tmp：临时文件

这些缓存是如何被存储并利用的呢？

这就和npm install机制联系在一起了。当npm install执行时，会通过pacote将相应的包资源解压在对应的node_modules下面。npm 下载依赖时，会先将依赖下载到缓存中，再将其解压到项目的node_modules下。pacote依赖 npm-registry-fetch 来下载包资源，npm-registry-fetch 可以通过设置cache属性在给定的路径下根据 IETF RFC 7234 生成缓存数据。

接着，在每次安装资源时，根据 package-lock.json 中存储的 integrity、version、name 信息生成一个唯一的 key，这个 key 能对应到 index-v5 下的缓存记录。如果发现有缓存资源，就会找到 tar 包的 hash 值，根据 hash 值找到缓存的包，并再次通过 pacote 将对应的二进制文件解压到相应的项目 node_modules 下，省去了网络下载资源的时间。

npm 不完全指南

自定义 npm init

npm 支持自定义 npm init，快速创建一个符合自己需求的自定义项目。npm init 命令本身并不复杂，它的功能其实就是调用Shell脚本输出一个初始化的package.json文件。相应地，我们要自定义 npm init 命令，就是写一个 Node.js 脚本，它的 module.exports 即为 package.json 配置内容。

为了实现更加灵活的自定义功能，我们可以使用 prompt() 方法，获取用户输入内容：

const desc = prompt('请输入项目描述', '描述...')
module.exports = {
    key: 'value',
    name: prompt('name?', process.cwd().split('/').pop()),
    version: prompt('version?', '0.1.1'),
    description: desc,
    main: 'index.js',
    repository: prompt('github repository url', '', function() {
        if (url) {
            run('touch README.md');
            run('git init');
            run('git add README.md');
            run('git commit -m "first commit"');
            run(`git remote add origin ${url}`);
            run('git push -u origin master');
        }
        return url
    })
}

假设该脚本名为.npm-init.js，执行以下命令来确保 npm init 所对应的脚本指向正确的文件

npm config set init-module ~\.npm-init.js

我们也可以通过配置 npm init 默认字段来自定义 npm init 内容：

npm config set init.author.name "Lucas"
npm config set init.author.email "xxx.com"
npm config set init.author.url "xxx.com"
npm config set init.license "MIT"

npx 的作用

npx 在 npm v5.2 版本中被引入，解决了使用 npm 时面临的快速开发、调试，以及在项目内使用全局模块的痛点。

在传统 npm 模式下，如果需要使用代码检测工具 ESLint，就要先进行安装，命令如下：

npm install eslint --save-dev

然后在项目根目录下执行命令，或通过项目脚本和 package.json 的 npm scripts 字段调用 ESLint。

./node_modules/.bin/eslint --init
./node_modules/.bin/eslint yourfile.js

而使用 npx 就简单多了：

npx eslint --init
npx eslint yourfile.js

npx 可以直接运行 node_modules/.bin 文件夹下的文件。npx 可以自动去node_modules/.bin 路径和环境变量 $PATH 里面检查命令是否存在，而不需要再在 package.json 中定义相关的 script。

npx 另一个更实用的特点是，它在执行模块时会优先安装依赖，但是在安装成功后便删除此依赖，避免了全局安装带来的问题。

npm 多源镜像和企业级部署私服原理

npm 中的源(regsitry) 其实就是一个查询服务。我们可以通过 npm config 命令来设置安装源或某个作用范围域对应的安装源，很多企业也会搭建自己的 npm 源。我们可以通过 npm-preinstall 的钩子和 npm 脚本，在安装公共依赖前自动切换源。

"scripts": {
  "preinstall": "node ./bin/preinstall.js"
}
// 其中 preinstall.js 脚本的逻辑是通过 Node.js 执行 npm config set 命令
require(' child_process').exec('npm config get registry', function(error, stout, stderr) {
  if (!stdout.toString().match(/registry\.x\/com/)) {
    exec('npm config set @xscope:registry https://xxx.com/npm/')
  }
})