Jetpack Compose および Compose Multiplatform 向けの Koin
このページでは、Android Jetpack Compose または Multiplatform Compose アプリケーションで依存関係を注入する方法について説明します。
Koin Compose Multiplatform と Koin Android Jetpack Compose の比較
2024年半ば以降、Compose アプリケーションは Koin Multiplatform API を使用して開発できるようになりました。Koin Jetpack Compose (koin-androidx-compose) と Koin Compose Multiplatform (koin-compose) の間のすべての API は同一です。
Compose にはどの Koin パッケージを使用するか？
Android Jetpack Compose API のみを使用する純粋な Android アプリケーションの場合、以下のパッケージを使用します:
koin-androidx-compose- Compose のベース API と Compose ViewModel API を有効にするkoin-androidx-compose-navigation- Navigation API 統合による Compose ViewModel API
Android/Multiplatform アプリケーションの場合、以下のパッケージを使用します:
koin-compose- Compose のベース APIkoin-compose-viewmodel- Compose ViewModel APIkoin-compose-viewmodel-navigation- Navigation API 統合による Compose ViewModel API
既存の Koin コンテキストから開始する
Composeアプリケーションの前にstartKoin関数を使用することで、アプリケーションはKoinインジェクションを受け入れる準備ができています。ComposeでKoinコンテキストを設定するために、これ以上何も必要ありません。
NOTE
KoinContext と KoinAndroidContext は非推奨です
Compose アプリで Koin を起動する - KoinApplication
startKoin 関数を実行できる場所にアクセスできない場合、Compose と Koin に頼って Koin の設定を開始できます。
KoinApplication というコンポーズ関数は、KoinアプリケーションインスタンスをComposableとして作成するのに役立ちます:
@Composable
fun App() {
KoinApplication(application = {
modules(...)
}) {
// your screens here ...
MyScreen()
}
}KoinApplication 関数は、Compose コンテキストのライフサイクルに応じて、Koin コンテキストの開始と停止を処理します。この関数は新しい Koin アプリケーションコンテキストを開始および停止します。
INFO
Android アプリケーションでは、KoinApplication は設定変更や Activity のドロップに伴う Koin コンテキストの停止/再起動の必要性を処理します。
NOTE
(実験的API) KoinMultiplatformApplication を使用してマルチプラットフォームのエントリポイントを置き換えることができます。これはKoinApplicationと同じですが、自動的にandroidContextとandroidLoggerを注入します。
KoinApplicationPreview を使用した Compose プレビュー
KoinApplicationPreview コンポーズ関数は、Composableをプレビューするために特化されています:
@Preview(name = "1 - Pixel 2 XL", device = Devices.PIXEL_2_XL, locale = "en")
@Preview(name = "2 - Pixel 5", device = Devices.PIXEL_5, locale = "en", uiMode = Configuration.UI_MODE_NIGHT_YES)
@Preview(name = "3 - Pixel 7 ", device = Devices.PIXEL_7, locale = "ru", uiMode = Configuration.UI_MODE_NIGHT_YES)
@Composable
fun previewVMComposable(){
KoinApplicationPreview(application = { modules(appModule) }) {
ViewModelComposable()
}
}@Composable への注入
コンポーザブル関数を記述する際、Koinコンテナからインスタンスを注入するために、以下のKoin APIであるkoinInject()にアクセスできます。
'MyService' コンポーネントを宣言するモジュールの場合:
val androidModule = module {
single { MyService() }
// or constructor DSL
singleOf(::MyService)
}インスタンスは次のように取得できます:
@Composable
fun App() {
val myService = koinInject<MyService>()
}Jetpack Compose の関数型アスペクトに合わせるため、最適な記述アプローチは、インスタンスを関数のパラメーターに直接注入することです。この方法により、Koin を使用したデフォルトの実装が可能になりつつ、インスタンスを自由に注入する余地を残します。
@Composable
fun App(myService: MyService = koinInject()) {
}パラメーターを持つ @Composable への注入
Koin から新しい依存関係を要求する際に、パラメーターを注入する必要がある場合があります。これを行うには、koinInject 関数の parameters パラメーターを parametersOf() 関数とともに次のように使用できます:
@Composable
fun App() {
val myService = koinInject<MyService>(parameters = parametersOf("a_string"))
}INFO
koinInject<MyService>{ parametersOf("a_string") } のようにラムダ注入でパラメーターを使用できますが、頻繁に再コンポーズする場合、パフォーマンスに影響を与える可能性があります。このラムダを使ったバージョンは、呼び出し時にパラメーターをアンラップする必要があり、パラメーターを記憶するのを避けるのに役立ちます。
Koin のバージョン 4.0.2 から、パラメーターを最も効率的な方法で使用できるように koinInject(Qualifier,Scope,ParametersHolder) が導入されました。
@Composable 用の ViewModel
従来のsingle/factoryインスタンスにアクセスするのと同様に、以下のKoin ViewModel APIにアクセスできます:
koinViewModel()- ViewModel インスタンスを注入koinNavViewModel()- ViewModel インスタンス + Navigation 引数データ（NavigationAPI を使用している場合）を注入
'MyViewModel' コンポーネントを宣言するモジュールの場合:
module {
viewModel { MyViewModel() }
// or constructor DSL
viewModelOf(::MyViewModel)
}インスタンスは次のように取得できます:
@Composable
fun App() {
val vm = koinViewModel<MyViewModel>()
}インスタンスは関数のパラメーターでも取得できます:
@Composable
fun App(vm : MyViewModel = koinViewModel()) {
}NOTE
Jetpack Compose の更新では Lazy API はサポートされていません。
共有 Activity ViewModel (4.1 - Android)
koinActivityViewModel() を使用して、同じViewModelホスト（Activity）からViewModelを注入できるようになりました。
@Composable
fun App() {
// hold ViewModel instance at Activity level
val vm = koinActivityViewModel<MyViewModel>()
}@Composable 用の ViewModel と SavedStateHandle
SavedStateHandle コンストラクターパラメーターを持つことができ、それは Compose 環境（Navigation の BackStack または ViewModel）に応じて注入されます。 ViewModelのCreationExtras経由で注入されるか、NavigationのBackStackEntry経由で注入されます:
// Setting objectId argument in Navhost
NavHost(
navController,
startDestination = "list"
) {
composable("list") { backStackEntry ->
//...
}
composable("detail/{objectId}") { backStackEntry ->
val objectId = backStackEntry.arguments?.getString("objectId")?.toInt()
DetailScreen(navController, objectId!!)
}
}
// Injected Argument in ViewModel
class DetailViewModel(
private val savedStateHandle: SavedStateHandle
) : ViewModel() {
init {
println("$this - objectId: ${savedStateHandle.get<String>("objectId")}")
}
}NOTE
SavedStateHandle の注入の違いに関する詳細: https://github.com/InsertKoinIO/koin/issues/1935#issuecomment-2362335705
共有 ViewModel と Navigation (実験的)
Koin Compose Navigation には、現在の NavBackEntry に既に保存されているViewModelを取得できる NavBackEntry.sharedKoinViewModel() 関数が追加されました。ナビゲーション部分では、単に sharedKoinViewModel を使用します:
navigation<Route.BookGraph>(
startDestination = Route.BookList
) {
composable<Route.BookList>(
exitTransition = { slideOutHorizontally() },
popEnterTransition = { slideInHorizontally() }
) {
// Use SharedViewModel here ...
val selectedBookViewModel =
it.sharedKoinViewModel<SelectedBookViewModel>(navController)Composable に紐付けられたモジュールのロードとアンロード
Koin は、特定の Composable 関数用に特定のモジュールをロードする方法を提供します。rememberKoinModules 関数は、Koin モジュールをロードし、現在の Composable 上でそれらを記憶します:
@Composable
@Preview
fun MyComponentComposable() {
// load module at first call of this component
rememberKoinModules(myModule)
}2つの側面でモジュールをアンロードするために、いずれかの放棄関数を使用できます:
onForgotten- コンポジションがドロップされた後onAbandoned- コンポジションが失敗した場合
このためには、rememberKoinModules の unloadOnForgotten または unloadOnAbandoned 引数を使用します。
Composable で Koin スコープを作成する
Composable 関数 rememberKoinScope および KoinScope は、Composable 内で Koin Scope を処理し、Composable の終了時にスコープを閉じるように追跡します。
INFO
この API は現時点ではまだ不安定です。