Kotlin Multiplatformアプリにおける定義とモジュールのためのアノテーション

KSPのセットアップ

KSPのセットアップは、公式ドキュメント「KSP with Kotlin Multiplatform」に記載されている手順に従ってください。

また、Koin Annotationsの基本的なセットアップが記載されているHello Koin KMPプロジェクトも確認できます。

KSPプラグインを追加

plugins {
    alias(libs.plugins.ksp)
}

共通APIでアノテーションライブラリを使用します。

sourceSets {
        commonMain.dependencies {
            implementation(libs.koin.core)
            api(libs.koin.annotations)
            // ...
        }
}

そして、適切なsourceSetでKSPを設定するのを忘れないでください。

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)
}

共通モジュールとKMP Expectコンポーネントの宣言

commonMainのsourceSetでは、expectクラスや関数のネイティブな実装が含まれるパッケージをスキャンするためのモジュールを宣言するだけです。

以下にPlatformModuleがあります。これはPlatformHelper expectクラスを持つcom.jetbrains.kmpapp.platformパッケージをスキャンします。このモジュールクラスには@Moduleと@ComponentScanアノテーションが付与されています。

// in commonMain

@Module
@ComponentScan("com.jetbrains.kmpapp.platform")
class PlatformModule

// package com.jetbrains.kmpapp.platform 

@Single
expect class PlatformHelper {
    fun getName() : String
}

NOTE

生成されるコードは各プラットフォームの実装で行われます。モジュールによるパッケージスキャンが適切なプラットフォームの実装を収集します。

ネイティブコンポーネントのアノテーション

各実装のsourceSetで、適切なプラットフォームの実装を定義できるようになりました。これらの実装には@Singleアノテーションが付与されています（他の定義アノテーションでも可能です）。

// in androidMain
// package com.jetbrains.kmpapp.platform

@Single
actual class PlatformHelper(
    val context: Context
){
    actual fun getName(): String = "I'm Android - $context"
}

// in nativeMain
// package com.jetbrains.kmpapp.platform

@Single
actual class PlatformHelper(){
    actual fun getName(): String = "I'm Native"
}