🔎 ViewModel이란

비즈니스 로직 혹은 화면 레벨의 상태 보유자. 상태를 UI에 노출하고 관련 비즈니스 로직을 캡슐화함.
상태를 캐싱하고 구성 변경을 통해 상태 유지 -> 화면을 회전하는 등의 구성 변경 시에도 UI가 데이터를 다시 가져오지 않아도 됨.

📖 ViewModel 장점

1. UI 상태를 유지할 수 있음.
2. 비즈니스 로직에 액세스할 수 있음.
3. Hilt 및 Navigation과 같은 주요 JetPack 라이브러리와의 통합을 지원, Compose와도 완벽하게 호환됨.

• ViewModel 대신 데이터를 보유하는 일반 클래스를 사용할 경우
  액티비티나 네비게이션 목적지 간 이동 시 문제가 됨.
  데이터를 저장하지 않으면 데이터가 소멸됨.

📕 지속성

ViewModel이 보유하는 상태와 ViewModel이 트리거하는 작업을 통해 지속성 제공.
이러한 캐싱을 통해 화면 회전과 같은 구성 요소 변경이 일어날 때 데이터를 다시 가져올 필요가 없게 함.

📕 범위

ViewModel을 생성할 때 ViewModelStoreOwner 인터페이스를 구현하는 객체를 전달. (Navigation 목적지, Navigation 그래프, 액티비티, 프래그먼트 또는 해당 인터페이스를 구현하는 다른 유형일 수 있음.)

ViewModel은 ViewModelStoreOwner의 수명 주기에 대한 범위로 설정됨.
ViewModelStoreOwner가 영구적으로 사라질 때까지 메모리에 유지됨.

ViewModel이 범위로 설정된 액티비티나 프래그먼트가 파괴될 때, ViewModel이 해당 범위로 설정되어 있는 상태에서 비동기 작업이 계속됨.

📕 SavedStateHandle

SavedStateHandle을 사용하면 구성 변경 뿐만이 아닌 프로세스 재생성을 통해 데이터를 지속시킬 수 있음.
사용자가 앱을 닫고 나중에 다시 열어도 UI 상태를 그대로 유지할 수 있게 해줌.

📕 비즈니스 로직 액세스

UI 레이어에서 비즈니스 로직을 처리하는 올바른 위치는 ViewModel.
ViewModel은 이벤트를 처리하고 비즈니스 로직이 응용 프로그램 데이터를 수정해야 할 때 계층 구조의 다른 레이어로 이벤트를 위임하는 역할을 함.

---

📖 ViewModel 구현

• 주사위 예제
  -> 사용자 목록을 얻고 유지하는 역할은 액티비티나 프래그먼트가 아닌 ViewModel에 있음.

뷰모델 코드

data class DiceUiState(
    val firstDieValue: Int? = null,
    val secondDieValue: Int? = null,
    val numberOfRolls: Int = 0,
)

class DiceRollViewModel : ViewModel() {

    // Expose screen UI state
    private val _uiState = MutableStateFlow(DiceUiState())
    val uiState: StateFlow<DiceUiState> = _uiState.asStateFlow()

    // Handle business logic
    fun rollDice() {
        _uiState.update { currentState ->
            currentState.copy(
                firstDieValue = Random.nextInt(from = 1, until = 7),
                secondDieValue = Random.nextInt(from = 1, until = 7),
                numberOfRolls = currentState.numberOfRolls + 1,
            )
        }
    }
}

액티비티에서 뷰모델에 접근

import androidx.activity.viewModels

class DiceRollActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        // Create a ViewModel the first time the system calls an activity's onCreate() method.
        // Re-created activities receive the same DiceRollViewModel instance created by the first activity.

        // Use the 'by viewModels()' Kotlin property delegate
        // from the activity-ktx artifact
        val viewModel: DiceRollViewModel by viewModels()
        lifecycleScope.launch {
            repeatOnLifecycle(Lifecycle.State.STARTED) {
                viewModel.uiState.collect {
                    // Update UI elements
                }
            }
        }
    }
}



