跳到主要内容

Codegen CLI

调用 Gradle 或手动调用脚本可能难以记住，并且需要很多繁琐的操作。

为了简化操作，我们创建了一个 CLI 工具，可以帮助你运行这些任务：Codegen cli。此命令为你的项目运行 @react-native/codegen。以下选项可用

sh
npx @react-native-community/cli codegen --help
Usage: rnc-cli codegen [options]

Options:
  --verbose            Increase logging verbosity
  --path <path>        Path to the React Native project root. (default: "/Users/MyUsername/projects/my-app")
  --platform <string>  Target platform. Supported values: "android", "ios", "all". (default: "all")
  --outputPath <path>  Path where generated artifacts will be output to.
  -h, --help           display help for command

示例​

  • 从当前工作目录读取 package.json，根据其 codegenConfig 生成代码。
shell
npx @react-native-community/cli codegen
  • 从当前工作目录读取 package.json，在 codegenConfig 中定义的位置生成 iOS 代码。
shell
npx @react-native-community/cli codegen --platform ios
  • 从 third-party/some-library 读取 package.json，在 third-party/some-library/android/generated 中生成 Android 代码。
shell
npx @react-native-community/cli codegen \
    --path third-party/some-library \
    --platform android \
    --outputPath third-party/some-library/android/generated

将生成的代码包含到库中​

Codegen CLI 是库开发者的绝佳工具。它可以用于预览生成的代码，以查看你需要实现哪些接口。

通常，生成的代码不包含在库中，并且使用该库的应用负责在构建时运行 Codegen。对于大多数情况来说，这是一个很好的设置，但 Codegen 还提供了一种机制，可以通过 includesGeneratedCode 属性将生成的代码包含在库本身中。

重要的是要了解使用 includesGeneratedCode = true 的含义。包含生成的代码有几个好处，例如

  • 无需依赖应用为你运行 Codegen，生成的代码始终存在。
  • 实现文件始终与生成的接口保持一致（这使你的库代码更能抵抗 codegen 中的 API 更改）。
  • 无需包含两组文件来支持 Android 上的两种架构。你只需保留新架构的一组文件，并且保证向后兼容。
  • 由于所有原生代码都存在，因此可以将库的原生部分作为预构建版本发布。

另一方面，你还需要注意一个缺点

  • 生成的代码将使用你的库中定义的 React Native 版本。因此，如果你的库随 React Native 0.76 一起发布，则生成的代码将基于该版本。这可能意味着生成的代码与使用应用所用之前 React Native 版本的应用不兼容（例如，在 React Native 0.75 上运行的应用）。

启用 includesGeneratedCode​

要启用此设置

  • 将 includesGeneratedCode 属性添加到库的 package.json 文件中的 codegenConfig 字段。将其值设置为 true。
  • 使用 codegen CLI 在本地运行 Codegen。
  • 更新你的 package.json 以包含生成的代码。
  • 更新你的 podspec 以包含生成的代码。
  • 更新你的 build.Gradle 文件以包含生成的代码。
  • 更新 react-native.config.js 中的 cmakeListsPath，以便 Gradle 不会在 build 目录中查找 CMakeLists 文件，而是在你的 outputDir 中查找。