Corrige problemas de estabilidad

Cuando te encuentras con una clase inestable que causa problemas de rendimiento, debes hacer que sea estable. En este documento, se describen varias técnicas que puedes usar para hacerlo.

Cómo hacer que la clase sea inmutable

Primero, debes intentar hacer que una clase inestable sea completamente inmutable.

• Inmutable: Indica un tipo en el que el valor de cualquier propiedad nunca puede cambiar después de que se construye una instancia de ese tipo, y todos los métodos son transparentes en términos de referencia.
  • Asegúrate de que todas las propiedades de la clase sean val en lugar de var y que sean de tipos inmutables.
  • Los tipos primitivos, como String, Int y Float, son siempre inmutables.
  • Si esto es imposible, debes usar el estado de Compose para cualquier propiedad mutable.
• Estable: Indica un tipo que es mutable. El entorno de ejecución de Compose no detecta si cualquiera de las propiedades públicas o el comportamiento del método del tipo generarían resultados diferentes de los de una invocación anterior, y cuándo lo hacen.

Colecciones inmutables

Una razón común por la que Compose considera que una clase es inestable son las colecciones. Como se señaló en la página Cómo diagnosticar problemas de estabilidad, el compilador de Compose no puede estar completamente seguro de que colecciones como List, Map y Set son verdaderamente inmutables y, por lo tanto, las marca como inestables.

Para resolver esto, puedes usar colecciones inmutables. El compilador de Compose admite las colecciones inmutables de Kotlinx. Se garantiza que estas colecciones son inmutables, y el compilador de Compose las trata como tales. Esta biblioteca todavía está en versión alfa, por lo que puedes esperar posibles cambios en su API.

Considera de nuevo esta clase inestable de la guía Diagnostica problemas de estabilidad:

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

Puedes hacer que tags sea estable con una colección inmutable. En la clase, cambia el tipo de tags a ImmutableSet<String>:

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

Después de hacerlo, todos los parámetros de la clase son inmutables, y el compilador de Compose la marca como estable.

Anota con Stable o Immutable

Una posible ruta para resolver los problemas de estabilidad es anotar las clases inestables con @Stable o @Immutable.

La anotación de una clase anula lo que el compilador inferiría sobre tu clase. Es similar al operador !! en Kotlin. Debes tener mucho cuidado con el uso de estas anotaciones. Anular el comportamiento del compilador podría generar errores imprevistos, como que el elemento componible no se vuelva a componer cuando esperas que lo haga.

Si es posible hacer que tu clase sea estable sin una anotación, deberías esforzarte para lograr la estabilidad de esa manera.

En el siguiente fragmento, se proporciona un ejemplo mínimo de una clase de datos con anotaciones como inmutables:

@Immutable
data class Snack(
…
)

Ya sea que uses la anotación @Immutable o @Stable, el compilador de Compose marca la clase Snack como estable.

Clases con anotaciones en las colecciones

Considera un elemento componible que incluye un parámetro de tipo List<Snack>:

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

Incluso si anotas Snack con @Immutable, el compilador de Compose aún marca el parámetro snacks en HighlightedSnacks como inestable.

Los parámetros enfrentan el mismo problema que las clases cuando se trata de tipos de colección, el compilador de Compose siempre marca un parámetro de tipo List como inestable, incluso cuando es una colección de tipos estables.

No puedes marcar un parámetro individual como estable ni puedes anotar un elemento componible para que siempre se pueda omitir. Hay múltiples caminos hacia adelante.

Existen varias formas de evitar el problema de las colecciones inestables. En las siguientes subsecciones, se describen estos enfoques diferentes.

Archivo de configuración

Si estás conforme con el contrato de estabilidad de tu base de código, puedes aceptar que las colecciones de Kotlin sean estables. Para ello, agrega kotlin.collections.* a tu archivo de configuración de estabilidad.

Colección inmutable

Para garantizar la seguridad del tiempo de compilación de la inmutabilidad, puedes usar una colección inmutable de kotlinx, en lugar de List.

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

Wrapper

Si no puedes usar una colección inmutable, puedes crear la tuya. Para ello, une el List en una clase estable con anotaciones. Según tus requisitos, es probable que la mejor opción sea un wrapper genérico.

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

Luego, puedes usarlo como el tipo de parámetro en el elemento componible.

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

Solución

Después de tomar cualquiera de estos enfoques, el compilador de Compose ahora marca el elemento componible HighlightedSnacks como skippable y 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
)

Durante la recomposición, ahora Compose puede omitir HighlightedSnacks si ninguna de sus entradas cambió.

Archivo de configuración de estabilidad

A partir del compilador de Compose 1.5.5, se puede proporcionar un archivo de configuración de clases que se consideren estables en el tiempo de compilación. De esta manera, puedes considerar las clases que no controlas, como las clases de biblioteca estándar (como LocalDateTime), como estables.

El archivo de configuración es un archivo de texto sin formato con una clase por fila. Se admiten comentarios y comodines únicos y dobles. A continuación, se muestra un ejemplo de configuración:

// 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<*,_>

Para habilitar esta función, pasa la ruta de acceso del archivo de configuración a las opciones del compilador de Compose.

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

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

Como el compilador de Compose se ejecuta en cada módulo de tu proyecto por separado, puedes proporcionar diferentes configuraciones a distintos módulos si es necesario. Como alternativa, puedes tener una configuración en el nivel de raíz de tu proyecto y pasar esa ruta de acceso a cada módulo.

Varios módulos

Otro problema común involucra la arquitectura de varios módulos. El compilador de Compose solo puede inferir si una clase es estable si todos los tipos no primitivos a los que hace referencia están marcados explícitamente como estables o en un módulo que también se compiló con el compilador de Compose.

Si tu capa de datos está en un módulo independiente de tu capa de IU, que es el enfoque recomendado, es posible que este sea un problema.

Solución

Para solucionar este problema, puedes adoptar uno de los siguientes enfoques:

1. Agrega las clases al archivo de configuración del compilador.
2. Habilita el compilador de Compose en los módulos de capa de datos o etiqueta tus clases con @Stable o @Immutable cuando corresponda.
   • Esto implica agregar una dependencia de Compose a tu capa de datos. Sin embargo, es solo la dependencia del entorno de ejecución de Compose y no de Compose-UI.
3. Dentro del módulo de IU, une las clases de capa de datos en clases de wrapper específicas de la IU.

El mismo problema también ocurre cuando se usan bibliotecas externas si no usan el compilador de Compose.

No todos los elementos componibles deben poder omitirse

Cuando intentes solucionar problemas de estabilidad, no debes intentar hacer que todos los elementos componibles se puedan omitir. Intentar hacerlo puede generar una optimización prematura que introduce más problemas de los que corrige.

En muchas situaciones, no tiene ningún beneficio real y puede dificultar el mantenimiento del código. Por ejemplo:

• Es un elemento componible que no se recompone con frecuencia ni en absoluto.
• Un elemento componible que en sí solo llama a elementos componibles que se pueden omitir.
• Un elemento componible con una gran cantidad de parámetros con implementaciones de igualdad costosas En este caso, el costo de verificar si cambió algún parámetro podría superar el costo de una recomposición económica.

Cuando un elemento que admite composición se puede omitir, se agrega una pequeña sobrecarga que puede no valer la pena. Incluso puedes anotar el elemento componible para que sea no reiniciable en casos en los que determines que reiniciarse implica más sobrecarga de lo que vale la pena.