Android - ViewModel
이 튜토리얼에서는 안드로이드 애플리케이션을 작성하고 Koin 의존성 주입(dependency injection)을 사용하여 컴포넌트를 가져오는 방법을 알아봅니다. 이 튜토리얼을 마치는 데 약 10분이 소요됩니다.
NOTE
업데이트 - 2024-10-21
코드 가져오기
Gradle 설정
아래와 같이 Koin 안드로이드 의존성을 추가하세요:
dependencies {
// Koin for Android
implementation("io.insert-koin:koin-android:$koin_version")
}애플리케이션 개요
이 애플리케이션의 아이디어는 사용자 목록을 관리하고, Presenter 또는 ViewModel을 사용하여 MainActivity 클래스에 이를 표시하는 것입니다.
Users -> UserRepository -> UserService -> (Presenter 또는 ViewModel) -> MainActivity
"User" 데이터
사용자 컬렉션을 관리할 것입니다. 데이터 클래스는 다음과 같습니다:
data class User(val name: String, val email: String)사용자 목록을 관리(사용자 추가 또는 이름으로 검색)하기 위한 "Repository" 컴포넌트를 만듭니다. 아래는 UserRepository 인터페이스와 그 구현체입니다:
interface UserRepository {
fun findUserOrNull(name: String): User?
fun addUsers(users: List<User>)
}
class UserRepositoryImpl : UserRepository {
private val _users = arrayListOf<User>()
override fun findUserOrNull(name: String): User? {
return _users.firstOrNull { it.name == name }
}
override fun addUsers(users: List<User>) {
_users.addAll(users)
}
}UserService 컴포넌트
사용자 작업을 관리하기 위한 서비스 컴포넌트를 작성해 봅시다:
interface UserService {
fun getUserOrNull(name: String): User?
fun loadUsers()
fun prepareHelloMessage(user: User?): String
}
class UserServiceImpl(
private val userRepository: UserRepository
) : UserService {
override fun getUserOrNull(name: String): User? = userRepository.findUserOrNull(name)
override fun loadUsers() {
userRepository.addUsers(listOf(
User("Alice", "[email protected]"),
User("Bob", "[email protected]"),
User("Charlie", "[email protected]")
))
}
override fun prepareHelloMessage(user: User?): String {
return user?.let { "Hello '${user.name}' (${user.email})! 👋" } ?: "❌ User not found"
}
}Koin 모듈
Koin 모듈을 선언하려면 module 함수를 사용하세요. Koin 모듈은 주입될 모든 컴포넌트를 정의하는 장소입니다.
val appModule = module {
}컴포넌트를 선언해 보겠습니다. UserRepository와 UserService의 싱글톤(singleton)을 만들고자 합니다:
val appModule = module {
single<UserRepositoryImpl>() bind UserRepository::class
single<UserServiceImpl>() bind UserService::class
}INFO
이 튜토리얼에서는 컴파일 타임에 자동 와이어링(auto-wiring)을 제공하는 Koin 컴파일러 플러그인 DSL(single<T>(), viewModel<T>())을 사용합니다. 설정 방법은 컴파일러 플러그인 설정을 참조하세요.
ViewModel로 사용자 표시하기
사용자를 표시하기 위한 ViewModel 컴포넌트를 작성해 봅시다:
class UserViewModel(private val userService: UserService) : ViewModel() {
fun sayHello(name: String): String {
val user = userService.getUserOrNull(name)
val message = userService.prepareHelloMessage(user)
return "[UserViewModel] $message"
}
}
UserService는UserViewModel의 생성자에서 참조됩니다.
Koin 모듈에 UserViewModel을 선언합니다. 메모리에 인스턴스를 유지하지 않도록(안드로이드 생명주기로 인한 누수 방지) viewModel 정의로 선언합니다:
val appModule = module {
single<UserRepositoryImpl>() bind UserRepository::class
single<UserServiceImpl>() bind UserService::class
viewModel<UserViewModel>()
}안드로이드에서 ViewModel 주입하기
UserViewModel 컴포넌트가 생성될 때 UserService 인스턴스가 함께 해결(resolve)됩니다. 이를 액티비티로 가져오기 위해 by viewModel() 위임(delegate) 함수를 사용하여 주입해 보겠습니다:
class MainActivity : AppCompatActivity() {
private val viewModel: UserViewModel by viewModel()
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
//...
}
}이제 앱이 준비되었습니다.
INFO
by viewModel() 함수를 사용하면 ViewModel 인스턴스를 검색하고, 관련 ViewModel Factory를 생성하며, 이를 생명주기(lifecycle)에 바인딩할 수 있습니다.
Koin 시작하기
안드로이드 애플리케이션과 함께 Koin을 시작해야 합니다. 애플리케이션의 메인 진입점인 MainApplication 클래스에서 startKoin() 함수를 호출하기만 하면 됩니다:
class MainApplication : Application(){
override fun onCreate() {
super.onCreate()
startKoin{
androidLogger()
androidContext(this@MainApplication)
modules(appModule)
}
}
}INFO
startKoin 내부의 modules() 함수는 주어진 모듈 목록을 로드합니다.
Koin 모듈: DSL 비교
다음은 클래식 DSL(수동 와이어링)을 사용한 Koin 모듈 선언입니다:
val appModule = module {
single<UserRepository> { UserRepositoryImpl() }
single<UserService> { UserServiceImpl(get()) }
viewModel { UserViewModel(get()) }
}컴파일러 플러그인 DSL(컴파일 타임 자동 와이어링)을 사용하는 경우:
val appModule = module {
single<UserRepositoryImpl>() bind UserRepository::class
single<UserServiceImpl>() bind UserService::class
viewModel<UserViewModel>()
}TIP
컴파일러 플러그인 DSL을 사용하려면 Koin 컴파일러 플러그인이 필요합니다. 이는 컴파일 타임 의존성 해결(dependency resolution)과 더 깔끔한 구문을 제공합니다.