KSP 퀵스타트

빠른 시작을 위해 직접 프로세서를 생성하거나 샘플 프로세서를 사용할 수 있습니다.

프로세서 추가

프로세서를 추가하려면 KSP Gradle 플러그인을 포함하고 해당 프로세서에 대한 의존성을 추가해야 합니다:

build.gradle(.kts) 파일에 KSP Gradle 플러그인 com.google.devtools.ksp을 추가합니다:

KotlinGroovy

kotlin

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

groovy

plugins {
    id 'com.google.devtools.ksp' version '2.2.0-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.0-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.0-2.0.2'
    id 'org.jetbrains.kotlin.jvm' version '2.2.10'
}

repositories {
    mavenCentral()
}

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

직접 프로세서 생성

빈 Gradle 프로젝트를 생성합니다.

다른 프로젝트 모듈에서 사용할 수 있도록 루트 프로젝트에서 Kotlin 플러그인의 버전 2.2.0을 지정합니다:

KotlinGroovy

kotlin

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

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

groovy

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

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

프로세서를 호스팅할 모듈을 추가합니다.

모듈의 빌드 스크립트에서 Kotlin 플러그인을 적용하고 dependencies 블록에 KSP API를 추가합니다.

KotlinGroovy

kotlin

plugins {
    kotlin("jvm")
}

repositories {
    mavenCentral()
}

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

groovy

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

repositories {
    mavenCentral()
}

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

com.google.devtools.ksp.processing.SymbolProcessor와 com.google.devtools.ksp.processing.SymbolProcessorProvider를 구현해야 합니다. 구현한 SymbolProcessorProvider는 구현한 SymbolProcessor를 인스턴스화하기 위한 서비스로 로드됩니다. 다음 사항에 유의하세요:
- SymbolProcessorProvider.create()를 구현하여 SymbolProcessor를 생성합니다. 프로세서에 필요한 의존성(예: 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.0-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.0-2.0.2'
}

dependencies {
    implementation 'org.jetbrains.kotlin:kotlin-stdlib:2.2.10'
    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.0-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.0-2.0.2'
    id 'org.jetbrains.kotlin.jvm' version '2.2.10'
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.jetbrains.kotlin:kotlin-stdlib:2.2.10'
    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와 Gradle 플러그인에서 KSP를 사용하는 경우 위 스니펫은 다음 경고를 발생시킬 것입니다:

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 웹 서비스 만들기

Java에서 Kotlin으로 마이그레이션 가이드

C 상호 운용

Objective-C 상호 운용

메모리 관리자

참조 및 팁

JS 플랫폼을 위한 Kotlin

Gradle

Dokka 실행

출력 형식

인지 복잡성 최소화

KSP 퀵스타트

프로세서 추가

직접 프로세서 생성

프로젝트에서 직접 만든 프로세서 사용

프로세서에 옵션 전달

IDE에서 생성된 코드 인식시키기

Spring Boot를 사용하여 데이터베이스와 RESTful 웹 서비스 만들기

KSP 퀵스타트 ​

프로세서 추가 ​

직접 프로세서 생성 ​

프로젝트에서 직접 만든 프로세서 사용 ​

프로세서에 옵션 전달 ​

IDE에서 생성된 코드 인식시키기 ​

KSP 퀵스타트

프로세서 추가

직접 프로세서 생성

프로젝트에서 직접 만든 프로세서 사용

프로세서에 옵션 전달

IDE에서 생성된 코드 인식시키기