模块化开发在前端越来越流行,使用node和npm可以很方便的下载管理项目所需要的依赖模块。package.json就是用来描述项目及项目所依赖的信息模块。那package.json和package-lock.json有什么关联呢。
一、package.json
通过npm包管理工具,命令行npminstall可以自动生成package.json。
dependencies和devDependencies
devDependencies下列出的模块,是我们开发时用的依赖项,像一些进行单元测试之类的包,比如jest,我们用写单元测试,它们不会被部署到生产环境。
dependencies下的模块,则是我们生产环境中需要的依赖,即正常运行该包时所需要的依赖项。
语义化版本:
使用第三方依赖时,通常需要指定依赖的版本范围,比如:
"dependencies":{
"core-js":"^3.8.3",
"axios":"^1.3.1",
"element-ui":"^2.15.12",
"vue-router":"^3.6.5",
"vuex":"^3.6.2",
"vue":"^2.6.14"
},
版本号由三部分组成:major.minor.patch,主版本号.次版本号.修补版本号。
例如:"vue-router":"^3.6.5",主要版本3,次要版本6,补丁5。
补丁中的更改表示不会破坏任何内容的错误修复。
次要版本的更改表示不会破坏任何内容的新功能。
主要版本的更改代表了一个破坏兼容性的大变化。如果用户不适应主要版本更改,则内容将无法正常工作。
^向上尖号是定义向后(新)兼容依赖,在大版本上相同,就允许下载最新的包。
语义化版本规则定义了一种理想的版本号更新规则,希望所有的依赖更新都能遵循这个规则,但是往往会有许多依赖不是严格遵循这些规定的。
因此,如何管理好这些依赖,尤其是这些依赖的版本就显得尤为重要,否则一不小心就会陷入因依赖版本不一致导致的各种问题中。
二、问题的产生
当我们使用了^或者其他符号来控制依赖包版本号的时候,多人开发,就有可能存在大家安装的依赖包版本不一样的情况,就会存在项目运行的结果不一样。
场景
安装vue后,我们可以在项目中的package.json中看到版本号为vue:^3.0.0,这也是我们电脑中的版本号。然而,时间一长,vue发布了新版本3.0.1。如果一个新同事克隆了项目并执行了npminstall,那么他电脑中的vue版本将会是3.0.1。因为^仅锁定了主版本,所以我们的电脑中的vue版本会不一致。理论上来说,它们应该是兼容的(如果大家都遵循语义版本控制),但是bugfix可能会影响我们正在使用的功能。此外,当使用不同版本的vue运行时,应用程序也会产生不同的结果。
大家思考思考,这样的话,不同人电脑安装的依赖版项目,是不是都有可能不一样,就会导致每个人电脑运行的应用程序产生不同的结果。就会存在bug的隐患。
问题产出的原因
package.json文件只能锁定大版本,即版本号的第一位,不能锁定后面的小版本,你每次npminstall时候拉取的该大版本下面最新的版本
解决办法
为了解决npminstall的不确定性问题,在npm5.x版本新增了package-lock.json文件
当你执行npminstall的时候,node从package.json文件读取模块名称,从package-lock.json文件中获取版本号,然后进行下载或者更新。
三、package-lock.json
package-lock.json它会在npm更改node_modules目录树或者package.json时自动生成的,它准确的描述了当前项目npm包的依赖树,并且在随后的安装中会根据package-lock.json来安装,保证是相同的一个依赖树,不考虑这个过程中是否有某个依赖有小版本的更新。
package-lock.json文件可以锁定所有模块的版本号,包括主模块和所有依赖子模块。package-lock.json的作用是锁定依赖结构,即只要你目录下有package-lock.json文件,那么你每次执行npminstall后生成的node_modules目录结构一定是完全相同的。
package-lock.json生成逻辑
正文例如:我们有如下依赖结构
"dependencies":{
"core-js":"^3.8.3",
"axios":"^1.3.1",
"element-ui":"^2.15.12",
"vue-router":"^3.6.5",
"vuex":"^3.6.2",
"vue":"^2.6.14"
}
在执行npminstall后生成的package-lock.json如下:
"dependencies":{
"axios":{
"version":"1.3.2",
"resolved":"