Kotlin Academy · leksjon

Innholdsforhandling og kotlinx.serialization

Konfigurer JSON-serialisering, og deserialiser request-bodyer automatisk.

Leksjon 3 av 413 trinn

Innholdsforhandling og kotlinx.serialization er en gratis leksjon i Kotlin Academy på CoddyKit. Dette er leksjon 3 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.

Hva er innholdsforhandling?

Innholdsforhandling er HTTP-mekanismen som gjør at en klient og en server kan bli enige om formatet på svarinnholdet. Klienten sender en Accept-header, og serveren velger formatet som passer best. Ktors plugin ContentNegotiation automatiserer dette.

Legge til avhengigheter

Legg til pluginen ContentNegotiation og JSON-konverteren fra kotlinx.serialization:

dependencies {
    implementation("io.ktor:ktor-server-content-negotiation:2.3.12")
    implementation("io.ktor:ktor-serialization-kotlinx-json:2.3.12")
    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.7.1")
}

Installere ContentNegotiation

Installer pluginen i en Application-modul, og registrer JSON-konverteren:

import io.ktor.server.plugins.contentnegotiation.*
import io.ktor.serialization.kotlinx.json.*

fun Application.configureSerialization() {
    install(ContentNegotiation) {
        json()
    }
}

@Serializable-dataklasser

Annoter dataklassene med @Serializable fra kotlinx.serialization. Kotlin-kompilatorpluginen genererer serializeren ved kompilering, slik at refleksjon ikke er nødvendig under kjøring:

import kotlinx.serialization.Serializable

@Serializable
data class User(val id: Long, val name: String, val email: String)

Svare med et serialiserbart objekt

Når ContentNegotiation er installert, kan et hvilket som helst @Serializable-objekt sendes til call.respond(). Ktor serialiserer det automatisk til JSON:

get("/users/{id}") {
    val user = User(1L, "Alice", "alice@example.com")
    call.respond(user)  // serialized to JSON
}

Motta et serialiserbart objekt

Bruk call.receive() for å deserialisere forespørselsinnholdet til en @Serializable-klasse. Hvis innholdet er ugyldig, kaster Ktor en ContentTransformationException:

post("/users") {
    val newUser = call.receive<User>()
    call.respond(HttpStatusCode.Created, newUser)
}

Tilpasse JSON-konfigurasjonen

Send en Json-instans til json() for å tilpasse serialiseringen: ignorer ukjente nøkler, bruk pen utskrift, aktiver lenient-modus og så videre:

install(ContentNegotiation) {
    json(Json {
        prettyPrint = true
        isLenient = true
        ignoreUnknownKeys = true
    })
}

Flere innholdstyper

Registrer flere konvertere for å støtte ulike Accept-typer. Ktor velger den første som samsvarer med klientens Accept-header:

install(ContentNegotiation) {
    json()
    // xml() with ktor-serialization-kotlinx-xml if needed
}

Serialisere lister og map

Legg samlinger i et svarobjekt, eller bruk call.respond(list) direkte. kotlinx.serialization håndterer List, Map og nestede generiske typer så lenge elementtypene er @Serializable:

get("/users") {
    val users = listOf(
        User(1, "Alice", "a@example.com"),
        User(2, "Bob", "b@example.com")
    )
    call.respond(users)
}

Egendefinerte serializere

For typer man ikke eier (for eksempel java.time.Instant) implementerer man en KSerializer og registrerer den via @Serializable(with = MySerializer::class) eller en kontekstuell serializermodul:

val module = SerializersModule {
    contextual(Instant::class, InstantSerializer)
}
install(ContentNegotiation) {
    json(Json { serializersModule = module })
}

Feilhåndtering ved deserialiseringsfeil

Installer StatusPages-pluginen for å returnere et ryddig feilsvar når call.receive() mislykkes:

install(StatusPages) {
    exception<ContentTransformationException> { call, _ ->
        call.respond(HttpStatusCode.BadRequest, "Invalid request body")
    }
}

Hurtigsjekk

Hvilken annotasjon må en Kotlin-dataklasse ha for at den skal kunne serialiseres av kotlinx.serialization?

Oppsummering: Content Negotiation og kotlinx.serialization

Viktigste punkter:

  • Installer ContentNegotiation + json() for automatisk JSON-serialisering og -deserialisering
  • Annoter dataklasser med @Serializable
  • Bruk call.respond(obj) for å serialisere og call.receive() for å deserialisere
  • Tilpass med en Json { ... }-instans som sendes til json()
  • Bruk StatusPages til å håndtere deserialiseringsfeil på en kontrollert måte
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

Ofte stilte spørsmål

Er leksjonen «Innholdsforhandling og kotlinx.serialization» gratis?

Ja – du kan lese valgfritt 3 av leksjonene i læringsstien Kotlin Academy, inkludert «Innholdsforhandling og kotlinx.serialization», 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 «Innholdsforhandling og kotlinx.serialization»?

Konfigurer JSON-serialisering, og deserialiser request-bodyer automatisk. 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 3 av 4.

Hvor lang tid tar leksjonen «Innholdsforhandling og kotlinx.serialization»?

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

  1. Ktor-prosjektoppsett: embeddedServer og Application-moduler
  2. Ruting og typede parametere
  3. Innholdsforhandling og kotlinx.serialization
  4. Autentiseringsplugins: JWT og session
← Tilbake til Kotlin Academy