跳至主要内容

Koin

在你的專案中設定 Koin 所需的一切

目前版本​

你可以在 maven central 上找到所有 Koin 的套件 (packages)。

以下是目前可用的版本：

專案 (Project)版本 (Version)
koin-bomMaven Central
koin-coreMaven Central
koin-core-viewmodelMaven Central
koin-core-viewmodel-navigationMaven Central
koin-core-coroutinesMaven Central
koin-testMaven Central
koin-test-junit4Maven Central
koin-test-junit5Maven Central
koin-androidMaven Central
koin-android-testMaven Central
koin-android-compatMaven Central
koin-androidx-navigationMaven Central
koin-androidx-workmanagerMaven Central
koin-androidx-startupMaven Central
koin-composeMaven Central
koin-compose-viewmodelMaven Central
koin-compose-viewmodel-navigationMaven Central
koin-androidx-composeMaven Central
koin-androidx-compose-navigationMaven Central
koin-ktorMaven Central
koin-logger-slf4jMaven Central

Gradle 設定​

Kotlin​

從 3.5.0 開始，你可以使用 BOM 版本來管理所有 Koin 函式庫版本。在你的應用程式中使用 BOM 時，你不需要為 Koin 函式庫的依賴項添加任何版本。當你更新 BOM 版本時，你正在使用的所有函式庫都會自動更新到它們的新版本。

添加 koin-bom BOM 和 koin-core 依賴項到你的應用程式：

implementation(project.dependencies.platform("io.insert-koin:koin-bom:$koin_version"))
implementation("io.insert-koin:koin-core")

如果你正在使用版本目錄 (version catalogs)：

[versions]
koin-bom = "x.x.x"
...

[libraries]
koin-bom = { module = "io.insert-koin:koin-bom", version.ref = "koin-bom" }
koin-core = { module = "io.insert-koin:koin-core" }
...
dependencies {
    implementation(project.dependencies.platform(libs.koin.bom))
    implementation(libs.koin.core)
}

或者使用舊方法為 Koin 指定確切的依賴項版本：

dependencies {
    implementation("io.insert-koin:koin-core:$koin_version")
}

你現在可以開始使用 Koin 了：

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

如果你需要測試功能：

dependencies {
    // Koin 測試功能 (Test features)
    testImplementation("io.insert-koin:koin-test:$koin_version")
    // Koin for JUnit 4
    testImplementation("io.insert-koin:koin-test-junit4:$koin_version")
    // Koin for JUnit 5
    testImplementation("io.insert-koin:koin-test-junit5:$koin_version")
}
資訊

從現在開始，你可以繼續學習 Koin 教學以了解如何使用 Koin：Kotlin App Tutorial

Android​

添加 koin-android 依賴項到你的 Android 應用程式：

dependencies {
    implementation("io.insert-koin:koin-android:$koin_android_version")
}

你現在可以在你的 Application 類別中開始使用 Koin 了：

class MainApplication : Application() {
    override fun onCreate() {
        super.onCreate()
        
        startKoin {
            modules(appModule)
        }
    }
}

如果你需要額外功能，請添加以下所需的套件：

dependencies {
    // Java 相容性 (Compatibility)
    implementation("io.insert-koin:koin-android-compat:$koin_android_version")
    // Jetpack WorkManager
    implementation("io.insert-koin:koin-androidx-workmanager:$koin_android_version")
    // 導航圖 (Navigation Graph)
    implementation("io.insert-koin:koin-androidx-navigation:$koin_android_version")
    // 應用程式啟動 (App Startup)
    implementation("io.insert-koin:koin-androidx-startup:$koin_android_version")
}
資訊

從現在開始，你可以繼續學習 Koin 教學以了解如何使用 Koin：Android App Tutorial

Jetpack Compose 或 Compose Multiplatform​

添加 koin-compose 依賴項到你的 multiplatform 應用程式，以使用 Koin & Compose API：

dependencies {
    implementation("io.insert-koin:koin-compose:$koin_version")
    implementation("io.insert-koin:koin-compose-viewmodel:$koin_version")
    implementation("io.insert-koin:koin-compose-viewmodel-navigation:$koin_version")
}

如果你正在使用純 Android Jetpack Compose，你可以使用

dependencies {
    implementation("io.insert-koin:koin-androidx-compose:$koin_version")
    implementation("io.insert-koin:koin-androidx-compose-navigation:$koin_version")
}

Kotlin Multiplatform​

添加 koin-core 依賴項到你的 multiplatform 應用程式，用於共享的 Kotlin 部分：

dependencies {
    implementation("io.insert-koin:koin-core:$koin_version")
}
資訊

從現在開始，你可以繼續學習 Koin 教學以了解如何使用 Koin：Kotlin Multiplatform App Tutorial

Ktor​

添加 koin-ktor 依賴項到你的 Ktor 應用程式：

dependencies {
    // Koin for Ktor 
    implementation("io.insert-koin:koin-ktor:$koin_ktor")
    // SLF4J Logger
    implementation("io.insert-koin:koin-logger-slf4j:$koin_ktor")
}

你現在可以將 Koin 功能安裝到你的 Ktor 應用程式中：

fun Application.main() {
    install(Koin) {
        slf4jLogger()
        modules(appModule)
    }
}
資訊

從現在開始，你可以繼續學習 Koin 教學以了解如何使用 Koin：Ktor App Tutorial

Koin BOM​

Koin 的物料清單 (Bill of Materials, BOM) 讓你只需指定 BOM 的版本即可管理所有 Koin 函式庫版本。 BOM 本身具有指向不同 Koin 函式庫的穩定版本的連結，以便它們可以很好地協同工作。在你的應用程式中使用 BOM 時，你不需要為 Koin 函式庫的依賴項添加任何版本。當你更新 BOM 版本時，你正在使用的所有函式庫都會自動更新到它們的新版本。

dependencies {
    // 宣告 koin-bom 版本 (version)
    implementation platform("io.insert-koin:koin-bom:$koin_bom")
    
    // 宣告你需要的 koin 依賴項 (dependencies)
    implementation("io.insert-koin:koin-android")
    implementation("io.insert-koin:koin-core-coroutines")
    implementation("io.insert-koin:koin-androidx-workmanager")
    
    // 如果你需要指定一些版本 (version)，只需指向所需的版本
    implementation("io.insert-koin:koin-androidx-navigation:1.2.3-alpha03")
    
    // 也適用於測試函式庫 (test libraries)！
    testImplementation("io.insert-koin:koin-test-junit4")
    testImplementation("io.insert-koin:koin-android-test")
}