Skip to content

Gradleのセットアップ ​

このページでは、各プラットフォーム向けのGradle依存関係と、公開されているすべてのKoinアーティファクトを一覧で示します。サンプルではKotlin DSL(build.gradle.kts)およびバージョンカタログを使用しています。コンパイル時チェックやCompiler Plugin DSLを追加する場合は、Compiler Plugin Setupの手順もあわせて参照してください。

バージョン ​

koin-annotations を含むすべてのKoinライブラリは、共通のバージョンを共有しています。現在の安定版バージョンは 4.2.2 です。

  • Koin: Maven Central

すべてのアーティファクトは、グループ io.insert-koin の下で Maven Central に公開されています。バージョンの履歴やアップグレードに関する注意事項は Releases に記載されています。

Koin BOM ​

Koin BOM(Bill of Materials)は、すべてのKoinライブラリを同じバージョンに固定します。BOMのバージョンを一度宣言すれば、Koinライブラリをバージョン指定なしで追加できます。BOMを更新すると、すべてのKoinライブラリが一括で更新されます。

gradle/libs.versions.toml の場合:

toml
[versions]
koin = "4.2.2"

[libraries]
koin-bom = { module = "io.insert-koin:koin-bom", version.ref = "koin" }
koin-core = { module = "io.insert-koin:koin-core" }
koin-android = { module = "io.insert-koin:koin-android" }
koin-compose = { module = "io.insert-koin:koin-compose" }
koin-compose-viewmodel = { module = "io.insert-koin:koin-compose-viewmodel" }
koin-compose-viewmodel-navigation = { module = "io.insert-koin:koin-compose-viewmodel-navigation" }
koin-ktor = { module = "io.insert-koin:koin-ktor" }
koin-logger-slf4j = { module = "io.insert-koin:koin-logger-slf4j" }
koin-annotations = { module = "io.insert-koin:koin-annotations" }
koin-test = { module = "io.insert-koin:koin-test" }
koin-test-junit4 = { module = "io.insert-koin:koin-test-junit4" }

モジュールの build.gradle.kts の場合:

kotlin
dependencies {
    implementation(platform(libs.koin.bom))
    implementation(libs.koin.android)
}

バージョンカタログを使用しない場合:

kotlin
dependencies {
    implementation(platform("io.insert-koin:koin-bom:4.2.2"))
    implementation("io.insert-koin:koin-android")
    testImplementation("io.insert-koin:koin-test-junit4")
}

特定の依存関係にバージョンを記述すると、その依存関係についてのみBOMの設定が上書きされます。特定のライブラリのより新しいリリースに含まれる修正が必要な場合を除き、これは避けてください。

BOMを使用しない場合 ​

各ライブラリに個別にバージョンを指定することもできます。Koin samples ではこの方法が採用されており、Kotlin Multiplatformのソースセットでも同様に動作します。

toml
[versions]
koin = "4.2.2"

[libraries]
koin-core = { module = "io.insert-koin:koin-core", version.ref = "koin" }
koin-android = { module = "io.insert-koin:koin-android", version.ref = "koin" }

すべてのKoinライブラリで単一の koin バージョンを維持してください。異なるバージョンの混在はサポートされていません。

Kotlin/JVM ​

kotlin
dependencies {
    implementation(platform(libs.koin.bom))
    implementation(libs.koin.core)
}

その後、main でKoinを起動します。Starting Koin および Kotlin tutorial を参照してください。

Android ​

kotlin
dependencies {
    implementation(platform(libs.koin.bom))
    implementation(libs.koin.android)
}

koin-android には koin-core とViewModelサポートが含まれています。Application クラスでKoinを起動してください。Start Koin on Android を参照してください。

任意のAndroidライブラリ:

アーティファクト追加される機能
koin-androidx-workmanagerWorkManagerのワーカー:WorkManager を参照
koin-androidx-navigationナビゲーショングラフにスコープされたViewModel(Fragment向け)
koin-androidx-startupAndroidX App StartupによるKoinの起動
koin-android-compatJavaクラスからインジェクトするためのJavaヘルパー
koin-dagger-bridge移行期間中にKoinからDaggerコンポーネントを使用

Android with Jetpack Compose ​

kotlin
dependencies {
    implementation(platform(libs.koin.bom))
    implementation(libs.koin.android)
    implementation(libs.koin.compose)
    implementation(libs.koin.compose.viewmodel)
}

koin-androidx-compose は、koin-compose と koin-compose-viewmodel を1つの依存関係にまとめたAndroid専用のアーティファクトです。どちらの設定でも動作します。

ナビゲーションを利用する場合は、次のいずれかを追加してください:

アーティファクトナビゲーションライブラリ
koin-androidx-compose-navigationNavigation Compose 2(Android専用)
koin-compose-viewmodel-navigationNavigation Compose 2(マルチプラットフォーム)
koin-compose-navigation3Navigation 3:Navigation 3 を参照

