Skip to content

ダイナミックモジュール ​

このページでは、Composable がコンポジションに入ったときに Koin モジュールを読み込み、離れたときにアンロードできる rememberKoinModules について解説します。これを使用すると、特定の画面が表示されたときにのみ、その機能の定義を読み込むことができます。事前にモジュールの宣言方法を理解しておく必要があります。

rememberKoinModules は io.insert-koin:koin-compose に含まれており、@KoinExperimentalAPI が付与されています。

rememberKoinModules ​

kotlin
import org.koin.compose.module.rememberKoinModules

val checkoutModule = module {
    factory<CheckoutRepository>()
    viewModel<CheckoutViewModel>()
}

@OptIn(KoinExperimentalAPI::class)
@Composable
fun CheckoutScreen() {
    rememberKoinModules(unloadOnForgotten = true) { listOf(checkoutModule) }

    val viewModel = koinViewModel<CheckoutViewModel>()
}

ラムダは読み込むモジュールを返します。Koin は CheckoutScreen が初めてコンポーズされたときに、それらをコンポジションの Koin インスタンスに読み込みます。リコンポジション時に再度読み込まれることはありません。

その定義を必要とする koinInject() や koinViewModel() の呼び出しよりも前に、rememberKoinModules を呼び出してください。

アンロード ​

デフォルトでは、Composable がコンポジションを離れた後もモジュールは読み込まれたままになります。3つのパラメータでアンロードを制御できます。

パラメータデフォルト値効果
unloadOnForgottenunloadModulesComposable がコンポジションを離れたときにアンロードする
unloadOnAbandonedunloadModulesコンポジションが破棄された場合にアンロードする
unloadModulesfalse上記両パラメータのデフォルト値
kotlin
// 両方のケースでアンロードする
rememberKoinModules(unloadModules = true) { listOf(checkoutModule) }

アンロードを行うと、定義が削除され、その single インスタンスも破棄されます。インスタンスへの参照をまだ保持しているコードはそのまま参照を保持しますが、Koin はその型をそれ以上解決できなくなります。他の画面でまだ使用されているモジュールはアンロードしないでください。

デスティネーションごとの読み込み ​

ユーザーが特定の機能に遷移したときにそれを読み込むには、ナビゲーションのデスティネーション内で rememberKoinModules を呼び出します。

kotlin
NavHost(navController, startDestination = HomeRoute) {
    composable<HomeRoute> {
        HomeScreen()
    }
    composable<CheckoutRoute> {
        rememberKoinModules(unloadOnForgotten = true) { listOf(checkoutModule) }
        CheckoutScreen()
    }
}

モジュールの記述スタイル ​

kotlin
val checkoutModule = module {
    factory<CheckoutRepository>()
    viewModel<CheckoutViewModel>()
}

rememberKoinModules は Module の値を受け取ります。アノテーションが付与された @Module クラスは、@KoinApplication 経由で起動時に読み込まれます(モジュールを参照)。機能をオンデマンドで読み込むには、DSL を使用してモジュールを宣言してください。

kotlin
val checkoutModule = module {
    factoryOf(::CheckoutRepository)
    viewModelOf(::CheckoutViewModel)
}

制限事項 ​

  • メインスレッド: モジュールはコンポジション中に同期的に読み込まれます。大規模なモジュールは、そのフレームの処理時間を増加させます。起動時にバックグラウンドでモジュールを読み込むには、Lazy モジュールを参照してください。
  • オーバーライド: 後から読み込まれたモジュールは、同じ型の以前の定義を上書きします(定義を参照)。それをアンロードしても、以前の定義は復元されません。
  • プレビュー: rememberKoinModules には実行中の Koin インスタンスが必要です。プレビューで使用する場合は、KoinApplicationPreview を使用してください(Compose テストを参照)。