ProfileInstaller

  
使库能够预先填充提前编译跟踪，供 ART 读取。
最新更新 稳定版 候选发布版 Beta 版 Alpha 版
2024 年 9 月 4 日 1.3.1 1.4.0-rc01 - -

声明依赖项

要添加对 ProfileInstaller 的依赖项，您必须将 Google Maven 存储库添加到您的项目中。阅读 Google 的 Maven 存储库，以了解更多信息。

在应用程序或模块的 build.gradle 文件中添加您需要的工件的依赖项

Groovy

dependencies {
    implementation "androidx.profileinstaller:profileinstaller:1.3.1"
}

Kotlin

dependencies {
    implementation("androidx.profileinstaller:profileinstaller:1.3.1")
}

有关依赖项的更多信息，请参阅 添加构建依赖项。

反馈

您的反馈有助于使 Jetpack 变得更好。如果您发现新的问题或有改进此库的想法，请告诉我们。在创建新的问题之前，请查看此库中的 现有问题。您可以通过单击星形按钮来为现有问题添加您的投票。

创建新的问题

有关更多信息，请参阅 问题跟踪器文档。

版本 1.4

版本 1.4.0-rc01

2024 年 9 月 4 日

androidx.profileinstaller:profileinstaller:1.4.0-rc01 发布，与上一个 Beta 版发布没有变化。版本 1.4.0-rc01 包含 这些提交。

版本 1.4.0-beta01

2024 年 8 月 21 日

androidx.profileinstaller:profileinstaller:1.4.0-beta01 发布，与上一个 Alpha 版发布没有变化。版本 1.4.0-beta01 包含 这些提交。

版本 1.4.0-alpha02

2024 年 8 月 7 日

androidx.profileinstaller:profileinstaller:1.4.0-alpha02 发布。版本 1.4.0-alpha02 包含 这些提交。

新功能

  • 向 Profile Installer 添加了 api 35 支持。 (6f9f6fa)

错误修复

  • 删除了对访问新平台 API 的手动概述，因为这在使用 R8 与 AGP 7.3 或更高版本（例如 R8 版本 3.3）时通过 API 建模自动发生，以及在使用 AGP 8.1 或更高版本（例如 D8 版本 8.1）时发生在所有构建中。建议不使用 AGP 的客户更新到 D8 版本 8.1 或更高版本。有关更多详细信息，请参阅 这篇文章。 (If6b4c, b/345472586)

版本 1.4.0-alpha01

2024 年 2 月 7 日

androidx.profileinstaller:profileinstaller:1.4.0-alpha01 已发布。 版本 1.4.0-alpha01 包含以下提交。

错误修复

  • 向配置文件验证器添加了无嵌入配置文件的错误代码。 (Ifb109, b/313928520)
  • 修复了在 Android U (API 34) 以及模拟器上删除着色器时发生的崩溃。 (I031ca, b/274314544)
  • 在配置文件安装程序中启用了对 Android U 的支持。 (Iaf177)
  • 修复了 Android U 上的配置文件安装程序由于进程启动时当前配置文件未创建为空而导致的失败。 (Ie3899)
  • 修复了 V_015S 配置文件格式中的方法位图转码。 (aosp/2906631) 和 (aosp/2847740)

版本 1.3

版本 1.3.1

2023 年 5 月 3 日

androidx.profileinstaller:profileinstaller:1.3.1 已发布。 版本 1.3.1 包含以下提交。

错误修复

  • 在配置文件安装程序中启用了对 Android U 的支持 (Iaf177)
  • 修复了 Android U 上的配置文件安装程序由于进程启动时当前配置文件未创建为空而导致的失败。 (Ie3899)

版本 1.3.0

2023 年 3 月 22 日

androidx.profileinstaller:profileinstaller:1.3.0 已发布。 版本 1.3.0 包含以下提交。

