前端工程化-包管理工具npm-yarn-cnpm-pnpm详细介绍以及如何选择

刺骨的言语ヽ痛彻心扉 2023-09-28 14:32 148阅读 0赞

#### 文章目录 ####

*  包管理工具详解
 *   *  npm包管理工具
     *   *  1.代码共享的方案
         *  2.npm包管理工具介绍
         *  3.npm的配置文件
         *   *  常见配置文件
             *  常见配置文件属性
             *  版本号的说明
         *  4.npm install
         *   *  npm install 命令
             *  npm install 原理
             *  package-lock.json解析
         *  5.npm其他命令
         *  6.npm发布包
     *  yarn包管理工具
     *  cnpm包管理工具
     *  npx工具
     *  pnpm包管理工具
     *   *  1.认识pnpm
         *  2.pnpm做了什么
         *  3.pnpm的安装和使用

## 包管理工具详解 ##

### npm包管理工具 ###

#### 1.代码共享的方案 ####

**我们已经学习了在JavaScript中可以通过模块化的方式将代码划分成一个个小的结构**：

*  在以后的开发中我们就可以通过模块化的方式来封装自己的代码，并且封装成一个工具；
 *  这个工具我们可以让同事通过导入的方式来使用，甚至你可以分享给世界各地的程序员来使用；

**如果我们分享给世界上所有的程序员使用，有哪些方式呢？**

**方式一：上传到GitHub上、其他程序员通过GitHub下载我们的代码手动的引用；**

*  **缺点是大家必须知道你的代码GitHub的地址，并且从GitHub上手动下载**；
 *  **需要在自己的项目中手动的引用，并且管理相关的依赖**；
 *  **不需要使用的时候，需要手动来删除相关的依赖**；
 *  **当遇到版本升级或者切换时，需要重复上面的操作**；

**显然，上面的方式是有效的，但是这种传统的方式非常麻烦，并且容易出错；**

--------------------

**方式二：使用一个专业的工具来管理我们的代码**

*  **我们通过工具将代码发布到特定的位置**；
 *  **其他程序员直接通过工具来安装、升级、删除我们的工具代码**；

**显然，通过第二种方式我们可以更好的管理自己的工具包，其他人也可以更好的使用我们的工具包。**

#### 2.npm包管理工具介绍 ####

**包管理工具npm**：

*  Node Package Manager，也就是Node包管理器；
 *  但是目前已经不仅仅是Node包管理器了，在前端项目中我们也在使用它来管理依赖的包；
 *  比如vue、vue-router、vuex、express、koa、react、react-dom、axios、babel、webpack等等；

**如何下载和安装npm工具呢？**

*  npm属于node的一个管理工具，所以我们需要先安装Node；
 *  node管理工具：https://nodejs.org/en/，安装Node的过程会自动安装npm工具；

**npm管理的包可以在哪里查看、搜索呢？**

*  https://www.npmjs.org/
 *  这是我们安装相关的[npm包的官网][npm]；

**npm管理的包存放在哪里呢？**

*  我们发布自己的包其实是发布到registry上面的；
 *  当我们安装一个包时其实是从registry上面下载的包；

#### 3.npm的配置文件 ####

**那么对于一个项目来说，我们如何使用npm来管理这么多包呢？**

*  事实上，我们每一个项目都会有一个对应的配置文件，无论是前端项目（Vue、React）还是后端项目（Node）；
 *  这个配置文件会记录着你项目的名称、版本号、项目描述等；
 *  也会记录着你项目所依赖的其他库的信息和依赖库的版本号；

**这个配置文件就是package.json**

**我们有两种方式可以得到这个配置文件**:

**方式一**：手动从零创建项目

*  `npm init` 创建时填写信息
 *  `npm init -y` 所有信息使用默认的

**方式二**：通过脚手架创建项目，脚手架会帮助我们生成package.json，并且里面有相关的配置

##### 常见配置文件 #####

通过npm init 或者 npm init -y 创建的配置文件

![在这里插入图片描述][cdca29ee953e4385bdb240d8416ca1aa.png_pic_center]

Vue CLI4创建的Vue3项目的配置文件

