Kotlin Multiplatform での KSP
このガイドでは、Kotlin Multiplatform プロジェクトで Kotlin Symbol Processing (KSP) を使用する方法について説明します。 クイックスタートについては、マルチプラットフォームプロジェクトのサンプルを参照してください。 このサンプルでは複数のターゲットで KSP を使用しており、プロセッサーによってプロジェクトで使用される Foo クラスが生成されます。
マルチプラットフォームプロジェクトへの KSP の追加
クライアントモジュール(プロセッサーを使用するモジュール)に KSP を追加するには、次の手順を実行します。
モジュールの
build.gradle(.kts)ファイルを開きます。plugins {}ブロックに KSP プラグインを追加します。kotlin// build.gradle.kts plugins { kotlin("multiplatform") version "2.4.21" id("com.google.devtools.ksp") version "2.3.12" }groovy// build.gradle plugins { id 'org.jetbrains.kotlin.multiplatform' version '2.4.21' id 'com.google.devtools.ksp' version '2.3.12' }シンボル処理を必要とするターゲットごとに、プロセッサーの依存関係を追加します。
kotlindependencies { add("ksp<Target>", <processor>) }<Target>は、マルチプラットフォームプロジェクトで使用されているターゲット名の先頭を大文字にしたものです。たとえば、iosArm64ターゲットの場合はkspIosArm64コンフィグレーションを使用します。ターゲットの完全なリストについては、Multiplatform Gradle DSL リファレンスおよび Kotlin/Native でサポートされているターゲットとホストを参照してください。
<processor>はプロセッサーの依存関係です。以下を指定できます。シンボルプロセッサーのロジックを含むプロジェクト内のモジュール:
kotlinadd("kspJvm", project(":local-processor"))Room などの外部プロセッサー:
kotlinadd("kspJvm", "androidx.room3:room3-compiler:3.0.3")
KSP 2.3.12 以降、すべてを包括する ksp(...) コンフィグレーションはマルチプラットフォームプロジェクトでビルドエラーを引き起こします。それ以前のバージョンでは非推奨として報告されます。不要な場所でプロセッサーが実行されるのを防ぐため、各ターゲットを明示的に設定してください。
単一のターゲットで複数のプロセッサーを使用する
1 つのターゲットに複数のプロセッサーを追加できます。
dependencies {
add("kspAndroid", project(":test-processor"))
add("kspAndroid", "androidx.room3:room3-compiler:3.0.3")
}dependencies {
add('kspAndroid', project(':test-processor'))
add('kspAndroid', 'androidx.room3:room3-compiler:3.0.3')
}複数のターゲットで同じプロセッサーを使用する
同じプロセッサーを複数のターゲットに追加できます。
dependencies {
add("kspIosX64", project(":test-processor"))
add("kspIosArm64", project(":test-processor"))
add("kspIosSimulatorArm64", project(":test-processor"))
}dependencies {
add('kspIosX64', project(':test-processor'))
add('kspIosArm64', project(':test-processor'))
add('kspIosSimulatorArm64', project(':test-processor'))
}多数の iOS ターゲットがある場合は、ループを使用して重複を避けることができます。
dependencies {
kotlin.targets.filter { it.name.startsWith("ios") }.forEach { target ->
add(
"ksp${target.name.replaceFirstChar { it.uppercaseChar() }}",
project(":test-processor")
)
}
}dependencies {
kotlin.targets.findAll { it.name.startsWith('ios') }.each { target ->
add("ksp${target.name.capitalize()}", project(':test-processor'))
}
}テストコンパイル用の KSP の設定
テストコンパイル時に KSP を実行するには、対応するテストコンフィグレーションにプロセッサーを追加します。
dependencies {
add("kspJvmTest", project(":test-processor"))
add("kspJsTest", project(":test-processor"))
add("kspIosX64Test", project(":test-processor"))
}dependencies {
add('kspJvmTest', project(':test-processor'))
add('kspJsTest', project(':test-processor'))
add('kspIosX64Test', project(':test-processor'))
}Android のホストテストおよびデバイステストの場合、KSP は対応するソースセット名からコンフィグレーション名を導出します。
dependencies {
add("kspAndroidHostTest", project(":test-processor"))
add("kspAndroidDeviceTest", project(":test-processor"))
}dependencies {
add('kspAndroidHostTest', project(':test-processor'))
add('kspAndroidDeviceTest', project(':test-processor'))
}KSP コンフィグレーション名の確認
KSP は Kotlin Multiplatform のソースセットからコンフィグレーション名を導出します。モジュールの KSP コンフィグレーションの完全なリストを確認するには、次を実行します。
./gradlew :<your-module-name>:dependencies | grep kspターゲットのソースセットに対応するコンフィグレーション名を探してください。
コンパイルと処理
マルチプラットフォームプロジェクトでは、Kotlin は各ターゲットに対して main や test などの個別のコンパイルを作成します。1 つ以上のプロセッサーが設定された Kotlin コンパイルタスクごとに、KSP は対応するシンボル処理タスクを作成します。
サンプルプロジェクトでは 6 つのターゲットが定義されています。各ターゲットには main と test のコンパイルがあり、その結果、以下のコンパイルタスクとシンボル処理タスクが生成されます。
- JVM:
jvmMainおよびjvmTest - JS:
jsMainおよびjsTest - LinuxX64:
linuxX64MainおよびlinuxX64Test - AndroidNativeX64:
androidNativeX64MainおよびandroidNativeX64Test - AndroidNativeArm64:
androidNativeArm64MainおよびandroidNativeArm64Test - MingwX64:
mingwX64MainおよびmingwX64Test
サンプルの workload/build.gradle.kts ファイルでは、以下のコンフィグレーションに対して KSP の依存関係が宣言されています。
kspJvmおよびkspJvmTestkspJsおよびkspJsTestkspAndroidNativeX64およびkspAndroidNativeX64TestkspAndroidNativeArm64およびkspAndroidNativeArm64TestkspLinuxX64kspMingwX64
KSP は、KSP の依存関係が宣言されているコンフィグレーションごとにシンボル処理タスクを作成します。この例では、プロジェクトには少なくとも 12 個の Kotlin コンパイルタスクと 10 個のシンボル処理タスクが存在します。残りのコンパイルには KSP が設定されていないため、対応する KSP タスクはありません。
関連項目
- KSP リポジトリ内のマルチプラットフォームプロジェクトのサンプル
- コマンドラインから KSP を実行する場合の各プラットフォームのエントリーポイント一覧
