Kotlin 코틀린의 ViewModel

ViewModel

1. 정의

ViewModel 이란 Android Jetpack의 구성 요소 중 하나로, MVVM(Model - View - ViewModel) 디자인 패턴으로부터 파생된 단어이다. ViewModel의 정의를 내리자면 아래와 같다.

👍 Activity와 Fragment와 같은 UI 컨트롤러의 로직에서 데이터를 다루는 로직을 분리하기 위해서 등장한 Android JetPack 라이브러리

그렇다면 이러한 ViewModel이 필요한 이유가 무엇일까?

2. 필요성

안드로이드는 모바일 OS 특성상 리소스에 대한 많은 제약들이 존재한다.

그에 따라 리소스 제거가 요구되는 이벤트가 발생하게 되는데 그러한 이벤트가 발생했을 때 Activity와 Fragment 같은 UI 컨트롤러에 대한 제거와 복구가 수행되게 된다.

한 가지 예로 화면 전환을 생각해 보자.

화면을 가로로 회전했을때 텍스트가 초기 값으로 돌아가는 것을 확인 할 수 있다.

화면 전환이 이루어지게 되면 Activity가 파괴(onDestroy)된 다음 다시 화면이 만들어지기 때문에(onCreate -> onStart) 기존의 데이터가 날아가는 것이다. 이와 관련된 내용은 생명주기를 알고 있다면 쉽게 이해할 수 있다.

생명주기에 관한 내용은 여기에 자세히 적어 두었다.

화면을 전환 하는 등 이러한 이벤트 등을 통해 데이터가 날아가는 문제를 해결 하기 위해 기존에는 saveInstanceState를 이용하였다.

class MainActivity : AppCompatActivity() {
 
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState) 
        setContentView(R.layout.activity_main)
    }
}

우리가 Activity를 생성하면 항상 자동으로 생성되는 이 부분이 바로 saveInstanceState이다. Activity가 파괴되기 전 세이브 하고 싶은 데이터를 저 부분을 통해 onCreate로 넘겨주면 데이터를 날리지 않고 계속 이용할 수 있는 것이다.

하지만 이 방법에는 문제가 존재한다.

담을 수 있는 데이터가 적다. - 공식 문서에 따르면 Parcelables and Bundles에서는 50k 미만의 데이터를 권장하고 있다.
담을 수 있는 데이터의 형태가 제한된다.
onCreate에서 작업을 처리해야 하므로 UI 컨트롤러가 해야 할 일이 늘어나면서 화면을 띄우는데 시간이 오래 걸리게 된다.

Activity나 Fragment와 같은 UI 컨트롤러에서 데이터를 관리하면 생명 주기에 따라서 값이 사라지는 문제가 발생하고, saveInstanceState로 데이터를 저장하려면 다음과 같은 문제가 존재한다.

이러한 문제를 해결하기 위해 나온것이 바로 ViewModel이다.

3. ViewModel 생명 주기

Activity의 생명 주기에 관계없이 ViewModel이 해제되지 않고 살아있다면 데이터 손실을 방지 할 수 있다. 그래서 ViewModel은 Activity의 생명 주기 보다 긴 수명을 가지는 생명 주기를 가지고 있기 때문에 ViewModel을 사용하면 화면 전환시 데이터의 소멸을 방지할 수 있다.

Activity는 Create, Rotate, Finish 되면서 다양한 생명 주기 상태를 갖는 반면에 ViewModel의 생명주기는 변하지 않는다.

ViewModel은 Activity가 더 이상 사용하지 않는 상태인 onDestroy() 호출 이후 onCleared()을 호출하여 내부 데이터를 초기화하고 해제하게 된다.

ViewModel의 Scope(생명 주기의 범위)는 ViewModelProvider에 의해서 결정 된다.

4. ViewModel 프로세스

ViewModel을 구현하기 위해서는 VIewModelProvider의 도움을 받아야 한다.

프로세스를 간단하게 정리하면 이렇게 된다.

