前端包管理工具

243 阅读8分钟

1.npm

包管理工具是我们前端开发人员经常使用的工具,非常地方便好用,包管理工具全称Node Package Manager(Node包管理器),简称npm,当我们下载node.js的时候已经顺带下载好了npm,我们可以在终端输入 npm -v 查看npm的版本:

image.png

现在来看,它已经不仅仅是node包管理器了,我们也经常用它来管理依赖的包。

我们用npm安装的各种包都是从npm官网网站下载过来的,这个网站上的各种包是由全世界成千上万的开发者上传的。

点击进入npm官网

image.png

1.1 npm配置文件package.json

对于一个项目来说,可能有非常多的包,我们如何使用npm来管理这么多包呢?

事实上,我们每一个项目都会有一个对应的配置文件,无论是前端项目(Vue、React)还是后端项目(Node);

这个配置文件会记录着你项目的名称、版本号、项目描述等;

也会记录着你项目所依赖的其他库的信息和依赖库的版本号;

这个配置文件就是package.json

那么这个配置文件如何得到呢?

方式一:手动从零创建项目,npm init –y

image.png

方式二:通过脚手架创建项目,脚手架会帮助我们生成package.json,并且里面有相关的配置,如图是用vue cli脚手架创建的项目

image.png

如图所示,package.json文件中有很多属性,

name是项目的名称;

version是当前项目的版本号;

description是描述信息,很多时候是作为项目的基本描述;

author是作者相关信息(发布时用到);

