了解`npm install`命令_npm install命令-CSDN博客

本文链接：https://blog.csdn.net/kaka_buka/article/details/144846838

了解`npm install`命令

npm install几乎是每个JavaScript开发者日常工作的一部分。然而，npm install到底在做什么？为什么在项目初次启动时必须执行它？而且，它与其他编程语言生态中的类似工具（比如Java的Maven）相比有哪些独特之处？

`npm install`的核心作用

简单来说，npm install会根据项目的package.json文件中定义的依赖项，把项目所需的所有库和工具安装到本地环境中。

`npm install`到底做了什么？

解析依赖项：首先，npm install会读取项目根目录下的package.json文件，该文件记录了项目所需的依赖项以及它们的版本信息。
安装依赖包：解析完依赖信息后，npm install会访问npm官方仓库或者其他配置的包源，根据指定的版本范围下载项目需要的库。
构建依赖树：依赖包之间往往相互依赖，比如你的项目可能依赖A库，而A库又依赖于B和C库。npm install会递归解析所有依赖，构建出一个完整的依赖树。
存储依赖：在解析和下载完毕后，npm会将这些包放到项目的node_modules文件夹中。这是项目的本地依赖目录，包含了项目运行或构建所需的所有外部库。
生成或更新lock文件：在npm install的过程中，npm会根据实际安装的依赖版本生成或更新package-lock.json文件。这个文件记录了每一个依赖的确切版本，保证即使是其他开发者克隆项目后，安装的依赖库版本也保持一致。

`npm install`的工作流程

在一个干净的项目目录中（没有node_modules文件夹），npm install的流程如下：

读取package.json文件：确定需要安装的依赖项和版本。
生成或更新package-lock.json文件：确保每个人使用的依赖版本一致。
安装依赖到node_modules目录：所有外部依赖库都集中安装到这里。
执行任何postinstall脚本：有些库在安装后需要执行额外的脚本，npm会自动运行这些脚本。

为什么在项目启动时必须执行`npm install`？

在初次启动时，项目并不包含node_modules目录。这个目录通常不放入版本控制系统（例如Git），因为node_modules目录体积庞大，且包含的文件可以通过依赖信息重新生成。因此在获取新项目的代码后，我们必须手动执行npm install，从而为项目安装所需的依赖包，否则项目将缺少依赖库而无法运行。

此外，即使是一个老项目，在引入新的依赖或更新已有依赖版本后，仍然需要重新执行npm install来保证项目的依赖完整性。

与Java中的Maven对比

Java中最常用的构建和依赖管理工具之一是Maven。Maven与npm有许多相似之处，但在实现细节和一些核心概念上有所区别。

相似之处

依赖管理：Maven的pom.xml类似于npm的package.json，都用于定义项目的依赖项。Maven会在pom.xml中记录项目需要的库及其版本号，mvn install命令会根据这个文件下载和安装依赖。
依赖树的解析：Maven和npm都会递归解析依赖项并构建依赖树，确保所有的依赖项都能正常安装。
本地缓存机制：npm和Maven都会缓存已下载的依赖库，减少重复下载的开销。

不同之处

依赖安装位置：npm的依赖会直接安装在项目根目录下的node_modules文件夹，而Maven会把所有依赖统一缓存到本地仓库（通常是~/.m2/repository目录），在项目构建时从这个位置引用库文件。
构建过程：Maven不仅仅是依赖管理工具，更是一个完整的构建工具，它能编译代码、运行测试、打包并发布构建产物。而npm虽然也可以执行构建任务，但通常依赖于其他工具（如Webpack或Gulp）来完成复杂的构建任务。
依赖冲突处理：Maven默认遵循最近定义原则（nearest-wins），即选择依赖树中离根节点最近的版本。而npm在早期版本（npm 2之前）对版本冲突处理较简单，npm 3及之后则会通过扁平化依赖树来尽量减少重复依赖项。
锁定文件：npm使用package-lock.json锁定依赖版本，保证团队中的每个人都使用相同的版本。Maven则不具备完全相同的机制，它通常通过指定明确的版本号来减少差异。

`npm install` 常见参数解析

在运行npm install时，可以根据需求添加一些常见的参数，以定制安装方式和依赖管理策略。以下是一些常见的参数及其作用：

1. `--save` 与 `--save-dev`

--save：将安装的依赖添加到package.json的dependencies字段中，适用于项目在运行时需要的依赖包。通常，npm install <package>默认带有--save效果，因此这一参数在npm 5及之后版本中已不常用。
--save-dev：将安装的依赖添加到devDependencies字段中。这类依赖仅在开发环境中使用，例如构建工具、测试框架等，不会随项目发布。

