Kotlin Academy · 강의

KSP 프로세서를 Gradle 빌드에 통합하기

Gradle에서 KSP를 구성하고 생성된 소스를 추가하며 프로세서 출력을 디버깅해 보세요.

레슨 4/413개 단계

KSP 프로세서를 Gradle 빌드에 통합하기은(는) CoddyKit의 무료 Kotlin Academy 강의입니다. 이것은 4개 중 4번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 Kotlin Academy 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. Kotlin Academy 강의에는 총 4개의 강의가 포함되어 있습니다.

다중 모듈 구조

일반적인 KSP 설정에는 최소 두 개의 모듈이 있습니다. :annotation에는 애너테이션 클래스가 포함되고, :processor에는 SymbolProcessor가 포함됩니다. 사용하는 모듈에서는 KSP 플러그인을 적용하고 ksp 및 implementation 의존성을 선언합니다.

KSP 플러그인 적용하기

사용하는 모듈의 build.gradle.kts에서 다음과 같이 작성합니다:

plugins {
    kotlin("jvm")  // or android, multiplatform
    id("com.google.devtools.ksp") version "2.0.0-1.0.21"
}

ksp 의존성 선언하기

KSP 프로세서를 추가할 때는 implementation이 아니라 ksp 구성을 사용합니다. 프로세서는 빌드 시에만 실행되며 최종 산출물에는 포함되지 않습니다:

dependencies {
    implementation(project(":annotation"))
    ksp(project(":processor"))
}

생성된 소스 디렉터리

KSP는 생성된 파일을 build/generated/ksp/<sourceSet>/kotlin/ 아래에 작성합니다. KSP 플러그인이 이 디렉터리를 Kotlin 소스 세트에 자동으로 추가하므로 별도로 구성하지 않아도 생성된 클래스를 코드에서 사용할 수 있습니다.

프로세서에 옵션 전달하기

ksp { arg("key", "value") }를 통해 Gradle의 빌드 시 옵션을 프로세서에 전달합니다. 프로세서에서는 environment.options["key"]를 통해 옵션을 읽습니다:

// build.gradle.kts (consumer)
ksp {
    arg("generateMocks", "true")
    arg("outputPackage", "com.example.generated")
}

프로세서에서 옵션 읽기

SymbolProcessorProvider.create() 메서드에서 환경의 옵션에 액세스합니다:

class MyProcessorProvider : SymbolProcessorProvider {
    override fun create(environment: SymbolProcessorEnvironment): SymbolProcessor {
        val genMocks = environment.options["generateMocks"] == "true"
        return MyProcessor(environment.codeGenerator, environment.logger, genMocks)
    }
}

증분 빌드

KSP는 입력과 출력 간의 의존성을 추적합니다. codeGenerator.createNewFile()을 호출할 때 생성된 각 파일을 소스 심볼과 연결합니다. 그러면 추적 중인 입력이 변경되지 않은 경우 KSP가 다시 처리하지 않습니다.

val deps = Dependencies(aggregating = false, *symbols.map { it.containingFile!! }.toTypedArray())
codeGenerator.createNewFile(deps, packageName, fileName)

Android에서 KSP 사용하기

Android 프로젝트에서는 플러그인과 의존성 선언 모두에서 kapt를 ksp로 바꿉니다. 빌드 유형에 따라 프로세서 동작을 다르게 설정해야 한다면 kspDebug 또는 kspRelease와 같은 변형별 구성을 사용합니다.

Kotlin 멀티플랫폼에서 KSP 사용하기

KMP 프로젝트에서는 KSP 플러그인을 적용하고, 프로세서가 지원하는 대상에 따라 add(kotlinCompilation.defaultSourceSetName + "ksp", project(":processor")) 또는 kspCommonMainMetadata, kspJvmMain 등의 약식 표기를 사용합니다.

생성된 파일 확인하기

