Kotlin Multiplatformのセットアップ
このページでは、Kotlin Multiplatform (KMP) プロジェクトでKoinをセットアップする方法を説明します。Gradleの依存関係、Koinコードの配置場所、Koinを開始する1つの共通関数、そして各プラットフォームからそれを呼び出す方法について扱います。なお、モジュールおよびKoinの開始について理解していることを前提としています。各プラットフォーム独自の実装を提供する方法については、KMP共有パターンで解説しています。
サポートされているターゲット
koin-coreとCompiler Pluginは、すべてのKotlinターゲットをサポートしています。
| ターゲット | サポート状況 |
|---|---|
| Android | 対応 |
iOS (iosArm64, iosX64, iosSimulatorArm64) | 対応 |
| JVM (デスクトップ、サーバー) | 対応 |
JSおよびWasm (js, wasmJs) | 対応 |
| macOS、Linux、Windows (Kotlin/Native) | 対応 |
Composeアーティファクトは、Compose Multiplatformのターゲットに準拠します。Gradleのセットアップのアーティファクト一覧表を参照してください。
依存関係
共有モジュールにKoin Compiler Pluginを適用し、ソースセットにKoinを追加します:
// shared/build.gradle.kts
plugins {
kotlin("multiplatform")
alias(libs.plugins.koin.compiler)
}
kotlin {
androidTarget()
iosArm64()
iosSimulatorArm64()
jvm()
sourceSets {
commonMain.dependencies {
implementation(project.dependencies.platform(libs.koin.bom))
implementation(libs.koin.core)
implementation(libs.koin.annotations) // アノテーションを使用する場合のみ
// Compose Multiplatform
implementation(libs.koin.compose)
implementation(libs.koin.compose.viewmodel)
}
androidMain.dependencies {
implementation(libs.koin.android)
}
commonTest.dependencies {
implementation(libs.koin.test)
}
}
}Compiler Pluginは、1つの宣言からすべてのターゲットに対して実行されます。Koin Annotations 1.xのKSPセットアップとは異なり、ターゲットごとの設定は不要です(KSPからの移行を参照)。
プロジェクト構成
shared/
└── src/
├── commonMain/kotlin/di/
│ ├── Koin.kt // モジュールと initKoin()
│ └── PlatformModule.kt // expect 宣言
├── androidMain/kotlin/di/
│ └── PlatformModule.android.kt
└── iosMain/kotlin/di/
└── PlatformModule.ios.kt
androidApp/ // Application クラスが initKoin() を呼び出す
iosApp/ // Swift の App が initKoin() を呼び出す共通の定義はcommonMainに配置します。各プラットフォームのソースセットには、プラットフォームごとに異なるコードのみを含めます。
共通の開始関数
commonMainにKoinを開始する関数を1つ記述します。各プラットフォームはこの関数を呼び出し、configパラメータを介してプラットフォーム固有の設定を追加できます:
// commonMain/kotlin/di/Koin.kt
import org.koin.core.context.startKoin
import org.koin.dsl.KoinAppDeclaration
import org.koin.dsl.includes
import org.koin.dsl.module
import org.koin.plugin.module.dsl.*
val dataModule = module {
single<UserRepository>()
viewModel<UserViewModel>()
}
val appModule = module {
includes(dataModule, platformModule())
}
fun initKoin(config: KoinAppDeclaration? = null) {
startKoin {
includes(config)
modules(appModule)
}
}// commonMain/kotlin/di/Koin.kt
import org.koin.core.annotation.*
import org.koin.dsl.KoinAppDeclaration
import org.koin.dsl.includes
import org.koin.plugin.module.dsl.startKoin
@Module(includes = [PlatformModule::class])
@ComponentScan("com.example.app")
@Configuration
class AppModule
@KoinApplication
object KoinApp
fun initKoin(config: KoinAppDeclaration? = null) {
startKoin<KoinApp> {
includes(config)
}
}@Configurationモジュールは、ビルド時に@KoinApplicationによって検出されます。PlatformModuleはexpectモジュールクラスです。KMP共有パターンを参照してください。
// commonMain/kotlin/di/Koin.kt
import org.koin.core.context.startKoin
import org.koin.core.module.dsl.*
import org.koin.dsl.KoinAppDeclaration
import org.koin.dsl.includes
import org.koin.dsl.module
val dataModule = module {
singleOf(::UserRepository)
viewModelOf(::UserViewModel)
}
val appModule = module {
includes(dataModule, platformModule())
}
fun initKoin(config: KoinAppDeclaration? = null) {
startKoin {
includes(config)
modules(appModule)
}
}includes(config)は、プラットフォーム固有の設定(Android context、ロガー、追加モジュール)を同一のKoin起動プロセスに適用します。platformModule()はexpect関数です。KMP共有パターンを参照してください。
プラットフォームのエントリーポイント
Android
ApplicationクラスからinitKoinを呼び出し、Androidコンテキストを渡します:
// androidApp
class MainApplication : Application() {
override fun onCreate() {
super.onCreate()
initKoin {
androidContext(this@MainApplication)
androidLogger()
}
}
}これにより、Androidの定義でContextをコンストラクタパラメータとして使用できるようになります。Androidでの開始を参照してください。
iOS
iosMainにパラメータのない関数を追加し、SwiftのAppイニシャライザから呼び出します:
// iosMain/kotlin/di/KoinIos.kt
fun initKoinIos() = initKoin()// iosApp/iOSApp.swift
import Shared
@main
struct iOSApp: App {
init() {
KoinIosKt.doInitKoinIos()
}
var body: some Scene {
WindowGroup { ContentView() }
}
}Swiftからの呼び出し方法は、Kotlin/Nativeの命名規則に基づいています。KoinIos.ktのトップレベル関数は、KoinIosKtという名前のクラスにエクスポートされます。名前がinitで始まる関数にはdoプレフィックスが付加されるため、initKoinIosはdoInitKoinIosになります。このヘルパー関数を用意することで、SwiftからKotlinのラムダ(config)を渡す必要がなくなります。
SwiftコードからKoinを呼び出す方法については、KMPプラットフォーム統合で説明しています。
JVMデスクトップ
// jvmMain
fun main() = application {
initKoin {
printLogger()
}
Window(onCloseRequest = ::exitApplication) {
App()
}
}Web
// jsMain または wasmJsMain
fun main() {
initKoin()
// UIを開始
}Compose Multiplatform
Compose Multiplatformを使用する場合、各プラットフォームでinitKoinを呼び出す代わりに、ルートのComposableからKoinApplicationを使用してKoinを開始できます。Androidでは、自動的にAndroidコンテキストが設定されます:
// commonMain
@Composable
fun App() {
KoinApplication(configuration = koinConfiguration { modules(appModule) }) {
MainScreen()
}
}// commonMain
@Composable
fun App() {
KoinApplication(configuration = koinConfiguration<KoinApp>()) {
MainScreen()
}
}koinConfiguration<T>()はorg.koin.plugin.module.dslから提供されています。
// commonMain
@Composable
fun App() {
KoinApplication(configuration = koinConfiguration { modules(appModule) }) {
MainScreen()
}
}Compose外部のコード(バックグラウンドサービスやSwiftコードなど)が最初の画面表示前にKoinを必要とする場合は、initKoinを引き続き使用してください。両方の選択肢の比較については、Koin for Composeを参照してください。
関連情報
- KMP共有パターン: プラットフォームモジュールと
expect/actual定義。 - KMPプラットフォーム統合: 共通コードでのAndroidコンテキスト、Swiftとの相互運用性、デスクトップおよびWeb。
- Koin for Compose:
KoinApplicationとkoinInject()。 - ViewModel: AndroidとCompose Multiplatformで共有されるViewModel。
- Gradleのセットアップ: BOM、バージョンカタログ、アーティファクト一覧。
