Skip to content

セットアップ ​

このセクションでは、Koinを使用するためにGradleビルドへ追加する内容について説明します。以下から対象のプラットフォームを選択し、リンク先のGradleのセットアップのセクションに従ってください。宣言スタイルをまだ決めていない場合は、まずスタイルの選択をお読みください。スタイルによってCompiler Pluginが必要かどうかが決まります。

インストール対象 ​

プラットフォームアーティファクトセットアップ
Kotlin/JVMkoin-coreKotlin/JVM
Androidkoin-androidAndroid
Jetpack Composeを使用するAndroidkoin-android, koin-compose, koin-compose-viewmodelJetpack Compose
Compose Multiplatformkoin-compose, koin-compose-viewmodelCompose Multiplatform
Kotlin MultiplatformcommonMain 内の koin-coreKotlin Multiplatform
Ktorkoin-ktor, koin-logger-slf4jKtor
テストkoin-test, koin-test-junit4 または koin-test-junit5テスト

新規プロジェクトの場合:

  1. Koin BOM: io.insert-koin:koin-bom をインポートし、バージョンを指定せずにKoinアーティファクトを宣言することで、バージョンが常に一致するようにします。Gradleのセットアップを参照してください。
  2. 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.22.3.20でビルド
Koin Compiler Plugin1.2.12.3.20、2.4.0、2.4.10、2.4.20で検証済み(Koin 4.2.0以上が必要)

最新の公開バージョン:

  • Koin: Maven Central
  • Koin Compiler Plugin: Maven Central

以前のKoinバージョン系列:

KoinKotlinCompiler Plugin
4.2.x2.3.20+対応
4.1.x2.1+非対応(KSPプロセッサのみ)
4.0.x1.9+非対応(KSPプロセッサのみ)
3.5.x1.8+非対応

バージョン間の変更点およびアップグレード方法については、リリースを参照してください。