聊聊 node.js 中各种 dependency

A Loity 发布于2019-08-20 14:23 / 2116人阅读

摘要：项目中常见，，，平时开发的时候总是遇到，但就是没细了解过它们之间的异同，今天简单深入一下，记录下来。与的异同这是与的不同点之一。项目依赖的的不会被安装，但自身的会被安装，而所有的都会被安装。其它的其实还有另外两种配置。

node 项目中常见 dependency，devDependency，peerDependency，平时开发的时候总是遇到，但就是没细了解过它们之间的异同，今天简单深入一下，记录下来。

首先看下方的图，project-main 的 dependency 是 package-a，package-a 的 devDependency 是 package-a-1，此外，project-main 也有一个 devDependency 是 package-b：

├── project-main
    ├── package-a (dependency)
    │   └── package-a-1 (devDependency)
    └── package-b (devDependency)

// package.json
{
  "name": "project-main",
  "dependencies": {
    "package-a": "^1.0.0"
  },
  "devDependencies": {
    "package-b": "^1.0.0"
  }
}

在 project-main 下执行 npm install 之后，package-a 和 package-b 都会被安装，但 package-a-1 不会被安装，所以你在 project-main 的 node_modules 文件夹下找不到 package-c。

dependency 与 devDependency 的异同

这是 dependency 与 devDependency 的不同点之一。项目依赖的 package 的 devDependency 不会被安装，但自身的 devDependency 会被安装，而所有的 dependency 都会被安装。如果不想安装自身的 devDependency 就使用 npm install --production 这个指令来，这样的话对于 project-main 来说，它的 devDependency 也不会被安装了。

所以，在开发一个 node 包时，要注意区分什么时候用 dependencies 什么时候用 devDependencies，一般做测试、打包、ES6转ES5此类的工作所依赖的库就使用 devDependencies，而正常功能所依赖的包就使用 dependencies 声明。

> npm install react --save  // 做为 dependencies 安装
> npm install eslint --save-dev // 做为 devDependencies 安装

peerDependencies

还是拿上面的例子来说，假如 project-main 依赖的 package-a 的 package.json 中声明了 peerDependency 是 package-apeer@^1.0.0，而 project-main 中没有任何 package-apeer 的配置，此时在 project-main 下使用 npm3 执行 npm install，控制台就会告警 UNMET PEER DEPENDENCY package-apeer@^1.0.0，意思就是说使用到 package-a 的项目必须安装同时安装 package-apeer@^1.0.0 ，否则程序就可能会有异常，而在 npm@1 和 npm@2 下，就不会报错而是自动把 package-apeer@^1.0.0 安装上，因为很多用户反应这样很困惑，我没声明这个包，你为什么要给我安装呢？所以在 npm@3 中这个 peerDependencies 如果没装就变成了控制台告警。

其它的 dependency

其实 node 还有另外两种 dependency 配置。

bundleDependencies

它还有一个别名，bundledDependencies，这个配置的作用如下：

对于下面这个包 package-a

{
  "name": "package-a",
  "dependencies": {
    "react": "^15.0.0",
    "core-js": "^2.0.0",
    "lodash": "^4.0.0"
  },
  "bundleDependencies": [
    "react",
    "core-js"
  ]
}

在你的项目中使用 npm@3 安装 package-a 之后，项目的 node_modules 的文件结构：

├── node_modules
    ├── package-a
    │   └── react
    │   └── core-js
    └── loadsh

bundleDependencies 的作用就是在用户安装了 package-a 之后，将 package-a 所声明的依赖包汇总到 package-a 自身的 node_modules 下，便于用户管理，如果 package-a 中没有配置 bundleDepencies，在安装了 package-a 的项目下 node_modules 就会长这样：

├── node_modules
    ├── package-a
    ├── react
    ├── core-js
    └── loadsh

optionalDependencies

如果你的node项目依赖了一个包 package-optional，假如这个 package-optional 没有安装，你仍然想让程序正常执行，这个时候 optionalDependencies 就非常适合你这个需求，optionalDependencies 跟 dependencies 声明方式完全一致，而且一个依赖如果同时在 dependencies 和 optionalDependencies 中声明，option 还会覆盖 dependency 的声明。如果 package-optional 这个包是可选的，在代码中就可以这样写了：

try {
    var pkgOpt = require("package-optional");
} catch (e) {
    pkgOpt = null;
}
console.log(pkgOpt);

结语

node package 的依赖管理在如今的前端工程化时代背景下变得尤为重要，构建优雅可维护的 node_modules 结构是值得探讨的一个话题，希望今天本文能对你有所帮助和启发。

idc机房托管专线服务 java中各种布局 php中各种注释符号 js 中各种数据类型的比较 Dependencies

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/81586.html

MEAN.js 文档

摘要：感谢使用框架本文档涵盖构建应用所需的基础知识。用于数据校验的组件及相关文件在此目录进行管理。除了自定义中间件外，还是用了诸多第三方的中间件，它们是五测试我们使用组件对服务端代码进行测试。识别当前导航从已有导航中删除给定标识的导航配置。本文同步至个人博客 MEAN.js 文档，转载请注明出处。 Overview 感谢使用 MEAN.js 框架！本文档涵盖构建 MEAN 应用所需的基础...

Hydrogen 2019-06-26 17:37 评论0 收藏0
前端工具演变

摘要：做菜的工具有历史演变的过程，我们软件开发的工具也是如此。今天就从前端工具演变来聊聊前端的历史发展。上面的做法很显然是存在效率和不方便的问题，在这种情况下前端的工具应运而生。是只被用于管理前端的组件，例如，，的工具，只用在前端。假如你烘焙过蛋糕（哪怕没有亲自做过，但是也应该听说过），除了基本的面粉，鸡蛋等原材料外，或许你还需要一个电动蛋白打发器，一个烤箱。这是现代的做法，那么在打发器和...

icyfire 2019-08-23 17:00 评论0 收藏0
聊聊 2018 年后端技术趋势

摘要：现在在后端业务开发编程方面，技术力量强的团队已经开始将技术栈从同步模式切换为异步了。使用这些技术方案是无法兼容已有程序的。影响了异步回调技术栈的普及。将会成为未来后端开发领域的主流技术方案。今天太忙，少写一点，后面再补充。异步模式 Go 语言越来越热门，很多大型互联网公司后端正在转向 GO 。Java 圈知名的服务化框架 Dubbo 也宣布转型异步模式。这是一个大趋势，异步模式已经...

Miyang 2019-06-28 18:19 评论0 收藏0
聊聊毕业设计系列 --- 项目介绍

摘要：又将整个文艺类阅读系统的业务划分为两大部分，分别是面向管理员和合作作者的后台管理系统和面向用户的移动端，系统的需求分析将围绕这两部分进行展开。效果展示 showImg(https://user-gold-cdn.xitu.io/2018/8/26/16576a709bd02f5f?w=1409&h=521&f=gif&s=30128195); showImg(https://user...

Pink 2019-06-26 17:48 评论0 收藏0
聊聊毕业设计系列 --- 项目介绍

摘要：又将整个文艺类阅读系统的业务划分为两大部分，分别是面向管理员和合作作者的后台管理系统和面向用户的移动端，系统的需求分析将围绕这两部分进行展开。效果展示 showImg(https://user-gold-cdn.xitu.io/2018/8/26/16576a709bd02f5f?w=1409&h=521&f=gif&s=30128195); showImg(https://user...

villainhr 2019-08-23 11:31 评论0 收藏0