[TIL] 🌼24/05/10🌼#MutableStateFlow value vs emit vs update

[TIL] 🌼24/05/10🌼#MutableStateFlow value vs emit vs update

MutableStateFlow value vs emit vs update

📌참고자료

• Difference Between Value and Emit in MutableStateFlow Kotlin
• Atomic Updates on MutableStateFlow

📌도움될만한 지난 포스팅

• [TIL] 🌼24/04/30🌼#StateFlow #SharedFlow
  

• MutableStateFlow의 값을 변경하는 방법
  • MutableStateFlow.value = newValue
  • MutableStateFlow.emit(newValue)
  • MutableStateFlow.update{ newValue }

value 프로퍼티로 값 변경하기

• MutableStateFlow의 read-write 프로퍼티
  • flow를 subscribe하지 않아도 MutableStateFlow의 값 set/get가능
  • read하는 경우, get을 호출하는 시점의 snapshot 반환
• thread-safe

emit 함수로 값 변경하기

• MutableStateFlow 값을 변경하는 suspend function
  -> coroutine/coroutine context 내에서 호출해야
• flow의 버퍼가 full인 경우, buffer에 자리가 생길 때까지 emit 함수 suspend 됨!

• 참고) tryEmit 함수
  • MutableStateFlow에 emit을 시도하는 함수
    -> emit 성공 시 true 반환, 실패 시 false 반환
  • thread-safe

update 함수로 값 변경하기

• MutableStateFlow의 값을 atomic하게 변경하기 위한 확장함수
  • MutableStateFlow의 값이 제대로 갱신되었는지 busy loop을 돌며 확인

public inline fun <T> MutableStateFlow<T>.update(function: (T) -> T) {
    while (true) {
        val prevValue = value
        val nextValue = function(prevValue)
        if (compareAndSet(prevValue, nextValue)) {
            return
        }
    }
}

• update함수가 필요한 이유?
  value 프로퍼티로 flow의 값을 변경할 때 set 연산 자체는 thread-safe하지만, 주의해야 할 race condition이 있음

// Launch A
viewModelScope.launch(Dispatchers.IO) {
    _viewState.value = _viewState.value.copy(doneButtonEnabled = true)
}
// Launch B
viewModelScope.launch(Dispatchers.Default) {
    _viewState.value = _viewState.value.copy(title = "New Title")
}

• 초기 상태
  _viewState: title = "Old Title", doneButtonEnabled = false
• Launch A 실행 시작
  _viewState: title = "Old Title", doneButtonEnabled = false
  _viewState.value.copy 상태: title = "Old Title", doneButtonEnabled = true
• Launch A 일시정지, Launch B 실행 시작
  _viewState: title = "Old Title", doneButtonEnabled = false
  _viewState.value.copy 상태: title = "New Title", doneButtonEnabled = false
• Launch B 일시정지, Launch A 실행 재개
  _viewState: title = "Old Title", doneButtonEnabled = true
• Launch B 실행 재개
  _viewState: title = "New Title", doneButtonEnabled = false

• 위와 같은 일이 발생하지 않으려면, copy와 value set을 amotic하게 실행해야 함!

viewModelScope.launch(Dispatchers.IO) {
  _viewState.update { it.copy(doneButtonEnabled = true) }
}

viewModelScope.launch(Dispatchers.Default) {
  _viewState.update { it.copy(title = "New title") }
}

• 참고) mutex lock을 사용하여 atomic하게 실행되도록 직접 lock을 구현하는 방법도 있음

val mutex = Mutex()

viewModelScope.launch(Dispatchers.IO) {
    mutex.withLock { 
        _viewState.value = _viewState.value.copy(doneButtonEnabled = true)
    }
}

viewModelScope.launch(Dispatchers.Default) {
    mutex.withLock { 
        _viewState.value = _viewState.value.copy(title = "New title")
    }
}