一、npm

1、代码共享方案

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

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

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

• 方式一：我们将代码上传到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会自动帮助我们安装npm工具
  • node管理工具：http://nodejs.cn/download/

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

  • https://www.npmjs.com/
  • 这是我们安装相关的npm包的官网。

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

  • 我们发布自己的包其实是发布在registry上面的。
  • 当我们安装一个包时其实也是从registry上面下载的包。

nvm是专门给windows来使用的。

查看npm的版本：npm --version

npm在一个项目中会管理很多包，会有一个配置文件 package.json文件，这个文件会记录依赖包的名称、版本

3.npm的配置文件

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

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

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

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

  • 方式一：手动从零创建项目：npm init -y
  • 方式二：通过脚手架创建项目，脚手架会帮助我们生成package.json，并且里面有相关的配置。

3.1 常见的配置文件

• npm init # 创建时填写信息
• npm init -y # 所有信息都使用默认的

3.2 常见的属性

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

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

• private属性

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

• main属性

  • ll设置程序的入口
  • 很多人会有疑惑，webpack不是会自动找到程序的入口吗
  • 这个入口和webpack打包的入口并不冲突
  • 它是在你发布一个模块的时候会用到的
  • 比如我们使用axios模块 const axios=require("axios")
  • 实际上是找到对应的main属性查找文件的。

• scripts属性

  • scripts属性用于配置一些脚本命令，以键值对的形式存在
  • 配置后 我们可以通过npm run 命令的key来执行这个命令
  • npm start和npm run start的区别是什么呢？
    • 它们是等价的
    • 对于常用的start、test、stop、restart可以省略run直接通过npm start等方式运行。

• dependencies属性

  • dependencies属性是指定无论开发环境还是生产环境都需要依赖的包
    • npm install xxx --save
    • npm install xxx
    • 以上两种方式是等价的，都会将信息记录到dependencies属性中。
  • 通常是我们项目实际开发用到的一些库模块 vue、vuex、vue-router、react、react-dom、axios等等
  • 与之对应的是devDependencies
  • 如果想要跟同事分享代码时，可以将node_modules文件夹删掉，同事拿到后，在命令行终端 运行 npm install，就会根据这个项目的package.json的dependencies属性的依赖的包下载下来，但是对应的第三方包所依赖的包也会被下载下来：例如：本项目使用了axios，但是axios其实依赖了其他包，那么我们也可以通过axios的package.json的dependencies属性所依赖的包也下载下来。

• devDependencies属性

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

• peerDependencies属性

  • 还有一种项目依赖关系是对等依赖，也就是你依赖的一个包，它必须是以另外一个宿主包为前提的。
  • 比如element-plus是依赖于vue3，ant design是依赖于react、react-dom
  • 也就是说 如果 你安装element-plus的时候会先检测环境中有没有vue3环境，如果没有，会发出警告

【在源代码用到的库，都需要安装到dependencies属性中】。

4.依赖的版本管理

我们会发现安装的依赖版本出现：^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）9

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

• ^x.y.z：表示x是保持不变的，y和z永远安装最新的版本。
• ~x.y.z：表示x和y保持不变，z永远安装最新的版本。

image-20220521220657334.png

例如上面：最后安装vue的版本不一定就是3.2.35，一般X保持不变，Y和Z永远安装最新的

package-lock.json文件就是记录真实安装的版本号

image-20220521221059883.png

当我们将项目的node_modules文件夹删掉，在命令行终端 运行 npm install

• 【前提：package.json文化和package-lock.json文件都有的情况下】它会根据package.json的版本去匹配package-lock.json文件中的版本号，如果package-lock.json文件的版本号是符合的，会根据package-lock.json文件的版本号去下载真实的对应的版本号的依赖包。
• 如果没有packge-lock.json文件，一般是根据semver规范来按照依赖包的版本号的。

4.1 常见属性

• engines属性 【以前会出现，现在很少出现了】

  • engines属性用于指定Node和NPM的版本号
  • 在安装的过程中，会先检查对应的引擎版本，如果不符合就会报错
  • 事实上也可以指定所在操作系统 "os":["darwin","linux"]，只是很少用到。

• browserlist属性【这不是package.json文件原本的属性，其实它可以单独写一个配置文件】

  • 用于配置打包后的js浏览器的兼容情况，参考
  • 否则我们需要手动的添加polyfills来让支持某些语法
  • 也就是说 它是为webpack等打包工具服务的一个属性

5.npm install命令

安装npm包分为两种情况：

• 全局安装(global install)：npm install webpack -g
• 项目（局部）安装(local install)：npm install webpack

全局安装

• 全局安装是直接将某个包安装到全局
• 比如yarn的全局安装
• 全局安装的包，在任何地方都可以使用，并且会将对应的可执行命令添加到环境变量中。

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

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

在源代码用到的包，都是需要进行局部安装的。全局安装的包并不会用在源代码中，只是作为一个工具来使用的。

例如：有时候在项目会进行webpack的局部安装，有时候在全局安装webpack，这有什么区别呢？

• 在全局安装webpack是想在命令行执行一些webpack的命令。
• 每个项目为了有针对性，会做一些局部的安装。

