你需要知道的几类npm依赖包管理

系统管理员 2021-04-24 14:41 542阅读 0赞

在一个Node.js项目中,package.json几乎是一个必须的文件,它的主要作用就是管理项目中所使用到的外部依赖包,同时它也是npm命令的入口文件。

npm 目前支持以下几类依赖包管理:

  • dependencies
  • devDependencies
  • peerDependencies
  • optionalDependencies
  • bundledDependencies / bundleDependencies

如果你想使用哪种依赖管理,那么你可以将它放在package.json中对应的依赖对象中,比如:

  1. "devDependencies": {
  2. "fw2": "^0.3.2",
  3. "grunt": "^1.0.1",
  4. "webpack": "^3.6.0"
  5. },
  6. "dependencies": {
  7. "gulp": "^3.9.1",
  8. "hello-else": "^1.0.0"
  9. },
  10. "peerDependencies": { },
  11. "optionalDependencies": { },
  12. "bundledDependencies": []

下面我们一一来看:

dependencies

应用依赖,或者叫做业务依赖,这是我们最常用的依赖包管理对象!它用于指定应用依赖的外部包,这些依赖是应用发布后正常执行时所需要的,但不包含测试时或者本地打包时所使用的包。可使用下面的命令来安装:

  1. npm install packageName --save

dependencies是一个简单的JSON对象,包含包名包版本,其中包版本可以是版本号或者URL地址。比如:

  1. {
  2. "dependencies" :{
  3. "foo" : "1.0.0 - 2.9999.9999", // 指定版本范围
  4. "bar" : ">=1.0.2 <2.1.2",
  5. "baz" : ">1.0.2 <=2.3.4",
  6. "boo" : "2.0.1", // 指定版本
  7. "qux" : "<1.0.0 || >=2.3.1 <2.4.5 || >=2.5.2 <3.0.0",
  8. "asd" : "http://asdf.com/asdf.tar.gz", // 指定包地址
  9. "til" : "~1.2", // 最近可用版本
  10. "elf" : "~1.2.3",
  11. "elf" : "^1.2.3", // 兼容版本
  12. "two" : "2.x", // 2.1、2.2、...、2.9皆可用
  13. "thr" : "*", // 任意版本
  14. "thr2": "", // 任意版本
  15. "lat" : "latest", // 当前最新
  16. "dyl" : "file:../dyl", // 本地地址
  17. "xyz" : "git+ssh://git@github.com:npm/npm.git#v1.0.27", // git 地址
  18. "fir" : "git+ssh://git@github.com:npm/npm#semver:^5.0",
  19. "wdy" : "git+https://isaacs@github.com/npm/npm.git",
  20. "xxy" : "git://github.com/npm/npm.git#v1.0.27",
  21. }
  22. }

devDependencies

开发环境依赖,仅次于dependencies的使用频率!它的对象定义和dependencies一样,只不过它里面的包只用于开发环境,不用于生产环境,这些包通常是单元测试或者打包工具等,例如gulp, grunt, webpack, moca, coffee等,可使用以下命令来安装:

  1. npm install packageName --save-dev

举个栗子:

  1. { "name": "ethopia-waza",
  2. "description": "a delightfully fruity coffee varietal",
  3. "version": "1.2.3",
  4. "devDependencies": {
  5. "coffee-script": "~1.6.3"
  6. },
  7. "scripts": {
  8. "prepare": "coffee -o lib/ -c src/waza.coffee"
  9. },
  10. "main": "lib/waza.js"
  11. }

prepare脚本会在发布前运行,因此使用者在编译项目时不用依赖它。在开发模式下,运行npm install, 同时也会执行prepare脚本,开发时可以很容易的测试。

至此,你理解了--save--save-dev的区别了吗?

peerDependencies

同等依赖,或者叫同伴依赖,用于指定当前包(也就是你写的包)兼容的宿主版本。如何理解呢? 试想一下,我们编写一个gulp的插件,而gulp却有多个主版本,我们只想兼容最新的版本,此时就可以用同等依赖(peerDependencies)来指定:

  1. {
  2. "name": "gulp-my-plugin",
  3. "version": "0.0.1",
  4. "peerDependencies": {
  5. "gulp": "3.x"
  6. }
  7. }

当别人使用我们的插件时,peerDependencies就会告诉明确告诉使用方,你需要安装该插件哪个宿主版本。

通常情况下,我们会在一个项目里使用一个宿主(比如gulp)的很多插件,如果相互之间存在宿主不兼容,在执行npm install时,cli会抛出错误信息来告诉我们,比如:

  1. npm ERR! peerinvalid The package gulp does not satisfy its siblings' peerDependencies requirements!
  2. npm ERR! peerinvalid Peer gulp-cli-config@0.1.3 wants gulp@~3.1.9
  3. npm ERR! peerinvalid Peer gulp-cli-users@0.1.4 wants gulp@~2.3.0

运行命令npm install gulp-my-plugin --save-dev来安装我们插件,我们来看下依赖图谱:

  1. ├── gulp-my-plugin@0.0.1
  2. └── gulp@3.9.1

OK, Nice!

注意,npm 1 与 npm 2 会自动安装同等依赖,npm 3 不再自动安装,会产生警告!手动在package.json文件中添加依赖项可以解决。

optionalDependencies

可选依赖,如果有一些依赖包即使安装失败,项目仍然能够运行或者希望npm继续运行,就可以使用optionalDependencies。另外optionalDependencies会覆盖dependencies中的同名依赖包,所以不要在两个地方都写。

举个栗子,可选依赖包就像程序的插件一样,如果存在就执行存在的逻辑,不存在就执行另一个逻辑。

  1. try {
  2. var foo = require('foo')
  3. var fooVersion = require('foo/package.json').version
  4. } catch (er) {
  5. foo = null
  6. }
  7. if ( notGoodFooVersion(fooVersion) ) {
  8. foo = null
  9. }
  10. // .. then later in your program ..
  11. if (foo) {
  12. foo.doFooThings()
  13. }

bundledDependencies / bundleDependencies

打包依赖,bundledDependencies是一个包含依赖包名的数组对象,在发布时会将这个对象中的包打包到最终的发布包里。如:

  1. {
  2. "name": "fe-weekly",
  3. "description": "ELSE 周刊",
  4. "version": "1.0.0",
  5. "main": "index.js",
  6. "devDependencies": {
  7. "fw2": "^0.3.2",
  8. "grunt": "^1.0.1",
  9. "webpack": "^3.6.0"
  10. },
  11. "dependencies": {
  12. "gulp": "^3.9.1",
  13. "hello-else": "^1.0.0"
  14. },
  15. "bundledDependencies": [
  16. "fw2",
  17. "hello-else"
  18. ]
  19. }

执行打包命令npm pack, 在生成的fe-weekly-1.0.0.tgz包中,将包含fw2hello-else。 但是值得注意的是,这两个包必须先在devDependenciesdependencies声明过,否则打包会报错。

总结

以上就是目前npm支持的依赖管理,如有不明白或者错误之处,请在评论区留言。

发表评论

表情:
评论列表 (有 0 条评论,542人围观)

还没有评论,来说两句吧...

相关阅读

    相关 应该知道npm依赖配置

    在搭建一个会使用到`npm`包的项目时往往会有一个`package.json`文件来记录项目所依赖的库以及版本等其他信息,而其中依赖信息则是通过以下几个字段来区分控制: