KSP クイックスタート

クイックスタートとして、独自のプロセッサを作成するか、サンプルを入手できます。

プロセッサの追加

プロセッサを追加するには、KSP Gradleプラグインを含め、プロセッサへの依存関係を追加する必要があります。

KSP Gradleプラグイン com.google.devtools.ksp を build.gradle(.kts) ファイルに追加します。

KotlinGroovy

kotlin

plugins {
    id("com.google.devtools.ksp") version "2.2.10-2.0.2"
}

groovy

plugins {
    id 'com.google.devtools.ksp' version '2.2.10-2.0.2'
}

プロセッサへの依存関係を追加します。この例ではDaggerを使用しています。追加したいプロセッサに置き換えてください。

KotlinGroovy

kotlin

dependencies {
    implementation("com.google.dagger:dagger-compiler:2.51.1")
    ksp("com.google.dagger:dagger-compiler:2.51.1")
}

groovy

dependencies {
    implementation 'com.google.dagger:dagger-compiler:2.51.1'
    ksp 'com.google.dagger:dagger-compiler:2.51.1'
}

./gradlew build を実行します。生成されたコードは build/generated/ksp ディレクトリにあります。

完全な例を次に示します。

KotlinGroovy

kotlin

plugins {
    id("com.google.devtools.ksp") version "2.2.10-2.0.2"
    kotlin("jvm")
}

repositories {
    mavenCentral()
}

dependencies {
    implementation(kotlin("stdlib-jdk8"))
    implementation("com.google.dagger:dagger-compiler:2.51.1")
    ksp("com.google.dagger:dagger-compiler:2.51.1")
}

groovy

plugins {
    id 'com.google.devtools.ksp' version '2.2.10-2.0.2'
    id 'org.jetbrains.kotlin.jvm' version '2.2.21'
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.jetbrains.kotlin:kotlin-stdlib:2.2.21'
    implementation 'com.google.dagger:dagger-compiler:2.51.1'
    ksp 'com.google.dagger:dagger-compiler:2.51.1'
}

独自のプロセッサを作成する

空のGradleプロジェクトを作成します。

他のプロジェクトモジュールで使用するために、ルートプロジェクトでKotlinプラグインのバージョン 2.2.10 を指定します。

KotlinGroovy

kotlin

plugins {
    kotlin("jvm") version "2.2.10" apply false
}

buildscript {
    dependencies {
        classpath(kotlin("gradle-plugin", version = "2.2.10"))
    }
}

groovy

plugins {
    id 'org.jetbrains.kotlin.jvm' version '2.2.10' apply false
}

buildscript {
    dependencies {
        classpath 'org.jetbrains.kotlin:kotlin-gradle-plugin:2.2.10'
    }
}

プロセッサをホストするためのモジュールを追加します。

モジュールのビルドスクリプトで、Kotlinプラグインを適用し、KSP APIを dependencies ブロックに追加します。

KotlinGroovy

kotlin

plugins {
    kotlin("jvm")
}

repositories {
    mavenCentral()
}

dependencies {
    implementation("com.google.devtools.ksp:symbol-processing-api:2.2.10-2.0.2")
}

groovy

plugins {
    id 'org.jetbrains.kotlin.jvm' version '2.2.21'
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'com.google.devtools.ksp:symbol-processing-api:2.2.10-2.0.2'
}

com.google.devtools.ksp.processing.SymbolProcessor および com.google.devtools.ksp.processing.SymbolProcessorProvider を実装する必要があります。あなたが実装する SymbolProcessorProvider の実装は、実装した SymbolProcessor をインスタンス化するためのサービスとしてロードされます。以下に注意してください。
- SymbolProcessor を作成するために SymbolProcessorProvider.create() を実装します。プロセッサが必要とする依存関係（CodeGenerator、プロセッサオプションなど）を SymbolProcessorProvider.create() のパラメータを通じて渡します。
- メインロジックは SymbolProcessor.process() メソッドに記述する必要があります。
- アノテーションの完全修飾名を指定して、resolver.getSymbolsWithAnnotation() を使用して処理したいシンボルを取得します。
- KSPの一般的なユースケースは、シンボルを操作するためのカスタマイズされたビジター（インターフェース com.google.devtools.ksp.symbol.KSVisitor）を実装することです。シンプルなテンプレートビジターは com.google.devtools.ksp.symbol.KSDefaultVisitor です。
- SymbolProcessorProvider および SymbolProcessor インターフェースのサンプル実装については、サンプルプロジェクト内の以下のファイルを参照してください。
  - src/main/kotlin/BuilderProcessor.kt
  - src/main/kotlin/TestProcessor.kt
- 独自のプロセッサを記述したら、src/main/resources/META-INF/services/com.google.devtools.ksp.processing.SymbolProcessorProvider にその完全修飾名を含めることによって、プロセッサプロバイダーをパッケージに登録します。

プロジェクトで独自のプロセッサを使用する

プロセッサを試したいワークロードを含む別のモジュールを作成します。

KotlinGroovy

kotlin

pluginManagement { 
    repositories { 
        gradlePluginPortal()
    }
}

groovy

pluginManagement {
    repositories {
        gradlePluginPortal()
    }
}

モジュールのビルドスクリプトで、指定されたバージョンで com.google.devtools.ksp プラグインを適用し、プロセッサを依存関係のリストに追加します。

KotlinGroovy

kotlin

plugins {
    id("com.google.devtools.ksp") version "2.2.10-2.0.2"
}

