包管理工具详解（一）--npm、版本依赖、install原理、yarn、cnpm、npx、npm包发布

看月亮的方源
172 阅读9分钟

1. 代码共享方案

  1. 我们已经学习了在JavaScript中可以通过模块化的方式将代码划分成一个个小的结构：
  • 在以后的开发中我们就可以通过模块化的方式来封装自己的代码，并且封装成一个工具；
  • 这个工具我们可以让同事通过导入的方式来使用，甚至你可以分享给世界各地的程序员来使用；
  1. 如果我们分享给世界上所有的程序员使用，有哪些方式呢？
  2. 方式一：上传到GitHub上、其他程序员通过GitHub下载我们的代码手动的引用；
  • 缺点是大家必须知道你的代码GitHub的地址，并且从GitHub上手动下载；
  • 需要在自己的项目中手动的引用，并且管理相关的依赖；
  • 不需要使用的时候，需要手动来删除相关的依赖；
  • 当遇到版本升级或者切换时，需要重复上面的操作；
  1. 显然，上面的方式是有效的，但是这种传统的方式非常麻烦，并且容易出错；
  2. 方式二：使用一个专业的工具来管理我们的代码
  • 我们通过工具将代码发布到特定的位置；
  • 其他程序员直接通过工具来安装、升级、删除我们的工具代码；
  1. 显然，通过第二种方式我们可以更好的管理自己的工具包，其他人也可以更好的使用我们的工具包。

2. 包管理工具npm

  1. 包管理工具npm：
  • Node Package Manager，也就是Node包管理器；
  • 但是目前已经不仅仅是Node包管理器了，在前端项目中我们也在使用它来管理依赖的包；
  • 比如vue、vue-router、vuex、express、koa、react、react-dom、axios、babel、webpack等等；
  1. 如何下载和安装npm工具呢？
  • npm属于node的一个管理工具，所以我们需要先安装Node；
  • node管理工具：nodejs.org/en/， 安装Node的过程会自动安装npm工具；
  • npm管理的包可以在哪里查看、搜索呢？
  • www.npmjs.org/
  • 这是我们安装相关的npm包的官网；
  1. npm管理的包存放在哪里呢？
  • 我们发布自己的包其实是发布到registry上面的；
  • 当我们安装一个包时其实是从registry上面下载的包；

3. npm的配置文件

  1. 那么对于一个项目来说，我们如何使用npm来管理这么多包呢？
  • 事实上，我们每一个项目都会有一个对应的配置文件，无论是前端项目（Vue、React）还是后端项目（Node）；
  • 这个配置文件会记录着你项目的名称、版本号、项目描述等；
  • 也会记录着你项目所依赖的其他库的信息和依赖库的版本号；

3.1 package.json文件配置

  1. 这个配置文件就是package.json image.png
  2. 那么这个配置文件如何得到呢？
  • 方式一：手动从零创建项目，npm init –y
  • npm -init -y 直接默认同意，直接生成 image.png
  • 方式二：通过脚手架创建项目，脚手架会帮助我们生成package.json，并且里面有相关的配置
  1. 常见的配置文件

image.png

3.2 packhage.json常见的属性

  1. 必须填写的属性：name、version
  • name是项目的名称；
  • version是当前项目的版本号；
  • description是描述信息，很多时候是作为项目的基本描述；
  • author是作者相关信息（发布时用到）；
  • license是开源协议（发布时用到）；
  1. privat属性：
  • private属性记录当前的项目是否是私有的；
  • 当值为true时，npm是不能发布它的，这是防止私有项目或模块发布出去的方式
  1. main属性：
  • 设置程序的入口。
    • 比如我们使用axios模块 const axios = require('axios');
    • 如果有main属性，实际上是找到对应的main属性查找文件的；

image.png 4. scripts属性

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

默认开发环境和生产环境都有

  • dependencies属性是指定无论开发环境还是生成环境都需要依赖的包；
  • 通常是我们项目实际开发用到的一些库模块vue、vuex、vue-router、react、react-dom、axios等等；
  • 与之对应的是devDependencies；
  1. devDependencies属性,开发依赖，生产环境用不到。
npm install label --save-dev

简写

npm intsall label -D
  • 一些包在生成环境是不需要的，比如webpack、babel等；
  • 这个时候我们会通过 npm install webpack --save-dev，将它安装到devDependencies属性中；
  1. peerDependencies属性
  • 还有一种项目依赖关系是对等依赖，也就是你依赖的一个包，它必须是以另外一个宿主包为前提的；
  • 比如element-plus是依赖于vue3的，ant design是依赖于react、react-dom；
  1. engines属性
  • engines属性用于指Node和NPM的版本号；
  • 在安装的过程中，会先检查对应的引擎版本，如果不符合就会报错；
  • 事实上也可以指定所在的操作系统 "os" : [ "darwin", "linux" ]，只是很少用到；
  1. browserslist属性
  • 用于配置打包后的JavaScript浏览器的兼容情况，参考；
  • 否则我们需要手动的添加polyfills来让支持某些语法；
  • 也就是说它是为webpack等打包工具服务的一个属性（这里不是详细讲解webpack等工具的工作原理，所以不再给出详情）；

