跳到主要内容

React Native 中的包导出支持

·10 分钟阅读
Alex Hunt
亚历克斯·亨特
Meta 软件工程师

随着 React Native 0.72 的发布，Metro——我们的 JavaScript 构建工具——现在包含了对 package.json "exports" 字段的 Beta 版支持。当 启用 时，它会添加以下功能

在这篇文章中，我们将介绍包导出（Package Exports）的工作原理，以及这些变化对您作为 React Native 应用程序开发人员或包维护者的意义。

什么是包导出（Package Exports）？​

包导出在 Node.js 12.7.0 中引入，是 npm 包指定**入口点**的现代方法——将包子路径映射到可以外部导入的文件以及它们应该解析到的文件。

支持 "exports" 改善了 React Native 项目与更广泛的 JavaScript 生态系统（目前在约 1.66 万个包中使用）的协作方式，并为包作者提供了一套标准化的功能集，用于多平台包定位 React Native。

"exports" 可以与 package.json 文件中的 "main" 一起使用，也可以替代它。

{
  "name": "@storybook/addon-actions",
  "main": "./dist/index.js",
  ...
  "exports": {
    ".": {
      "node": "./dist/index.js",
      "import": "./dist/index.mjs",
      "default": "./dist/index.js"
    },
    "./preview": {
      "import": "./dist/preview.mjs",
      "default": "./dist/preview.js"
    },
    ...
    "./package.json": "./package.json"
  }
}

这是一些应用程序代码，通过导入 @storybook/addon-actions 的不同子路径来使用上述包。

import {action} from '@storybook/addon-actions';
// -> '@storybook/addon-actions/dist/index.js'

import {action} from '@storybook/addon-actions/preview';
// -> '@storybook/addon-actions/dist/preview.js'

import helpers from '@storybook/addon-actions/src/preset/addArgsHelpers';
// Inaccessible - not listed in "exports"!

包导出的主要功能是

  • 包封装：只有 "exports" 中定义的子路径才能从包外部导入——使包能够控制其公共 API。
  • 子路径别名：包可以定义自定义子路径，这些子路径映射到不同的文件位置（包括通过子路径模式）——允许文件重新定位，同时保留公共 API。
  • 条件导出：一个子路径可能会根据环境解析为不同的底层文件。例如，为了定位 "node"、"browser" 或 "react-native" 运行时——替换 "browser" 字段规范。
注意

"exports" 的完整功能在 Node.js 包入口点规范中有详细说明。

由于这些功能与现有的 React Native 概念（如特定平台扩展）重叠，并且由于 "exports" 已在 npm 生态系统中存在一段时间，因此我们联系了 React Native 社区，以确保我们的实现能够满足开发人员的需求（PR，最终 RFC）。

对于应用程序开发人员​

包导出功能目前已可启用，处于 Beta 阶段。

  • 依赖于包导出功能（例如 Firebase 和 Storybook）的包的导入现在应该按设计工作。
  • 使用 Metro 的 React Native for Web 项目现在将能够使用 "browser" 条件导出，从而无需再使用变通方法。

启用包导出带来了一些边缘情况下的重大更改，可能会影响特定项目，您现在可以进行测试。

在未来的 React Native 版本中，包导出将默认启用。在鸡生蛋蛋生鸡的情况下，React Native 应用之前是一些包迁移到 "exports" 的阻碍——或者使用了我们的 "react-native" 根字段的逃生舱。在 Metro 中支持这些功能将使生态系统向前发展。

启用包导出（Beta）​

包导出可以在您应用程序的 metro.config.js 文件中通过 resolver.unstable_enablePackageExports 选项启用。

const config = {
  // ...
  resolver: {
    unstable_enablePackageExports: true,
  },
};

Metro 暴露了另外两个解析器选项，用于配置条件导出的行为方式

  • unstable_conditionNames — 解析条件导出时要断言的条件名称集合。默认情况下，我们匹配 ['require', 'import', 'react-native']。
  • unstable_conditionsByPlatform — 在为给定平台目标解析时要断言的附加条件名称。默认情况下，当平台为 'web' 时，它匹配 'browser'。
提示

请记住使用 React Native Jest 预设！ Jest 默认包含对包导出的支持。在测试中，您可以使用 testEnvironmentOptions 选项覆盖解析的 customExportConditions。

如果您正在使用 TypeScript，可以通过在项目的 tsconfig.json 中设置 moduleResolution: 'bundler' 和 resolvePackageJsonImports: false 来匹配解析行为。

验证项目中的更改​

对于现有项目，我们建议早期采用者遵循这些步骤，以查看在启用 unstable_enablePackageExports 后是否发生解析更改。这是一个一次性过程。很可能根本不会有任何更改，但我们希望开发人员能够确定地选择加入。

💡 验证项目中的更改
注意

