セットアップ
このセクションでは、Koinを使用するためにGradleビルドへ追加する内容について説明します。以下から対象のプラットフォームを選択し、リンク先のGradleのセットアップのセクションに従ってください。宣言スタイルをまだ決めていない場合は、まずスタイルの選択をお読みください。スタイルによってCompiler Pluginが必要かどうかが決まります。
インストール対象
| プラットフォーム | アーティファクト | セットアップ |
|---|---|---|
| Kotlin/JVM | koin-core | Kotlin/JVM |
| Android | koin-android | Android |
| Jetpack Composeを使用するAndroid | koin-android, koin-compose, koin-compose-viewmodel | Jetpack Compose |
| Compose Multiplatform | koin-compose, koin-compose-viewmodel | Compose Multiplatform |
| Kotlin Multiplatform | commonMain 内の koin-core | Kotlin Multiplatform |
| Ktor | koin-ktor, koin-logger-slf4j | Ktor |
| テスト | koin-test, koin-test-junit4 または koin-test-junit5 | テスト |
推奨セットアップ
新規プロジェクトの場合:
- Koin BOM:
io.insert-koin:koin-bomをインポートし、バージョンを指定せずにKoinアーティファクトを宣言することで、バージョンが常に一致するようにします。Gradleのセットアップを参照してください。 - Koin Compiler Plugin: Gradleプラグイン
io.insert-koin.compiler.pluginを適用して、コンパイル時チェックを備えたCompiler Plugin DSLまたはアノテーションを利用できるようにします。これにはKotlin 2.3.20以降が必要です。Compiler Pluginのセットアップを参照してください。
Constructor DSLまたはClassic DSLのみを使用する場合、ステップ1だけで十分です。ただし、これらの定義にもコンパイル時チェックが追加されるため、ステップ2も推奨されます。
WARNING
KSPプロセッサ koin-ksp-compiler は非推奨(deprecated)です。既存プロジェクト向けにのみ、そのセットアップ手順がKSPプロセッサのセットアップに残されています。新規プロジェクトではCompiler Pluginを使用してください。
バージョン
| コンポーネント | 現在のバージョン | Kotlin |
|---|---|---|
Koin(koin-annotations を含むすべてのライブラリ) | 4.2.2 | 2.3.20でビルド |
| Koin Compiler Plugin | 1.2.1 | 2.3.20、2.4.0、2.4.10、2.4.20で検証済み(Koin 4.2.0以上が必要) |
最新の公開バージョン:
以前のKoinバージョン系列:
| Koin | Kotlin | Compiler Plugin |
|---|---|---|
| 4.2.x | 2.3.20+ | 対応 |
| 4.1.x | 2.1+ | 非対応(KSPプロセッサのみ) |
| 4.0.x | 1.9+ | 非対応(KSPプロセッサのみ) |
| 3.5.x | 1.8+ | 非対応 |
バージョン間の変更点およびアップグレード方法については、リリースを参照してください。
関連情報
- Gradleのセットアップ: BOMおよび各Koinアーティファクトについて。
- Compiler Pluginのセットアップ: プラグインのインストールと設定。
- スタイルの選択: 各スタイルに必要なものについて。
- チュートリアル: 各プラットフォーム向けの最初のアプリケーション作成。
- リリース: バージョン情報とアップグレードの注意事項。
