解决稳定性问题

当面对会导致性能问题的类不稳定时，您应使其保持稳定。本文档简要介绍了可用于实现此目的的几种方法。

使类不可变

您应首先尝试使不稳定的类完全不可变。

  • 不可变：表示一种类型，在此类型中，任何属性的值在构建该类型的实例后都永远不会更改，并且所有方法都是透明的。
    • 请确保该类的所有属性均为 val（而非 var），并且均为不可变类型。
    • String, Int 和 Float 等基元类型始终是不可变的。
    • 如果无法做到这一点，您必须对任何可变属性使用 Compose 状态。
  • 稳定：表示可变类型。Compose 运行时不会知道类型的任何公共属性或方法行为是否以及何时会产生与先前调用不同的结果。

不可变的集合

Compose 认为某个类不稳定的常见原因是集合。如诊断稳定性问题页面中所述，Compose 编译器无法完全确定 List, Map 和 Set 等集合是否确实不可变，因此会将其标记为不稳定。

为了解决此问题，您可以使用不可变集合。Compose 编译器支持 Kotlinx 不可变集合。这些集合一定会是不可变的，Compose 编译器也会如此处理。此库仍为 Alpha 版，因此其 API 可能会发生变化。

再次考虑一下诊断稳定性问题指南中的这个不稳定类：

unstable class Snack {
  …
  unstable val tags: Set<String>
  …
}

您可以使用不可变集合使 tags 保持稳定。在该类中，将 tags 的类型更改为 ImmutableSet<String>：

data class Snack{
    …
    val tags: ImmutableSet<String> = persistentSetOf()
    …
}

执行此操作后，该类的所有参数都是不可变的，并且 Compose 编译器会将该类标记为稳定。

使用 Stable 或 Immutable 添加注解

解决稳定性问题的一种可能方法是使用 @Stable 或 @Immutable 为不稳定的类添加注解。

为类添加注解会覆盖编译器以其他方式推断类的内容。它类似于 Kotlin 中的 !! 运算符。您应非常谨慎地如何使用这些注释。替换编译器行为可能会导致无法预料的 bug，例如可组合项没有按预期重组。

如果在不使用注解的情况下也可使类稳定，那么您应力求以这种方式实现稳定性。

以下代码段提供了一个被注释为不可变的数据类的极小示例：

@Immutable
data class Snack(
…
)

无论您使用 @Immutable 注解还是 @Stable 注解，Compose 编译器都会将 Snack 类标记为稳定类。

集合中的带注解的类

假设某个可组合项包含一个 List<Snack> 类型的形参：

restartable scheme("[androidx.compose.ui.UiComposable]") fun HighlightedSnacks(
  …
  unstable snacks: List<Snack>
  …
)

即使您使用 @Immutable 为 Snack 添加注解，Compose 编译器仍会将 HighlightedSnacks 中的 snacks 参数标记为不稳定。

就集合类型而言，参数与类存在相同的问题，Compose 编译器始终将 List 类型的参数标记为不稳定，即使它是稳定类型的集合也是如此。

您无法将单个参数标记为“稳定”，也无法为可组合项添加注解以使其始终可跳过。有多条向前路径。

您可以通过多种方法解决集合不稳定的问题。以下小节概述了这些不同的方法。

配置文件

如果您乐于遵守代码库中的稳定性协定，则可以通过向稳定性配置文件中添加 kotlin.collections.*，选择将 Kotlin 集合视为稳定。

不可变集合

为了确保不可变性在编译时的安全性，您可以使用 kotlinx 不可变集合，而不是 List。

@Composable
private fun HighlightedSnacks(
    …
    snacks: ImmutableList<Snack>,
    …
)

Wrapper

如果您无法使用不可变集合，则可以创建自己的集合。为此，请将 List 封装在带注解的稳定版中。根据您的要求，通用封装容器可能是最佳选择。

@Immutable
data class SnackCollection(
   val snacks: List<Snack>
)

然后，您可以将其用作可组合项中形参的类型。

@Composable
private fun HighlightedSnacks(
    index: Int,
    snacks: SnackCollection,
    onSnackClick: (Long) -> Unit,
    modifier: Modifier = Modifier
)

解决方案

采用上述任一方法后，Compose 编译器现在会将 HighlightedSnacks 可组合项同时标记为 skippable 和 restartable。

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

在重组期间，如果 HighlightedSnacks 的输入未发生更改，Compose 现在可以跳过它。

稳定性配置文件

从 Compose Compiler 1.5.5 开始，您可以在编译时提供要视为稳定版的类的配置文件。这样，您就可以将不控制的类（例如 LocalDateTime 等标准库类）视为稳定。

配置文件是一个纯文本文件，其中每行包含一个类。支持注释、单个和双通配符。示例配置如下所示：

// Consider LocalDateTime stable
java.time.LocalDateTime
// Consider kotlin collections stable
kotlin.collections.*
// Consider my datalayer and all submodules stable
com.datalayer.**
// Consider my generic type stable based off it's first type parameter only
com.example.GenericClass<*,_>

如需启用此功能，请将配置文件的路径传递给 Compose 编译器选项。

Groovy

kotlinOptions {
    freeCompilerArgs += [
            "-P",
            "plugin:androidx.compose.compiler.plugins.kotlin:stabilityConfigurationPath=" +
                    project.absolutePath + "/compose_compiler_config.conf"
    ]
}

Kotlin

kotlinOptions {
  freeCompilerArgs += listOf(
      "-P",
      "plugin:androidx.compose.compiler.plugins.kotlin:stabilityConfigurationPath=" +
      "${project.absolutePath}/compose_compiler_config.conf"
  )
}

由于 Compose 编译器在项目中的每个模块上分别运行，因此您可以根据需要为不同的模块提供不同的配置。或者，在项目的根级别设置一项配置，并将该路径传递给每个模块。

多个模块

另一个常见问题涉及多模块架构。Compose 编译器只有在某个类引用的所有非基元类型均已明确标记为“稳定”或在也是使用 Compose 编译器构建的模块中时，才能推断相应类是否稳定。

如果数据层与界面层位于不同的模块中（建议采用此方法），那么您可能会遇到以下问题。

解决方案

如需解决此问题，您可以采用以下方法之一：

  1. 将类添加到 Compiler 配置文件中。
  2. 对数据层模块启用 Compose 编译器，或者在适当的情况下使用 @Stable 或 @Immutable 标记您的类。
    • 这涉及到向数据层添加 Compose 依赖项。不过，这只是 Compose 运行时的依赖项，而不是 Compose-UI 的依赖项。
  3. 在界面模块中，将您的数据层类封装在界面专用的封装容器类中。

如果外部库不使用 Compose 编译器，也会出现同样的问题。

并非每个可组合项都应该是可跳过的

在解决稳定性问题时，您不应尝试将每个可组合项都设为可跳过。尝试这样做可能会导致过早优化，导致引入的问题多于所修复的问题。

在许多情况下，可跳过没有实际的好处，并且可能导致代码维护困难。例如：

  • 不经常重组或根本不重组的可组合项。
  • 一个可组合项，本身仅调用可跳过的可组合项。
  • 包含大量参数且使用开销很高的 equals 实现的可组合项。在这种情况下，检查任何参数是否发生变化的成本可能会高于低成本重组的成本。

如果可组合项可跳过，则会增加少量开销，可能不值得。如果您确定可重启的开销超出其价值，甚至可以将可组合项注解为不可重启。