自 1.2.0 以来重要的更改

  • 修复了 ProfileInstallReceiver 中的 NullPointerException。 (b/243851384)
  • 添加了 ProfileVerifier api，用于从应用内部检查是否已编译、安排或缺少基线配置文件 (I263a4, b/246653809)
  • 添加了一个新的 shell 广播，使 Macrobenchmark 能够将内存中的配置文件数据完全刷新到磁盘，以包含在基线配置文件生成中。这需要使用 macrobenchmark 库来使用 BaselineProfileRule 捕获基线配置文件，并使用 CompilationMode.Partial(warmupIterations) 评估配置文件性能。
  • 添加了 诊断代码 来检测压缩的基线配置文件。由于 CPU 开销，Profileinstaller 在 Macrobenchmarks 或生产环境中无法安装压缩的基线配置文件，并且在构建应用时应避免使用压缩的基线配置文件，方法是将 Studio/AGP Electric Eel 或 bundletool 版本更新到 1.13.1(I86413, b/261998144)
  • 添加了 macrobenchmark 的挂钩，用于捕获配置文件和删除着色器缓存，这是在非 ROOT 设备上生成基线配置文件或进行宏基准测试所必需的 (Ie0a7d, b/250083467, b/253094958) (Ia5171, b/231455742)

版本 1.3.0-rc01

2023 年 3 月 8 日

androidx.profileinstaller:profileinstaller:1.3.0-rc01 已发布，自上次 beta 版以来没有任何更改。 版本 1.3.0-rc01 包含以下提交。

版本 1.3.0-beta01

2023 年 2 月 8 日

androidx.profileinstaller:profileinstaller:1.3.0-beta01 已发布。 版本 1.3.0-beta01 包含以下提交。

API 更改

  • 删除了对处理压缩配置文件的支持 - 打开和解压缩会导致启动期间 CPU 利用率下降 10 毫秒，因此改为添加了诊断以发现错误压缩的基线配置文件。 (I86413, b/261998144)

版本 1.3.0-alpha03

2023 年 1 月 11 日

androidx.profileinstaller:profileinstaller:1.3.0-alpha03 已发布。 版本 1.3.0-alpha03 包含以下提交。

错误修复

  • 启用了处理压缩或未压缩的基线配置文件 (Ic61a0)
  • 修复了 MacrobenchmarkScope.dropShaderCache()，通过修复配置文件安装程序清单中的广播注册表不再崩溃 (I5c728, b/258619948)

版本 1.3.0-alpha02

2022 年 11 月 9 日

androidx.profileinstaller:profileinstaller:1.3.0-alpha02 已发布。 版本 1.3.0-alpha02 包含以下提交。

API 更改

  • 添加了基准测试的挂钩，用于删除着色器缓存，以确保冷启动的性能一致，尤其是在使用热身迭代中的配置文件进行编译时。此更新需要使用 benchmark-macro-junit4:1.2.0-alpha05 或更高版本来测量冷启动。有关 Benchmark 库的 API 更改，请参阅 Benchmark 1.2.0-alpha07 页面。 (Ia5171, b/231455742)

版本 1.3.0-alpha01

2022 年 10 月 24 日

androidx.profileinstaller:profileinstaller:1.3.0-alpha01 已发布。 版本 1.3.0-alpha01 包含以下提交。

API 更改

  • 添加了 ProfileVerifier api，用于从应用内部检查是否已编译、安排或缺少基线配置文件 (I263a4, b/246653809)
  • 添加了一个新的 shell 广播，使 Macrobenchmark 能够将内存中的配置文件数据完全刷新到磁盘，以包含在基线配置文件生成中。这需要使用 macrobenchmark 库来使用 BaselineProfileRule 捕获基线配置文件，并使用 CompilationMode.Partial(warmupIterations) 评估配置文件性能。 (Ie0a7d, b/250083467, b/253094958)

版本 1.2.2

版本 1.2.2

2023 年 1 月 11 日

androidx.profileinstaller:profileinstaller:1.2.2 已发布。 版本 1.2.2 包含以下提交。

错误修复

  • 启用了处理压缩或未压缩的基线配置文件 (Ic61a0)

版本 1.2.1

版本 1.2.1

2022 年 12 月 7 日

androidx.profileinstaller:profileinstaller:1.2.1 已发布。 版本 1.2.1 包含以下提交。

新功能

  • 为 S_V2 (API 32) 和 TIRAMISU (API 33) 启用配置文件安装程序 (b/254900303)。

版本 1.2.0

