Kotlin

このチュートリアルでは、Kotlinアプリケーションを記述し、Koinの依存性注入を使用してコンポーネントを取得する方法を学びます。 チュートリアルを完了するのに約__10分__かかります。

NOTE

更新日 - 2024-10-21

コードの入手

INFO

ソースコードはGitHubで入手できます

セットアップ

まず、koin-coreの依存関係が以下のように追加されていることを確認してください。

dependencies {
    
    // Koin for Kotlin apps
    implementation "io.insert-koin:koin-core:$koin_version"
}

アプリケーションの概要

このアプリケーションのアイデアは、ユーザーのリストを管理し、それをUserApplicationクラスで表示することです。

Users -> UserRepository -> UserService -> UserApplication

「ユーザー」データ

ユーザーのコレクションを管理します。データクラスは以下の通りです。

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 {
    single<UserRepository> { UserRepositoryImpl() }
}

UserServiceコンポーネント

デフォルトユーザーをリクエストするためにUserServiceコンポーネントを記述しましょう。

class UserService(private val userRepository: UserRepository) {

    fun getDefaultUser() : User = userRepository.findUser(DefaultData.DEFAULT_USER.name) ?: error("Can't find default user")
}

UserRepositoryはUserPresenterのコンストラクタで参照されています。

KoinモジュールでUserServiceを宣言します。これをsingle定義として宣言します。

val appModule = module {
     single<UserRepository> { UserRepositoryImpl() }
     single { UserService(get()) }
}

get()関数は、Koinに必要な依存関係を解決するよう要求することを可能にします。

UserApplicationでの依存関係の注入

UserApplicationクラスは、Koinからインスタンスをブートストラップするのに役立ちます。KoinComponentインターフェースのおかげで、UserServiceを解決します。これにより、by inject()デリゲート関数でそれを注入できます。

class UserApplication : KoinComponent {

    private val userService : UserService by inject()

    // display our data
    fun sayHello(){
        val user = userService.getDefaultUser()
        val message = "Hello '$user'!"
        println(message)
    }
}

これで、アプリの準備ができました。

INFO

by inject()関数を使用すると、KoinComponentを継承する任意のクラスでKoinインスタンスを取得できます。

Koinの開始

アプリケーションと一緒にKoinを開始する必要があります。アプリケーションのメインエントリーポイントであるmain関数でstartKoin()関数を呼び出すだけです。

fun main() {
    startKoin {
        modules(appModule)
    }

    UserApplication().sayHello()
}

INFO

startKoin内のmodules()関数は、指定されたモジュールリストをロードします。

Koinモジュール：クラシックまたはコンストラクタDSL？

これが私たちのアプリのKoinモジュール宣言です。

val appModule = module {
    single<UserRepository> { UserRepositoryImpl() }
    single { UserService(get()) }
}

コンストラクタを使用することで、より簡潔な方法で記述できます。

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