![在这里插入图片描述][0448c3407e4f41a78a96f7bc6eb81633.png_pic_center]

create-react-app创建的react17项目的配置文件

![在这里插入图片描述][8c2c9c636cb145209054d2550fa9f566.png_pic_center]

##### 常见配置文件属性 #####

**必须填写的属性：name、version**

*  **name**是项目的名称；
 *  **version**是当前项目的版本号；
 *  **description**是描述信息，很多时候是作为项目的基本描述；
 *  **author**是作者相关信息（发布时用到）；
 *  **license**是开源协议（发布时用到）；

**private属性:**

*  **private属性**记录当前的**项目是否是私有**的；
 *  **当值为true时，npm是不能发布它的**，这是防止私有项目或模块发布出去的方式；

**main属性：设置程序的入口**

*  比如我们使用axios模块`const axios = require('axios')`;
 *  如果**有main属性，实际上是找到对应的main属性查找文件的**；
 *  简单来说, **main属性就是用来配置入口文件的**

{
        
      "main": "index.js"
    }

**scripts属性: 用于配置一些脚本命令，以键值对的形式存在**

*  配置后我们可以**通过 `npm run` 命令的key来执行这个命令**；
 *  **`npm start` 和 `npm run start` 它们是等价的**；
 *  对于**常用的 start、 test、stop、restart可以省略掉run直接通过 npm start等方式**运行；

{
        
      "script": {
        
        "start": "node ./src/index.js"
      }
    }

**dependencies属性: 是指定无论开发环境还是生产环境都需要依赖的包**

*  通常是我们项目实际开发用到的一些库模块vue、vuex、vue-router、react、react-dom、axios等等；
 *  执行`npm install`会根据dependenciess**自动安装需要依赖的包**
 *  与之对应的是devDependencies；

**devDependencies属性**

*  **一些包在生产环境是不需要**的，比如webpack、babel等；
 *  这个时候**我们会通过** `npm install webpack --save-dev`，将它**安装到devDependencies属性**中；

**peerDependencies属性**

*  还有一种项目依赖关系是**对等依赖**，也就是**你依赖的一个包，而这个包又依赖另外一个包为前提的**；
 *  比如element-plus这个包是依赖于vue3的，ant design这个包是依赖于react、react-dom；

**browserslist属性**

*  用于配置打包后的JavaScript浏览器的兼容情况，参考；
 *  否则我们需要手动的添加polyfills来让支持某些语法；
 *  也就是说它是为webpack等打包工具服务的一个属性（这里不是详细讲解webpack等工具的工作原理，所以不再给出详情）；

##### 版本号的说明 #####

**我们会发现安装的依赖版本出现：^2.0.3或~2.0.3，这是什么意思呢？**

**npm的包通常需要遵从semver版本规范**：

*  semver：https://semver.org/lang/zh-CN/
 *  npm semver：https://docs.npmjs.com/misc/semver

**semver版本规范是X.Y.Z的格式**：

*  **X主版本号（major）**：当你做了不兼容的 API 修改（可能不兼容之前的版本）；
 *  **Y次版本号（minor）**：当你做了向下兼容的功能性新增（新功能增加，但是兼容之前的版本）；
 *  **Z修订号（patch）**：当你做了向下兼容的问题修正（没有新功能，修复了之前版本的bug）；

**我们这里解释一下 ^和~的区别**：

*  **x.y.z**：表示**一个明确的版本号**；
 *  **^x.y.z**：表示**x是保持不变**的，**y和z永远安装最新的版本**；
 *  **~x.y.z**：表示**x和y保持不变**的，**z永远安装最新的版本**；

#### 4.npm install ####

##### npm install 命令 #####

**安装npm包分两种情况**：

*  **全局安装（global install）**： `npm install webpack -g`;
 *  **项目（局部）安装（local install）**： `npm install webpack`;

**全局安装**

*  全局安装是直接将某个包安装到全局：
 *  比如全局安装yarn: `npm install yarn -g`

**但是很多人对全局安装有一些误会**：

*  通常使用**npm全局安装的包都是一些工具包**：yarn、webpack等；
 *  **并不是类似于 axios、express、koa等库文件**；
 *  所以全局安装了之后并不能让我们在所有的项目中使用 axios等库；