사용자가 ViewModeProvider를 통하여 VIewModel 인스턴스를 요청한다.
ViewModeProvider내부에서는 ViewModelStoreOwner를 참조하여 VIewModelStore를 가져온다.
ViewModelStore에게 이미 생성(저장)된 ViewModel 인스터스를 요청한다.
만약 ViewModelStore에 적합한 ViewModel 인스턴스를 가지고 있지 않다면, Factory를 통하여 ViewModel인 인스턴스를 생성한다.
생성한 ViewModel 인스턴스를 VIewModeStore에 저장하고 만들어진 ViewModel 인스턴스를 클라이언트에게 반환한다.

만약 같은 ViewModel 인스턴스 요청이 들어온다면, 1~3번의 과정을 반복하게 된다.

그렇다면 여기서 나오는 각각의 요소를 살펴보자.

1. ViewModelProvider

ViewModelProvider는 ViewModel 객체를 생성하기 위해 사용하는 클래스이다. Activity나 Fragment에서는 ViewModelProvider를 통해 자기 자신을 생성자로 전달하여 ViewModel 인스턴스를 획득해야 한다.

class MainActivity : AppCompatActivity(), View.OnClickListener {
      myNumberViewModel = ViewModelProvider =(this).get(MyNumberViewModel::class.java)
      ...
}

2. ViewModelStoreOwner

FragmentActivity의 부모 클래스인 ComponentActivity와 Fragment 클래스가 ViewModelStoreOwner를 구현한다. 즉, Activity와 Fragment가 ViewModelStoreOwner를 구현하기 대문에 VIewModel 객체를 생성할 때 Activity나 Fragment를 생성자로 전달하게 되는 것이다.

어떤 Owner를 통해 생성하느냐에 따라 ViewModel의 Scope이 정해진다.

3. ViewModelStore

ViewModelStore 클래스는 내부적으로 HashMap<String, ViewModel>를 두어 ViewModel을 관리한다. ViewModelStore는 화면 회전시에도 유지되는 인스턴스이다. ViewModel의 Owner인 Activity나 Fragment가 화면 전환에 의해서 Destroy되고 Rotate 되어도 Owner의 새로운 객체는 여전히 같은 ViewModelStore를 갖게 된다. 즉, Owner의 생명 주기가 완전이 Destroy되지 않는 이상 동일한 ViewModelStore를 가지고, ViewModelStore가 ViewModel을 관리하기 때문에 데이터 손실이 없는 것이다.

ViewModelStore는 ViewModelStoreOwner에서 생성하고 관리한다.

5. ViewModel 구현

ViewModel을 구현하기 전에 ViewModel을 사용할때 단짝 처럼 붙어 다니는 LiveData라는 라이브러리가 존재한다.

여기를 클릭하여 미리 학습하고 오자!

1. gradle 추가

dependencies {
    implementation 'androidx.core:core-ktx:1.7.0'
    implementation 'androidx.appcompat:appcompat:1.4.2'
    implementation 'com.google.android.material:material:1.6.1'
    implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
    testImplementation 'junit:junit:4.13.2'
    androidTestImplementation 'androidx.test.ext:junit:1.1.3'
    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
    implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:2.5.1"
    implementation "androidx.lifecycle:lifecycle-livedata-ktx:2.5.1"
}

최신 버전에 맞는것 으로 ViewModel 과 LiveData를 추가해주면 된다.

2. Layout 파일

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity"
    android:paddingHorizontal="10dp"
    >

    <TextView
        android:id="@+id/number_textview"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Hello World!"
        android:textSize="30dp"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

    <EditText
        android:id="@+id/number_input_edittext"
        android:layout_width="0dp"
        android:layout_height="wrap_content"
        android:inputType="number"
        app:layout_constraintHorizontal_weight="1"
        app:layout_constraintEnd_toStartOf="@+id/plus_btn"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/number_textview"
        android:layout_marginTop="30dp"
        />

    <Button
        android:id="@+id/plus_btn"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="더하기"
        app:layout_constraintEnd_toStartOf="@+id/minus_btn"
        app:layout_constraintStart_toEndOf="@+id/number_input_edittext"
        app:layout_constraintTop_toTopOf="@+id/number_input_edittext"
        android:layout_marginHorizontal="10dp"
        />

    <Button
        android:id="@+id/minus_btn"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="빼기"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toEndOf="@+id/plus_btn"
        app:layout_constraintTop_toTopOf="@+id/number_input_edittext" />


</androidx.constraintlayout.widget.ConstraintLayout>

