加速你的构建阶段
构建你的 React Native 应用可能会**耗费大量资源**,并占用开发者数分钟的时间。随着项目的发展以及在拥有多个 React Native 开发者的更大组织中,这可能会成为一个问题。
为了减轻这种性能影响,本页分享了一些关于如何**提高构建时间**的建议。
请注意,这些建议是高级功能,需要对原生构建工具的工作原理有一定的了解。
开发期间仅构建一个 ABI(仅限 Android)
在本地构建你的 Android 应用时,默认情况下会构建所有 4 个 应用二进制接口 (ABI):armeabi-v7a
、arm64-v8a
、x86
和 x86_64
。
但是,如果你是在本地构建并在模拟器或物理设备上进行测试,则可能不需要构建所有这些 ABI。
这应该会将你的**原生构建时间**减少约 75%。
如果你使用的是 React Native CLI,可以将 --active-arch-only
标志添加到 run-android
命令中。此标志将确保从正在运行的模拟器或连接的手机中选择正确的 ABI。为了确认此方法正常工作,你将在控制台上看到类似 info Detected architectures arm64-v8a
的消息。
$ yarn react-native run-android --active-arch-only
[ ... ]
info Running jetifier to migrate libraries to AndroidX. You can disable it using "--no-jetifier" flag.
Jetifier found 1037 file(s) to forward-jetify. Using 32 workers...
info JS server already running.
info Detected architectures arm64-v8a
info Installing the app...
此机制依赖于 reactNativeArchitectures
Gradle 属性。
因此,如果你直接使用 Gradle 从命令行构建而无需 CLI,可以按如下方式指定要构建的 ABI
$ ./gradlew :app:assembleDebug -PreactNativeArchitectures=x86,x86_64
如果你希望在 CI 上构建你的 Android 应用并使用矩阵并行化不同架构的构建,这会很有用。
如果需要,你也可以在本地覆盖此值,使用项目顶层文件夹中的 gradle.properties
文件
# Use this property to specify which architecture you want to build.
# You can also override it from the CLI using
# ./gradlew <task> -PreactNativeArchitectures=x86_64
reactNativeArchitectures=armeabi-v7a,arm64-v8a,x86,x86_64
一旦你构建了应用的**发布版本**,请不要忘记删除这些标志,因为你想要构建一个适用于所有 ABI 的 apk/app bundle,而不仅仅是你在日常开发工作流程中使用的那个。
启用配置缓存(仅限 Android)
从 React Native 0.79 开始,你还可以启用 Gradle 配置缓存。
当你使用 yarn android
运行 Android 构建时,你将执行一个由两个步骤组成的 Gradle 构建(来源)
- 配置阶段,所有
.gradle
文件在此阶段被评估。 - 执行阶段,任务在此阶段实际执行,例如编译 Java/Kotlin 代码等。
你现在可以启用配置缓存,这将允许你在后续构建中跳过配置阶段。
当频繁更改原生代码时,这会很有益,因为它提高了构建时间。
例如,在这里你可以看到在原生代码更改后重新构建 RN-Tester 的速度有多快
你可以通过在 android/gradle.properties
文件中添加以下行来启用 Gradle 配置缓存
org.gradle.configuration-cache=true
请参考官方 Gradle 文档以获取更多关于配置缓存的资源。
使用编译器缓存
如果你经常进行原生构建(无论是 C++ 还是 Objective-C),使用**编译器缓存**可能会受益。
具体来说,你可以使用两种类型的缓存:本地编译器缓存和分布式编译器缓存。
本地缓存
以下说明适用于**Android 和 iOS**。如果你只构建 Android 应用,应该没问题。如果你也构建 iOS 应用,请按照下面XCode 特定设置部分中的说明进行操作。
我们建议使用**ccache**来缓存原生构建的编译结果。Ccache 的工作原理是包装 C++ 编译器,存储编译结果,如果中间编译结果已被存储,则跳过编译。
Ccache 在大多数操作系统的包管理器中都可用。在 macOS 上,我们可以使用 brew install ccache
安装 ccache。或者你可以按照官方安装说明从源代码安装。
然后你可以进行两次干净构建(例如,在 Android 上,你可以先运行 yarn react-native run-android
,删除 android/app/build
文件夹,然后再次运行第一个命令)。你会注意到第二次构建比第一次快得多(应该只需要几秒钟而不是几分钟)。在构建过程中,你可以验证 ccache
是否正常工作,并使用 ccache -s
检查缓存命中/未命中率。
$ ccache -s
Summary:
Hits: 196 / 3068 (6.39 %)
Direct: 0 / 3068 (0.00 %)
Preprocessed: 196 / 3068 (6.39 %)
Misses: 2872
Direct: 3068
Preprocessed: 2872
Uncacheable: 1
Primary storage:
Hits: 196 / 6136 (3.19 %)
Misses: 5940
Cache size (GB): 0.60 / 20.00 (3.00 %)
请注意,ccache
会汇总所有构建的统计信息。你可以在构建之前使用 ccache --zero-stats
重置它们,以验证缓存命中率。
如果你需要清除缓存,可以使用 ccache --clear
执行此操作。
XCode 特定设置
为了确保 ccache
在 iOS 和 XCode 中正常工作,你需要在 ios/Podfile
中启用 React Native 对 ccache 的支持。
在你的编辑器中打开 ios/Podfile
,并取消注释 ccache_enabled
这一行。
post_install do |installer|
# https://github.com/facebook/react-native/blob/main/packages/react-native/scripts/react_native_pods.rb#L197-L202
react_native_post_install(
installer,
config[:reactNativePath],
:mac_catalyst_enabled => false,
# TODO: Uncomment the line below
:ccache_enabled => true
)
end
在 CI 上使用此方法
Ccache 在 macOS 上使用 /Users/$USER/Library/Caches/ccache
文件夹来存储缓存。因此,你也可以在 CI 上保存和恢复相应的文件夹来加速你的构建。
但是,有几点需要注意
-
在 CI 上,我们建议进行完全干净构建,以避免缓存中毒问题。如果你遵循前一段中提到的方法,你应该能够在 4 个不同的 ABI 上并行化原生构建,并且很可能不需要在 CI 上使用
ccache
。 -
ccache
依赖时间戳来计算缓存命中。这在 CI 上效果不佳,因为文件在每次 CI 运行时都会重新下载。为了克服这个问题,你需要使用compiler_check content
选项,该选项转而依赖于文件内容的哈希。
分布式缓存
与本地缓存类似,你可能需要考虑为你的原生构建使用分布式缓存。这对于进行频繁原生构建的大型组织尤其有用。