kmp について
Android、iOS、Desktop、Web(WASM)、Server間でコードを共有するKotlin Multiplatform開発者向けの実践ガイドです。モジュール構成、プラットフォーム別コード、テスト、各ターゲットの制約を扱います。
主な機能
- 01マルチモジュール構成
- 02ソースセットとターゲット設定
- 03expect/actualによる実装
- 04共有・プラットフォーム別テスト
- 05WASMの制約とストレージ方式
活用シーン
- 01KMPプロジェクトのモジュール設計
- 02プラットフォーム固有APIの実装
- 03共有Kotlinコードのテスト
- 04WASM向けストレージとネットワークの調整
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ andvl1/ claude-plugin --skill kmpインストール後、Claude Code で/kmpを入力して読み込まれたか確認します。
詳細
Kotlin Multiplatform(KMP)の基礎
Kotlin Multiplatform を使うと、Android、iOS、Desktop、Web(WASM)、Server 間でコードを共有できます。
プロジェクト構造
マルチモジュールアーキテクチャ(機能ベース+api/impl)
your-project-admin/
├── build.gradle.kts # Root build config
├── settings.gradle.kts # Module includes
├── gradle/libs.versions.toml # Version catalog
│
├── core/
│ ├── common/ # Utilities, Result types, extensions
│ │ └── src/commonMain/kotlin/
│ ├── data/ # Data abstractions, DataStore
│ │ ├── src/commonMain/kotlin/
│ │ ├── src/androidMain/kotlin/
│ │ └── src/iosMain/kotlin/
│ ├── database/ # Room (Android/iOS/JVM only)
│ │ └── src/commonMain/kotlin/
│ ├── network/ # Ktor client
│ │ └── src/commonMain/kotlin/
│ └── ui/ # Design system, theme
│ └── src/commonMain/kotlin/
│
├── feature/
│ ├── auth/
│ │ ├── api/ # Public interfaces, models
│ │ │ └── src/commonMain/kotlin/
│ │ └── impl/ # Implementation, UI
│ │ └── src/commonMain/kotlin/
│ └── home/
│ ├── api/
│ └── impl/
│
├── composeApp/ # Platform entry points
│ ├── src/commonMain/ # App composition, DI graph
│ ├── src/androidMain/ # MainActivity
│ ├── src/iosMain/ # iOS entry
│ ├── src/jvmMain/ # Desktop main()
│ └── src/wasmJsMain/ # Web entry
│
└── iosApp/ # Xcode project
ソースセットの階層
commonMain
├── androidMain
├── iosMain
│ ├── iosX64Main
│ ├── iosArm64Main
│ └── iosSimulatorArm64Main
├── jvmMain
├── wasmJsMain
└── jsMain (fallback)
Gradle の設定
ルートの build.gradle.kts
plugins {
alias(libs.plugins.kotlinMultiplatform) apply false
alias(libs.plugins.androidApplication) apply false
alias(libs.plugins.androidLibrary) apply false
alias(libs.plugins.composeMultiplatform) apply false
alias(libs.plugins.composeCompiler) apply false
alias(libs.plugins.kotlinSerialization) apply false
alias(libs.plugins.ksp) apply false
alias(libs.plugins.room) apply false
alias(libs.plugins.metro) apply false
}
settings.gradle.kts
pluginManagement {
repositories {
google()
mavenCentral()
gradlePluginPortal()
}
}
dependencyResolutionManagement {
repositories {
google()
mavenCentral()
}
}
rootProject.name = "your-project-admin"
// Core modules
include(":core:common")
include(":core:data")
include(":core:database")
include(":core:network")
include(":core:ui")
// Feature modules
include(":feature:auth:api")
include(":feature:auth:impl")
include(":feature:home:api")
include(":feature:home:impl")
// App entry points
include(":composeApp")
gradle/libs.versions.toml
[versions]
kotlin = "2.3.20"
agp = "9.1.0"
compose-multiplatform = "1.10.3"
ktor = "3.4.1"
room = "2.8.4"
datastore = "1.2.0"
decompose = "3.5.0"
metro = "0.10.2"
essenty = "2.5.0"
coroutines = "1.10.2"
serialization = "1.10.0"
ksp = "2.3.20-1.0.31"
[libraries]
# Kotlin
kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "coroutines" }
kotlinx-serialization-json = { module = "org.jetbrains.kotlinx:kotlinx-serialization-json", version.ref = "serialization" }
# Ktor
ktor-client-core = { module = "io.ktor:ktor-client-core", version.ref = "ktor" }
ktor-client-cio = { module = "io.ktor:ktor-client-cio", version.ref = "ktor" }
ktor-client-darwin = { module = "io.ktor:ktor-client-darwin", version.ref = "ktor" }
ktor-client-content-negotiation = { module = "io.ktor:ktor-client-content-negotiation", version.ref = "ktor" }
ktor-serialization-kotlinx-json = { module = "io.ktor:ktor-serialization-kotlinx-json", version.ref = "ktor" }
# Room (Android, iOS, JVM only)
androidx-room-runtime = { module = "androidx.room:room-runtime", version.ref = "room" }
androidx-room-compiler = { module = "androidx.room:room-compiler", version.ref = "room" }
androidx-sqlite-bundled = { module = "androidx.sqlite:sqlite-bundled", version = "2.6.2" }
# DataStore
datastore-preferences-core = { module = "androidx.datastore:datastore-preferences-core", version.ref = "datastore" }
# Decompose
decompose = { module = "com.arkivanov.decompose:decompose", version.ref = "decompose" }
decompose-compose = { module = "com.arkivanov.decompose:extensions-compose", version.ref = "decompose" }
essenty-lifecycle = { module = "com.arkivanov.essenty:lifecycle", version.ref = "essenty" }
[plugins]
kotlinMultiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
kotlinSerialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
androidApplication = { id = "com.android.application", version.ref = "agp" }
androidLibrary = { id = "com.android.library", version.ref = "agp" }
composeMultiplatform = { id = "org.jetbrains.compose", version.ref = "compose-multiplatform" }
composeCompiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
ksp = { id = "com.google.devtools.ksp", version.ref = "ksp" }
room = { id = "androidx.room", version.ref = "room" }
metro = { id = "dev.zacsweers.metro", version.ref = "metro" }
モジュールの build.gradle.kts(KMP ライブラリ)
// core/common/build.gradle.kts
plugins {
alias(libs.plugins.kotlinMultiplatform)
alias(libs.plugins.androidLibrary)
}
kotlin {
androidTarget {
compilerOptions {
jvmTarget.set(org.jetbrains.kotlin.gradle.dsl.JvmTarget.JVM_21)
}
}
listOf(
iosX64(),
iosArm64(),
iosSimulatorArm64()
).forEach { iosTarget ->
iosTarget.binaries.framework {
baseName = "CoreCommon"
isStatic = true
}
}
jvm("desktop")
wasmJs {
browser()
}
sourceSets {
commonMain.dependencies {
implementation(libs.kotlinx.coroutines.core)
}
androidMain.dependencies {
// Android-specific
}
iosMain.dependencies {
// iOS-specific
}
val desktopMain by getting {
dependencies {
// Desktop-specific
}
}
}
}
android {
namespace = "com.your-project.admin.core.common"
compileSdk = 35
defaultConfig {
minSdk = 24
}
compileOptions {
sourceCompatibility = JavaVersion.VERSION_21
targetCompatibility = JavaVersion.VERSION_21
}
}
expect/actual パターン
宣言(commonMain)
// commonMain/kotlin/Platform.kt
expect class PlatformContext
expect fun getPlatformName(): String
expect fun createDataStorePath(context: PlatformContext): String
Android の実装
// androidMain/kotlin/Platform.android.kt
actual typealias PlatformContext = android.content.Context
actual fun getPlatformName(): String = "Android ${android.os.Build.VERSION.SDK_INT}"
actual fun createDataStorePath(context: PlatformContext): String {
return context.filesDir.resolve("datastore").absolutePath
}
iOS の実装
// iosMain/kotlin/Platform.ios.kt
import platform.Foundation.NSDocumentDirectory
import platform.Foundation.NSFileManager
import platform.Foundation.NSUserDomainMask
actual class PlatformContext
actual fun getPlatformName(): String = "iOS"
actual fun createDataStorePath(context: PlatformContext): String {
val documentDir = NSFileManager.defaultManager.URLForDirectory(
NSDocumentDirectory,
NSUserDomainMask,
null,
false,
null
)
return "${documentDir?.path}/datastore"
}
Desktop の実装
// desktopMain/kotlin/Platform.jvm.kt
import java.io.File
actual class PlatformContext
actual fun getPlatformName(): String =
"${System.getProperty("os.name")} ${System.getProperty("os.version")}"
actual fun createDataStorePath(context: PlatformContext): String {
val home = System.getProperty("user.home")
return File(home, ".your-project-admin/datastore").absolutePath
}
WASM の実装
// wasmJsMain/kotlin/Platform.wasmJs.kt
actual class PlatformContext
actual fun getPlatformName(): String = "Web (WASM)"
actual fun createDataStorePath(context: PlatformContext): String {
return "your-project-admin-datastore" // Uses localStorage
}
モジュールの依存関係
依存関係のルール
composeApp
├── feature:auth:impl
│ ├── feature:auth:api
│ ├── core:ui
│ └── core:network
├── feature:home:impl
│ ├── feature:home:api
│ ├── core:ui
│ └── core:database
├── core:ui
│ └── core:common
├── core:network
│ └── core:common
├── core:database
│ └── core:common
└── core:data
└── core:common
api/impl パターン
// feature/auth/api/build.gradle.kts
plugins {
alias(libs.plugins.kotlinMultiplatform)
}
kotlin {
// Targets...
sourceSets {
commonMain.dependencies {
// Only models and interfaces - no implementations
api(projects.core.common)
}
}
}
// feature/auth/impl/build.gradle.kts
plugins {
alias(libs.plugins.kotlinMultiplatform)
alias(libs.plugins.composeMultiplatform)
alias(libs.plugins.composeCompiler)
}
kotlin {
sourceSets {
commonMain.dependencies {
implementation(projects.feature.auth.api)
implementation(projects.core.ui)
implementation(projects.core.network)
implementation(libs.decompose)
implementation(libs.decompose.compose)
}
}
}
一般的なパターン
Result 型
// core/common/src/commonMain/kotlin/Result.kt
sealed class AppResult<out T> {
data class Success<T>(val data: T) : AppResult<T>()
data class Error(val message: String, val cause: Throwable? = null) : AppResult<Nothing>()
data object Loading : AppResult<Nothing>()
}
inline fun <T, R> AppResult<T>.map(transform: (T) -> R): AppResult<R> = when (this) {
is AppResult.Success -> AppResult.Success(transform(data))
is AppResult.Error -> this
is AppResult.Loading -> this
}
inline fun <T> AppResult<T>.onSuccess(action: (T) -> Unit): AppResult<T> {
if (this is AppResult.Success) action(data)
return this
}
inline fun <T> AppResult<T>.onError(action: (String, Throwable?) -> Unit): AppResult<T> {
if (this is AppResult.Error) action(message, cause)
return this
}
Repository インターフェース(api モジュール)
// feature/auth/api/src/commonMain/kotlin/AuthRepository.kt
interface AuthRepository {
suspend fun login(email: String, password: String): AppResult<User>
suspend fun logout(): AppResult<Unit>
fun observeAuthState(): Flow<AuthState>
}
data class User(
val id: String,
val email: String,
val name: String
)
sealed class AuthState {
data object Unauthenticated : AuthState()
data class Authenticated(val user: User) : AuthState()
}
Repository の実装(impl モジュール)
// feature/auth/impl/src/commonMain/kotlin/AuthRepositoryImpl.kt
class AuthRepositoryImpl(
private val apiService: AuthApiService,
private val tokenStorage: TokenStorage
) : AuthRepository {
private val _authState = MutableStateFlow<AuthState>(AuthState.Unauthenticated)
override suspend fun login(email: String, password: String): AppResult<User> {
return try {
val response = apiService.login(LoginRequest(email, password))
tokenStorage.saveToken(response.token)
_authState.value = AuthState.Authenticated(response.user)
AppResult.Success(response.user)
} catch (e: Exception) {
AppResult.Error("Login failed: ${e.message}", e)
}
}
override suspend fun logout(): AppResult<Unit> {
tokenStorage.clearToken()
_authState.value = AuthState.Unauthenticated
return AppResult.Success(Unit)
}
override fun observeAuthState(): Flow<AuthState> = _authState.asStateFlow()
}
実行時のプラットフォーム判定
// When expect/actual is overkill, use runtime checks
enum class Platform {
Android, iOS, Desktop, Web
}
expect val currentPlatform: Platform
// androidMain
actual val currentPlatform: Platform = Platform.Android
// iosMain
actual val currentPlatform: Platform = Platform.iOS
// desktopMain
actual val currentPlatform: Platform = Platform.Desktop
// wasmJsMain
actual val currentPlatform: Platform = Platform.Web
// Usage
@Composable
fun AdaptiveComponent() {
when (currentPlatform) {
Platform.Android -> AndroidSpecificUI()
Platform.iOS -> IOSSpecificUI()
Platform.Desktop -> DesktopSpecificUI()
Platform.Web -> WebSpecificUI()
}
}
テスト
共有テスト(commonTest)
// core/common/src/commonTest/kotlin/ResultTest.kt
class ResultTest {
@Test
fun `map transforms success value`() {
val result: AppResult<Int> = AppResult.Success(5)
val mapped = result.map { it * 2 }
assertTrue(mapped is AppResult.Success)
assertEquals(10, (mapped as AppResult.Success).data)
}
@Test
fun `map preserves error`() {
val result: AppResult<Int> = AppResult.Error("test error")
val mapped = result.map { it * 2 }
assertTrue(mapped is AppResult.Error)
}
}
プラットフォーム固有のテスト
// androidTest - uses Robolectric or instrumented tests
// iosTest - runs on simulator
// jvmTest - standard JUnit
ベストプラクティス
推奨事項
- できるだけ多くのコードを
commonMainに配置します - プラットフォーム API にのみ expect/actual を使用します
- プラットフォーム固有の実装は最小限に抑えます
- プラットフォーム間の差異には依存性注入を使用します
- 共有コードを
commonTestでテストします - 依存関係にはバージョンカタログを使用します
禁止事項
- プラットフォーム固有のコードを共通モジュールに配置しないでください
- プラットフォームのソースセット間でコードを重複させないでください
- 公開 API でプラットフォーム固有の型を使用しないでください
- 適切なモジュール分割(api/impl)を省略しないでください
- データベースに関する WASM の制限を無視しないでください
WASM の制限
WebAssembly をターゲットにする場合の重要な制限:
データベース
- Room:WASM ではサポートされていません
- expect/actual パターンを介して
localStorageまたはIndexedDBを使用します - wasmJsMain ソースセットではデータベースの使用を省略することを検討します
// commonMain - interface only
expect class AppStorage {
fun getString(key: String): String?
fun putString(key: String, value: String)
}
// wasmJsMain - browser storage
actual class AppStorage {
actual fun getString(key: String): String? =
window.localStorage.getItem(key)
actual fun putString(key: String, value: String) {
window.localStorage.setItem(key, value)
}
}
ネットワーク
- CORS:すべての HTTP リクエストはブラウザーの CORS ポリシーの対象です
- WebSocket:動作しますが、CORS に対応したサーバーが必要です
ファイルシステム
- ファイルシステムに直接アクセスできません
- 仮想ファイル API または blob URL を使用します
スレッド処理
Dispatchers.IOは使用できません(Dispatchers.Defaultを使用します)- バックグラウンドタスクには Web Workers を使用します(制限あり)
関連スキル
kotlin-web— Kotlin ベースの Web フロントエンド(Compose WASM、Kotlin/JS+React、Kotlin/JS+Vue)。基本的な設定を超えるwasmJsMainおよびjsMainの Web パターンに使用します。kmp-feature-slice— 手順に沿った機能生成ワークフロー。このスキルのプロジェクト構造を使用します。compose-arch— Compose UI レイヤーのアーキテクチャルール。
リソース
コメント
Markdown 対応