了解 NPM 的 package.json 中的依赖关系：Dependency、devDependency 和 peerDependency

了解 NPM 的 package.json 中的依赖关系：Dependency、devDependency 和 peerDependency
了解 NPM 的 package.json 中的依赖关系：Dependency、devDependency 和 peerDependency
Arthur Petit
2024年7月14日星期日 下午5:25:41

澄清 NPM 依赖关系

使用 Node.js 和 NPM 时，了解 package.json 文件中指定的不同类型的依赖项可能会令人困惑。术语dependency、devDependency 和peerDependency 经常会引起开发人员的困惑，尤其是那些刚接触Node.js 的开发人员。

在本文中，我们将用简单的语言分解这些术语并提供清晰的示例。我们的目标是帮助您了解何时以及为何在项目中使用每种类型的依赖项，使您的开发过程更顺畅、更高效。

命令 描述
npm init -y 使用默认设置初始化一个新的 Node.js 项目。
npm install 安装指定的包作为依赖项。
npm install --save-dev 安装指定的包作为开发依赖项。
express Node.js 的 Web 应用程序框架，用于构建 Web 应用程序和 API。
mongoose MongoDB 和 Node.js 的 ODM（对象数据建模）库，用于数据库操作。
nodemon 该工具可在检测到文件更改时自动重新启动应用程序，从而帮助开发 Node.js 应用程序。
jest 一个 JavaScript 测试框架，用于编写和运行测试。
peerDependencies 指定项目所需的、必须由项目使用者安装的包。

探索 Node.js 依赖关系

上面提供的脚本旨在帮助您理解和管理 Node.js 项目中不同类型的依赖项。在第一个脚本中，我们有一个示例 package.json 指定的文件 dependencies, devDependencies， 和 peerDependencies。依赖关系如 express 和 mongoose 对于运行项目至关重要，因为它们对于应用程序正常运行是必需的。开发依赖项例如 jest 和 nodemon 在开发阶段用于测试和自动重启等任务，但在生产环境中不需要。对等依赖性，例如 react，确保与项目使用的库的特定版本兼容，确保包的使用者安装兼容的版本。

第二个脚本演示了如何从头开始设置 Node.js 项目。首先，它创建一个新的项目目录并使用命令对其进行初始化 npm init -y，这建立了一个 package.json 具有默认值的文件。然后该脚本会安装必要的依赖项 npm install 对于常规依赖项和 npm install --save-dev 用于开发依赖。命令 npm install react 用于添加对等依赖项，尽管这不会安装该包，而只是在 package.json。这些步骤对于正确设置 Node.js 项目并确保正确安装和管理所有必需的包至关重要。

了解 Node.js 中的依赖关系

JavaScript (Node.js)

// Example package.json file with dependencies, devDependencies, and peerDependencies
{
  "name": "example-project",
  "version": "1.0.0",
  "dependencies": {
    "express": "^4.17.1", // Required for running the project
    "mongoose": "^5.10.9" // Required for database operations
  },
  "devDependencies": {
    "jest": "^26.6.3", // Required for running tests
    "nodemon": "^2.0.6" // Required for development
  },
  "peerDependencies": {
    "react": "^17.0.1" // Ensures compatibility with React
  }
}

用于设置依赖关系的简单脚本

外壳（重击）

# Create a new Node.js project
mkdir example-project
cd example-project
npm init -y
# Install dependencies
npm install express mongoose
# Install development dependencies
npm install --save-dev jest nodemon
# Add peer dependency (note: this does not install it)
npm install react

深入研究 NPM 依赖管理

除了了解 Node.js 项目中的依赖项、devDependency 和 peerDependency 之外，探索这些依赖项如何影响项目管理和协作也很重要。正确管理依赖关系可确保您的项目可维护并降低冲突风险。一个重要方面是语义版本控制 (semver) 的使用 package.json。 Semver 帮助您指定您的项目可以使用哪些版本的包。例如，“^1.2.3”允许向后兼容 1.2.3 的任何版本，而“~1.2.3”仅允许与 1.2.x 兼容但不与 1.3.0 兼容的版本。这种精度级别有助于避免更新包时发生重大更改。

另一个重要方面是传递依赖项的管理，即依赖项的依赖项。 npm 和 Yarn 等工具提供了锁定所有已安装软件包版本的机制，确保不同环境之间的一致性。这 package-lock.json npm 中的文件或 17 号 Yarn 中的文件捕获所有已安装依赖项的确切版本，使您能够可靠地重新创建相同的环境。此外，使用以下命令定期审核您的依赖项是否存在安全漏洞也很重要 npm audit。这有助于识别并修复项目依赖树中潜在的安全问题。

有关 NPM 依赖项的常见问题

  1. 依赖项和 devDependency 之间有什么区别？
  2. 19 号 对于运行项目至关重要，同时 devDependencies 仅在开发过程中需要。
  3. 如何向我的项目添加依赖项？
  4. 使用命令 npm install package-name 添加依赖项。
  5. 如何添加开发依赖项？
  6. 使用命令 22 号 添加开发依赖项。
  7. 什么是peerDependency？
  8. A peerDependency 指定您的项目需要消费者安装的包。
  9. 如何指定peerDependency？
  10. 将对等依赖项添加到 peerDependencies 您的部分 package.json。
  11. 什么是语义版本控制？
  12. 语义版本控制是一种版本控制方案，它使用三部分数字格式 (major.minor.patch) 来指示兼容性。
  13. 什么是 package-lock.json 文件？
  14. 这 package-lock.json 文件锁定所有已安装依赖项的版本，以确保不同环境之间的一致性。
  15. 如何审核我的项目是否存在安全漏洞？
  16. 使用命令 npm audit 检查依赖项中的安全漏洞。

总结 Node.js 中的依赖管理

了解之间的区别 dependencies, devDependencies， 和 peerDependencies 对于有效的 Node.js 项目管理至关重要。正确分类这些依赖项可确保您的应用程序拥有运行所需的一切，同时保持开发和生产环境清洁高效。

通过遵循最佳实践，例如使用语义版本控制和安全漏洞审核，您可以维护稳定且安全的项目。这些知识使开发人员能够自信地处理依赖关系，从而开发出更健壮且可维护的 Node.js 应用程序。