构建性能分析

较大的项目或实现大量自定义构建逻辑的项目可能需要您更深入地了解构建过程以查找瓶颈。您可以通过分析 Gradle 执行构建生命周期各个阶段和每个构建任务所需的时间来做到这一点。例如，如果您的构建配置文件显示 Gradle 花费了过多的时间来配置您的项目，则可能建议您需要将自定义构建逻辑移出配置阶段。此外，如果mergeDevDebugResources任务消耗了大量构建时间，则可能表示您需要将图像转换为 WebP或禁用 PNG 压缩。

如果您使用的是 Android Studio 4.0 或更高版本，则调查构建性能问题的最佳方法是使用构建分析器。

此外，还有两种选择可以在 Android Studio 之外分析构建性能

独立的gradle-profiler工具，一个用于深入分析构建的强大工具。
Gradle 的--profile选项，一个可从 Gradle 命令行使用的便捷工具。

使用独立的`gradle-profiler`工具

为了找到为您提供最佳构建速度的项目设置，您应该使用Gradle 性能分析器，这是一个用于收集 Gradle 构建的性能分析和基准测试信息的工具。Gradle 性能分析器允许您创建构建场景并多次运行它们，从而避免结果之间出现较大的差异，并确保结果的可重复性。

基准测试模式应用于收集有关干净构建和增量构建的信息，而性能分析模式可用于收集有关运行的更详细的信息，包括 CPU 快照。

一些用于基准测试的项目设置配置包括

插件版本
Gradle 版本
JVM 设置（堆大小、永久代大小、垃圾回收等）
Gradle 工作线程数 (org.gradle.workers.max)
每个插件的选项以进一步优化性能

入门

按照这些说明安装 gradle-profiler
运行：gradle-profiler --benchmark --project-dir <root-project> :app:assembleDebug

这将对完全最新的构建进行基准测试，因为--benchmark会多次运行任务，而不会在两次运行之间更改项目。然后，它将在profile-out/目录下生成 HTML 报告，向您显示构建时间。

还有一些其他场景可能更有用处

您在其中执行大部分工作的类中方法体中的代码更改。
在整个项目中使用的模块中的 API 更改。虽然这不如您自己的代码更改频繁，但它会产生更大的影响，因此测量它非常有用。
布局编辑以模拟 UI 工作的迭代。
字符串编辑以模拟处理翻译工作。
干净构建以模拟对构建本身的更改（例如，Android Gradle 插件更新、Gradle 更新或对buildSrc下您自己的构建代码的编辑）。

为了对这些用例进行基准测试，您可以创建一个将用于驱动gradle-profiler执行并对您的源代码应用适当更改的场景。您可以查看下面的一些常见场景。

分析不同的内存/CPU 设置

为了对不同的内存和 CPU 设置进行基准测试，您可以创建多个场景，这些场景使用 org.gradle.jvmargs 的不同值。例如，您可以创建以下场景

# <root-project>/scenarios.txt
clean_build_2gb_4workers {
    tasks = [":app:assembleDebug"]
    gradle-args = ["--max-workers=4"]
    jvm-args = ["-Xmx2048m"]
    cleanup-tasks = ["clean"]
}
clean_build_parallelGC {
    tasks = [":app:assembleDebug"]
    jvm-args = ["-XX:+UseParallelGC"]
    cleanup-tasks = ["clean"]
}

clean_build_G1GC_4gb {
    tasks = [":app:assembleDebug"]
    jvm-args = ["-Xmx4096m", "-XX:+UseG1GC"]
    cleanup-tasks = ["clean"]
}

运行 gradle-profiler --benchmark --project-dir <root-project> --scenario-file scenarios.txt 将运行三个场景，您可以比较 :app:assembleDebug 在每个设置下花费的时间。

分析不同的 Gradle 插件版本

为了找出更改 Gradle 插件版本如何影响构建时间，请为基准测试创建一个场景。这需要一些准备工作，以便从场景中注入插件版本。修改您的根 build.gradle 文件

# <root-project>/build.gradle
buildscript {
    def agpVersion = providers.systemProperty("agpVersion").forUseAtConfigurationTime().orNull ?: '4.1.0'

    ext.kotlin = providers.systemProperty('kotlinVersion').forUseAtConfigurationTime().orNull ?: '1.4.0'

    dependencies {
        classpath "com.android.tools.build:gradle:$agpVersion"
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin"
    }
}

现在，您可以从场景文件中指定 Android Gradle 插件和 Kotlin Gradle 插件版本，并让场景向源文件中添加一个新方法

