Skip to content

kaptからKSPへの移行 ​

このガイドでは、アノテーションプロセッサを Kotlin Annotation Processing Tool (kapt) から Kotlin Symbol Processing (KSP) へ移行する方法を説明します。移行によって、プロジェクトはKotlinの機能を最大限に活用し、ビルドパフォーマンスを向上させることができます。

kaptを使用すると、KotlinでJavaアノテーションプロセッサを利用できます。KotlinソースコードをJavaの「スタブ(stub)」に変換し、それらのスタブに対してアノテーションプロセッサを実行します。しかし、この処理には高い負荷がかかり、ビルド時間を大幅に増加させるだけでなく、変換の過程でKotlin固有の機能の一部が失われてしまいます。

これに対し、KSPはKotlin専用に設計されたkaptの代替ツールです。Kotlinソースを直接解析し、null許容性(nullability)などのKotlin固有の情報をそのまま利用できるようにすることで、ビルド時間を短縮します。

始める前に ​

プロジェクト内のプロセッサがKSPをサポートしているかどうかを確認してください。サポートされているライブラリのリストを参照するか、各ライブラリのドキュメントを確認してください。

KSPとkaptは共存して実行できるため、ライブラリやモジュールごとに1つずつ段階的にプロジェクトを移行できます。

プロジェクトにKSPプラグインを追加する ​

プロジェクトレベルの build.gradle(.kts) ファイルの plugins {} ブロックにKSPプラグインを追加します。

kotlin
// build.gradle.kts

plugins {
    id("com.google.devtools.ksp") version "2.3.12" apply false
}
groovy
// build.gradle

plugins {
    id 'com.google.devtools.ksp' version '2.3.12' apply false
}

KSPの最新バージョンを確認するには、GitHubの Releases を参照してください。

モジュール内のkaptをKSPに置き換える ​

移行したいプロセッサを使用しているモジュールを見つけます。そのモジュールの build.gradle(.kts) ファイルで以下の手順を行います。

  1. plugins {} ブロックにKSPプラグインを追加します。

    kotlin
    // build.gradle.kts
    
    plugins {
        id("com.google.devtools.ksp")
    }
    groovy
    // build.gradle
    
    plugins {
        id 'com.google.devtools.ksp'
    }
  2. dependencies {} ブロックで、kapt を ksp に置き換えます。

    kotlin
    // build.gradle.kts
    
    dependencies {
        implementation("com.google.dagger:dagger:2.48")
    
        // kapt("com.google.dagger:dagger-compiler:2.48") を置き換えます
        ksp("com.google.dagger:dagger-compiler:2.48")
    }
    groovy
    // build.gradle
    
    dependencies {
        implementation 'com.google.dagger:dagger:2.48'
    
        // kapt 'com.google.dagger:dagger-compiler:2.48' を置き換えます
        ksp 'com.google.dagger:dagger-compiler:2.48'
    }

ほとんどのライブラリでは、この置き換えだけで十分です。追加の変更が必要かどうかについては、各ライブラリのドキュメントを確認してください。

kaptプラグインを削除する ​

すべてのプロセッサをKSPに移行した後は、すべての build.gradle(.kts) ファイルからkaptプラグインを安全に削除できます。

kotlin
// build.gradle.kts

plugins {
    // kaptプラグインの宣言を削除:
    id("org.jetbrains.kotlin.kapt")
}
groovy
// build.gradle

plugins {
    // kaptプラグインの宣言を削除:
    id 'org.jetbrains.kotlin.kapt'
}

kapt {} ブロックなど、残っているkaptの設定があれば削除してください。

関連項目 ​