Android & Annotations

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

노트

업데이트 - 2024-10-21

코드 가져오기

정보

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

Gradle 설정

다음과 같이 KSP 플러그인을 구성하고 다음 의존성을 추가합니다.

plugins {
    alias(libs.plugins.ksp)
}

dependencies {
    // ...

    implementation(libs.koin.annotations)
    ksp(libs.koin.ksp)
}

// 컴파일 시간 확인
ksp {
    arg("KOIN_CONFIG_CHECK","true")
}

노트

현재 버전은 libs.versions.toml을 참조하세요.

애플리케이션 개요

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

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

"User" 데이터

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 모듈

다음과 같이 AppModule 모듈 클래스를 선언합니다.

@Module
@ComponentScan("org.koin.sample")
class AppModule

• @Module을 사용하여 클래스를 Koin 모듈로 선언합니다.
• @ComponentScan("org.koin.sample")은 "org.koin.sample" 패키지에서 Koin 정의를 스캔할 수 있도록 합니다.

UserRepositoryImpl 클래스에 @Single을 추가하여 싱글톤으로 선언합니다.

@Single
class UserRepositoryImpl : UserRepository {
    // ...
}

Presenter로 사용자 표시

사용자를 표시하는 presenter 컴포넌트를 작성합니다.

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`s 생성자에서 참조됩니다.

Koin 모듈에서 UserPresenter를 선언합니다. 메모리에 인스턴스를 유지하지 않도록 (Android lifecycle과 관련된 누수를 방지하기 위해) @Factory 어노테이션으로 factory 정의로 선언합니다.

@Factory
class UserPresenter(private val repository: UserRepository) {
    // ...
}

Android에서 의존성 주입

UserPresenter 컴포넌트는 UserRepository 인스턴스를 resolving하여 생성됩니다. Activity에 가져오려면 by inject() 델리게이트 함수를 사용하여 주입합니다.

class MainActivity : AppCompatActivity() {

    private val presenter: UserPresenter by inject()

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

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

정보

by inject() 함수를 사용하면 Android 컴포넌트 런타임 (Activity, fragment, Service...)에서 Koin 인스턴스를 검색할 수 있습니다.

Koin 시작

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

// generated
import org.koin.ksp.generated.*

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

Koin 모듈은 .module 확장자를 사용하여 AppModule에서 생성됩니다. AppModule().module 표현식을 사용하여 어노테이션에서 Koin 모듈을 가져옵니다.

정보

생성된 Koin 모듈 컨텐츠를 사용하려면 import org.koin.ksp.generated.* import가 필요합니다.

ViewModel로 사용자 표시

사용자를 표시하는 ViewModel 컴포넌트를 작성합니다.

@KoinViewModel
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 생성자에서 참조됩니다.

UserViewModel은 Koin ViewModel 정의를 선언하기 위해 @KoinViewModel 어노테이션으로 태그되어 메모리에 인스턴스를 유지하지 않도록 합니다 (Android lifecycle과 관련된 누수를 방지하기 위해).

Android에서 ViewModel 주입

UserViewModel 컴포넌트는 UserRepository 인스턴스를 resolving하여 생성됩니다. Activity에 가져오려면 by viewModel() 델리게이트 함수를 사용하여 주입합니다.

class MainActivity : AppCompatActivity() {

    private val viewModel: UserViewModel by viewModel()

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

컴파일 시간 검사

Koin Annotations를 사용하면 컴파일 시간에 Koin 구성을 확인할 수 있습니다. 다음 Gradle 옵션을 사용하여 사용할 수 있습니다.

ksp {
    arg("KOIN_CONFIG_CHECK","true")
}

앱 검증!

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

Gradle 설정

다음과 같이 Koin Android 의존성을 추가합니다.

// 필요한 경우 Maven Central을 저장소에 추가합니다.
repositories {
	mavenCentral()    
}

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

모듈 확인

androidVerify() 함수를 사용하면 지정된 Koin 모듈을 확인할 수 있습니다.

class CheckModulesTest : KoinTest {

    @Test
    fun checkAllModules() {

        AppModule().module.androidVerify()
    }
}

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