# <root-project>/scenarios.txt
non_abi_change_agp4.1.0_kotlin1.4.10 {
    tasks = [":app:assembleDebug"]
    apply-abi-change-to ["app/src/main/java/com/example/your_app/your_code_file.java,
                              "app/src/main/java/com/example/your_app/your_code_file.kt"]
    System-properties {
      "agpVersion" = "4.1.0"
      "kotlinVersion" = "1.4.10"
}

non_abi_change_agp4.2.0_kotlin1.4.20 {
    tasks = [":app:assembleDebug"]
    apply-abi-change-to ["app/src/main/java/com/example/your_app/your_code_file.java,
                              "app/src/main/java/com/example/your_app/your_code_file.kt"]
    System-properties {
      "agpVersion" = "4.2.0-alpha16"
      "kotlinVersion" = "1.4.20"
}

分析增量构建

大多数构建都是增量构建，这使得它成为最重要的分析场景之一。Gradle Profiler 广泛支持分析增量构建。它能够通过更改方法体、添加新方法或更改布局或字符串资源来自动应用源文件的更改。例如，您可以创建如下增量场景

# <root-project>/scenarios.txt
non_abi_change {
    tasks = [":app:assembleDebug"]
    apply-non-abi-change-to = ["app/src/main/java/com/example/your_app/your_code_file.java,
                              "app/src/main/java/com/example/your_app/your_code_file.kt"]
}

abi_change {
    tasks = [":app:assembleDebug"]
    apply-abi-change-to = ["app/src/main/java/com/example/your_app/your_code_file.java,
                              "app/src/main/java/com/example/your_app/your_code_file.kt"]
}

layout_change {
    tasks = [":app:assembleDebug"]
    apply-android-layout-change-to = "app/src/main/res/your_layout_file.xml"
}
string_resource_change {
    tasks = [":app:assembleDebug"]
    apply-android-resource-value-change-to = "app/src/main/res/values/strings.xml"
}

运行 gradle-profiler --benchmark --project-dir <root-project> --scenario-file scenarios.txt 将生成包含基准测试数据的 HTML 报告。

您可以将增量场景与其他设置（如堆大小、工作线程数或 Gradle 版本）结合使用

# <root-project>/scenarios.txt
non_abi_change_4g {
    tasks = [":app:assembleDebug"]
    apply-non-abi-change-to ["app/src/main/java/com/example/your_app/your_code_file.java,
                              "app/src/main/java/com/example/your_app/your_code_file.kt"]
    jvm-args = ["-Xmx4096m"]
}

non_abi_change_4g_8workers {
    tasks = [":app:assembleDebug"]
    apply-non-abi-change-to ["app/src/main/java/com/example/your_app/your_code_file.java,
                              "app/src/main/java/com/example/your_app/your_code_file.kt"]
    jvm-args = ["-Xmx4096m"]
    gradle-args = ["--max-workers=8"]
}

non_abi_change_3g_gradle67 {
    tasks = [":app:assembleDebug"]
    apply-non-abi-change-to ["app/src/main/java/com/example/your_app/your_code_file.java,
                              "app/src/main/java/com/example/your_app/your_code_file.kt"]
    jvm-args = ["-Xmx3072m"]
    version = ["6.7"]
}

分析干净构建

为了对干净构建进行基准测试，您可以创建一个场景来驱动 gradle-profiler 的执行

# <root-project>/scenarios.txt
clean_build {
    tasks = [":app:assembleDebug"]
    cleanup-tasks = ["clean"]
}

要运行此场景，请使用以下命令

gradle-profiler --benchmark --project-dir <root-project> --scenario-file scenarios.txt

使用 Gradle 的 `--profile` 选项

要从 Gradle 命令行生成和查看构建配置文件，请执行以下步骤

在项目的根目录打开命令行终端。
通过输入以下命令执行干净构建。在分析构建时，您应该在每次分析的构建之间执行干净构建，因为如果任务的输入（如源代码）没有更改，Gradle 会跳过这些任务。因此，第二次没有输入更改的构建总是运行得更快，因为任务不会重新运行。因此，在构建之间运行 clean 任务可以确保您分析完整的构建过程。
```
// On Mac or Linux, run the Gradle wrapper using "./gradlew".
gradlew clean
```
使用以下标志执行其中一个产品变体的调试构建，例如“dev”变体
```
gradlew --profile --offline --rerun-tasks assembleFlavorDebug
```
- --profile：启用分析。
- --offline：禁用 Gradle 获取在线依赖项。这确保了 Gradle 尝试更新依赖项引起的任何延迟不会干扰您的分析数据。您应该已经构建过项目一次，以确保 Gradle 已经下载并缓存了您的依赖项。
- --rerun-tasks：强制 Gradle 重新运行所有任务并忽略任何任务优化。
图 1. 项目视图指示配置文件的位置。

构建完成后，使用项目窗口导航到 project-root/build/reports/profile/ 目录（如图 1 所示）。
右键单击 profile-timestamp.html 文件，然后选择在浏览器中打开 > 默认。报告应类似于图 2 中所示的报告。您可以检查报告中的每个选项卡以了解您的构建，例如任务执行选项卡，该选项卡显示 Gradle 执行每个构建任务花费的时间。

图 2. 在浏览器中查看报告。
可选：在对项目或构建配置进行任何更改之前，重复步骤 3 中的命令，但省略 --rerun-tasks 标志。由于 Gradle 尝试通过不重新执行输入未更改的任务来节省时间（这些任务在报告的任务执行选项卡中显示为 UP-TO-DATE，如图 3 所示），因此您可以识别哪些任务在不应该执行时正在执行工作。例如，如果 :app:processDevUniversalDebugManifest 未标记为 UP-TO-DATE，则可能表明您的构建配置正在每次构建时动态更新清单。但是，某些任务需要在每次构建期间运行，例如 :app:checkDevDebugManifest。

图 3. 查看任务执行结果。

现在您已经有了构建配置文件报告，您可以通过检查报告中每个选项卡的信息来开始寻找优化机会。某些构建设置需要进行实验，因为好处可能因项目和工作站而异。例如，代码库较大的项目可能会从代码缩减中受益，以删除未使用的代码并缩减应用程序大小。但是，较小的项目可能会更多地受益于完全禁用代码缩减。此外，增加 Gradle 堆大小（使用 org.gradle.jvmargs）可能会对内存不足的机器的性能产生负面影响。

在对构建配置进行更改后，通过重复上述步骤并生成新的构建配置文件来观察更改的结果。例如，图 4 显示了在应用本页中描述的一些基本优化后，同一示例应用程序的报告。

图 4. 优化构建速度后查看新报告。