诊断稳定性问题

如果您遇到因不必要或过度重组而导致的性能问题，则应调试应用的稳定性。本指南概述了执行此调试的几种方法。

重要提示：您应力求抵制不必要或不成熟的优化。在针对稳定性进行优化之前，请确保您遵循了我们旨在提高 Compose 性能的最佳实践。

注意：如果您想详细了解如何正确测量性能，请参阅 Macrobenchmark 指南。

布局检查器

利用 Android Studio 中的布局检查器，您可以查看哪些可组合项在应用中执行了重组。其中会显示 Compose 执行重组或跳过组件的次数。

Compose 编译器报告

Compose 编译器可以输出其稳定性推断的结果，以供检查。利用输出的这些结果，您可以确定哪些可组合项可跳过，哪些不可跳过。以下小节总结了如何使用这些报告，但如需了解更详细的信息，请参阅技术文档。

警告：只有当您确实遇到了与稳定性相关的性能问题时，才应使用此方法。尝试使整个界面都可跳过是一种不成熟的优化，可能会导致将来的维护困难。

设置

Compiler 编译器报告并非默认启用。您可以通过编译器标记进行激活。确切的设置因项目而异，但对于大多数项目而言，可以将以下脚本粘贴到根 build.gradle 文件中。

Groovy

subprojects {
  tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile).configureEach {
        kotlinOptions {
            if (project.findProperty("composeCompilerReports") == "true") {
                freeCompilerArgs += [
                        "-P",
                        "plugin:androidx.compose.compiler.plugins.kotlin:reportsDestination=" +
                                project.buildDir.absolutePath + "/compose_compiler"
                ]
            }
            if (project.findProperty("composeCompilerMetrics") == "true") {
                freeCompilerArgs += [
                        "-P",
                        "plugin:androidx.compose.compiler.plugins.kotlin:metricsDestination=" +
                                project.buildDir.absolutePath + "/compose_compiler"
                ]
            }
        }
    }
}

Kotlin

subprojects {
    tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile>().configureEach {
        kotlinOptions {
            if (project.findProperty("composeCompilerReports") == "true") {
                freeCompilerArgs += listOf(
                    "-P",
                    "plugin:androidx.compose.compiler.plugins.kotlin:reportsDestination=${project.buildDir.absolutePath}/compose_compiler"
                )
            }
            if (project.findProperty("composeCompilerMetrics") == "true") {
                freeCompilerArgs += listOf(
                    "-P",
                    "plugin:androidx.compose.compiler.plugins.kotlin:metricsDestination=${project.buildDir.absolutePath}/compose_compiler"
                )
            }
        }
    }
}

运行任务

如需调试可组合项的稳定性，请按如下方式运行任务：

./gradlew assembleRelease -PcomposeCompilerReports=true

重要提示：请务必在发布 build 中运行此任务，以确保结果的准确性。

输出示例

此任务会输出三个文件。以下是 JetSnack 中的输出示例。

• <modulename>-classes.txt：关于本模块中类稳定性的报告。示例。
• <modulename>-composables.txt：关于模块中可组合项的可重启和可跳过程度的报告。示例。
• <modulename>-composables.csv：可组合项报告的 CSV 版本，您可以将其导入电子表格或使用脚本进行处理。示例。

注意：composeCompilerMetrics 任务会生成关于项目中可组合项数量的总体统计信息以及其他类似信息。

注意：这些报告会使用 Compose 稳定性指南中描述的编译器标记。

可组合项报告

composables.txt 文件中会详细说明给定模块的每个可组合函数的相关情况，包括其参数的稳定性以及它们是否可重启或可跳过。以下是 JetSnack 中的假设示例：

restartable skippable scheme("[androidx.compose.ui.UiComposable]") fun SnackCollection(
  stable snackCollection: SnackCollection
  stable onSnackClick: Function1<Long, Unit>
  stable modifier: Modifier? = @static Companion
  stable index: Int = @static 0
  stable highlight: Boolean = @static true
)

此 SnackCollection 可组合项完全可重启、可跳过，并且很稳定。一般来说，这是比较好的状态，但无疑并不是强制性要求。

另一方面，我们来看看另一个示例。

restartable scheme("[androidx.compose.ui.UiComposable]") fun HighlightedSnacks(
  stable index: Int
  unstable snacks: List<Snack>
  stable onSnackClick: Function1<Long, Unit>
  stable modifier: Modifier? = @static Companion
)

HighlightedSnacks 可组合项不可跳过。Compose 在重组期间从未跳过它。即使其所有参数均未更改，也是如此。原因在于 unstable 参数 snacks。

类报告

文件 classes.txt 中包含关于给定模块中的类的类似报告。以下代码段是针对类 Snack 的输出：

unstable class Snack {
  stable val id: Long
  stable val name: String
  stable val imageUrl: String
  stable val price: Long
  stable val tagline: String
  unstable val tags: Set<String>
  <runtime stability> = Unstable
}

以下是 Snack 的定义，供参考：

data class Snack(
    val id: Long,
    val name: String,
    val imageUrl: String,
    val price: Long,
    val tagline: String = "",
    val tags: Set<String> = emptySet()
)

Compose 编译器将 Snack 标记为了不稳定。这是因为 tags 参数的类型是 Set<String>。这是一个不可变类型，因为它不是 MutableSet。然而，Set, List 和 Map 等标准集合类最终都是接口。因此，底层实现可能仍然可变。

例如，您可以编写 val set: Set<String> = mutableSetOf("foo")。该变量是常量，其声明的类型不可变，但其实现仍然可变。Compose 编译器无法确定此类的不可变性，因为它只能看到声明的类型，因此将 tags 标记为了不稳定。

重要提示：如需了解如何为这样的不稳定类带来稳定性，请参阅修复稳定性问题指南。