--------------------

**项目安装会在当前目录下生成一个 node\_modules 文件夹，我们之前讲解require查找顺序时有讲解过这个包在什么情况下被查找；**

**刚刚我们说过局部安装分为开发时依赖和生产时依赖**：

*  默认安装是开发和生产依赖

`npm install axios`简写为`npm i axios`

*  开发依赖

`npm install webpack --save-dev`简写为`npm i webpack -D`

*  根据package.json中的依赖包

`npm install`

##### npm install 原理 #####

**很多同学之前应该已经会了 npm install <package>，但是你是否思考过它的内部原理呢？**

*  执行 npm install它背后帮助我们完成了什么操作？
 *  我们会发现还有一个称之为package-lock.json的文件，它的作用是什么？
 *  从npm5开始，npm支持缓存策略（来自yarn的压力），缓存有什么作用呢？

**这是一幅 npm install 的原理图**：

![在这里插入图片描述][7f5d1d97a5404f12a77a1effc45042e1.png_pic_center]

**原理图解析: npm install会检测是有package-lock.json文件：**

**没有lock文件**

*  分析依赖关系，这是因为我们可能包会依赖其他的包，并且多个包之间会产生相同依赖的情况；
 *  从registry仓库中下载压缩包（如果我们设置了镜像，那么会从镜像服务器下载压缩包）；
 *  获取到压缩包后会对压缩包进行缓存（从npm5开始有的）；
 *  将压缩包解压到项目的node\_modules文件夹中（前面我们讲过，require的查找顺序会在该包下面查找）

**有lock文件**

*  检测lock中包的版本是否和package.json中一致（会按照semver版本规范检测）；
 *  不一致，那么会重新构建依赖关系，直接会走顶层的流程；
 *  一致的情况下，会去优先查找缓存
 *  没有找到，会从registry仓库下载，直接走顶层流程；
 *  查找到，会获取缓存中的压缩文件，并且将压缩文件解压到node\_modules文件夹中；

##### package-lock.json解析 #####

**name**：项目的名称；

**version**：项目的版本；

**lockfileVersion**：lock文件的版本；

**requires**：使用requires来跟踪模块的依赖关系；

**dependencies**：项目的依赖的包

![在这里插入图片描述][4d1409c17c6243ed9cb4e9cbbf36585d.png_pic_center]

**axios中的属性如下**：

*  **version**表示实际安装的axios的版本；
 *  **resolved**用来记录下载的地址，registry仓库中的位置；
 *  **requires/dependencies**记录当前模块的依赖；
 *  **integrity**用来从缓存中获取索引，再通过索引去获取压缩包文件；

#### 5.npm其他命令 ####

**我们这里再介绍几个比较常用的npm命令**：

**卸载某个依赖包**：

*  `npm uninstall package`
 *  `npm uninstall package --save-dev`
 *  `npm uninstall package -D`

**强制重新build**:

*  `npm rebuild`

**清除缓存**:

`npm cache clean`

**npm的命令其实是非常多的**：

*  更多的命令，可以根据需要查阅官方文档[链接][Link 1]给到大家
 *  https://docs.npmjs.com/cli-documentation/cli

#### 6.npm发布包 ####

**注册npm账号**：

*  https://www.npmjs.com/
 *  选择sign up

**在命令行登录**：

*  `npm login`

**修改package.json**

**发布到npm registry上**

*  `npm publish`

**更新仓库**：

*  修改版本号(最好符合semver规范)
 *  重新发布

**删除发布的包**：

*  `npm unpublish`

**让发布的包过期**：

*  `npm deprecate`

### yarn包管理工具 ###

**另一个node包管理工具yarn**：

*  **yarn是由Facebook、Google、Exponent 和 Tilde 联合推出了一个新的 JS 包管理工具**；
 *  yarn 是为了**弥补早期npm 的一些缺陷而出现的**；
 *  早期的npm存在**很多的缺陷**，比如安装依赖速度很慢、版本依赖混乱等等一系列的问题；
 *  虽然从npm5版本开始，**进行了很多的升级和改进**，但是**依然很多人喜欢使用yarn**；

