Skip to content

設定 ​

本節說明為了使用 Koin 需要在 Gradle 建置中加入哪些內容。請在下方選擇你的平台,然後依照 Gradle 設定 的連結章節進行操作。如果你尚未選擇宣告樣式,請先閱讀 選擇你的樣式:這決定了你是否還需要編譯器外掛程式 (Compiler Plugin)。

安裝項目 ​

平台構件 (Artifacts)設定
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 編譯器外掛程式:套用 Gradle 外掛程式 io.insert-koin.compiler.plugin 以取得具備編譯期檢查的 Compiler Plugin DSL 或註解。這需要 Kotlin 2.3.20 或更新版本。請參閱 編譯器外掛程式設定。

若你僅使用 Constructor DSL 或 Classic DSL,步驟 1 就足夠了。但仍建議執行步驟 2:它能為這些定義加入編譯期檢查。

WARNING

KSP 處理器 koin-ksp-compiler 已棄用。其設定僅保留在 KSP 處理器設定 中供現有專案參考。新專案請使用編譯器外掛程式。

版本 ​

組建目前版本Kotlin
Koin(所有程式庫,包含 koin-annotations)4.2.2以 2.3.20 建置
Koin 編譯器外掛程式1.2.1已在 2.3.20、2.4.0、2.4.10、2.4.20 上驗證(需要 Koin 4.2.0+)

最新發佈版本:

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

較舊的 Koin 系列版本:

KoinKotlin編譯器外掛程式
4.2.x2.3.20+是
4.1.x2.1+否,僅支援 KSP 處理器
4.0.x1.9+否,僅支援 KSP 處理器
3.5.x1.8+否

版本之間的變更與升級方式請參閱 版本發佈。