npm的lock机制解析

npm是什么

npm是一个包管理工具,开源做者能够把开源包发布在平台上供其余人下载使用。前端的同窗基本都使用过npm,这里就不作过多介绍。平常工做中npm的主要用途就是根据项目的package.json使用npm install去安装依赖。前端

npm install能够说是咱们使用最频繁的一个指令。在npm5版本以前,npm install会根据package.json指定的依赖版本去进行安装。但每每package.json中指定的是一个版本范围,例如:vue

"dependencies": {
    "packageA": "^2.0.0"
},
复制代码

以上这个 ^2.0.0 指定的范围是版本号大于等于2.0.0且大版本号为2。即2.6.10这个是符合的,而3.0.0和1.0.0这种是不符合的。npm

这样的范围指定会致使一个问题:A新建了一个项目,生成了上面这份package.json文件,但A安装依赖的时间比较早,此时packageA的最新版本是2.1.0,该版本与代码兼容,没有出现bug。后来B克隆了A的项目,在安装依赖时packageA的最新版本是2.2.0,那么根据语义npm会去安装2.2.0的版本,但2.2.0版本的API可能发生了改动,致使代码出现bug。json

这就是package.json会带来的问题,同一份package.json在不一样的时间和环境下安装会产生不一样的结果。bash

理论上这个问题是不该该出现的,由于npm做为开源世界的一部分,也遵循一个发布原则:相同大版本号下的新版本应该兼容旧版本。即2.1.0升级到2.2.0时API不该该发生变化。工具

但不少开源库的开发者并无严格遵照这个发布原则,致使了上面的这个问题。spa

lock机制

一个新的事物的诞生都是为了解决一个历史问题code

基于这种情况,npm5推出了lock机制。在使用npm5.0.0以后的版本时,npm install后会自动生成package-lock.json文件,该文件记录了当前此次install所安装的依赖版本号。cdn

例如当package.json的依赖以下:blog

"dependencies": {
    "vue": "^2.0.0"
  },
复制代码

install后自动生成的package-lock.json会指定安装vue2.6.10版本(当前最新)

"dependencies": {
    "vue": {
      "version": "2.6.10",
      "resolved": "https://registry.npm.taobao.org/vue/download/vue-2.6.10.tgz",
      "integrity": "sha1-pysaQqTYKnIepDjRtr9V5mGVxjc="
    }
  }
复制代码

package-lock.json至关于本次install的一个快照,它不只记录了package.json指明的直接依赖的版本,也记录了间接依赖的版本。

若是咱们想在不一样环境和不一样时间下每次install时安装相同版本的依赖,咱们就能够把package-lock.json带上。

当package.json和package-lock.json同时存在时,npm install会去检测package-lock.json指定的依赖版本是否在package.json指定的范围内。若是在,则安装package-lock.json指定的版本。若是不在,则忽略package-lock.json,而且用安装的新版本号覆盖package-lock.json。

举个例子:

// package.json
"dependencies": {
    "vue": "^2.0.0"
  }

// package-lock.json
"dependencies": {
    "vue": {
      "version": "2.1.0",
      "resolved": "https://registry.npm.taobao.org/vue/download/vue-2.1.0.tgz",
      "integrity": "sha1-KTuj76rKhGqmvL+sRc+FJMxZfj0="
    }
  }
复制代码

这种状况下package-lock.json指定的2.1.0在^2.0.0指定的范围内,npm install会安装vue2.1.0版本。

// package.json
"dependencies": {
    "vue": "^2.2.0"
  }

// package-lock.json
"dependencies": {
    "vue": {
      "version": "2.1.0",
      "resolved": "https://registry.npm.taobao.org/vue/download/vue-2.1.0.tgz",
      "integrity": "sha1-KTuj76rKhGqmvL+sRc+FJMxZfj0="
    }
  }
复制代码

这种状况下package-lock.json指定的2.1.0不在^2.2.0指定的范围内,npm install会按照^2.2.0的规则去安装最新的2.6.10版本,而且将package-lock.json的版本更新为2.6.10。

值得注意的是npm5一发布时并非采起这种install逻辑,在npm5.0到npm5.6之间install的逻辑发生了屡次变动,而在npm5.6以后一直沿用当前这种逻辑。

npm ci

npm5以后的lock机制知足了要求锁版本的开发者们的须要,咱们只须要拿到一份package-lock.json就能够知道要安装的依赖的具体版本号。但细心的同窗会发现当package-lock.json指定的版本号不在package.json指定的范围内时,package-lock.json就会被更新覆盖。这可不利于咱们去维持版本的固定。

所以后续npm也推出了npm ci的指令来解决这一问题,npm ci和npm i的不一样之处在于:当package-lock.json指定的依赖版本不在package.json指定的依赖版本范围内时,npm会报错并取消安装。

这样咱们就不怕在package-lock和package.json不一致时发生覆盖更新。

总结

在npm5.6之后咱们就能够放心大胆地使用package-lock.json文件来锁版本,而在构建部署时可使用npm ci安装命令来防止npm install的覆盖更新问题。

相关文章
相关标签/搜索