안드로이드

이 튜토리얼에서는 안드로이드 애플리케이션을 작성하고 Koin 의존성 주입을 사용하여 컴포넌트를 가져오는 방법을 설명합니다. 튜토리얼을 완료하는 데 약 __10분__이 소요됩니다.

NOTE

업데이트 - 2024-10-21

코드 가져오기

INFO

소스 코드는 GitHub에서 확인할 수 있습니다

그레이들 설정

아래와 같이 Koin 안드로이드 의존성을 추가하세요:

dependencies {

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

애플리케이션 개요

이 애플리케이션의 아이디어는 사용자 목록을 관리하고, MainActivity 클래스에서 프레젠터 또는 뷰모델을 사용하여 이를 표시하는 것입니다:

Users -> UserRepository -> (Presenter or ViewModel) -> MainActivity

"User" 데이터

사용자 컬렉션을 관리할 것입니다. 데이터 클래스는 다음과 같습니다:

data class User(val name : String)

사용자 목록을 관리하기 위한 "리포지토리" 컴포넌트를 생성합니다 (사용자 추가 또는 이름으로 사용자 찾기). 아래는 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 모듈은 주입할 모든 컴포넌트를 정의하는 곳입니다.

val appModule = module {
    
}

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

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

프레젠터를 이용한 사용자 표시

사용자를 표시하기 위한 프레젠터 컴포넌트를 작성해 봅시다:

class UserPresenter(private val repository: UserRepository) {

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

UserRepository는 UserPresenter의 생성자에서 참조됩니다.

Koin 모듈에 UserPresenter를 선언합니다. 안드로이드 생명주기 관련 누수를 방지하기 위해 메모리에 인스턴스를 유지하지 않도록 factoryOf 정의로 선언합니다:

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

get() 함수를 통해 Koin에게 필요한 의존성을 해결(주입)하도록 요청할 수 있습니다.

안드로이드에서 의존성 주입하기

UserPresenter 컴포넌트가 생성될 때, UserRepository 인스턴스가 함께 해결(주입)됩니다. 이를 액티비티에서 사용하려면 by inject() 델리게이트 함수를 사용하여 주입해 봅시다:

class MainActivity : AppCompatActivity() {

    private val presenter: UserPresenter by inject()

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

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

INFO

by inject() 함수를 통해 안드로이드 컴포넌트 런타임(액티비티, 프래그먼트, 서비스 등)에서 Koin 인스턴스를 가져올 수 있습니다.

Koin 시작하기

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

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

INFO

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

Koin 모듈: 기존 방식 또는 생성자 DSL?

우리 앱의 Koin 모듈 선언은 다음과 같습니다:

val appModule = module {
    single<HelloRepository> { HelloRepositoryImpl() }
    factory { MyPresenter(get()) }
}

생성자를 사용하여 더 간결한 방식으로 작성할 수 있습니다:

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

앱 검증하기!

앱을 실행하기 전에 간단한 JUnit 테스트로 Koin 설정을 검증하여 올바른지 확인할 수 있습니다.

그레이들 설정

아래와 같이 Koin 안드로이드 의존성을 추가하세요:

// Add Maven Central to your repositories if needed
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 테스트 하나만으로도 정의 설정에 누락된 부분이 없는지 확인할 수 있습니다!