脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 网络编程 → JavaScript → node.js → 应该知道的npm依赖包管理

你应该知道的几类npm依赖包管理详解

 更新时间：2017年10月06日 09:27:11   作者：风清洋  
npm 是node.js 里的包管理器,是一个命令行工具，下面这篇文章主要给大家介绍了关于你应该知道的几类npm依赖包管理，文中通过示例代码介绍的非常详细，需要的朋友可以参考借鉴，下面随着小编来一起学习学习吧。

前言

大家都知道在一个Node.js项目中，package.json几乎是一个必须的文件，它的主要作用就是管理项目中所使用到的外部依赖包，同时它也是npm命令的入口文件。下面话不多说了，来一起看看详细的介绍把。

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

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

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

 "devDependencies": {
 "fw2": "^0.3.2",
 "grunt": "^1.0.1",
 "webpack": "^3.6.0"
 },
 "dependencies": {
 "gulp": "^3.9.1",
 "hello-else": "^1.0.0"
 },
 "peerDependencies": { },
 "optionalDependencies": { },
 "bundledDependencies": []

下面我们一一来看：

dependencies

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

npm install packageName --save

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

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

devDependencies

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

npm install packageName --save-dev

举个栗子：

{ "name": "ethopia-waza",
 "description": "a delightfully fruity coffee varietal",
 "version": "1.2.3",
 "devDependencies": {
 "coffee-script": "~1.6.3"
 },
 "scripts": {
 "prepare": "coffee -o lib/ -c src/waza.coffee"
 },
 "main": "lib/waza.js"
}

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

至此，你理解了--save和--save-dev的区别了吗？

peerDependencies

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

{
 "name": "gulp-my-plugin",
 "version": "0.0.1",
 "peerDependencies": {
 "gulp": "3.x"
 }
}

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

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

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

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

├── gulp-my-plugin@0.0.1
└── gulp@3.9.1

OK, Nice!

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

optionalDependencies

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

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

try {
 var foo = require('foo')
 var fooVersion = require('foo/package.json').version
} catch (er) {
 foo = null
}
if ( notGoodFooVersion(fooVersion) ) {
 foo = null
}

// .. then later in your program ..

if (foo) {
 foo.doFooThings()
}

bundledDependencies / bundleDependencies

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

{
 "name": "fe-weekly",
 "description": "ELSE 周刊",
 "version": "1.0.0",
 "main": "index.js",
 "devDependencies": {
 "fw2": "^0.3.2",
 "grunt": "^1.0.1",
 "webpack": "^3.6.0"
 },
 "dependencies": {
 "gulp": "^3.9.1",
 "hello-else": "^1.0.0"
 },
 "bundledDependencies": [
 "fw2",
 "hello-else"
 ]
}

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

总结

以上就是目前npm支持的依赖管理，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家对脚本之家的支持。

您可能感兴趣的文章:

相关文章

  • Node错误处理笔记之挖坑系列教程

    Node错误处理笔记之挖坑系列教程

    因为nodejs是单线程的,所以一旦发生错误或异常,如果没有及时被处理整个系统就会崩溃。下面这篇文章主要给大家介绍了关于Node错误处理笔记之挖坑系列的相关资料，需要的朋友可以参考借鉴，下面来一起看看吧
    2018-06-06
  • node.js中的Socket.IO使用实例

    node.js中的Socket.IO使用实例

    这篇文章主要介绍了node.js中的Socket.IO使用实例,本文讲解了Socket.IO的安装、结合express来构建服务器、基本使用方法及一个网络聊天室的完整案例,需要的朋友可以参考下
    2014-11-11
  • Node.js中的模块路径解析规则和子模块包

    Node.js中的模块路径解析规则和子模块包

    NodeJS特性如事件驱动、异步编程、无阻塞IO,这些特性为它带来了高效的性能和更少的代码,require函数支持斜杠（/）或盘符（C:）开头的绝对路径,也支持./开头的相对路径,为了便于管理和使用,我们可以把由多个子模块组成的大模块称做包,并把所有子模块放在同一个目录里
    2023-11-11
  • Node.js+Express+Mysql 实现增删改查

    Node.js+Express+Mysql 实现增删改查

    这篇文章主要介绍了Node.js+Express+Mysql 实现增删改查，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2019-04-04
  • 在Mac OS下使用Node.js的简单教程

    在Mac OS下使用Node.js的简单教程

    这篇文章主要介绍了在Mac OS下使用Node.js的简单教程,Node.js是让JavaScript应用运行于服务器端的框架,需要的朋友可以参考下
    2015-06-06
  • Node.js的Koa框架上手及MySQL操作指南

    Node.js的Koa框架上手及MySQL操作指南

    Node世界中新兴的Koa框架比Express更加轻便,且扩展对数据库操作的支持十分强大,这里我们就来看一下Node.js的Koa框架上手及MySQL操作指南:
    2016-06-06
  • node使用querystring内置模块解决分页返回数据太多导致json.parse()解析报错问题

    node使用querystring内置模块解决分页返回数据太多导致json.parse()解析报错问题

    这篇文章主要介绍了node使用querystring内置模块解决分页返回数据太多导致json.parse()解析报错问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-09-09
  • Node.js连接postgreSQL并进行数据操作

    Node.js连接postgreSQL并进行数据操作

    自从MySQL被Oracle收购以后，PostgreSQL逐渐成为开源关系型数据库的首选。这篇文章就给大家介绍了关于Node.js如何连接postgreSQL数据库，并进行数据操作的方法，有需要的朋友们可以参考借鉴，下面来一起看看吧。
    2016-12-12
  • node-sass常见报错的问题及解决方法

    node-sass常见报错的问题及解决方法

    在安装node-sass时,经常会遇到下载慢、版本不匹配或python错误等问题,使用淘宝镜像加速下载、通过nvm管理node版本或指定node-sass版本号安装,都能有效解决这些问题,若遇到python相关错误,检查node版本是否合适通常可以解决,感兴趣的朋友一起看看本文吧
    2024-09-09
  • Node.js使用SQLite数据库方法大全

    Node.js使用SQLite数据库方法大全

    Node.js是一种流行的JavaScript运行时,提供了许多有用的模块和库来构建Web应用程序,而SQLite是一种嵌入式关系型数据库,它可以运行在各种操作系统上,包括Windows、Linux和Mac OS X等,在Node.js中,可以通过安装sqlite3模块来访问SQLite数据库
    2023-10-10

最新评论