**yarn的使用方法和npm是相似的, 略微有差异, 我将yarn和npm常用命令列出来对比一下**:

![在这里插入图片描述][9ecea155aff04e04ba693752edc55dcf.png_pic_center]

### cnpm包管理工具 ###

**由于一些特殊的原因，某些情况下我们没办法很好的从 https://registry.npmjs.org下载下来一些需要的包。**

**这个时候我们可以使用国内的淘宝镜像安装**

**方式一: 直接将npm镜像地址改掉**

*  **查看npm镜像**：`npm config get registry`
 *  此时是官渠道 , 我们再输入`npm config set registry https://registry.npm.taobao.org`将其修改为淘宝镜像
 *  **设置完成后使用npm安装就是在淘宝镜像服务器中下载包**

**但是对于大多数人来说（比如我），并不希望将npm镜像修改了**:

*  第一，不太希望随意修改npm原本从官方下来包的渠道；
 *  第二，担心某天淘宝的镜像挂了或者不维护了，又要改来改去；

**方式二: 我们可以使用cnpm，并且将cnpm设置为淘宝的镜像**：

*  输入`npm install -g cnpm --registry=https://registry.npm.taobao.org`命令, 安装cnpm并修改安装渠道为淘宝镜像
 *  再输入`cnpm config get registry`查看是否更换成功
 *  也可以先安装`npm install -g cnpm`,
 *  再修改`cnpm config set registry=https://registry.npm.taobao.org`

**设置完成后使用cnpm安装包就是在淘宝镜像服务器中下载包**

### npx工具 ###

**npx是npm5.2之后自带的一个命令。**

*  npx的作用非常多，但是比较常见的是使用它来调用项目中的**某个模块的指令**。

**我们以yarn为例**：

*  全局安装的是yarn1.1.3
 *  项目安装的是yarn0.28.4

**如果我在终端执行 yarn --version使用的是哪一个命令呢？**

*  显示结果会是 yarn 1.1.3，事实上使用的是全局的，为什么呢？
 *  原因非常简单，**在当前目录下找不到webpack时，就会去环境变量中找到全局，并且执行命令**；

**如何解决这个问题呢？**

**那么如何使用项目（局部）的webpack，常见的方式是**：

**方式一：在终端中进入如下文件夹, 再命令（在项目根目录下）**

*  进入文件夹 ./node\_modules/.bin, 再执行`webpack --version`

**方式二：修改package.json中的scripts**

"scripts": {
        
    	"yarn": "yarn --version"
    }

再通过输入`npm run yarn`运行

**方式三：使用npx工具**

*  终端中输入: `npx webpack --version`

**npx的原理非常简单，它会到当前目录的node\_modules/.bin目录下查找对应的命令；**

### pnpm包管理工具 ###

#### 1.认识pnpm ####

**什么是pnpm呢？我们来看一下官方的解释**：

*  pnpm：我们可以理解成是performant npm缩写；
 *  **pnpm官网介绍的是: 速度快, 节省磁盘空间的软件包管理工具**

**pnpm的优势**:

*  快速: 比**其他包管理器快两倍**
 *  高效: node\_modules中的**文件链接自特定的内容寻址存储库**
 *  支持monorepos: pnpm内置**支持单仓多包**
 *  严格: pnpm默认创建了一个非平铺的node\_modules, 因此**代码无法访问任意包**

**哪些公司在用呢？**

*  包括Vue在内的很多公司或者开源项目的包管理工具都切换到了pnpm；

![在这里插入图片描述][502cf986ece24a59a17a2e2e2bdd4805.png_pic_center]

--------------------

#### 2.pnpm做了什么 ####

**当使用 npm 或 Yarn 时，如果你有 100 个项目，并且所有项目都有一个相同的依赖包，那么， 你在硬盘上就需要保存 100 份该相同依赖包的副本。**

**如果是使用 pnpm，依赖包将被 存放在一个统一的位置，因此**：

*  如果你**对同一依赖包使用相同的版本**，那么**磁盘上只有这个依赖包的一份文件**；
 *  如果你**对同一依赖包需要使用不同的版本**，则**仅有版本之间不同的文件会被存储起来**；

**所有文件都保存在硬盘上的统一的位置**：

*  当安装软件包时， 其包含的**所有文件都会硬链接到此位置**，而**不会占用额外的硬盘空间**；
 *  这让你可以在项目之间方便地共享相同版本的依赖包；

**简单来说**:

*  **同样的包在磁盘只有一份, 当需要的包已经存在, 那么会直接创建硬链接指向磁盘的包**
 *  **如果不存在, 那么会下载到硬盘的同一位置, 如果再有其他项目使用该包, 直接创建硬链接即可**

**pnpm创建非扁平的 node\_modules 目录**

*  当使用 npm 或 Yarn 安装依赖包时，所有**软件包都将被提升到 node\_modules 的 根目录下**。
 *  其结果是，由于安装的包可能会依赖其他的包, **导致源码可以访问本不属于当前项目所设定的依赖包**；
 *  而pnpm的**非扁平目录可以防止项目访问本不属于当前项目所设定的依赖包**

**下面一幅图解释了pnpm的目录结构**

![在这里插入图片描述][9cfe234e41324fbaaeb41781fceb66ef.png_pic_center]

#### 3.pnpm的安装和使用 ####

**那么我们应该如何安装pnpm呢？**

*  **官网上提供了很多种方式来安装pnpm**：https://www.pnpm.cn/installation
 *  因为我们之前安装过Node，Node中有npm，所以我们**通过npm安装即可**: `npm i pnpm -g`

**以下 pnpm 是一个与 npm 常用命令的等价对照表，帮助你快速入门**：

<table> 
 <thead> 
  <tr> 
   <th>npm 命令</th> 
   <th>pnpm 等价命令</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>npm install</td> 
   <td>pnpm install</td> 
  </tr> 
  <tr> 
   <td>npm install &lt;pkg&gt;</td> 
   <td>pnpm add &lt;pkg&gt;</td> 
  </tr> 
  <tr> 
   <td>npm uninstall &lt;pkg&gt;</td> 
   <td>pnpm remove &lt;pkg&gt;</td> 
  </tr> 
  <tr> 
   <td>npm run &lt;cmd&gt;</td> 
   <td>pnpm &lt;cmd&gt;</td> 
  </tr> 
 </tbody> 
</table>

更多命令和用法可以参考pnpm的官网：https://pnpm.io/zh/

**另外一个非常重要的store命令是prune（修剪）：从store中删除当前未被引用的包来释放store的空间**

*  `pnpm store prune`

[npm]: https://www.npmjs.org/
[cdca29ee953e4385bdb240d8416ca1aa.png_pic_center]: https://img-blog.csdnimg.cn/cdca29ee953e4385bdb240d8416ca1aa.png#pic_center
[0448c3407e4f41a78a96f7bc6eb81633.png_pic_center]: https://img-blog.csdnimg.cn/0448c3407e4f41a78a96f7bc6eb81633.png#pic_center
[8c2c9c636cb145209054d2550fa9f566.png_pic_center]: https://img-blog.csdnimg.cn/8c2c9c636cb145209054d2550fa9f566.png#pic_center
[7f5d1d97a5404f12a77a1effc45042e1.png_pic_center]: https://img-blog.csdnimg.cn/7f5d1d97a5404f12a77a1effc45042e1.png#pic_center
[4d1409c17c6243ed9cb4e9cbbf36585d.png_pic_center]: https://img-blog.csdnimg.cn/4d1409c17c6243ed9cb4e9cbbf36585d.png#pic_center
[Link 1]: https://docs.npmjs.com/cli-documentation/cli
[9ecea155aff04e04ba693752edc55dcf.png_pic_center]: https://img-blog.csdnimg.cn/9ecea155aff04e04ba693752edc55dcf.png#pic_center
[502cf986ece24a59a17a2e2e2bdd4805.png_pic_center]: https://img-blog.csdnimg.cn/502cf986ece24a59a17a2e2e2bdd4805.png#pic_center
[9cfe234e41324fbaaeb41781fceb66ef.png_pic_center]: https://img-blog.csdnimg.cn/9cfe234e41324fbaaeb41781fceb66ef.png#pic_center