license是开源协议(发布时用到 private属性:

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

main属性:设置程序的入口。

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

配置后我们可以通过 npm run 命令的key来执行这个命令;

npm start和npm run start的区别是什么? 它对于常用的 start、 test、stop、restart可以省略掉run直接通过 npm start等方式运行;

dependencies属性

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

通常是我们项目实际开发用到的一些库模块vue、vuex、vue-router、react、react-dom、axios等等;

与之对应的是devDependencies;

devDependencies属性

一些包在生成环境是不需要的,比如webpack、babel等;

这个时候我们会通过 npm install webpack --save-dev,将它安装到devDependencies属性中;

peerDependencies属性

还有一种项目依赖关系是对等依赖,也就是你依赖的一个包,它必须是以另外一个宿主包为前提的;

比如element-plus是依赖于vue3的,ant design是依赖于react、react-dom;

1.2 依赖的版本管理

我们会发现安装的依赖版本出现:^2.0.3或~2.0.3,这是什么意思呢?因为npm的包通常需要遵从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永远安装最新的版本;

1.3 npm install的使用细节

安装npm包分两种情况:

全局安装(global install): npm install XXX -g;

局部安装(local install): npm install XXX

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

局部安装分为开发时依赖和生产时依赖:

默认安装开发和生产依赖

npm install axios

npm i axios

开发依赖

npm install webpack --save-dev

npm install webpack -D

npm i webpack –D

根据package.json中的依赖包

npm install

1.4 npm install 原理

下面这是一个npm安装依赖的流程图

image.png

除了package.json,我们会发现还有一个称之为package-lock.json的文件,它的主要作用就是缓存。npm install安装依赖时,会检测是有package-lock.json文件:

  • 没有lock文件

✓ 分析依赖关系,这是因为我们可能包会依赖其他的包,并且多个包之间会产生相同依赖的情况;

✓ 从registry仓库中下载压缩包(如果我们设置了镜像,那么会从镜像服务器下载压缩包);

✓ 获取到压缩包后会对压缩包进行缓存(从npm5开始有的);

✓ 将压缩包解压到项目的node_modules文件夹中

  • 有lock文件

✓ 检测lock中包的版本是否和package.json中一致(会按照semver版本规范检测);

➢ 不一致,那么会重新构建依赖关系,直接会走顶层的流程;

✓ 一致的情况下,会去优先查找缓存

➢ 没有找到,会从registry仓库下载,直接走顶层流程;

✓ 查找到,会获取缓存中的压缩文件,并且将压缩文件解压到node_modules文件夹中;

package-lock.json文件解析:

image.png

name:项目的名称;

◼ version:项目的版本;

◼ lockfileVersion:lock文件的版本;

◼ requires:使用requires来跟踪模块的依赖关系;

◼ dependencies:项目的依赖

当前项目依赖axios,但是axios依赖follow-redireacts;

axios中的属性如下:

✓ version表示实际安装的axios的版本;

✓ resolved用来记录下载的地址,registry仓库中的位置;

✓ requires/dependencies记录当前模块的依赖;

✓ integrity用来从缓存中获取索引,再通过索引去获取压缩包文件;

npm其他命令

卸载某个依赖包:

npm uninstall package

npm uninstall package --save-dev

npm uninstall package -D

强制重新build

npm rebuild

清除缓存

npm cache clean

2.yarn

yarn是由Facebook、Google、Exponent 和 Tilde 联合推出了一个新的 JS 包管理工具; yarn 是为了弥补 早期npm 的一些缺陷而出现的;

早期的npm存在很多的缺陷,比如安装依赖速度很慢、版本依赖混乱等等一系列的问题;

虽然从npm5版本开始,进行了很多的升级和改进,但是依然很多人喜欢使用yarn;

yarn和npm的指令对比

image.png

3.cnpm

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

查看npm镜像:

npm config get registry

我们可以直接设置npm的镜像:

npm config set registry registry.npm.taobao.org

但是对于大多数人来说(比如我),并不希望将npm镜像修改了 ,不太希望随意修改npm原本从官方下来包的渠道;这个时候,我们可以使用cnpm,并且将cnpm设置为淘宝的镜像:

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

4.pnpm

pnpm:我们可以理解成是performant npm缩写;在官方介绍中,它有几个非常突出的优势:

1.快速(比其他包管理快2倍)

2.高效率

3支持monorepos

4.严格

很多一线大公司也在逐步使用pnpm。

为什么会出现pnpm呢?我们先来看npm 和 yarn的痛点:

当使用 npm 或 Yarn 时,如果你有 100 个项目,并且所有项目都有一个相同的依赖包,那么, 你在硬盘上就需要保存 100 份该相同依赖包的副本。这就非常消耗空间,因此,pnpm应运而生。

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

如果你对同一依赖包使用相同的版本,那么磁盘上只有这个依赖包的一份文件;

如果你对同一依赖包需要使用不同的版本,则仅有 版本之间不同的文件会被存储起来;

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

✓ 当安装软件包时, 其包含的所有文件都会硬链接到此位置,而不会占用 额外的硬盘空间;

✓ 这让你可以在项目之间方便地共享相同版本的 依赖包;

为什么pnpm可以做到这些? 什么原理呢?

这里就不得不提一下 软链接、硬链接。

符号链接(软链接soft link、Symbolic link):

 符号链接(软链接、Symbolic link)是一类特殊的文件;

 其包含有一条以绝对路径或者相对路径的形式指向其它文件或者目录的引用;

硬链接(hard link):

 硬链接(英语:hard link)是电脑文件系统中的多个文件平等地共享同一个文件存储单元;

 删除一个文件名字后,还可以用其它名字继续访问该文件;

举个例子,我们在windows系统中,看到一个aaa.MP4文件,这个文件真实存放于磁盘中,如果我们创建一个aaa.mp4文件的快捷方式,这个快捷方式里的内容只是aaa.mp4文件的绝对路径或者相对路径,此时这个快捷方式相当于我们所说的软连接,如果我们创建一个aaa.mp4的硬链接文件,这个硬链接文件也指向磁盘中相同位置,和aaa.mp4共享磁盘中的真实文件。

我们上图示意一下:

image.png

image.png

pnpm常用指令

image.png