npm的lock机制解析


Posted in Javascript onJune 20, 2019

npm是什么

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

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

"dependencies": {
  "packageA": "^2.0.0"
},

以上这个 ^2.0.0 指定的范围是版本号大于等于2.0.0且大版本号为2。即2.6.10这个是符合的,而3.0.0和1.0.0这种是不符合的。
这样的范围指定会导致一个问题:A新建了一个项目,生成了上面这份package.json文件,但A安装依赖的时间比较早,此时packageA的最新版本是2.1.0,该版本与代码兼容,没有出现bug。后来B克隆了A的项目,在安装依赖时packageA的最新版本是2.2.0,那么根据语义npm会去安装2.2.0的版本,但2.2.0版本的API可能发生了改动,导致代码出现bug。

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

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

但很多开源库的开发者并没有严格遵守这个发布原则,导致了上面的这个问题。

lock机制

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

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

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

"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会报错并取消安装。

npm的lock机制解析

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

总结

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

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
mailto的使用技巧分享
Dec 21 Javascript
键盘上一张下一张兼容IE/google/firefox等浏览器
Jan 28 Javascript
JS中完美兼容各大浏览器的scrolltop方法
Apr 17 Javascript
解决JS请求服务器gbk文件乱码的问题
Oct 16 Javascript
JS使用eval解析JSON的注意事项分析
Nov 14 Javascript
Node.js 使用命令行工具检查更新
Jun 08 Javascript
解决Vue编译时写在style中的路径问题
Sep 21 Javascript
基于对象合并功能的实现示例
Oct 10 Javascript
傻瓜式vuex语法糖kiss-vuex整理
Dec 21 Javascript
微信小程序实现的自定义分享功能示例
Feb 12 Javascript
layui数据表格重载实现往后台传参
Nov 15 Javascript
微信小程序实现星级评价
Nov 20 Javascript
express如何解决ajax跨域访问session失效问题详解
Jun 20 #Javascript
JS去除字符串最后的逗号实例分析【四种方法】
Jun 20 #Javascript
如何在微信小程序中实现Mixins方案
Jun 20 #Javascript
js JSON.stringify()基础详解
Jun 19 #Javascript
使用jquery-easyui的布局layout写后台管理页面的代码详解
Jun 19 #jQuery
Vue-Cli 3.0 中配置高德地图的两种方式
Jun 19 #Javascript
vue axios重复点击取消上一次请求封装的方法
Jun 19 #Javascript
You might like
如何使用动态共享对象的模式来安装PHP
2006/10/09 PHP
让PHP以ROOT权限执行系统命令的方法
2011/02/10 PHP
thinkPHP5实现数据库添加内容的方法
2017/10/25 PHP
javascript对象的property和prototype是这样一种关系
2007/03/24 Javascript
Js 中debug方式
2010/02/07 Javascript
如何让div span等元素能响应键盘事件操作指南
2012/11/13 Javascript
jQuery使用drag效果实现自由拖拽div
2015/06/11 Javascript
js实现简单排列组合的方法
2016/01/27 Javascript
JS简单编号生成器实现方法(附demo源码下载)
2016/04/05 Javascript
js 获取本地文件及目录的方法(推荐)
2016/11/10 Javascript
深入nodejs中流(stream)的理解
2017/03/27 NodeJs
nodejs服务搭建教程 nodejs访问本地站点文件
2017/04/07 NodeJs
Three.js入门之hello world以及如何绘制线
2017/09/25 Javascript
JS动画定时器知识总结
2018/03/23 Javascript
vue-cli开发环境实现跨域请求的方法
2018/04/07 Javascript
vue .sync修饰符的使用详解
2018/06/15 Javascript
Vuex mutitons和actions初使用详解
2019/03/04 Javascript
在Web关闭页面时发送Ajax请求的实现方法
2019/03/07 Javascript
详解Vuex下Store的模块化拆分实践
2019/07/31 Javascript
详解为什么Vue中不要用index作为key(diff算法)
2020/04/04 Javascript
如何使用jQuery操作Cookies方法解析
2020/09/08 jQuery
python2.7 mayavi 安装图文教程(推荐)
2017/06/22 Python
python实现csv格式文件转为asc格式文件的方法
2018/03/23 Python
selenium+python设置爬虫代理IP的方法
2018/11/29 Python
浅谈pytorch torch.backends.cudnn设置作用
2020/02/20 Python
Python使用Pyqt5实现简易浏览器(最新版本测试过)
2020/04/27 Python
python和php哪个容易学
2020/06/19 Python
css3 border旋转时的动画应用
2016/01/22 HTML / CSS
仿CSDN Blog返回页面顶部功能实现原理及代码
2013/06/30 HTML / CSS
英国家庭、花园、汽车和移动解决方案:Easylife Group
2018/05/23 全球购物
2014两会学习心得:时代的发展
2014/03/17 职场文书
施工协议书范本
2014/04/22 职场文书
辞职信格式范文
2015/05/13 职场文书
2016教师节感恩话语
2015/12/09 职场文书
Python中OpenCV实现简单车牌字符切割
2021/06/11 Python
聊聊配置 Nginx 访问与错误日志的问题
2022/05/25 Servers