Koin Annotations

プロジェクトでKoin Annotationsをセットアップする

バージョン

すべてのKoinパッケージはMaven Centralで見つけることができます。

現在利用可能なバージョンは以下の通りです。

セットアップと現在のバージョン

現在利用可能な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 Multiplatformプロジェクトでは、KSPを次のようにセットアップする必要があります。

• KSP Gradleプラグインを使用する
• commonMainにKoin annotationsの依存関係を追加する
• 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 annotationsと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"))
            }
        }
    }
}