Kotlin Multiplatform

セットアップ

Koin Compiler Plugin は KMP のセットアップを簡略化します。プラグインを適用するだけです。

// shared/build.gradle.kts
plugins {
    kotlin("multiplatform")
    alias(libs.plugins.koin.compiler)
}

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

これだけです！プラットフォームごとの KSP 設定は不要です。

共通コードでの定義とモジュールの宣言

commonMain sourceSet で、Module を宣言し、定義をスキャンするか、通常の Kotlin Koin 宣言として関数を定義します。Definitions および Modules を参照してください。

共有パターン

このセクションでは、定義とモジュールを使用してコンポーネントを共有するためのいくつかの方法を一緒に見ていきます。

Kotlin Multiplatform アプリケーションでは、一部のコンポーネントをプラットフォームごとに具体的に実装する必要があります。これらのコンポーネントは、特定のクラス（定義またはモジュール）に対して expect/actual を使用することで、定義レベルで共有できます。 expect/actual 実装を持つ定義、または expect/actual を持つモジュールを共有できます。

INFO

一般的な Kotlin のガイダンスについては、Multiplatform Expect & Actual Rules ドキュメントを参照してください。

WARNING

Expect/Actual クラスは、プラットフォームごとに異なるコンストラクタを持つことはできません。共通スペース（common space）で設計された現在のコンストラクタのコントラクトを尊重する必要があります。

ネイティブ実装のための定義の共有

INFO

共通モジュール（Common Module） + Expect/Actual クラス定義による共有を対象とします。

この最初の古典的なパターンでは、@ComponentScan による定義のスキャンと、モジュールクラスの関数としての定義の宣言の両方を使用できます。

expect/actual 定義を使用するには、同じコンストラクタ（デフォルトまたはカスタムのもの）を使用することに注意してください。このコンストラクタはすべてのプラットフォームで同じである必要があります。

Expect/Actual 定義のスキャン

commonMain の場合:

// commonMain

@Module
@ComponentScan("com.jetbrains.kmpapp.native")
class NativeModuleA()

// package com.jetbrains.kmpapp.native
@Factory
expect class PlatformComponentA() {
    fun sayHello() : String
}

ネイティブソースで actual クラスを実装します：

// androidMain

// package com.jetbrains.kmpapp.native
actual class PlatformComponentA {
    actual fun sayHello() : String = "I'm Android - A"
}

// iOSMain

// package com.jetbrains.kmpapp.native
actual class PlatformComponentA {
    actual fun sayHello() : String = "I'm iOS - A"
}

Expect/Actual 関数定義の宣言

commonMain の場合:

// commonMain

@Module
class NativeModuleB() {

    @Factory
    fun providesPlatformComponentB() : PlatformComponentB = PlatformComponentB()
}

expect class PlatformComponentB() {
    fun sayHello() : String
}

ネイティブソースで actual クラスを実装します：

// androidMain

// package com.jetbrains.kmpapp.native
actual class PlatformComponentB {
    actual fun sayHello() : String = "I'm Android - B"
}

// iOSMain

// package com.jetbrains.kmpapp.native
actual class PlatformComponentB {
    actual fun sayHello() : String = "I'm iOS - B"
}

異なるネイティブコントラクトを持つ定義の共有

INFO

Expect/Actual 共通モジュール + 共通インターフェース + ネイティブ実装を対象とします。

ネイティブ実装ごとに異なるコンストラクタ引数が必要な場合があります。その場合、Expect/Actual クラスは解決策になりません。 各プラットフォームで実装する interface と、モジュールが適切なプラットフォーム実装を定義できるようにするための Expect/Actual クラスモジュールを使用する必要があります。

commonMain の場合:

// commonMain

expect class NativeModuleD() {
    @Factory
    fun providesPlatformComponentD(scope : org.koin.core.scope.Scope) : PlatformComponentD
}

interface PlatformComponentD {
    fun sayHello() : String
}

ネイティブソースで actual クラスを実装します：

// androidMain

@Module
actual class NativeModuleD {
    @Factory
    actual fun providesPlatformComponentD(scope : org.koin.core.scope.Scope) : PlatformComponentD = PlatformComponentDAndroid(scope)
}

