Koin 注解

为你的项目设置 Koin 注解

版本

你可以在 Maven Central 上找到所有 Koin 包。

以下是当前可用版本：

设置与当前版本

以下是当前可用的 Koin 项目版本：

项目	版本
koin-annotations-bom
koin-annotations
koin-ksp-compiler

KSP 插件

我们需要 KSP 插件才能工作 (https://github.com/google/ksp)。请遵循官方的 KSP 设置文档。

只需添加 Gradle 插件：

plugins {
    id "com.google.devtools.ksp" version "$ksp_version"
}

最新的 KSP 兼容版本为：1.9.24-1.0.20

Kotlin 与多平台

在标准的 Kotlin/Kotlin 多平台项目中，你需要按如下方式设置 KSP：

• 使用 KSP Gradle 插件
• 在 commonMain 中添加 Koin 注解的依赖
• 为 commonMain 设置源集 (sourceSet)
• 添加带 Koin 编译器的 KSP 依赖任务
• 设置编译任务依赖于 kspCommonMainKotlinMetadata

plugins {
   id("com.google.devtools.ksp")
}

kotlin {

    sourceSets {
        
        // Add Koin Annotations
        commonMain.dependencies {
            // Koin
            implementation("io.insert-koin:koin-core:$koin_version")
            // Koin Annotations
            api("io.insert-koin:koin-annotations:$koin_annotations_version")
        }
    }
    
    // KSP Common sourceSet
    sourceSets.named("commonMain").configure {
        kotlin.srcDir("build/generated/ksp/metadata/commonMain/kotlin")
    }       
}

// KSP Tasks
dependencies {
    add("kspCommonMainMetadata", libs.koin.ksp.compiler)
    add("kspAndroid", libs.koin.ksp.compiler)
    add("kspIosX64", libs.koin.ksp.compiler)
    add("kspIosArm64", libs.koin.ksp.compiler)
    add("kspIosSimulatorArm64", libs.koin.ksp.compiler)
}

// Trigger Common Metadata Generation from Native tasks
project.tasks.withType(KotlinCompilationTask::class.java).configureEach {
    if(name != "kspCommonMainKotlinMetadata") {
        dependsOn("kspCommonMainKotlinMetadata")
    }
}

Android 应用设置

• 使用 KSP Gradle 插件
• 添加 Koin 注解和 Koin KSP 编译器的依赖
• 设置源集 (sourceSet)

plugins {
   id("com.google.devtools.ksp")
}

android {

    dependencies {
        // Koin
        implementation("io.insert-koin:koin-android:$koin_version")
        // Koin Annotations
        implementation("io.insert-koin:koin-annotations:$koin_annotations_version")
        // Koin Annotations KSP Compiler
        ksp("io.insert-koin:koin-ksp-compiler:$koin_annotations_version")
    }

    // Set KSP sourceSet
    applicationVariants.all {
        val variantName = name
        sourceSets {
            getByName("main") {
                java.srcDir(File("build/generated/ksp/$variantName/kotlin"))
            }
        }
    }
}