//Jetpack Compose

import androidx.lifecycle.viewmodel.compose.viewModel

// Use the 'viewModel()' function from the lifecycle-viewmodel-compose artifact
@Composable
fun DiceRollScreen(
    viewModel: DiceRollViewModel = viewModel()
) {
    val uiState by viewModel.uiState.collectAsStateWithLifecycle()
    // Update UI elements
}

• ❗️주의할 점
  ViewModel은 뷰,라이프사이클 혹은 액티비티 컨텍스트에 대한 참조를 가지지 않아야 함.
  ViewModel의 수명 주기가 UI보다 크기 때문에 ViewModel 내에서 라이프사이클 관련 API의 보유하는 것은 메모리 누수를 발생시킬 수 있음.

---

📖 ViewModel의 수명주기

ViewModel은 해당 ViewModelStoreOwner가 사라질 때까지 메모리에 남아있음.

액티비티가 종료될 때
프래그먼트가 분리될 때
**Navigation 항목이 백 스택에서 제거될 때

-> 따라서 ViewModel은 구성 변경이 일어나도 유지해야 하는 데이터를 저장하는데 적합.

프래그먼트의 수명 주기에도 동일하게 적용됨.

일반적으로 첫 번째로 시스템이 액티비티 객체의 onCreate() 메서드를 호출할 때 ViewModel을 요청. 시스템은 액티비티 존재 기간 동안 기기 화면이 회전하는 경우 등의 이유로 onCreate()를 여러 번 호출 가능.
ViewModel은 맨 처음으로 요청할 때부터 액티비티가 완료되고 파괴될 때까지 존재함.

📕 ViewModel 종속성 정리

ViewModel은 ViewModelStoreOwner가 파괴될 때 onCleared()메서드를 호출함.
이 때 ViewModel의 수명 주기를 따라서 발생하는 모든 작업과 종속성을 정리할 수 있음.

class MyViewModel(
    private val coroutineScope: CoroutineScope =
        CoroutineScope(SupervisorJob() + Dispatchers.Main.immediate)
) : ViewModel() {

    // Other ViewModel logic ...

    override fun onCleared() {
        coroutineScope.cancel()
    }
}

viewModelScope는 ViewModel 수명 주기를 자동으로 따르는 내장된 CoroutineScope.
ViewModelStoreOwner가 수명 주기의 끝에서 ViewModel을 지우면 ViewModel은 CoroutineScope를 취소함.

라이프사이클 버전 2.5 이상에서는 ViewModel의 생성자에 하나 이상의 Closeable 객체를 전달하여 ViewModel 인스턴스가 지워질 때 자동으로 닫히도록 할 수 있음.

class CloseableCoroutineScope(
    context: CoroutineContext = SupervisorJob() + Dispatchers.Main.immediate
) : Closeable, CoroutineScope {
    override val coroutineContext: CoroutineContext = context
    override fun close() {
        coroutineContext.cancel()
   }
}

class MyViewModel(
    private val coroutineScope: CoroutineScope = CloseableCoroutineScope()
) : ViewModel(coroutineScope) {
    // Other ViewModel logic ...
}

---

📖 Jetpack Compose와 ViewModel

Jetpack Compose를 사용할 때 ViewModel은 화면 UI 상태를 Composable에 노출하는 주요 방법.

ViewModel은 Composable에 범위 설정을 할 수 없다는 것이 가장 중요.
👉 Composable이 ViewModelStoreOwner가 아니기 때문.

• Compose에서 ViewModel의 이점을 얻는 방법
  각 화면을 프래그먼트 혹은 액티비티에 호스팅하거나 Compose Navigation을 사용하고 Composable 함수에서 Navigation 목적지에 가능한 가까운 위치에서 ViewModel을 사용.