Kotlin Academy · Lektion

Integration af KSP-processorer i et Gradle-build

Konfigurér KSP i Gradle, tilføj genererede kilder, og fejlfind processor-output.

Lektion 4 af 413 trin

Integration af KSP-processorer i et Gradle-build er en gratis Kotlin Academy-lektion på CoddyKit. Dette er lektion 4 af 4. Du kan læse alle 3 lektioner i dette læringsspor gratis i deres fulde længde — derefter låser CoddyKit PRO alle lektioner op samt praktiske øvelser med en indbygget kodeeditor og en AI-underviser døgnet rundt. Den er en del af læringsforløbet i Kotlin Academy, og dine fremskridt synkroniseres på tværs af nettet og CoddyKit-appen. Kotlin Academy-kurset indeholder 4 lektioner i alt.

Struktur med flere moduler

En typisk KSP-opsætning har mindst to moduler: :annotation (indeholder dine annotation-klasser) og :processor (indeholder SymbolProcessor). Forbrugermodulet anvender KSP-pluginet og erklærer ksp- og implementation-afhængigheder.

Anvendelse af KSP-pluginet

I forbrugermodulets build.gradle.kts:

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

Angivelse af ksp-afhængigheden

Brug ksp-konfigurationen (ikke implementation) til at tilføje en KSP-processor. Processoren kører kun under build og inkluderes ikke i det endelige artefakt:

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

Mapper til genereret kildekode

KSP skriver genererede filer under build/generated/ksp/<sourceSet>/kotlin/. KSP-pluginet føjer automatisk disse mapper til Kotlin's source set, så genererede klasser er synlige for din kode uden manuel konfiguration.

Videregivelse af indstillinger til processoren

Videregiv buildtidsindstillinger fra Gradle til din processor via ksp { arg("key", "value") }. Læs dem i processoren via environment.options["key"]:

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

Læsning af indstillinger i processoren

I metoden SymbolProcessorProvider.create() kan du få adgang til indstillinger fra miljøet:

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

Inkrementelle builds

KSP holder styr på input-output-afhængigheder. Knyt hver genereret fil til dens kildesymboler, når du kalder codeGenerator.createNewFile(). KSP springer derefter genbehandling over, når ingen af de registrerede input er ændret.

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

KSP med Android

I Android-projekter skal du erstatte kapt med ksp i både plugin- og afhængighedserklæringerne. Brug variantbevidste konfigurationer som kspDebug eller kspRelease, hvis processorens adfærd skal variere mellem buildtyper.

KSP med Kotlin Multiplatform

I et KMP-projekt skal du anvende KSP-pluginet og bruge add(kotlinCompilation.defaultSourceSetName + "ksp", project(":processor")) eller kortformerne kspCommonMainMetadata, kspJvmMain osv., afhængigt af hvilke targets din processor understøtter.

Visning af genererede filer

Efter kørsel af ./gradlew build (eller kspKotlin / kspDebugKotlin til Android) kan du inspicere build/generated/ksp/. IntelliJ og Android Studio markerer disse mapper som genererede kilder og gør det muligt at navigere fra anvendelser til genererede deklarationer.

Fejlfinding af en processor

Kør Gradle-opgaven med --debug, eller tilføj jvmArgs("-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005") til ksp-konfigurationen for at tilslutte en ekstern debugger til JVM'en til annotation-behandling.

Hurtigt tjek

Hvilken Gradle-konfiguration bruges til at tilføje en KSP-processor, der kører under build, men ikke inkluderes i runtime-classpathen?

Besvar den i den interaktive lektion

Opsummering: Integration af KSP i et Gradle-build

Vigtigste pointer:

Anvend com.google.devtools.ksp-pluginet, og tilføj processoren med en ksp()-afhængighed
Genererede kilder placeres i build/generated/ksp/ og føjes automatisk til source settet
Videregiv indstillinger fra Gradle via ksp { arg() }, og læs dem via environment.options
Brug Dependencies sammen med createNewFile() for nøjagtige inkrementelle builds
Fungerer med Android (variantkonfigurationer) og Kotlin Multiplatform

Gratis at komme i gang

Lær Kotlin med en AI-underviser — gratis

Skriv og kør rigtig kode i din browser, få øjeblikkelig hjælp fra en AI-underviser døgnet rundt, og fortsæt, hvor du slap, på web eller i appen.

Kurser: 51
Lektioner: 203

Start gratis Se hele kurset

Ofte stillede spørgsmål

Er lektionen “Integration af KSP-processorer i et Gradle-build” gratis?

Ja — alle 3 lektioner i læringssporet Kotlin Academy, inklusive “Integration af KSP-processorer i et Gradle-build”, kan læses gratis i deres fulde længde her på webstedet. Derefter låser CoddyKit PRO alle lektioner op samt interaktive øvelser med en indbygget kodeeditor og en AI-underviser døgnet rundt. Kotlin Academy-kurset indeholder 4 lektioner i alt.

Hvad lærer jeg i “Integration af KSP-processorer i et Gradle-build”?

Konfigurér KSP i Gradle, tilføj genererede kilder, og fejlfind processor-output. Du øver dig i Kotlin Academy med praktisk kode, som du kører direkte i browseren, og en AI-vejleder døgnet rundt besvarer dine spørgsmål, mens du arbejder dig gennem lektionen.

Skal jeg have erfaring for at begynde på Kotlin Academy?

Der kræves ingen tidligere erfaring. Kotlin Academy på CoddyKit er tilrettelagt for både begyndere og øvede, så du kan starte her eller fra begyndelsen og lære i dit eget tempo. Dette er lektion 4 af 4.

Hvor lang tid tager lektionen “Integration af KSP-processorer i et Gradle-build”?

De fleste CoddyKit-lektioner tager cirka 5–10 minutter. Hver lektion er kort og interaktiv, så du gør løbende fremskridt og kan fortsætte, hvor du slap – på både web og app.

Kan jeg skrive og køre kode i denne Kotlin Academy-lektion?

Ja. Alle Kotlin Academy-lektioner har en indbygget kodeeditor, så du kan skrive og køre rigtig kode direkte i din browser og få øjeblikkelig feedback fra AI – uden lokal opsætning.

Alle lektioner i dette kursus

KSP vs KAPT: Hvorfor KSP er hurtigere
Skriv Deres første SymbolProcessor
Generering af Kotlin-kildefiler med KotlinPoet
Integration af KSP-processorer i et Gradle-build

← Tilbage til Kotlin Academy