版本 1.2.0

2022 年 7 月 27 日

androidx.profileinstaller:profileinstaller:1.2.0 已发布。 版本 1.2.0 包含以下提交。

自 1.1.0 以来重要的更改

  • 添加了对 Android 12 及更高版本上使用的 ART 配置文件格式的支持。
  • 在 ProfileInstallReceiver 中添加了新的 API，以便在使用基线配置文件时使用 Macrobenchmarks 获得更一致的结果。

版本 1.2.0-rc01

2022 年 6 月 15 日

androidx.profileinstaller:profileinstaller:1.2.0-rc01 已发布。 版本 1.2.0-rc01 包含以下提交。

  • 此版本与 androidx.profileinstaller:profileinstaller:1.2.0-beta03 相同。

版本 1.2.0-beta03

2022 年 6 月 1 日

androidx.profileinstaller:profileinstaller:1.2.0-beta03 已发布。 版本 1.2.0-beta03 包含以下提交。

版本 1.2.0-beta02

2022 年 5 月 18 日

androidx.profileinstaller:profileinstaller:1.2.0-beta02 已发布。 版本 1.2.0-beta02 包含以下提交。

  • 没有更改，需要支持 Compose 1.2.0-beta02 版本。

版本 1.2.0-beta01

2022 年 5 月 11 日

androidx.profileinstaller:profileinstaller:1.2.0-beta01 已发布。 版本 1.2.0-beta01 包含以下提交。

API 更改

  • 在 ProfileInstallReceiver 中添加了新的 API，以便在使用基线配置文件时使用 Macrobenchmarks 获得更一致的结果。 (If2ae5, b/215740637)

错误修复

  • 配置文件安装程序在尝试在 Android 12 及更高版本上使用元数据 V_001 格式时抛出有用的消息。 (aosp/1978526, b/217502387)
  • 配置文件安装程序现在使用 androidx.startup 版本 1.1.1。 (aosp/2077099, b/229828376)

版本 1.2.0-alpha02

2022 年 1 月 26 日

androidx.profileinstaller:profileinstaller:1.2.0-alpha02 已发布。 版本 1.2.0-alpha02 包含以下提交。

此版本与 1.2.0-alpha01 相同。

版本 1.2.0-alpha01

2022 年 1 月 12 日

androidx.profileinstaller:profileinstaller:1.2.0-alpha01 已发布。 版本 1.2.0-alpha01 包含以下提交。

新功能

  • 添加了对 Android 12 及更高版本上使用的 ART 配置文件格式的支持。

版本 1.1.0

版本 1.1.0

2022 年 2 月 9 日

androidx.profileinstaller:profileinstaller:1.1.0 已发布。 版本 1.1.0 包含以下提交。

版本 1.1.0-rc01

2021 年 12 月 15 日

androidx.profileinstaller:profileinstaller:1.1.0-rc01 已发布，自 1.1.0-beta04 以来没有更新。 版本 1.1.0-rc01 包含以下提交。

版本 1.1.0-beta04

2021 年 12 月 1 日

androidx.profileinstaller:profileinstaller:1.1.0-beta04 已发布。 版本 1.1.0-beta04 包含以下提交。

版本 1.1.0-beta03

2021 年 11 月 17 日

androidx.profileinstaller:profileinstaller:1.1.0-beta03 已发布。 版本 1.1.0-beta03 包含以下提交。

错误修复

  • 更新以支持 Compose 1.1.0-beta03

版本 1.1.0-beta02

2021 年 11 月 3 日

androidx.profileinstaller:profileinstaller:1.1.0-beta02 已发布。 版本 1.1.0-beta02 包含以下提交。

错误修复

  • 更新以支持 Compose 1.1.0-beta02

版本 1.1.0-beta01

2021 年 10 月 27 日

androidx.profileinstaller:profileinstaller:1.1.0-beta01 已发布。 版本 1.1.0-beta01 包含以下提交。

  • 自 1.1.0-alpha07 以来没有更改。

版本 1.1.0-alpha07

2021 年 10 月 13 日

androidx.profileinstaller:profileinstaller:1.1.0-alpha07 已发布。 版本 1.1.0-alpha07 包含以下提交。

