상태 저장 ViewModel

Mar 13 2023
오늘 저는 제가 작성하고 한동안 사용해 온 편리한 ViewModel 클래스 변형을 여러분과 공유하고자 합니다. ViewModel에서 상태를 관리하고 노출하려면 Kotlins의 유명한 API인 StateFlow를 사용할 수 있습니다.
Unsplash에 있는 Kelly Sikkema의 사진

오늘 저는 제가 작성하고 한동안 사용해 온 편리한 ViewModel 클래스 변형을 여러분과 공유하고자 합니다 .

ViewModel 에서 상태를 관리하고 노출하려면 Kotlins의 유명한 API인 StateFlow를 사용할 수 있습니다 .

아래 데이터 클래스로 UI 상태를 표현해 보겠습니다.

data class UiState(
    val isLoading: Boolean = false,
    val hasError: Boolean = false,
    val data: ScreenData? = null,
)

위의 상태를 UI에 노출하기 위해 ViewModel을 확장하는 클래스를 사용합니다.

class ScreenViewModel() : ViewModel() {

    private val _uiState = MutableStateFlow(UiState())
    val uiState: StateFlow<UiState> = _uiState.asStateFlow()

    suspend fun fetchData() {
        _uiState.update { state ->
            state.copy(
                isLoading = true,
                hasError = false
            )
        }

        val fetchedData = fetchDataFromNetwork()
        val failed = fetchedData is Error
        val data = fetchedData as? Data

        _uiState.update { state ->
            state.copy(
                isLoading = false,
                hasError = failed,
                data = data,
            )
        }
    }

}

데이터를 업데이트할 다른 ​​함수가 필요하다고 가정하고 다음과 같이 작성합니다.

suspend fun updateData(newData: Data) {
    _uiState.update { state ->
        state.copy(
            isLoading = true,
            hasError = false
        )
    }

    val update = updateAndGetData(newData)
    val failed = update is Error
    val data = update as? Data

    _uiState.update { state ->
        state.copy(
            isLoading = false,
            hasError = failed,
            data = data,
        )
    }
}

많은 분들이 사용하셨겠지만 저는 이 패턴을 여러 번 사용했습니다. 그래서 저는 확장된 일반 ViewModel을 작성하기로 결정했고 이를 StatefulViewModel이라고 했습니다.

open class StatefulViewModel<T>(initState: T): ViewModel() {

    private val _uiState = MutableStateFlow(initState)
    val uiState = _uiState.asStateFlow()

    protected fun updateState(f: T.() -> T) {
        _uiState.update(f)
    }

    protected fun updateState(newState: T) {
        _uiState.value = newState
    }

    protected val state: T
        get() = _uiState.value
}

이 새 클래스를 사용하여 위에서 작성한 ScreenViewModel을 아래와 같이 리팩터링할 수 있습니다.

class ScreenViewModel : StatefulViewModel<UiState>(UiState()) {

    suspend fun fetchData() {
        updateState {
            copy(isLoading = true, hasError = false)
        }

        val fetchedData = fetchDataFromNetwork()
        val failed = fetchedData is Error
        val data = fetchedData as? Data

        updateState {
            copy(isLoading = false, hasError = failed, data = data)
        }
    }

    suspend fun updateData(newData: Data) {
        updateState {
            copy(isLoading = true, hasError = false)
        }

        val update = updateAndGetData()
        val failed = update is Error
        val data = update as? Data

        updateState {
            copy(isLoading = false, hasError = failed, data = data)
        }
    }
    
}

StatefulViewModel 클래스가 유용하다고 생각하고 다음 프로젝트에서 사용하기를 바랍니다.