跳到主要内容

React Native Gradle 插件

本指南介绍了如何配置 React Native Gradle 插件（通常称为 RNGP），以构建您的 Android React Native 应用程序。

使用插件​

React Native Gradle 插件作为一个单独的 NPM 包分发，并随 react-native 自动安装。

该插件已为使用 npx react-native init 创建的新项目预先配置。如果您使用此命令创建应用程序，则无需执行任何额外的安装步骤。

如果您要将 React Native 集成到现有项目中，请参阅相应页面：其中包含有关如何安装插件的具体说明。

配置插件​

默认情况下，插件将开箱即用，并带有合理的默认值。您应该参考本指南，仅在需要时自定义行为。

要配置插件，您可以修改 android/app/build.gradle 中的 react 块。

groovy
apply plugin: "com.facebook.react"

/**
 * This is the configuration block to customize your React Native Android app.
 * By default you don't need to apply any configuration, just uncomment the lines you need.
 */
react {
  // Custom configuration goes here.
}

每个配置键的描述如下

root​

这是您的 React Native 项目的根文件夹，即 package.json 文件所在的位置。默认值为 ..。您可以按如下方式自定义它

groovy
root = file("../")

reactNativeDir​

这是 react-native 包所在的文件夹。默认值为 ../node_modules/react-native。如果您在 monorepo 中或使用不同的包管理器，您可以根据您的设置调整 reactNativeDir。

您可以按如下方式自定义它

groovy
reactNativeDir = file("../node_modules/react-native")

codegenDir​

这是 react-native-codegen 包所在的文件夹。默认值为 ../node_modules/react-native-codegen。如果您在 monorepo 中或使用不同的包管理器，您可以根据您的设置调整 codegenDir。

您可以按如下方式自定义它

groovy
codegenDir = file("../node_modules/@react-native/codegen")

cliFile​

这是 React Native CLI 的入口文件。默认值为 ../node_modules/react-native/cli.js。入口文件是必需的，因为插件需要调用 CLI 来打包和创建您的应用程序。

如果您在 monorepo 中或使用不同的包管理器，您可以根据您的设置调整 cliFile。您可以按如下方式自定义它

groovy
cliFile = file("../node_modules/react-native/cli.js")

debuggableVariants​

这是可调试变体的列表（有关变体的更多上下文，请参见使用变体）。

默认情况下，插件只将 debug 视为 debuggableVariants，而 release 则不是。如果您有其他变体（如 staging、lite 等），您需要相应地调整此设置。

列为 debuggableVariants 的变体将不会附带捆绑包，因此您需要 Metro 来运行它们。

您可以按如下方式自定义它

groovy
debuggableVariants = ["liteDebug", "prodDebug"]

nodeExecutableAndArgs​

这是所有脚本应调用的节点命令和参数的列表。默认值为 [node]，但可以自定义以添加额外标志，如下所示

groovy
nodeExecutableAndArgs = ["node"]

bundleCommand​

这是为您的应用程序创建捆绑包时要调用的 bundle 命令的名称。如果您使用 RAM 捆绑包，这会很有用。默认值为 bundle，但可以自定义以添加额外标志，如下所示

groovy
bundleCommand = "ram-bundle"

bundleConfig​

这是将传递给 bundle --config <file> 的配置文件路径（如果提供）。默认值为空（不提供配置文件）。有关捆绑配置文件配置的更多信息，请参见CLI 文档。可以按如下方式自定义

groovy
bundleConfig = file(../rn-cli.config.js)

bundleAssetName​

这是应生成的捆绑文件名称。默认值为 index.android.bundle。可以按如下方式自定义

groovy
bundleAssetName = "MyApplication.android.bundle"

entryFile​

用于捆绑包生成的入口文件。默认是搜索 index.android.js 或 index.js。可以按如下方式自定义

groovy
entryFile = file("../js/MyApplication.android.js")

extraPackagerArgs​

将传递给 bundle 命令的额外标志列表。可用标志列表在CLI 文档中。默认值为空。可以按如下方式自定义

groovy
extraPackagerArgs = []

hermesCommand​

hermesc 命令（Hermes 编译器）的路径。React Native 捆绑了 Hermes 编译器的一个版本，因此您通常不需要自定义此项。插件将默认使用适用于您系统的正确编译器。

hermesFlags​

传递给 hermesc 的标志列表。默认值为 ["-O", "-output-source-map"]。您可以按如下方式自定义它

groovy
hermesFlags = ["-O", "-output-source-map"]

enableBundleCompression​

捆绑资产在打包到 .apk 时是否应压缩。

禁用 .bundle 的压缩允许其直接内存映射到 RAM，从而缩短启动时间——但代价是磁盘上生成的应用程序大小更大。请注意，.apk 下载大小基本不受影响，因为 .apk 文件在下载前会进行压缩

默认情况下，此功能是禁用的，除非您确实担心应用程序的磁盘空间，否则不应将其打开。

使用 Flavors 和 Build Variants​

在构建 Android 应用程序时，您可能希望使用自定义 flavor，以便从同一个项目开始拥有不同版本的应用程序。

请参阅官方 Android 指南以配置自定义构建类型（如 staging）或自定义 flavor（如 full、lite 等）。默认情况下，新应用程序会创建两个构建类型（debug 和 release），并且没有自定义 flavor。

所有构建类型和所有 flavor 的组合会生成一组构建变体。例如，对于 debug/staging/release 构建类型和 full/lite，您将有 6 个构建变体：fullDebug、fullStaging、fullRelease 等等。

如果您使用 debug 和 release 之外的自定义变体，您需要使用debuggableVariants 配置指示 React Native Gradle 插件，哪些变体是可调试的，如下所示

差异
apply plugin: "com.facebook.react"

react {
+ debuggableVariants = ["fullStaging", "fullDebug"]
}

这是必需的，因为插件将跳过所有 debuggableVariants 的 JS 捆绑：您需要 Metro 来运行它们。例如，如果您在 debuggableVariants 中列出 fullStaging，您将无法将其发布到商店，因为它将缺少捆绑包。

插件在底层做了什么？​

React Native Gradle 插件负责配置您的应用程序构建，以将 React Native 应用程序发布到生产环境。该插件还用于第三方库中，以运行用于新架构的 Codegen。

以下是插件职责的摘要

  • 为每个非可调试变体添加一个 createBundle<Variant>JsAndAssets 任务，该任务负责调用 bundle、hermesc 和 compose-source-map 命令。
  • 设置适当版本的 com.facebook.react:react-android 和 com.facebook.react:hermes-android 依赖项，从 react-native 的 package.json 读取 React Native 版本。
  • 设置所有必要的 Maven 依赖项所需的适当 Maven 存储库（Maven Central、Google Maven Repo、JSC 本地 Maven Repo 等）。
  • 设置 NDK，以便您可以构建使用新架构的应用程序。
  • 设置 buildConfigFields，以便您可以在运行时知道 Hermes 或新架构是否已启用。
  • 将 Metro DevServer 端口设置为 Android 资源，以便应用程序知道要连接哪个端口。
  • 如果库或应用程序将 Codegen 用于新架构，则调用 React Native Codegen。