如果您没有使用 Yarn，请将 yarn 替换为 npx（或您项目中使用的相关工具）。

  1. 获取所有已解析的依赖项（更改前）

    # Replace index.js with your entry file if needed, such as App.js
    yarn metro get-dependencies index.js --platform android --output before.txt
    • Expo CLI：如果您的项目尚未有 metro.config.js 文件，请运行 npx expo customize metro.config.js。
    • 为了全面覆盖，将 --platform android 替换为您的应用程序正在使用的其他平台（例如 ios，web）。

  2. 在 metro.config.js 中启用 resolver.unstable_enablePackageExports。

  3. 获取所有已解析的依赖项（更改后）

    yarn metro get-dependencies index.js --platform android --output after.txt

  4. 比较！

    diff before.txt after.txt

重大更改​

我们决定在 Metro 中实现 Package Exports，使其符合规范（需要一些重大更改），但否则向后兼容（帮助现有导入的应用程序逐步迁移）。

主要的重大更改是，当包提供 "exports" 时，它将首先被咨询（在任何其他 package.json 字段之前）——并且匹配的子路径目标将直接使用。

有关更多详细信息，请参阅 Metro 文档中所有重大更改。

包封装是宽松的​

当 Metro 遇到未在 "exports" 中列出的子路径时，它将回退到旧版解析。这是一个兼容性功能，旨在减少现有 React Native 项目中先前允许的导入对用户造成的摩擦。

Metro 将记录警告而不是抛出错误。

warn: You have imported the module "foo/private/fn.js" which is not listed in
the "exports" of "foo". Consider updating your call site or asking the package
maintainer(s) to expose this API.
注意

我们计划在未来实现严格模式的包封装，以与 Node 的默认行为保持一致。因此，如果用户提出警告，我们建议所有开发人员处理这些警告。

对于包维护者（预览）​

信息

根据我们的推出计划，包导出将在今年晚些时候的下一个 React Native 版本 (0.73) 中为大多数项目启用。

我们目前没有计划在短期内移除对 "main" 字段和其他当前包解析功能的支持。

包导出提供了限制对包内部访问的能力，以及库定位 React Native 和 React Native for Web 的更可预测的能力。

如果您今天正在使用 "exports"​

如果您的包在当前 "react-native" 根字段旁边使用 "exports"，请记住上述用户的重大更改。对于在 Metro 中启用此功能的用户，"exports" 现在将在模块解析期间首先被考虑。

实际上，我们预计对用户的主要变化将是强制执行（通过警告）应用程序中任何不可访问的子路径，以遵守 "exports" 包封装。

迁移到 "exports"​

向您的包添加 "exports" 字段是完全可选的。不使用 "exports" 的包的现有包解析功能将完全相同——我们没有计划移除此行为。

我们相信 "exports" 的新功能为 React Native 包维护者提供了一套引人注目的功能。

  • 收紧您的包 API：现在是审查您的包模块 API 的绝佳时机，该 API 现在可以通过导出的子路径别名正式定义。这可以防止用户访问内部 API，从而减少错误发生的表面积。
  • 条件导出：如果您的包定位 React Native for Web（即 "react-native" 和 "browser"），我们现在让包控制这些条件的解析顺序（参见下一节）。

如果您决定引入 "exports"，我们建议将其作为一项重大更改。我们已在 Metro 文档中准备了一份迁移指南，其中包括如何替换平台特定扩展等功能。

注意

请不要依赖 Metro 实现的宽松行为。 尽管 Metro 向后兼容，但包应遵循规范中记录的 "exports" 方式，并严格由其他工具实现。

新的 "react-native" 条件​

我们引入了 "react-native" 作为社区条件（与条件导出一起使用）。这代表 React Native 框架，与其他公认的运行时（如 "node" 和 "deno"）并存（RFC）。

社区条件定义 — "react-native"

将由 React Native 框架（所有平台）匹配。要定位 React Native for Web，"browser" 应在此条件之前指定。

这取代了之前的 "react-native" 根字段。之前此字段的解析优先级由项目决定，这在使用 React Native for Web 时造成了歧义。在 "exports" 下，包具体定义了条件入口点的解析顺序——消除了这种歧义。

  "exports": {
    "browser": "./dist/index-browser.js",
    "react-native": "./dist/index-react-native.js",
    "default": "./dist/index.js"
  }
注意

由于现有其他平台选择方法的普遍性以及此行为在不同框架中可能如何工作的复杂性，我们选择不引入 "android" 和 "ios" 条件。请改用 Platform.select() API。

未来：稳定的 "exports"，默认启用​

在下一个 React Native 版本中，我们旨在移除此功能的 unstable_ 前缀（在解决了计划中的性能工作和任何 bug 之后），并将默认启用包导出解析。

随着 "exports" 对所有人启用，我们可以开始推动 React Native 社区向前发展——例如，React Native 的核心包可以更新以更好地分离公共和内部模块。

Rollout plan for Package Exports support

致谢​

感谢 React Native 社区成员对 RFC 的反馈：@SimenB、@tido64、@byCedric、@thymikee。

非常感谢 Meta 的 @motiz88 和 @robhogan 对此功能开发的支持。