class PlatformComponentDAndroid(scope : org.koin.core.scope.Scope) : PlatformComponentD{
    val context : Context = scope.get()
    override fun sayHello() : String = "I'm Android - D - with ${context}"
}

// iOSMain
@Module
actual class NativeModuleD {
    @Factory
    actual fun providesPlatformComponentD(scope : org.koin.core.scope.Scope) : PlatformComponentD = PlatformComponentDiOS()
}

class PlatformComponentDiOS : PlatformComponentD{
    override fun sayHello() : String = "I'm iOS - D"
}

NOTE

Koin スコープへの手動アクセスを使用するたびに、ダイナミックワイヤリング（dynamic wiring）を行っていることになります。コンパイル時の安全性は、このようなワイヤリングをカバーしません。

プラットフォームラッパーによるプラットフォーム間での安全な共有

INFO

特定のプラットフォームコンポーネントを「プラットフォームラッパー（platform wrapper）」としてラップします。

特定のプラットフォームコンポーネントを「プラットフォームラッパー」としてラップすることで、ダイナミックインジェクション（dynamic injection）を最小限に抑えることができます。

例えば、必要に応じて Android の Context を注入でき、iOS 側には影響を与えない ContextWrapper を作成できます。

commonMain の場合:

// commonMain

expect class ContextWrapper

@Module
expect class ContextModule() {

    @Single
    fun providesContextWrapper(scope : Scope) : ContextWrapper
}

ネイティブソースで actual クラスを実装します：

// androidMain
actual class ContextWrapper(val context: Context)

@Module
actual class ContextModule {
    
    // 起動時に androidContext() のセットアップが必要
    @Single
    actual fun providesContextWrapper(scope : Scope) : ContextWrapper = ContextWrapper(scope.get())
}

// iOSMain
actual class ContextWrapper

@Module
actual class ContextModule {

    @Single
    actual fun providesContextWrapper(scope : Scope) : ContextWrapper = ContextWrapper()
}

INFO

これにより、プラットフォーム固有のダイナミックワイヤリングを1つの定義に最小限に抑え、システム全体で安全に注入できるようになります。

これで、共通コードから ContextWrapper を使用し、Expect/Actual クラスに簡単に渡すことができます。

commonMain の場合:

// commonMain

@Module
@ComponentScan("com.jetbrains.kmpapp.native")
class NativeModuleA()

// package com.jetbrains.kmpapp.native
@Factory
expect class PlatformComponentA(ctx : ContextWrapper) {
    fun sayHello() : String
}

ネイティブソースで actual クラスを実装します：

// androidMain

// package com.jetbrains.kmpapp.native
actual class PlatformComponentA actual constructor(val ctx : ContextWrapper) {
    actual fun sayHello() : String = "I'm Android - A - with context: ${ctx.context}"
}

// iOSMain

// package com.jetbrains.kmpapp.native
actual class PlatformComponentA actual constructor(val ctx : ContextWrapper) {
    actual fun sayHello() : String = "I'm iOS - A"
}

Expect/Actual モジュールの共有 - ネイティブモジュールスキャンへの依存

INFO

共通モジュールからネイティブモジュールに依存します。

制約を持たせず、各ネイティブ側でコンポーネントをスキャンしたい場合があります。共通ソースセットで空のモジュールクラスを定義し、各プラットフォームでその実装を定義します。

INFO

共通側で空のモジュールを定義すると、各ネイティブターゲットから各ネイティブモジュールの実装が生成され、例えばネイティブのみのコンポーネントをスキャンできるようになります。

commonMain の場合:

// commonMain

@Module
expect class NativeModuleC()

ネイティブソースセットの場合:

// androidMain
@Module
@ComponentScan("com.jetbrains.kmpapp.other.android")
actual class NativeModuleC

//com.jetbrains.kmpapp.other.android
@Factory
class PlatformComponentC(val context: Context) {
    fun sayHello() : String = "I'm Android - C - $context"
}

// iOSMain
// iOSでは何もしない
@Module
actual class NativeModuleC