2. `--global` 或 `-g`

-g / --global：全局安装依赖包，将包安装在系统全局目录中，而不是当前项目的node_modules文件夹中。全局安装适用于项目不依赖的工具，如eslint、http-server等命令行工具。全局安装的包可在终端中作为命令直接使用。

3. `--no-save`

--no-save：仅临时安装依赖，不会将其写入package.json文件。用于快速试用某个库或测试某个依赖的效果，但不希望影响项目的依赖配置。

4. `--no-package-lock`

--no-package-lock：跳过生成或更新package-lock.json文件。通常建议保留package-lock.json文件以锁定依赖版本，但在某些特殊情况下可以使用该参数避免更新。

5. `--legacy-peer-deps`

--legacy-peer-deps：忽略peerDependencies版本冲突，适用于当某些库的依赖版本之间存在冲突时。该参数会让npm忽略这些冲突并尝试安装，不会中断安装过程。通常用于临时解决依赖冲突问题。

6. `--force`

--force：强制重新安装所有依赖，不论当前是否已安装过。该参数会覆盖node_modules目录中的内容，适用于依赖或node_modules损坏的情况。它可用于排除一些常见的安装错误。

7. `--production`

--production：仅安装dependencies字段下的依赖，跳过devDependencies，通常在生产环境中使用，以减少不必要的开发依赖。

8. `--dry-run`

--dry-run：在实际安装前模拟安装过程。使用此参数可以查看依赖树和可能的变更，而不会真的下载或更改node_modules，用于调试和预检查安装过程。

如何在国内环境加速`npm install`命令

由于国内网络环境的原因，访问npm官方源可能会导致下载速度较慢，甚至出现超时。为了加速npm install命令的执行，可以使用国内镜像或工具来优化。

1. 使用淘宝镜像

阿里巴巴提供了npm的国内镜像（cnpm），该镜像与官方源实时同步。可以通过以下方式配置镜像源：

npm install -g cnpm --registry=https://registry.npmmirror.com

安装后，使用cnpm install代替npm install进行依赖安装。cnpm是npm的一个替代命令，它会自动从淘宝镜像下载依赖。

2. 临时设置镜像源

如果不想安装额外工具，可以直接用命令指定npm镜像源：

npm install --registry=https://registry.npmmirror.com

这样可以临时将npm install切换至淘宝镜像进行依赖下载。

3. 使用`nrm`快速切换镜像源

nrm（Node Registry Manager）是一个用于管理和快速切换npm镜像源的工具，支持多个常用源如淘宝镜像、npm官方源等。安装和使用如下：

npm install -g nrm
nrm ls                # 查看可用镜像源
nrm use taobao        # 切换到淘宝镜像

使用nrm可以快速切换镜像源，便于在不同环境中灵活选择合适的npm源。

4. Yarn或pnpm替代npm

Yarn和pnpm是两个常见的npm替代工具，都能加速依赖安装。它们在本地缓存机制上有所优化，因此后续安装相同依赖时会更快。国内用户可以结合淘宝镜像或其他镜像源来进一步提升下载速度：

yarn config set registry https://registry.npmmirror.com

5. 配置永久镜像源

若希望每次npm install都使用淘宝镜像，可以在配置中永久设置npm源：

npm config set registry https://registry.npmmirror.com

这样即使不加额外参数，npm install也会自动通过国内镜像下载依赖。

其他 `npm install` 执行速度非常慢的情况

1. 清理缓存或重建 `node_modules`

有时缓存损坏或依赖冲突可能导致安装时间过长，清理缓存可以帮助解决此类问题：

npm cache clean --force

在清理缓存后，可以删除 node_modules 文件夹和 package-lock.json 文件，然后重新执行安装：

rm -rf node_modules package-lock.json
npm install

2. 使用 `--prefer-offline` 选项

如果项目的依赖包在本地缓存中存在，可以用 --prefer-offline 优先从缓存安装，减少对网络的依赖：

npm install --prefer-offline

总结

npm install是JavaScript项目初次启动的关键命令，它通过解析和安装项目依赖，使得项目能够顺利运行。与Java中的Maven相比，npm在依赖管理上更灵活，而Maven则在构建过程和依赖冲突处理上具有优势。理解这两者的相似与不同之处，有助于在跨语言和跨框架开发时更好地管理项目依赖。

在日常开发中，记得在项目初次启动时执行npm install，这样才能避免运行时缺少依赖而导致的“崩溃”时刻！