1️⃣ 패턴

UDF 적용 MVVM 패턴을 사용합니다.

2️⃣ 패키지 관리

화면 단위로 presentation 내 sub-package를 둡니다.

feature
  ㄴ component
  ㄴ navigation
  ㄴ ${Feature}Contract.kt
  ㄴ ${Feature}Screen.kt
  ㄴ ${Feature}ViewModel.kt

3️⃣ Contract

Contract는 UiState와 UiEffect를 갖습니다.

data class ${Feature}UiState(
	...
) : UiState

sealed interface ${Feature}UiEffect : UiEffect {
	...
}

• UiState 규칙

  • 뷰모델에서 비동기로 로드하는 데이터의 경우 반드시 Async로 래핑 (초기값 Init)

    sealed interface Async<out T> {
        data object Empty : Async<Nothing>
    
    		data class Loading<out T>(
            val data: T? = null,
        ) : Async<T>
        
        data class Success<out T>(
            val data: T,
        ) : Async<T>
    
        data class Failure(
            val message: String,
        ) : Async<Nothing>
    
        data object Init : Async<Nothing>
    }
    

  • refresh 등 로딩 중에도 기존 불러온 데이터를 보여줄 때는, 기존 데이터를 Loading의 data에 넣기

  • Empty는 UI에 emptyUI를 보여주는 경우 사용

    • 실제 상태가 Empty더라도 UI 노출될 필요 없다면 Init으로 상태 변경

  • Failure는 UI에 에러를 인라인 메시지로 보여주는 경우 사용

    • 스낵바/토스트와 같이 일회성 메시지 노출로 보여준다면 SideEffect로 처리 (Init으로 상태 변경)
    • 실제 상태가 실패더라도, 유저가 재시도할 수 있고 UI 노출될 필요 없다면 Init으로 상태 변경
• UiEffect 네이밍 규칙
  • 모달 : Show{이름(optional)_타입}
    • e.g. ShowEditDialog, ShowBottomSheet
  • 네비게이션
    • 특정 화면 이동 : NavigateTo{화면}
    • 뒤로가기 : PopBackStack
  • 토스트/스낵바 : Show{타입}
    • e.g. ShowToast

4️⃣ ViewModel

ViewModel은 BaseViewModel을 상속받습니다.

UiState와 UiEffect에 대한 Flow 생성 및 구독을 위한 반복 코드를 최소화합니다.

• UI에 데이터가 실시간으로 반영되도록 UiState에는 StateFlow 사용
• SideEffect가 한 번만 처리되도록 데이터 소비 후 제거하는 Channel 사용