跳到主要内容

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，生成的代码始终在那里。
  • 实现文件始终与生成的接口保持一致。
  • 无需包含两组文件来支持 Android 上的两种架构。你只需保留新架构的文件，并且保证向后兼容。
  • 无需担心应用程序使用的 Codegen 版本与库开发期间使用的版本不匹配。
  • 由于所有原生代码都在那里，因此可以将库的原生部分作为预构建发布。

要启用此设置

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