Kotlin Academy · leksjon

Integrere KSP-prosessorer i et Gradle-bygg

Konfigurer KSP i Gradle, legg til genererte kilder og feilsøk prosessorens utdata.

Leksjon 4 av 413 trinn

Integrere KSP-prosessorer i et Gradle-bygg er en gratis leksjon i Kotlin Academy på CoddyKit. Dette er leksjon 4 av 4. Du kan lese valgfritt 3 leksjoner fra denne læringsstien gratis i sin helhet – deretter låser CoddyKit PRO opp alle leksjoner, samt praktisk øving med en innebygd kodeeditor og en AI-veileder som er tilgjengelig døgnet rundt. Den er en del av læringsløpet i Kotlin Academy, og fremdriften din synkroniseres mellom nettet og CoddyKit-appen. Kurset i Kotlin Academy inneholder totalt 4 leksjoner.

Modulstruktur med flere moduler

Et typisk KSP-oppsett har minst to moduler: :annotation (inneholder annotasjonsklassene) og :processor (inneholder SymbolProcessor). Modulen som bruker prosessoren, aktiverer KSP-pluginen og deklarerer ksp- og implementation-avhengigheter.

Aktivere KSP-pluginen

I build.gradle.kts for modulen som bruker prosessoren:

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

Deklarere ksp-avhengigheten

Bruk konfigurasjonen ksp (ikke implementation) for å legge til en KSP-prosessor. Prosessoren kjører bare ved bygging og inkluderes ikke i det endelige artefaktet:

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

Kataloger for generert kildekode

KSP skriver genererte filer under build/generated/ksp/<sourceSet>/kotlin/. KSP-pluginen legger automatisk disse katalogene til i Kotlin-kildesettet, slik at genererte klasser blir synlige i koden uten manuell konfigurasjon.

Sende alternativer til prosessoren

Send alternativer ved byggetid fra Gradle til prosessoren via ksp { arg("key", "value") }. Les dem i prosessoren via environment.options["key"]:

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

Lese alternativer i prosessoren

I metoden SymbolProcessorProvider.create() får man tilgang til alternativer 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 bygg

KSP holder oversikt over avhengigheter mellom inndata og utdata. Knytt hver genererte fil til kildesymbolene når codeGenerator.createNewFile() kalles. KSP hopper da over ny behandling når ingen av de sporede inndataene er endret.

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

KSP med Android

I Android-prosjekter erstatter man kapt med ksp i både plugin- og avhengighetsdeklarasjonene. Bruk variantbevisste konfigurasjoner som kspDebug eller kspRelease hvis prosessorens virkemåte skal variere mellom byggetyper.

KSP med Kotlin Multiplatform

I et KMP-prosjekt aktiverer man KSP-pluginen og bruker add(kotlinCompilation.defaultSourceSetName + "ksp", project(":processor")) eller kortformene kspCommonMainMetadata, kspJvmMain og så videre, avhengig av hvilke mål prosessoren støtter.

Vise genererte filer

Etter at ./gradlew build er kjørt (eller kspKotlin / kspDebugKotlin for Android), kan man inspisere build/generated/ksp/. IntelliJ og Android Studio markerer disse mappene som genererte kilder og tillater navigering fra bruk av symboler til genererte deklarasjoner.

Feilsøking av en prosessor

Kjør Gradle-oppgaven med --debug, eller legg til jvmArgs("-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005") i ksp-konfigurasjonen for å koble en ekstern feilsøker til JVM-en for annotasjonsbehandling.

Kort kontroll

Hvilken Gradle-konfigurasjon brukes til å legge til en KSP-prosessor som kjører ved bygging, men ikke inkluderes i kjøretids-classpathen?

Besvar den i den interaktive leksjonen

Oppsummering: Integrere KSP i et Gradle-bygg

Viktigste punkter:

Aktiver pluginen com.google.devtools.ksp, og legg til prosessoren med ksp()-avhengigheten
Genererte kilder havner i build/generated/ksp/ og legges automatisk til i kildesettet
Send alternativer fra Gradle via ksp { arg() }, og les dem via environment.options
Bruk Dependencies med createNewFile() for nøyaktige inkrementelle bygg
Fungerer med Android (variantkonfigurasjoner) og Kotlin Multiplatform

Gratis å komme i gang

Lær deg Kotlin med en AI-veileder – gratis

Skriv og kjør ekte kode i nettleseren, få umiddelbar hjelp fra en AI-veileder som er tilgjengelig døgnet rundt, og fortsett der du slapp – på nettet eller i appen.

Kurs: 51
Leksjoner: 203

Start læringen gratis Se hele kurset

Ofte stilte spørsmål

Er leksjonen «Integrere KSP-prosessorer i et Gradle-bygg» gratis?

Ja – du kan lese valgfritt 3 av leksjonene i læringsstien Kotlin Academy, inkludert «Integrere KSP-prosessorer i et Gradle-bygg», gratis i sin helhet her på nettet. Deretter låser CoddyKit PRO opp alle leksjoner, samt interaktiv øving med en innebygd kodeeditor og en AI-veileder som er tilgjengelig døgnet rundt. Kurset i Kotlin Academy inneholder totalt 4 leksjoner.

Hva lærer jeg i «Integrere KSP-prosessorer i et Gradle-bygg»?

Konfigurer KSP i Gradle, legg til genererte kilder og feilsøk prosessorens utdata. Du øver på Kotlin Academy med praktisk kode som du kjører direkte i nettleseren, mens en AI-veileder som er tilgjengelig døgnet rundt, svarer på spørsmålene dine mens du jobber deg gjennom leksjonen.

Trenger jeg erfaring for å begynne med Kotlin Academy?

Ingen tidligere erfaring er nødvendig. Kotlin Academy på CoddyKit er lagt opp for både nybegynnere og viderekomne, så De kan begynne her eller helt fra start og lære i Deres eget tempo. Dette er leksjon 4 av 4.

Hvor lang tid tar leksjonen «Integrere KSP-prosessorer i et Gradle-bygg»?

De fleste CoddyKit-leksjoner tar omtrent 5–10 minutter. Hver leksjon er kort og interaktiv, slik at De gjør jevne fremskritt og kan fortsette akkurat der De slapp – både på nettet og i appen.

Kan jeg skrive og kjøre kode i denne Kotlin Academy-leksjonen?

Ja. Alle Kotlin Academy-leksjoner har en innebygd kodeeditor, slik at De kan skrive og kjøre ekte kode direkte i nettleseren og få umiddelbar tilbakemelding fra AI – uten lokal konfigurering.

Alle leksjonene i dette kurset

KSP kontra KAPT: Hvorfor KSP er raskere
Skrive den første SymbolProcessor
Generere Kotlin-kildefiler med KotlinPoet
Integrere KSP-prosessorer i et Gradle-bygg

← Tilbake til Kotlin Academy