./gradlew build를 실행한 후(또는 Android에서는 kspKotlin / kspDebugKotlin 실행 후) build/generated/ksp/를 확인합니다. IntelliJ와 Android Studio는 이 폴더를 생성된 소스로 표시하며, 사용 위치에서 생성된 선언으로 이동할 수 있게 합니다.

프로세서 디버깅하기

--debug를 사용하여 Gradle 작업을 실행하거나, ksp 구성에 jvmArgs("-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005")를 추가하여 애너테이션 처리 JVM에 원격 디버거를 연결합니다.

빠른 확인

빌드 시 실행되지만 런타임 클래스 경로에는 포함되지 않는 KSP 프로세서를 추가할 때 사용하는 Gradle 구성은 무엇입니까?

인터랙티브 레슨에서 답해보세요

복습: Gradle 빌드에 KSP 통합하기

핵심 요점:

com.google.devtools.ksp 플러그인을 적용하고 ksp() 의존성으로 프로세서를 추가합니다
생성된 소스는 build/generated/ksp/에 생성되며 소스 세트에 자동으로 추가됩니다
ksp { arg() }를 통해 Gradle에서 옵션을 전달하고 environment.options를 통해 읽습니다
정확한 증분 재빌드를 위해 createNewFile()과 함께 Dependencies를 사용합니다
Android(변형별 구성)와 Kotlin 멀티플랫폼을 지원합니다

무료로 시작

AI 튜터와 함께 Kotlin을(를) 배우세요 — 무료

브라우저에서 실제 코드를 작성하고 실행하며, 24/7 AI 튜터로부터 즉각적인 도움을 받고, 웹이나 앱에서 중단한 부분부터 계속 학습하세요.

코스: 51
레슨: 203

무료로 학습 시작 전체 코스 보기

자주 묻는 질문

“KSP 프로세서를 Gradle 빌드에 통합하기” 강의는 무료인가요?

네 — “KSP 프로세서를 Gradle 빌드에 통합하기” 전체 내용을 이 웹사이트에서 무료로 읽을 수 있습니다. 인터랙티브하게 실습하려면(내장 코드 에디터와 24/7 AI 튜터), CoddyKit PRO로 업그레이드하면 Kotlin Academy 강의 전체를 잠금 해제할 수 있습니다. Kotlin Academy 강의에는 총 4개의 강의가 포함되어 있습니다.

“KSP 프로세서를 Gradle 빌드에 통합하기”에서 뭘 배우나요?

Gradle에서 KSP를 구성하고 생성된 소스를 추가하며 프로세서 출력을 디버깅해 보세요. 브라우저에서 직접 실행하는 실습 코드로 Kotlin Academy을(를) 배우며, 24/7 AI 튜터가 강의를 진행하면서 질문에 답변해줍니다.

Kotlin Academy을(를) 시작하는 데 경험이 필요한가요?

사전 경험은 필요하지 않습니다. CoddyKit의 Kotlin Academy은(는) 초급자부터 고급 학습자까지를 위해 구성되어 있으므로, 여기서 시작하거나 처음부터 시작할 수 있으며 자신의 속도대로 진행할 수 있습니다. 이것은 4개 중 4번째 강의입니다.

“KSP 프로세서를 Gradle 빌드에 통합하기” 강의는 얼마나 걸리나요?

대부분의 CoddyKit 강의는 약 5~10분이 소요됩니다. 각 강의는 간결하고 인터랙티브하여 꾸준한 진행이 가능하며, 웹과 앱에서 중단한 부분부터 바로 시작할 수 있습니다.

이 Kotlin Academy 강의에서 코드를 작성하고 실행할 수 있나요?

네. 모든 Kotlin Academy 강의에는 내장 코드 에디터가 포함되어 있으므로, 브라우저에서 바로 실제 코드를 작성하고 실행한 후 즉시 AI 피드백을 받을 수 있습니다 — 로컬 설정이 필요 없습니다.

이 강의의 모든 강의

← Kotlin Academy(으)로 돌아가기