Android - ViewModel

이 튜토리얼에서는 Android 애플리케이션을 작성하고 Koin 의존성 주입을 사용하여 컴포넌트를 검색할 수 있습니다. 튜토리얼을 완료하는 데 약 __10분__이 소요됩니다.

노트

업데이트 - 2024-10-21

코드 가져오기

정보

소스 코드는 Github에서 사용할 수 있습니다

Gradle 설정

다음과 같이 Koin Android 종속성을 추가합니다:

dependencies {

    // Koin for Android
    implementation("io.insert-koin:koin-android:$koin_version")
}

애플리케이션 개요

애플리케이션의 아이디어는 사용자 목록을 관리하고 MainActivity 클래스에서 Presenter 또는 ViewModel을 사용하여 표시하는 것입니다:

Users -> UserRepository -> (Presenter 또는 ViewModel) -> MainActivity

"User" 데이터

사용자 컬렉션을 관리합니다. 다음은 데이터 클래스입니다:

data class User(val name : String)

사용자 목록을 관리하는 "Repository" 컴포넌트를 생성합니다(사용자 추가 또는 이름으로 찾기). 다음은 UserRepository 인터페이스와 해당 구현입니다:

interface UserRepository {
    fun findUser(name : String): User?
    fun addUsers(users : List<User>)
}

class UserRepositoryImpl : UserRepository {

    private val _users = arrayListOf<User>()

    override fun findUser(name: String): User? {
        return _users.firstOrNull { it.name == name }
    }

    override fun addUsers(users : List<User>) {
        _users.addAll(users)
    }
}

Koin 모듈

module 함수를 사용하여 Koin 모듈을 선언합니다. Koin 모듈은 주입할 모든 컴포넌트를 정의하는 곳입니다.

val appModule = module {
    
}

첫 번째 컴포넌트를 선언해 보겠습니다. UserRepositoryImpl의 인스턴스를 생성하여 UserRepository의 싱글톤을 원합니다.

val appModule = module {
   singleOf(::UserRepositoryImpl) { bind<UserRepository>() }
}

ViewModel을 사용하여 사용자 표시

사용자를 표시하는 ViewModel 컴포넌트를 작성해 보겠습니다:

class UserViewModel(private val repository: UserRepository) : ViewModel() {

    fun sayHello(name : String) : String{
        val foundUser = repository.findUser(name)
        return foundUser?.let { "Hello '$it' from $this" } ?: "User '$name' not found!"
    }
}

UserRepository는 UserViewModel`s 생성자에서 참조됩니다.

Koin 모듈에서 UserViewModel을 선언합니다. 메모리에 인스턴스를 유지하지 않도록(Android 수명 주기에 따른 누수 방지) viewModelOf 정의로 선언합니다.

val appModule = module {
    singleOf(::UserRepositoryImpl) { bind<UserRepository>() }
    viewModelOf(::UserViewModel)
}

Android에서 ViewModel 주입

UserViewModel 컴포넌트가 생성되어 UserRepository 인스턴스를 함께 확인합니다. Activity에서 가져오려면 by viewModel() 대리자 함수를 사용하여 주입해 보겠습니다:

class MainActivity : AppCompatActivity() {

    private val viewModel: UserViewModel by viewModel()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        
        //...
    }
}

이제 앱이 준비되었습니다.

정보

by viewModel() 함수를 사용하면 ViewModel 인스턴스를 검색하고, 관련된 ViewModel Factory를 생성하고, 수명 주기에 바인딩할 수 있습니다.

Koin 시작

Android 애플리케이션으로 Koin을 시작해야 합니다. 애플리케이션의 기본 진입점인 MainApplication 클래스에서 startKoin() 함수를 호출하기만 하면 됩니다:

class MainApplication : Application(){
    override fun onCreate() {
        super.onCreate()
        
        startKoin{
            androidLogger()
            androidContext(this@MainApplication)
            modules(appModule)
        }
    }
}

정보

startKoin의 modules() 함수는 주어진 모듈 목록을 로드합니다.

Koin 모듈: 클래식 또는 생성자 DSL?

다음은 앱에 대한 Koin 모듈 선언입니다:

val appModule = module {
    single<HelloRepository> { HelloRepositoryImpl() }
    viewModel { MyViewModel(get()) }
}

생성자를 사용하여 더 간결하게 작성할 수 있습니다:

val appModule = module {
    singleOf(::UserRepositoryImpl) { bind<UserRepository>() }
    viewModelOf(::UserViewModel)
}

앱 확인!

간단한 JUnit 테스트로 Koin 구성을 확인하여 앱을 시작하기 전에 Koin 구성이 올바른지 확인할 수 있습니다.

Gradle 설정

다음과 같이 Koin Android 종속성을 추가합니다:

// 필요한 경우 Maven Central을 리포지토리에 추가합니다.
repositories {
	mavenCentral()    
}

dependencies {
    
    // Koin for Tests
    testImplementation "io.insert-koin:koin-test-junit4:$koin_version"
}

모듈 확인

verify() 함수를 사용하면 주어진 Koin 모듈을 확인할 수 있습니다:

class CheckModulesTest : KoinTest {

    @Test
    fun checkAllModules() {
        appModule.verify()
    }
}

JUnit 테스트만으로 정의 구성에 누락된 것이 없는지 확인할 수 있습니다!