HowTo

提供更智能的保留规则:库提供商如何助力应用级 DEX 代码优化

阅读用时:6 分钟
查看 Breana Tate 的个人资料
Breana Tate 开发者关系工程师

作为 Android 应用和库开发者,我们都追求同一个目标:打造性能出色、用户体验流畅的应用。其中很大一部分工作涉及 Android 的应用优化工具 R8。R8 会移除未使用的代码,并对剩余代码进行优化和混淆处理,从而提升应用性能。

Google Play 最近宣布了针对应用和游戏的新 DEX 代码优化阈值,这些阈值有助于缩短启动时间、减少内存占用,并契合 Android 的承诺,即防止应用占用过多内存,从而保障用户体验。虽然这些阈值适用于应用和游戏,但达到这些阈值是整个生态系统的责任共担。R8 只能在给定的参数范围内优化应用,这些参数包括应用所依赖的库捆绑的保留规则。

R8 配置分析器是一款出色的工具,可用于评估应用优化、缩减和混淆百分比,这些都是 Google Play 技术要求的核心。除了跟踪这些百分比之外,R8 配置分析器还会找出效率低下的保留规则,这些规则不仅源自应用,还源自应用所依赖的库中捆绑的消费者保留规则。

本指南概述了如何解决库提供商面临的一些最常见挑战,并提供精简、高性能的规则,帮助您的客户满足 Google Play 技术要求。

什么是使用方 keep 规则?

消费者保留规则是 Android 或 JAR 库中捆绑的指令,用于告知 R8 在应用级编译过程中,库代码的哪些部分可能无法优化。与应用或库在制品缩减过程中使用的标准保留规则不同,消费者保留规则嵌入在库中,会影响库在整个应用优化过程中的缩减方式,从而确保内部反射目标和原生接口保持不变,而无需应用开发者手动识别它们。

有针对性、范围狭窄的使用方保留规则是一项关键的最佳实践,对库和使用该库的应用都有好处。过于宽泛的使用方保留规则会保留未使用的代码,从而影响应用的优化和性能。Play 管理中心新增了 DEX 代码优化分析洞见,应用开发者看到的指标将反映应用及其集成库规则的综合影响。

平衡稳定性和性能

库提供商通常出于好意而提供宽泛的使用方 keep 规则。没有人希望自己的 SDK 在反射期间因类移除而触发崩溃。

不过,我们不建议将针对整个软件包或宽泛的保留规则作为防止崩溃的长期解决方案,因为它们会严重限制 R8 的全程序应用优化潜力。以下是一些推荐策略,可帮助您在不牺牲稳定性的情况下,发布范围窄、性能高的规则:

1. 测试和发布范围较窄的规则

为帮助您放心地发布范围较窄的规则,请考虑以下最佳实践:

  • 在示例应用中测试:测试优化效果中的本地测试指南也适用于示例应用。启用 R8 后,请测试关键用户历程,确保功能按预期运行。
  • 在示例应用上运行 R8 配置分析器,了解应用开发者在审核其 R8 配置时会看到什么。这样,您就可以轻松直观地了解保留规则对下游应用的影响。
  • 使用 Android CLI 中的 analyze 命令评估 AAR 或 JAR 的优化情况,包括保留的方法、类和字段。您可以比较不同版本之间的这些数字,以监控是否存在回归问题。
  • 在 Google Play SDK 管理中心内监控库版本的使用情况和崩溃情况。
  • 如需了解最佳实践,请参阅针对库作者的优化指南和 R8 文档。

2. 在不使用宽泛保留规则的情况下保留反射和 JNI 目标

如果库中包含宽泛或软件包范围的保留规则,不仅会影响您的 SDK,还会迫使开发者接受代码膨胀,从而导致应用启动时间变慢,并增加应用下载大小、内存用量和 ANR 发生率。注重性能的应用也可能会编写自定义规则来替换与库捆绑在一起的规则,这也会导致这些应用不愿采用未来的库更新,以降低风险。

如果您的 SDK 针对原生代码(例如游戏或照片和视频编辑器中的代码),请为所有使用 JNI 的类提供规则。大多数游戏都在 Unity 和 Unreal 等游戏引擎上运行,这些引擎会将游戏编译为原生代码。游戏原生代码和您的插件通过 JNI 调用与 Android 框架进行通信。

Jetpack Keep 注解(目前处于 Alpha 版阶段)可让您为反射用法添加注解,这些注解随后可用于在构建时生成保留规则,从而帮助减少反射所需的维护工作。

