Node.js 条件导出

本文将讨论 Node.js 条件导出，包括其目的、工作原理和示例。

Node.js 中的条件导出是什么？

Node.js 12.7.0 版本中引入的条件导出功能，使包作者能够根据环境变量、Node.js 版本或模块系统等变量，为他们的模块指定多个入口点。此功能在 package.json 文件的 exports 部分进行设置，允许一个包为 require (CommonJS)、import (ES 模块) 或不同环境 (Node.js vs. 浏览器) 提供不同的代码。条件导出最大限度地提高了性能，确保了跨多个平台和版本的兼容性，并提高了灵活性，而无需为每个目标环境提供新包。它在现代 JavaScript 开发中是必不可少的。

目的

• 在我们的包被用于 Node.js 或浏览器环境时，它提供了独立的模块入口点。
• 它为 ES 模块 (import) 和 CommonJS (require) 提供了其他代码路径。
• 当我们针对具有 ES6 特性等专用功能集的现代环境进行优化时，它也应该为旧场景提供回退。

条件导出的工作原理

package.json 中的 exports 字段确保模块可以在特定条件下提供，这些条件可以在 JSON 文件中指定。这些要求可能有其根源

• Node.js 版本：不同的 Node.js 版本应使用不同的模块实现。
• 环境：使用 Node.js 或其他浏览器代码。
• 模块系统：为每个需求提供不同的文件（CommonJS）和导入（ES 模块）。

示例 1

让我们通过一个例子来说明 Node.js 中的条件导出。

Package.json

说明

• 使用 require() 函数，main.cjs 用于加载包。
• 使用 import 加载时，文件 main.mjs 被使用。
• 当包在 Node.js 中使用且没有特殊 require 或 import 时，将使用 main-node.js 包。
• 如果没有条件匹配，则默认文件为 main.js。

示例 2

Package.json

说明

• 设置环境：将环境设置为 development，这将导致 Node.js 加载。
  
  1. CommonJS 需要 dev.cjs。
  2. 对于 ES 模块，导入 dev.mjs。
• 生产环境：当需要为 CommonJS 加载 prod.cjs 时，Node.js 将在生产环境中加载。
  
  1. prod.mjs 是 ES 模块的导入。
• Node.js 信息：当只针对 Node.js 而不指定 dev/prod 时，它会为 ES 模块加载 node.mjs，为 CommonJS 加载 node.cjs。
• 默认可恢复：在之前列出的任何条件都不满足的情况下，将改用 index.js。

示例 3

说明

在此示例中，如果我们对现代配置使用 ESM，则输出将是 modern.mjs 或 modern-browser.mjs。否则，如果我们对过时环境使用 CommonJS，则将加载相应的 legacy.cjs 或 legacy-browser.cjs。通过采用此技术，包导出可以调整为与各种模块系统和设置以及旧配置高效地工作。

结论

总之，**条件导出** 使开发人员能够根据目标平台（浏览器或 Node.js）、环境和模块格式（CommonJS vs. ES 模块）定义特定的模块入口点。它是一项功能强大且灵活的特性。通过这项功能，可以编写在较新环境中优化运行，同时在较旧环境中保持功能正常的代码。这些是条件导出指定的开发或生产渠道，通过指定旧版或现代 JavaScript 功能等情况来简化包的分发和维护。它通过简化针对不同平台的代码库的维护并确保更好的覆盖范围和兼容性来提高性能和适应性。