新功能

  • 添加了对 Android N 上 profm 的支持

版本 1.1.0-alpha06

2021 年 9 月 29 日

androidx.profileinstaller:profileinstaller:1.1.0-alpha06 已发布。 版本 1.1.0-alpha06 包含以下提交。

错误修复

  • 修复了 N、O 和 O_MR1 上的 profileinstaller 转换问题。 (I12d75)

版本 1.1.0-alpha05

2021 年 9 月 15 日

androidx.profileinstaller:profileinstaller:1.1.0-alpha05 已发布。 版本 1.1.0-alpha05 包含以下提交。

错误修复

  • 修复了 Android Nougat 和 Android Oreo 对多 dex apk 的配置文件转换。

版本 1.1.0-alpha04

2021 年 9 月 1 日

androidx.profileinstaller:profileinstaller:1.1.0-alpha04 已发布。 版本 1.1.0-alpha04 包含以下提交。

错误修复

  • 修复 ProfileInstaller 以便使用基线配置文件的应用更容易使用 CompilationMode.BaselineProfile 运行 MacroBenchmarks。 (I42657, b/196074999)

版本 1.1.0-alpha03

2021 年 8 月 18 日

androidx.profileinstaller:profileinstaller:1.1.0-alpha03 已发布。 版本 1.1.0-alpha03 包含以下提交。

错误修复

  • 将 profileinstaller 跳过行为更改为将 PackageInfo.lastUpdatedTime 记录在应用程序文件目录中的文件中，并在下次运行时进行比较，然后再安装配置文件。 (Ib93d1)
  • 调整 P、Q、R 设备上的配置文件格式，以符合 ART 要求 (I84e89)

版本 1.1.0-alpha02

2021 年 8 月 4 日

androidx.profileinstaller:profileinstaller:1.1.0-alpha02 已发布。 版本 1.1.0-alpha02 包含以下提交。

更新以与 Compose 1.1.0-alpha01 兼容。

版本 1.1.0-alpha01

2021 年 7 月 21 日

androidx.profileinstaller:profileinstaller:1.1.0-alpha01 已发布。 版本 1.1.0-alpha01 包含以下提交。

错误修复

  • 修复了在某些情况下会触发严格模式的错误。

版本 1.0

版本 1.0.4

2021 年 10 月 13 日

androidx.profileinstaller:profileinstaller:1.0.4 已发布。 版本 1.0.4 包含以下提交。

  • 更新以支持 Compose 1.0.4

版本 1.0.3

2021 年 9 月 29 日

androidx.profileinstaller:profileinstaller:1.0.3 已发布。 版本 1.0.3 包含以下提交。

  • 更新以支持 Compose 1.0.3

版本 1.0.2

2021 年 9 月 1 日

androidx.profileinstaller:profileinstaller:1.0.2 已发布。 版本 1.0.2 包含以下提交。

错误修复

  • 为 P、Q、R 设备添加了配置文件转换。此更改意味着这些设备将转换配置文件，确保写入的配置文件始终可供 ART 使用。以前，这些平台上的转换将被跳过，这有时会导致 ART 无法处理源配置文件。开发人员 API 没有变化。

版本 1.0.1

2021 年 8 月 4 日

androidx.profileinstaller:profileinstaller:1.0.1 已发布。 版本 1.0.1 包含以下提交。

更新以与 Compose 1.0.1 兼容。

版本 1.0.0

2021 年 7 月 28 日

androidx.profileinstaller:profileinstaller:1.0.0 已发布。 版本 1.0.0 包含以下提交。

1.0.0 的主要功能

Profile installer 是一个新库，允许库和应用程序定义“配置文件规则”并将 ART 配置文件信息捆绑到 APK 中，该库将在应用程序启动后安装这些配置文件。这可以用来提高应用程序性能。

有关这些配置文件规则是什么以及如何工作的更多信息，请参阅 1.0.0-beta01 中的详细发布说明。

版本 1.0.0-rc02

2021 年 7 月 14 日

androidx.profileinstaller:profileinstaller:1.0.0-rc02 已发布。 版本 1.0.0-rc02 包含以下提交。

版本 1.0.0-rc01

2021 年 7 月 1 日

