StateFlow for reactive state in Android Kotlin

Introduction

StateFlow helps your app react to changes in data automatically. It keeps your app's state updated and UI in sync without extra work.

When you want your app to update the screen automatically when data changes.

When you need to share data between different parts of your app and keep it consistent.

When you want to handle user input and show results immediately.

When you want to avoid manual updates and callbacks for state changes.

Syntax

Android Kotlin

private val _state = MutableStateFlow(initialValue)
val state: StateFlow<Type> = _state

// To update state:
_state.value = newValue

Use MutableStateFlow to change the state inside your class.

Expose StateFlow to other classes to observe changes without allowing them to modify the state.

Examples

This example creates a count state starting at 0 and updates it to 5.

Android Kotlin

private val _count = MutableStateFlow(0)
val count: StateFlow<Int> = _count

// Update count
_count.value = 5

This example holds a text state and updates it to "Hello".

Android Kotlin

private val _text = MutableStateFlow("")
val text: StateFlow<String> = _text

// Update text
_text.value = "Hello"

Sample App

This program creates a simple counter using StateFlow. It prints the count every time it changes. When increment() is called, the count updates and the new value prints automatically.

Android Kotlin

import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.StateFlow
import kotlinx.coroutines.runBlocking
import kotlinx.coroutines.launch

class Counter {
  private val _count = MutableStateFlow(0)
  val count: StateFlow<Int> = _count

  fun increment() {
    _count.value += 1
  }
}

fun main() = runBlocking {
  val counter = Counter()

  val job = launch {
    counter.count.collect { value ->
      println("Count is: $value")
    }
  }

  counter.increment() // Count becomes 1
  counter.increment() // Count becomes 2

  job.cancel()
}

Important Notes

StateFlow always has a current value, so you can get it anytime with .value.

Use collect to listen for changes and update UI or other parts of your app.

Remember to cancel collectors when they are no longer needed to avoid memory leaks.

Summary

StateFlow holds and emits state updates reactively.

Use MutableStateFlow to change state, and expose StateFlow to observe it.

Collect StateFlow to react to changes and update your UI automatically.

Practice

1. What is the main purpose of StateFlow in Android Kotlin development?

easy

A. To hold and emit state updates reactively to observers

B. To perform background network requests

C. To store user preferences permanently

D. To manage database transactions

Solution

1. Step 1: Understand StateFlow's role

   StateFlow is designed to hold a state value and emit updates whenever the state changes.

2. Step 2: Compare with other options

   Options A, B, and D describe unrelated tasks like storage, networking, or database management, which are not StateFlow's purpose.

3. Final Answer:

   To hold and emit state updates reactively to observers -> Option A

4. Quick Check:

   StateFlow = reactive state holder [OK]

Hint: StateFlow always relates to reactive state updates [OK]

Common Mistakes:

• Confusing StateFlow with networking or storage APIs
• Thinking StateFlow stores data permanently
• Assuming StateFlow manages database directly

2. Which of the following is the correct way to declare a mutable StateFlow holding an integer value starting at 0?

easy

A. val state = StateFlow<Int>(0)

B. val state = MutableStateFlow(0)

C. val state = mutableStateFlowOf(0)

D. val state = StateFlow.mutable(0)

Solution

1. Step 1: Recall MutableStateFlow syntax

   The correct way to create a mutable StateFlow is using MutableStateFlow(initialValue).

2. Step 2: Check each option

   val state = StateFlow<Int>(0) uses StateFlow constructor which is not allowed. val state = mutableStateFlowOf(0) uses a non-existent function. val state = StateFlow.mutable(0) uses invalid syntax.

3. Final Answer:

   val state = MutableStateFlow(0) -> Option B

4. Quick Check:

   MutableStateFlow = mutable state holder [OK]

Hint: MutableStateFlow constructor takes initial value directly [OK]

Common Mistakes:

• Trying to instantiate StateFlow directly
• Using wrong function names like mutableStateFlowOf
• Incorrect syntax for mutable StateFlow creation

3. Given the following code snippet, what will be printed to the console?

val state = MutableStateFlow(0)

state.value = 5
println(state.value)

medium

A. Compilation error

B. 0

C. null

D. 5

Solution

1. Step 1: Understand MutableStateFlow value assignment

   MutableStateFlow's value property can be updated directly, changing the current state.

2. Step 2: Trace the code execution

   Initially, state.value is 0. Then it is set to 5. Printing state.value outputs 5.

3. Final Answer:

   5 -> Option D

4. Quick Check:

   state.value after assignment = 5 [OK]

Hint: MutableStateFlow.value updates immediately and can be read directly [OK]

Common Mistakes:

• Assuming initial value remains unchanged
• Thinking value is nullable and prints null
• Expecting compilation error due to direct assignment

4. Identify the error in the following Kotlin code using StateFlow:

val state = MutableStateFlow(0)

fun updateState(newValue: Int) {
  state.emit(newValue)
}

medium

A. Cannot call emit on MutableStateFlow

B. MutableStateFlow does not hold an initial value

C. emit is a suspend function and must be called from a coroutine

D. StateFlow cannot be updated after creation

Solution

1. Step 1: Check usage of emit on MutableStateFlow

   The emit function is a suspend function and requires a coroutine context to be called.

2. Step 2: Analyze the code context

   The function updateState is not marked suspend and does not launch a coroutine, so calling emit here causes an error.

3. Final Answer:

   emit is a suspend function and must be called from a coroutine -> Option C

4. Quick Check:

   emit requires coroutine context [OK]

Hint: emit is suspend; call only inside coroutine or suspend function [OK]

Common Mistakes:

• Calling emit outside coroutine without suspend
• Confusing emit with direct value assignment
• Assuming MutableStateFlow has no initial value

5. You want to expose a read-only StateFlow from a ViewModel while keeping the ability to update the state internally. Which of the following is the best practice to achieve this?

hard

A. Keep a private MutableStateFlow and expose a public StateFlow using asStateFlow()

B. Expose the MutableStateFlow as a public property and update it internally

C. Declare a public MutableStateFlow and update it directly from outside the ViewModel

D. Use a regular Flow instead of StateFlow for state updates

Solution

1. Step 1: Understand encapsulation of state

   To prevent external modification, keep MutableStateFlow private inside ViewModel.

2. Step 2: Expose read-only StateFlow

   Use asStateFlow() to expose a read-only StateFlow to observers outside the ViewModel.

3. Step 3: Evaluate other options

   Declare a public MutableStateFlow and update it directly from outside the ViewModel breaks encapsulation. Expose the MutableStateFlow as a public property and update it internally exposes mutable state publicly. Use a regular Flow instead of StateFlow for state updates changes the reactive type unnecessarily.

4. Final Answer:

   Keep a private MutableStateFlow and expose a public StateFlow using asStateFlow() -> Option A

5. Quick Check:

   Private MutableStateFlow + public asStateFlow() = best practice [OK]

Hint: Use private MutableStateFlow + public asStateFlow() for safe exposure [OK]

Common Mistakes:

• Making MutableStateFlow public and mutable externally
• Not using asStateFlow() to expose read-only state
• Replacing StateFlow with Flow unnecessarily