4. 依赖的版本管理

  1. 我们会发现安装的依赖版本出现：^2.0.3或~2.0.3，这是什么意思呢？
  2. npm的包通常需要遵从semver版本规范：
  1. semver版本规范是X.Y.Z：
  • X主版本号（major：当你做了不兼容的 API 修改（可能不兼容之前的版本）；
  • Y次版本号（minor）：当你做了向下兼容的功能性新增（新功能增加，但是兼容之前的版本）；
  • Z修订号（patch）：当你做了向下兼容的问题修正（没有新功能，修复了之前版本的bug）；
  1. 我们这里解释一下 ^和~的区别：
  • x.y.z：表示一个明确的版本号；
  • ^x.y.z：表示x是保持不变的，y和z永远安装最新的版本；
  • ~x.y.z：表示x和y保持不变的，z永远安装最新的版本；

5. npm install 命令

  1. 安装npm包分两种情况：
  • 全局安装（global install）： npm install webpack -g;
  • 项目（局部）安装（local install）： npm install webpack
  1. 全局安装
  • 全局安装是直接将某个包安装到全局：
  • 比如全局安装yarn：
  1. 但是很多人对全局安装有一些误会：
  • 通常使用npm全局安装的包都是一些工具包：yarn、webpack等；
  • 并不是类似于 axios、express、koa等库文件；
  • 所以全局安装了之后并不能让我们在所有的项目中使用 axios等库；

6. 项目安装

image.png

7. npm install 原理

  1. 很多同学之前应该已经会了 npm install ，但是你是否思考过它的内部原理呢？
  • 执行 npm install它背后帮助我们完成了什么操作？
  • 我们会发现还有一个称之为package-lock.json的文件，它的作用是什么？
  • 从npm5开始，npm支持缓存策略（来自yarn的压力），缓存有什么作用呢？
  1. 这是一幅我画出的根据 npm install 的原理图：

image.png

  1. npm install会检测是有package-lock.json文件：
  • 没有lock文件
    • 分析依赖关系，这是因为我们可能包会依赖其他的包，并且多个包之间会产生相同依赖的情况；
    • 从registry仓库中下载压缩包（如果我们设置了镜像，那么会从镜像服务器下载压缩包）；
    • 获取到压缩包后会对压缩包进行缓存（从npm5开始有的）；
    • 将压缩包解压到项目的node_modules文件夹中（前面我们讲过，require的查找顺序会在该包下面查找）
  • 有lock文件
    • 检测lock中包的版本是否和package.json中一致（会按照semver版本规范检测）；
    • 不一致，那么会重新构建依赖关系，直接会走顶层的流程；
    • 一致的情况下，会去优先查找缓存 ➢ 没有找到，会从registry仓库下载，直接走顶层流程；
    • 查找到，会获取缓存中的压缩文件，并且将压缩文件解压到node_modules文件夹中；

8. package-lock.json

记录着所有包之间的依赖 image.png

9. npm其他命令

  1. 我们这里再介绍几个比较常用的：
  2. 卸载某个依赖包：
  • npm uninstall package
  • npm uninstall package --save-dev
  • npm uninstall package -D
  1. 强制重新build npm rebuild
  2. 清除缓存 npm cache clean
  3. npm的命令其实是非常多的：

10. yarn工具

image.png node直接执行 image.png

添加脚本执行

image.png

11. cnpm工具

  1. 由于一些特殊的原因，某些情况下我们没办法很好的从 registry.npmjs.org 下载下来一些需要的包。
  2. 查看npm镜像：
npm config get registry # npm config get registry
  1. 我们可以直接设置npm的镜像：
npm config set registry https://registry.npm.taobao.org
  1. 但是对于大多数人来说，并不希望将npm镜像修改了：
  • 第一，不太希望随意修改npm原本从官方下来包的渠道；
  • 第二，担心某天淘宝的镜像挂了或者不维护了，又要改来改去；
  1. 这个时候，我们可以使用cnpm，并且将cnpm设置为淘宝的镜像： cnpm工具
npm config get registry # npm config get registry npm config set registry https://registry.npm.taobao.org 

npm install -g cnpm --registry=https://registry.npm.taobao.org cnpm config get registry # https://r.npm.taobao.org/

12 . npx工具

  1. npx是npm5.2之后自带的一个命令。
  • npx的作用非常多，但是比较常见的是使用它来调用项目中的某个模块的指令。
  1. 我们以webpack为例：
  • 全局安装的是webpack5.1.3
  • 项目安装的是webpack3.6.0
  1. 如果我在终端执行 webpack --version使用的是哪一个命令呢？
  • 显示结果会是 webpack 5.1.3，事实上使用的是全局的，为什么呢？
  • 原因非常简单，在当前目录下找不到webpack时，就会去全局找，并且执行命令；
  1. window执行某个命令
  • 优先在当前目录下找到命令对的的程序，不会去子目录下查找。
  • 如果找不到，就会去全局查找。

13. npm发布自己的包

image.png

  1. 先进入当前目录
  • 发布之前必须要有一个package.json文件，通过npm init -y生成

image.png

  • 添加关键字

image.png 2. 在npm 官网注册自己的账号

image.png 3. 登录

image.png

  • 查看当前镜像
npm config get registry # npm config get registry
  • 设置的npm镜像
npm config set registry https://registry.npmjs.org/
  • 查看npm 当前登录的用户
 npm whoami
  1. 发布

image.png 5. 使用

image.png

avatar
文章
阅读
粉丝