考虑使用代码生成,而不是反射

为避免因反射而导致崩溃,我们最主要的建议是避免使用反射,并尽可能使用代码生成。

运行时反射会在编译期间向 R8 隐藏代码使用情况,因此需要保留规则来避免崩溃。如果您使用 codegen,代码会在构建过程中进行优化,从而使 R8 能够获得必要的可见性,以便使用最少的保留规则安全地优化代码。代码生成非常适合用于序列化和反序列化以及依赖项注入(Hilt 就是一个使用代码生成的库)。

不过,代码生成并不适用于所有场景。对于可选依赖项等模式,反射仍然是必要的。我们建议将反射与仅保护所需入口点的窄范围保留规则搭配使用,如通过反射支持可选依赖项指南中所述。

缩小规则范围,即使对于预优化的库 build 也是如此

如果无法避免反射,请确保您的消费者保留规则仅指定库反射的内容。当您的库动态访问某个类或方法时,您只需指定入口点,R8 会处理其余部分。R8 会使用这些入口点构建一个图,其中包含所有被引用的代码,并移除所有未被引用的类、方法和字段。

如果您已经优化或混淆了库 build,这也适用,这是确保 SDK 性能良好且轻量化的绝佳做法。由于您的规则会在应用的编译步骤中应用,因此 R8 仍可根据下游应用使用的实际类和方法进一步优化您的库。Android CLI analyze 命令会主动显示导致优化受阻的已用和未用软件包级 keep 规则。

针对第三方依赖项缩小保留规则的范围

我们发现了一种常见模式:

-keep public class com.google.android.gms.** { *; }

如果集成您 SDK 的应用还使用了其他 GMS 库,并且包含一条用于限制保留代码量的 keep 规则,那么这条宽泛的规则会取代该 keep 规则,从而导致应用不必要地膨胀。

调用外部库时,您应设计保留规则,严格仅保留库通过反射访问的特定元素。此外,事实上,许多库(包括 GMS)已经提供了自己的消费者保留规则,引入软件包级保留规则也可能会覆盖下游库中精心编写、范围狭窄的消费者规则。

考虑为广告中介适配器使用条件式保留规则

如果您的广告库是使用中介适配器加载的,您仍然可以选择使用范围较窄的保留规则。在这种情况下,我们建议使用条件保留规则,以便仅在应用包含相应适配器时保留特定功能或格式。这可确保 R8 仍能缩减应用不使用的功能。作为另一种选择,您也可以使用 Jetpack Keep 注解直接在源代码中为反射调用添加注解,并自动生成条件消费者保留规则(包括可选的插件模块),而无需手动编写复杂的规则。

在消费者规则中发布规则,而不是在文档中发布

通过在库中提供消费者规则,您可以确保启用了 R8 的应用能够开箱即用您的库,并实现最大程度的优化。

在文档中指定规则会增加手动设置的阻力(尤其是因为 AAR 和 JAR 多年来一直支持捆绑的使用方保留规则),并会产生持续的维护开销。当您更新库(包括重构、重命名类和更改反射的使用方式)时,必须记得更新文档,并且应用必须记得检查新规则。随着时间的推移,当应用升级到库的多个版本时,可能会累积不再需要的旧版保留规则,从而导致应用不必要地膨胀。

3. 读取发布版本堆栈轨迹

您可能因代码混淆而遇到无法读取的堆栈轨迹。为了不影响关键分析,您可能会想使用 keepnames,它允许缩减,但会阻止其他优化,例如在消费者应用中重命名,而这正是您在调试堆栈轨迹时需要的精确值。

您无需阻止其他优化即可获得可读的堆栈轨迹。

Firebase Crashlytics、Play 管理中心和 Android Studio 中的 Logcat 会为应用开发者对堆栈轨迹进行去混淆处理。这意味着,如果应用开发者与您分享堆栈轨迹,您无需阻止混淆处理即可读取该轨迹。

如果您将映射文件上传到 SDK 管理中心,则可以在 SDK 管理中心内查看去混淆堆栈轨迹。

告别盲目优化

优化游戏库不应像是一场试错游戏。

通过维护消费者保留规则,库提供商可以确保整个生态系统中的应用都能顺利进行优化。

如果库提供更好的规则,应用就会变得更小、更快。立即开始审核您的消费者保留规则,帮助依赖您库的应用发挥最佳性能。

作者:
继续阅读