androidx.profileinstaller:profileinstaller:1.0.0-rc01 已发布。 版本 1.0.0-rc01 包含以下提交。

这是一个 RC 版本，与 beta 版本没有变化。

版本 1.0.0-beta01

2021 年 6 月 16 日

androidx.profileinstaller:profileinstaller:1.0.0-beta01 已发布。 版本 1.0.0-beta01 包含以下提交。

库用途

Profile installer 是一个新库，允许库和应用程序定义“配置文件规则”并将 ART 配置文件信息捆绑到 APK 中，该库将在应用程序启动后安装这些配置文件。这可以用来提高应用程序性能。

此配置文件安装使用 androidx.startup 库完成。如果出于任何原因，您希望禁用配置文件安装，则可以修改清单以将其删除


       <provider
           android:name="androidx.startup.InitializationProvider"
           android:authorities="${applicationId}.androidx-startup"
           android:exported="false"
           tools:node="merge">
           <meta-data android:name="androidx.profileinstaller.ProfileInstallerInitializer"
                     tools:node="remove" />
       </provider>

如果您的应用程序具有非平凡的启动要求，并且您希望使用 ProfileInstaller.writeProfile API 手动触发配置文件安装，这将特别有用。

配置文件规则是什么？

  • 库的配置文件规则在 src/main 或等效目录中的文本文件 baseline-prof.txt 中指定。该文件每行指定一个规则，其中规则在这种情况下是匹配库中方法或类的模式。这些规则的语法是使用 adb shell profman --dump-classes-and-methods ... 时使用的可读 ART 配置文件格式的超集。这些规则采用两种形式之一来定位方法或类。

  • 方法规则将具有以下模式

    <FLAGS><CLASS_DESCRIPTOR>-><METHOD_SIGNATURE>

  • 类规则将具有以下模式

    <CLASS_DESCRIPTOR>

  • 这里 <FLAGS> 是一个或多个字符 H、S 和 P，表示是否应将此方法标记为“热”、“启动”或“启动后”。

  • <CLASS_DESCRIPTOR> 是目标方法所属类的描述符。例如，类 androidx.compose.runtime.SlotTable 的描述符为 Landroidx/compose/runtime/SlotTable;。

  • <METHOD_SIGNATURE> 是方法的签名，包括方法的名称、参数类型和返回类型。例如，方法 fun isPlaced(): Boolean 在 LayoutNode 上的签名为 isPlaced()Z。

  • 这些模式可以包含通配符 (**、* 和 ?) 以便单个规则包含多个方法或类。

规则的作用是什么？

  • 具有标志 H 的方法表示此方法是“热”方法，应提前编译。

  • 具有标志 S 的方法表示它是启动时调用的方法，应提前编译以避免启动时编译和解释方法的成本。

  • 具有标志 P 的方法表示它是启动后调用的方法。

  • 此文件中存在的类表示它在启动期间使用，应在堆中预先分配以避免类加载的成本。

这是如何运作的？

  • 库可以定义这些规则，这些规则将打包在 AAR 工件中。然后，当构建包含这些工件的 APK 时，这些规则将合并在一起，合并后的规则用于构建特定于 APK 的紧凑二进制 ART 配置文件。然后，ART 可以利用此配置文件，当 APK 安装在设备上时，提前编译应用程序的特定子集，以提高应用程序的性能，尤其是首次运行。请注意，这将对可调试应用程序没有影响。

  • 规则文件应命名为 baseline-prof.txt 并放置在主源集的根目录中（它应该是 AndroidManifset.xml 文件的同级文件）

  • 目前，这些文件只有在您使用 Android Gradle 插件 7.0+ 时才会使用，并且目前仅在您的 gradle.properties 中使用标志启用。

    # Enable adding baseline-prof.txt files to AAR artifacts, and binary profiles to APKs
android.experimental.enableArtProfiles=true

配置文件需要平衡

  • 正确制作的配置文件会正确优先考虑启动路径中将存在的和性能关键的方法和类，这将产生最佳结果，但是将太多方法或类包含在配置文件中最终会导致内存消耗和磁盘使用方面的负面影响，因此建议如果定义自己的配置文件规则，则从保守开始。