StateFlow, el sustituto natural de LiveData
Antonio Leiva

Llevamos una serie de capítulos dedicados a Flow, donde hemos visto desde los conceptos básicos de Flow hasta cómo usar Flow en un ejemplo real.

Incluso hemos visto cómo Flow se integra con Room.

Pero justo en este artículo anterior nos encontramos un problema: no podemos lanzar corrutinas a lo loco cuando se actualiza el scroll del adapter, porque nos podemos encontrar con que se lanza la misma petición a la API antes de que la anterior haya acabado.

Lo ideal sería tener una cola de peticiones, donde hasta que no acabe la anterior no se procese la siguiente. Pero… ¡esto es justo un Flow!

Si recuerdas, hablamos de que los flows emiten sus valores en secuencia, y por tanto la recolección también se hace en secuencia: hasta que no acaba de recolectarse un valor, no se genera el siguiente.

Aquí es donde entra en juego StateFlow, un Flow dedicado que te va a resultar familiar

¿Qué es StateFlow?

StateFlow es un Flow muy particular, porque:

  • Maneja un único valor en su campo value
  • Cada vez que se modifica, los recolectores asociados a él reciben una actualización
  • Nada más suscribirse, recibe el último valor asignado a value
  • Existen 2 variantes, StateFlow, que es inmutable (no se puede modificar value, y MutableStateFlow

En general, StateFlow sirve para almacenar un estado, y que los cambios en ese estado puedan ser escuchados de forma reactiva.

¿Te suena esto de algo? Es exactamente la definición de LiveData, pero aplicado a los Flows.

Sustituyendo LiveData por StateFlow

Antes de solucionar nuestro problema, te voy a mostrar cómo puedes usar StateFlow en lugar de LiveData.

En el ViewModel teníamos este código:

private val _spinner = MutableLiveData<Boolean>()
val spinner: LiveData<Boolean> get() = _spinner

Aquí es fácil. Solo tenemos que cambiar los LiveData por StateFlow:

private val _spinner = MutableStateFlow(true)
val spinner: StateFlow<Boolean> get() = _spinner

Solo hay un peuqeño cambio, y es que se nos pide un valor inicial, que le vamos a asignar true, y así nos olvidamos de hacerlo en el init.

Si ves que no te encuentra estas clases, es porque necesitas añadir una versión posterior de las corrutinas. En el momento de escribir este artículo, esta era la última versión existente:

implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.4.1'

En la activity también hay que cambar cosas. Antes teníamos:

viewModel.spinner.observe(this@MainActivity, { progress.visible = it })

Y ahora tendremos:

lifecycleScope.launchWhenStarted {
    viewModel.spinner.collect { visible ->
        progress.visible = visible
    }
}

Si no consigues importar lifecycleScope es porque necesitas la siguiente dependencia:

implementation 'androidx.lifecycle:lifecycle-runtime-ktx:2.2.0'

Además, cuando lo único que queremos es escuchar los cambios de un Flow, tenemos una opción más sencilla que abrir un bloque de launch. Podemos indicarle sencillamente en qué scope queremos que se lance:

viewModel.spinner
    .onEach { progress.visible = it }
    .launchIn(lifecycleScope)

En este caso no te lo recomiendo, porque queremos que se lance cuando la activity se inicia y que pare de escucharse cuando la activity para.

Solucionando nuestro problema con StateFlow

En vez de lanzar una corrutina cada vez que informamos de una nueva actualización del estado del scroll, lo podemos hacer mediante un StateFlow editable que dejemos público en el ViewModel:

val lastVisible = MutableStateFlow(0)

Desde la Activity solo tendríamos que hacer:

recycler.addOnScrollListener(object : RecyclerView.OnScrollListener() {
    override fun onScrolled(recyclerView: RecyclerView, dx: Int, dy: Int) {
        viewModel.lastVisible.value = layoutManager.findLastVisibleItemPosition()
    }
})

Y desde el ViewModel, observar los cambios de este StateFlow:

init {
    viewModelScope.launch {
        lastVisible.collect { notifyLastVisible(it) }
    }
}

private suspend fun notifyLastVisible(lastVisible: Int) {
    repository.checkRequireNewPage(lastVisible)
    _spinner.value = false
}

Conclusión

¡Pues ya está! Con esto ya hemos dado nuestros primeros pasos para entender cómo funciona Flow integrado con el framework de Android, y cómo algunas librerías ya lo soportan.

Si te interesa este tema y quieres ver otros ejemplos más particulares, déjame en los comentarios sugerencias y me plantearé hacerlo para siguientes vídeos.

Quizá también te interese…

2 formas de recolectar Flows en la UI que SÍ funcionan

2 formas de recolectar Flows en la UI que SÍ funcionan

En la serie de artículos sobre Programación Reactiva con Flow hemos visto muchos conceptos, y hemos aprendido cómo aplicarlos al desarrollo Android. Pero hay algo que no hemos hecho del todo bien. Esto es la recolección de Flows desde la Activity (o el Fragment, en...

Cómo hacer tests de Corrutinas y Flows – Paso a Paso

Cómo hacer tests de Corrutinas y Flows – Paso a Paso

¡Vaya viaje por el que hemos pasado en estos artículos! Hace ya varios de ellos empezamos hablando sobre la programación reactiva con Flow, y hemos aprendido un montón de conceptos e ideas sobre cómo aplicarlos en el día a día. Pero nada de esto está completo si no...

Convertir cualquier callback en un Flow con CallbackFlow

Convertir cualquier callback en un Flow con CallbackFlow

Existen varios tipos de Flows muy particulares que nos van a solucionar la vida cuando tengamos que hacer cosas muy concretas. Ya vimos StateFlow en un artículo anterior, y en esta ocasión hablamos de CallbackFlow ¿Qué es CallbackFlow? Es un tipo de Flow que nos...