dependencies {
    implementation(kotlin("stdlib-jdk8"))
    implementation(project(":test-processor"))
    ksp(project(":test-processor"))
}

groovy

plugins {
    id 'com.google.devtools.ksp' version '2.2.10-2.0.2'
}

dependencies {
    implementation 'org.jetbrains.kotlin:kotlin-stdlib:2.2.21'
    implementation project(':test-processor')
    ksp project(':test-processor')
}

./gradlew build を実行します。生成されたコードは build/generated/ksp にあります。

ワークロードにKSPプラグインを適用するサンプルのビルドスクリプトを次に示します。

KotlinGroovy

kotlin

plugins {
    id("com.google.devtools.ksp") version "2.2.10-2.0.2"
    kotlin("jvm") 
}

repositories {
    mavenCentral()
}

dependencies {
    implementation(kotlin("stdlib-jdk8"))
    implementation(project(":test-processor"))
    ksp(project(":test-processor"))
}

groovy

plugins {
    id 'com.google.devtools.ksp' version '2.2.10-2.0.2'
    id 'org.jetbrains.kotlin.jvm' version '2.2.21'
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.jetbrains.kotlin:kotlin-stdlib:2.2.21'
    implementation project(':test-processor')
    ksp project(':test-processor')
}

プロセッサにオプションを渡す

SymbolProcessorEnvironment.options 内のプロセッサオプションは、Gradleビルドスクリプトで指定します。

none

ksp {
    arg("option1", "value1")
    arg("option2", "value2")
    ...
}

IDEに生成されたコードを認識させる

KSP 1.8.0-1.0.9 以降、生成されたソースファイルは自動的に登録されます。 KSP 1.0.9 以降を使用しており、生成されたリソースをIDEに認識させる必要がない場合は、このセクションをスキップしても問題ありません。

デフォルトでは、IntelliJ IDEAなどのIDEは生成されたコードを認識しません。そのため、生成されたシンボルへの参照が解決不能としてマークされます。IDEが生成されたシンボルを認識できるようにするには、以下のパスを生成されたソースルートとしてマークします。

text

build/generated/ksp/main/kotlin/
build/generated/ksp/main/java/

IDEがリソースディレクトリをサポートしている場合、以下もマークします。

text

build/generated/ksp/main/resources/

KSPコンシューマーモジュールのビルドスクリプトでこれらのディレクトリを構成する必要がある場合もあります。

KotlinGroovy

kotlin

kotlin {
    sourceSets.main {
        kotlin.srcDir("build/generated/ksp/main/kotlin")
    }
    sourceSets.test {
        kotlin.srcDir("build/generated/ksp/test/kotlin")
    }
}

groovy

kotlin {
    sourceSets {
        main.kotlin.srcDirs += 'build/generated/ksp/main/kotlin'
        test.kotlin.srcDirs += 'build/generated/ksp/test/kotlin'
    }
}

IntelliJ IDEAとKSPをGradleプラグインで使用している場合、上記のスニペットでは以下の警告が表示されます。

text

Execution optimizations have been disabled for task ':publishPluginJar' to ensure correctness due to the following reasons:
Gradle detected a problem with the following location: '../build/generated/ksp/main/kotlin'. 
Reason: Task ':publishPluginJar' uses this output of task ':kspKotlin' without declaring an explicit or implicit dependency.

この場合、代わりに以下のスクリプトを使用してください。

KotlinGroovy

kotlin

plugins {
    // ...
    idea
}

idea {
    module {
        // Not using += due to https://github.com/gradle/gradle/issues/8749
        sourceDirs = sourceDirs + file("build/generated/ksp/main/kotlin") // or tasks["kspKotlin"].destination
        testSourceDirs = testSourceDirs + file("build/generated/ksp/test/kotlin")
        generatedSourceDirs = generatedSourceDirs + file("build/generated/ksp/main/kotlin") + file("build/generated/ksp/test/kotlin")
    }
}

groovy

plugins {
    // ...
    id 'idea'
}

idea {
    module {
        // Not using += due to https://github.com/gradle/gradle/issues/8749
        sourceDirs = sourceDirs + file('build/generated/ksp/main/kotlin') // or tasks["kspKotlin"].destination
        testSourceDirs = testSourceDirs + file('build/generated/ksp/test/kotlin')
        generatedSourceDirs = generatedSourceDirs + file('build/generated/ksp/main/kotlin') + file('build/generated/ksp/test/kotlin')
    }
}

概要

ビルダー

Spring

Spring Bootを使用してデータベースを持つRESTful Webサービスを作成する

JavaからKotlinへの移行ガイド

C interop

Objective-C interop

メモリマネージャー

リファレンスとヒント

JSプラットフォーム向けKotlin

概要

Dokkaを実行する

出力形式

認知複雑度の最小化

KSP クイックスタート

プロセッサの追加

独自のプロセッサを作成する

プロジェクトで独自のプロセッサを使用する

プロセッサにオプションを渡す

IDEに生成されたコードを認識させる

Spring Bootを使用してデータベースを持つRESTful Webサービスを作成する

KSP クイックスタート ​

プロセッサの追加 ​

独自のプロセッサを作成する ​

プロジェクトで独自のプロセッサを使用する ​

プロセッサにオプションを渡す ​

IDEに生成されたコードを認識させる ​

KSP クイックスタート

プロセッサの追加

独自のプロセッサを作成する

プロジェクトで独自のプロセッサを使用する

プロセッサにオプションを渡す

IDEに生成されたコードを認識させる