6.项目安装

• 项目安装会在当前目录下生产一个node_modules文件夹，我们之前讲解require查找顺序时有讲解过这个包会在什么情况下被查找。

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

  • dependencies：在开发时和生产时都会依赖的包
  • devDependencies：在开发时依赖

• 安装开发和生产依赖

  • npm install axios
  • npm i axios
  • npm i axios --save
  • npm i axios -S

• 开发依赖

  • npm install webpack --save-dev
  • npm install webpack -D
  • npm i webpack -D

• 根据package.json文件安装依赖包

  • npm install
  • npm i

7. npm install原理

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

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

• 这是一幅 我画出的根据npm install的原理图

npm install的原理图-16531956628141.png

7.1 npm install 原理图解析

• npm install会检测是否有package-lock.json文件

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

• 有lock文件

  • 检测lock中包的版本是否和package.json中一致，（会按照semver版本规范检测）

    • 不一致，那么会重新构建依赖关系，直接走顶层流程

  • 一致的情况下，会优先查找缓存

    • 没有找到，会从registry仓库下载，直接走顶层流程

  • 查找到，会获取缓存中的压缩文件，并且将压缩文件解压到node_modules文件夹中。

8.package-json文件的解析

• name：项目的名称

• version：项目的 版本号

• lockfileVersion：当前lock文件的版本

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

  • 例如axios模块，依赖于其他模块，所以也要将其他模块下载下来

• dependencies：记录项目具体依赖的包

• 每个具体的包

  • version：真实的版本号
  • resolved：下载的仓库地址
  • integrity：用来从缓存中获取索引，再通过索引去获取压缩包文件
  • requires：是一个对象，依赖的库

9. npm 其他命令

• 卸载某个依赖包：

  • npm uninstall package
  • npm uninstall package --save-dev
  • npm uninstall package -D
  • 【全局卸载 加一个 -g】

• 强制重新build【强制重新根据package.json文件下载包】

  • npm rebuild
  • 相当于 我们之前的操作 把node_modules文件夹删掉，然后再使用 npm install

• 清除缓存

  • npm cache clean

• 所有的命令：

  • https://docs.npmjs.com/cli/v7/commands

10.发布自己的包

• 填写好package.json文件相关属性

• 确保npm的源就是 https://registry.npmjs.org/

  • npm config get registry

• npm login

• 然后编写自己相关的代码

• npm publish

更新仓库：

• 修改版本号 （最好符合semver规范）
• 重新发布

删除发布的包：

• npm unpublish

让发布的包过期：

• npm deprecate

二、yarn工具

• 另一个node包管理工具yarn

  • yarn是由Facebook、Google、Exponent和Tilde联合推出了一个新的JS包管理工具。
  • yarn是为了弥补npm的一些缺陷而出现的。
  • 早期的npm存在很多的缺陷，比如安装依赖速度很慢、版本依赖混乱等等一系列的问题
    • 早期的npm的node_modules是以树形的结构来管理依赖的，尽管都依赖了同一个包，但还是会在各自的目录下都下载一份。
  • 虽然从npm5版本开始，进行了很多的升级和改进，但是依然很多人喜欢使用yarn

• 安装yarn

  • npm install yarn -g

yarn和npm不能混用

三、cnpm工具

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

• cnpm是一个工具，所以我们可以使用npm进行安装

  • npm install cnpm -g

• 也可以查看和设置cnpm的相关镜像

  • cnpm config get registry
  • cnpm config set registry xxx

• 查看和设置npm的当前仓库源

  • npm config get registry
  • npm config set registry xxx

• 但是对于大多数人来说，并不希望将npm镜像修改了。

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

直接修改npm的镜像是不太合适的，因为国内的有时候并不是实时更新的，国外的镜像是实时更新的。

所以可以平常使用cnpm 来下载对应的包，如果因为某些原因下载不下来，可以改变cnpm的镜像，而不用改官方的npm的镜像

cnpm和npm的使用方法是一样的。

四、npx工具

安装node的时候，会自动安装npx和npm

• 查看npx的版本

  • npx --version

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

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

如果在全局也安装了webpack@ 5.72.1，局部也安装了 webpack@3.6.0

如果当前项目中输入 webpack --version

• 它会去当前目录下查找，有没有webpack这个命令。因为我们安装到的是node_modules/.bin/webpack中
• 没有webpack，会去环境变量中查找，【之前全局安装的东西，会被安装到环境变量中】，所以使用的就是全局的webpack
• 所以输出的版本是 5.72.1

如果想使用局部的webpack命令怎么做呢？

• 可以使用 .\node_modules.bin\webpack --version 去运行

  • 但是这样看起来 特别长，而且不方便使用。

• 在package.json的scripts节点下添加

  • "wjy":"webpack --version"
    

  • 再在命令行终端 运行 npm run wjy

  • 因为npm run会优先 去 node_modules文件夹去查找有没有这个 命令。

• npx webpack --version

  • npx会自动当前目录下的node_modules文件夹看有没有webpack这个命令,如果有就直接使用。

五、总结

包管理工具.png