아까 위에서 보았던 버튼을 클릭하면 값이 추가되고 감소하는 간단한 앱이다.

기존에 ViewModel을 사용하지 않고 만든 프로그램에서는 화면전환과 같은 이벤트를 주었을때 데이터가 날라갔다면 ViewModel로 앱을 제작하면 어떻게 되는지 비교해보자!

3. ViewModel 클래스 추가 및 LiveData 초기화

class MyNumberViewModel : ViewModel(){

    // 내부에서 설정하는 자료형은 Mutable로 변경가능하도록 설정한다.
    private val _currentValue = MutableLiveData<Int>()
    // MutableLiveData - 수정 가능
    // LiveData - 값 수정 불가능

    val currentValue: LiveData<Int>
        get() = _currentValue
    // 뷰모델이 생성될대 초기값 설정해준다.
    
    init{
        //LiveData로 맵핑이 되어있을때 값을 수정하려면 value를 이용한다.
        //LivaData로는 값 수정이 불가능 하지만 MutableLiveData로 초기화 했기 때문에 수정이 가능하다.
        _currentValue.value = 0
    }
}

ViewModel 파일을 생성하기 위해서는 우선 VIewModel을 상속 받아야 한다.

추가로 AndroidViewModel도 상속받을수 있는데 이에 관련한 내용은 차후 학습하여 추가할 예정이다.

4. ViewModel 인스턴스 접근 및 LiveData에 Observer 객체 연결

class MainActivity : AppCompatActivity(), View.OnClickListener {

    lateinit var myNumberViewModel: MyNumberViewModel

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(binding.root)

        myNumberViewModel = ViewModelProvider(this).get(MyNumberViewModel::class.java)

        // 뷰모델이 가지고 있는 값의 변경사항을 관찰할 수 있는 라이브 데이터를 옵저빙한다.
        myNumberViewModel.currentValue.observe(this, Observer {
            binding.numberTextview.text = it.toString()
        })
    }
}

ViewModel을 생성하기 위해서는 ViewModel Provider 객체가 필요하다.

일반적으로 ViewModelProvider를 생성하기 위해서는 생성자 매개변수로 ViewModelStoreOwner와 ViewModelProvider.Factory가 필요하다.

하지만 ComponentActivity가 ViewModelStoreOwner 인터페이스를 구현하고 있으므로 ComponentActivity의 서브클래스인 AppCompatActivity를 사용하고 있다면 별도로 ViewModelStoreOwner를 구현할 필요는 없다.\

그래서 위 코드를 보면 인자를 this로 준것을 확인할 수 있다.

또한 뷰모델이 가지고 있는 값의 변경사항을 관찰할 수 있는 라이브 데이터를 Obeserver 객체와 연결하여 데이터의 변경사항을 Observe한다.

5. LiveData 객체를 업데이트 시키는 메소드 생성

fun updateValue(actionType: ActionType, input: Int){
        when(actionType){
            ActionType.PLUS ->
                _currentValue.value = _currentValue.value?.plus(input)
            ActionType.MINUS ->
                _currentValue.value = _currentValue.value?.minus(input)
        }
    }

뷰모델이 가지고 있는 값을 변경하는 메소드를 생성한다.

여기서 중요한 부분은 라이브 데이터로 맵핑 되어있는 값을 수정할때는 value를 사용한다는 점이다!

이후 VIewModel과 관련없는 추가적인 코드는 굳이 적지 않겠다. 이렇게 프로그램을 완성하고 결과를 확인해보자.

6. 결과 화면

결과 화면을 확인해보면 화면을 전환 했을때도 데이터가 사라지지 않는다. 이처럼 ViewModel을 사용하면 Activity나 Fragment에서 생명주기에 따른 데이터 손실를 막을 수 있고, 기존에 saveInstanceState에서 발생했던 여러 문제점들을 보안할 수 있다.

참고자료

저작자표시 비영리 변경금지

'안드로이드(Kotlin)' 카테고리의 다른 글

Kotlin 코틀린의 Context (0)	2022.08.08
Kotlin 코틀린의 Handler 와 Looper (0)	2022.08.04
Kotlin 코틀린의 Intent와 Inflate (0)	2022.08.04
Kotlin 코틀린의 Layout (0)	2022.08.04
Kotlin 코틀린의 Lifecycle (0)	2022.08.03