StateFlow или LiveData: что выбрать в новом проекте

Вопрос возникает каждый раз, когда заводят новый экран: состояние держать в LiveData, как привыкли, или в StateFlow, как советуют. Коротко: в новом коде — StateFlow. Ниже о том, почему, и в каких случаях ответ другой.

Что они вообще такое

LiveData — класс из Jetpack, придуманный до корутин. Он держит одно значение, умеет отдавать его подписчикам и — главная его идея — сам отписывается, когда экран уходит в фон. Операторов у него почти нет: map, switchMap и всё.

StateFlow — горячий поток из библиотеки корутин. Тоже всегда содержит текущее значение, тоже немедленно отдаёт его новому подписчику, тоже отсекает одинаковые значения подряд. Но при этом он часть Flow и работает со всеми операторами.

LiveDataStateFlow
ОткудаAndroid Jetpackkotlinx.coroutines
Работает вне Androidнетда
Операторыmap, switchMapвесь арсенал Flow
Жизненный циклзнает самнужен collectAsStateWithLifecycle или repeatOnLifecycle
Начальное значениенеобязательнообязательно
Тестированиенужен InstantTaskExecutorRuleобычный runTest

Почему StateFlow

Он не привязан к Android. ViewModel со StateFlow тестируется обычным runTest, без правил JUnit и без подмены главного исполнителя задач. Тот же код работает в общем модуле мультиплатформенного проекта.

У него есть операторы. Поиск с задержкой, объединение двух источников, отмена устаревшего запроса — всё это на LiveData пишется руками, а на Flow занимает строчку.

Он обязывает задать начальное значение. Выглядит как мелочь, но это означает, что состояние экрана всегда определено: нет момента, когда оно равно null и непонятно, что рисовать.

Чем за это платим

Главное преимущество LiveData — он сам знает про жизненный цикл. StateFlow не знает, и собирать его бездумно нельзя: подписка продолжит работать, когда экран ушёл в фон.

Лечится это одной функцией. В Compose:

val state by viewModel.state.collectAsStateWithLifecycle()

Во вьюхах:

lifecycleScope.launch {
    repeatOnLifecycle(Lifecycle.State.STARTED) {
        viewModel.state.collect { render(it) }
    }
}

Обычный collectAsState() без WithLifecycle — та самая ошибка, из-за которой экран в фоне продолжает жечь батарею.

Канонический вид состояния

class ProfileViewModel(repo: ProfileRepository) : ViewModel() {

    private val _state = MutableStateFlow<UiState>(UiState.Loading)
    val state: StateFlow<UiState> = _state.asStateFlow()

    fun load() = viewModelScope.launch {
        _state.value = repo.load()
    }
}

Приватный изменяемый, публичный только для чтения. asStateFlow() нужен именно для того, чтобы снаружи нельзя было присвоить значение.

Когда LiveData всё-таки уместна

  • в проекте, который целиком на ней написан: переписывать работающее ради единообразия — плохая сделка;
  • при работе со старым кодом, где LiveData приходит из чужого API — её можно превратить в поток через asFlow();
  • для одноразовых событий ни то ни другое не подходит: событие, показанное один раз, — это SharedFlow или Channel, а не состояние.

Короткий ответ

Новый экран — StateFlow плюс collectAsStateWithLifecycle(). Старый экран на LiveData, который работает, — оставить в покое.

Горячие потоки и состояние экрана разобраны в руководстве по корутинам.