APIの詳細については Koin for Compose を参照してください。

Compose Multiplatform ​

共有モジュールでは、Composeライブラリを commonMain に追加します。マルチプラットフォームのソースセットでは、バージョン情報を持つカタログエントリを使用してください(BOMを使用しない場合 を参照):

kotlin
kotlin {
    sourceSets {
        commonMain.dependencies {
            implementation(libs.koin.core)
            implementation(libs.koin.compose)
            implementation(libs.koin.compose.viewmodel)
            implementation(libs.koin.compose.viewmodel.navigation) // Navigation Composeを使用する場合
        }
    }
}

Androidでは koin-compose が自動的に koin-android を取り込むため、追加する必要はありません。Compose Multiplatform tutorial を参照してください。

Kotlin Multiplatform ​

共有モジュールの build.gradle.kts で、バージョン情報を持つカタログエントリを使用します(BOMを使用しない場合 を参照):

kotlin
kotlin {
    sourceSets {
        commonMain.dependencies {
            implementation(libs.koin.core)
        }
        androidMain.dependencies {
            implementation(libs.koin.android)
        }
        commonTest.dependencies {
            implementation(libs.koin.test)
        }
    }
}

koin-core は、JVM、Android、Appleターゲット(iOS、macOS、tvOS、watchOS)、Linux、Windows、JS、およびWasm(wasmJs)をサポートしています。プロジェクト構成やプラットフォーム固有の定義については、Kotlin Multiplatform Setup で解説されています。

Ktor ​

kotlin
dependencies {
    implementation(platform(libs.koin.bom))
    implementation(libs.koin.ktor)
    implementation(libs.koin.logger.slf4j)
}

KtorアプリケーションにKoinプラグインをインストールします。Koin for Ktor を参照してください。

テスト ​

kotlin
dependencies {
    testImplementation(libs.koin.test)
    testImplementation(libs.koin.test.junit4) // または koin-test-junit5
}

Androidのインストゥルメンテッドテスト(Instrumented tests)の場合は、androidTestImplementation に koin-android-test を追加してください。Injecting in Tests および Android Instrumented Testing を参照してください。

すべてのアーティファクト ​

アーティファクトプラットフォーム説明
koin-bom全プラットフォーム下記のすべてのアーティファクト向けBill of Materials(部品表)
koin-core全プラットフォームコンテナ、DSL、スコープ、Compiler Plugin DSL
koin-core-coroutines全プラットフォーム遅延ロードモジュールとバックグラウンドロード
koin-core-viewmodel全プラットフォームAndroidおよびCompose Multiplatform用のViewModel定義
koin-annotations全プラットフォームコンパイラプラグイン用アノテーション(@Singleton、@Module、@Named など)
koin-androidAndroidAndroidコンテキスト、ActivityおよびFragment用API、ViewModel
koin-android-compatAndroidJava互換性ヘルパー
koin-androidx-navigationAndroidナビゲーショングラフにスコープされたViewModel
koin-androidx-workmanagerAndroidWorkManagerの統合
koin-androidx-startupAndroidAndroidX App Startupの統合
koin-dagger-bridgeAndroidKoinからDaggerコンポーネントへのアクセス
koin-compose全ComposeターゲットkoinInject()、KoinApplication、およびComposeコンテキスト
koin-compose-viewmodel全ComposeターゲットkoinViewModel()
koin-compose-viewmodel-navigation全ComposeターゲットNavigation ComposeのバックスタックエントリにスコープされたViewModel
koin-compose-navigation3全ComposeターゲットNavigation 3の統合
koin-androidx-composeAndroidAndroid向けの koin-compose と koin-compose-viewmodel のバンドル
koin-androidx-compose-navigationAndroidAndroid向けNavigation Compose 2
koin-ktorJVM、JS、Wasm、iOS、macOS(Ktorサーバーターゲット)Ktorサーバープラグイン
koin-logger-slf4jJVMSLF4Jロガー
koin-test全プラットフォームテストAPI:KoinTest、verify()
koin-test-coroutinesJVM遅延ロードモジュールの検証
koin-test-junit4JVMJUnit 4ルール
koin-test-junit5JVMJUnit 5拡張機能
koin-android-testAndroidインストゥルメンテッドテスト用ヘルパー

Koin Compiler PluginはライブラリではなくGradleプラグインであり、独自のバージョンを持っています。Compiler Plugin Setup を参照してください。

  • Compiler Plugin Setup:コンパイラプラグインとコンパイル時チェックの追加。
  • Setup:プラットフォームごとにインストールするもの。
  • Starting Koin:依存関係の設定完了後にコンテナを起動する方法。
  • Tutorials:各プラットフォームでの最初のアプリ構築。
  • Releases:バージョン情報とアップグレードに関する注意事項。