Kotlin

このチュートリアルでは、Kotlinアプリケーションを作成し、Koinの依存関係注入（Dependency Injection）を使用してコンポーネントを取得する方法を説明します。 チュートリアルの所要時間は約 10分 です。

NOTE

更新 - 2024-10-21

TIP

このチュートリアルのアノテーション版（annotations version）をお探しですか？コンパイル時の検証と自動モジュール検出に Koin Annotations を使用する Kotlin & Annotations を確認してください。

コードの取得

INFO

ソースコードはGithubで公開されています

セットアップ

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

dependencies {
    
    // Kotlinアプリ用のKoin
    implementation "io.insert-koin:koin-core:$koin_version"
}

アプリケーションの概要

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

Users -> UserRepository -> UserService -> UserApplication

「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)
    }
}

Koinモジュール

module 関数を使用してKoinモジュールを宣言します。Koinモジュールは、注入するすべてのコンポーネントを定義する場所です。

val appModule = module {

}

最初のコンポーネントを宣言しましょう。UserRepositoryImpl のインスタンスを作成することで、UserRepository のシングルトンを作成します。

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

INFO

このチュートリアルでは、コンパイル時に自動ワイヤリング（auto-wiring）を提供する Koin Compiler Plugin DSL (single<T>()) を使用しています。設定については Compiler Plugin Setup を参照してください。

UserServiceコンポーネント

ユーザー操作を管理するための 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"
    }
}

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

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

val appModule = module {
    single<UserRepositoryImpl>() bind UserRepository::class
    single<UserServiceImpl>() bind UserService::class
}

UserApplicationでの依存関係の注入

UserApplication クラスは、Koinからインスタンスを起動（bootstrap）するのに役立ちます。コンストラクタ注入を通じて UserService を解決します。

class UserApplication(
    private val userService: UserService
) {

    init {
        userService.loadUsers()
    }

    // データの表示
    fun sayHello(name: String) {
        val user = userService.getUserOrNull(name)
        val message = userService.prepareHelloMessage(user)
        println(message)
    }
}

これで、アプリケーションの準備が整いました。

INFO

コンストラクタ注入は、Kotlinアプリケーションにおいて依存関係を注入する推奨される方法です。Koinは UserApplication を作成する際に、自動的に UserService を解決して注入します。

Koinの開始

アプリケーションでKoinを開始し、モジュールに UserApplication を追加する必要があります。アプリケーションのメインエントリポイントである main 関数で startKoin() 関数を呼び出すだけです。

val appModule = module {
    single<UserApplication>()
    single<UserRepositoryImpl>() bind UserRepository::class
    single<UserServiceImpl>() bind UserService::class
}

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

    val userApplication = KoinPlatform.getKoin().get<UserApplication>()
    userApplication.sayHello("Alice")
}

INFO

startKoin 内の modules() 関数は、指定されたモジュールのリストをロードします。KoinPlatform.getKoin().get<UserApplication>() を使用して、Koinから UserApplication インスタンスを取得します。

Koinモジュール：DSLの比較

以下は、クラシックDSL（手動ワイヤリング）を使用したKoinモジュールの宣言です。

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

Compiler Plugin DSL（コンパイル時の自動ワイヤリング）を使用した場合：

val appModule = module {
    single<UserApplication>()
    single<UserRepositoryImpl>() bind UserRepository::class
    single<UserServiceImpl>() bind UserService::class
}

TIP

Compiler Plugin DSLには Koin Compiler Plugin が必要です。これにより、コンパイル時の依存関係解決と、よりクリーンな構文が提供されます。