PricingLoginStart free
Kotlin Academy · Aula

Negociação de conteúdo e kotlinx.serialization

Configure a serialização JSON e desserialize automaticamente os corpos das requisições.

Aula 3 de 413 etapas

Negociação de conteúdo e kotlinx.serialization é uma aula grátis de Kotlin Academy no CoddyKit. Esta é a aula 3 de 4. Você pode ler a aula completa abaixo gratuitamente — depois pratica ao vivo no navegador com um editor de código integrado e um tutor de IA 24/7. Faz parte do caminho de aprendizado de Kotlin Academy, e seu progresso é sincronizado entre a web e o app CoddyKit. O curso de Kotlin Academy inclui 4 aulas no total.

O que é negociação de conteúdo?

A negociação de conteúdo é o mecanismo HTTP pelo qual um cliente e um servidor concordam sobre o formato do corpo da resposta. O cliente envia um cabeçalho Accept; o servidor escolhe o formato correspondente mais adequado. O plug-in ContentNegotiation do Ktor automatiza esse processo.

Adicionando dependências

Adicione o plug-in ContentNegotiation e o conversor JSON de 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")
}

Instalando ContentNegotiation

Instale o plug-in em um módulo da aplicação e registre o conversor JSON:

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

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

Classes de dados @Serializable

Anote suas classes de dados com @Serializable de kotlinx.serialization. O plug-in do compilador Kotlin gera o serializador durante a compilação — não é necessária reflexão durante a execução:

import kotlinx.serialization.Serializable

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

Respondendo com um objeto serializável

Depois que ContentNegotiation estiver instalado, passe qualquer objeto @Serializable para call.respond(). O Ktor o serializa automaticamente para JSON:

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

Recebendo um objeto serializável

Use call.receive() para desserializar o corpo da requisição em uma classe @Serializable. Se o corpo estiver malformado, o Ktor lançará uma ContentTransformationException:

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

Personalizando a configuração JSON

Passe uma instância de Json para json() a fim de personalizar a serialização: ignore chaves desconhecidas, use impressão formatada, ative o modo tolerante etc.:

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

Vários tipos de conteúdo

Registre vários conversores para oferecer suporte a diferentes tipos de Accept. O Ktor escolhe o primeiro que corresponde ao cabeçalho Accept do cliente:

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

Serializando listas e mapas

Coloque coleções em um objeto de resposta ou use call.respond(list) diretamente. kotlinx.serialization lida com List, Map e genéricos aninhados, desde que os tipos dos elementos sejam @Serializable:

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

Serializadores personalizados

Para tipos que não pertencem ao seu código (por exemplo, java.time.Instant), implemente um KSerializer e registre-o por meio de @Serializable(with = MySerializer::class) ou de um módulo de serializador contextual:

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

Tratamento de erros de desserialização

Instale o plugin StatusPages para retornar uma resposta de erro clara quando call.receive() falhar:

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

Verificação rápida

Qual anotação é necessária em uma classe de dados Kotlin para torná-la serializável pelo kotlinx.serialization?

Responda na aula interativa

Recapitulação: negociação de conteúdo e kotlinx.serialization

Principais pontos:

  • Instale ContentNegotiation + json() para serialização e desserialização automáticas de JSON
  • Anote as classes de dados com @Serializable
  • Use call.respond(obj) para serializar e call.receive() para desserializar
  • Personalize usando uma instância de Json { ... } passada para json()
  • Use StatusPages para tratar erros de desserialização de forma adequada
Grátis para começar

Aprenda Kotlin com um tutor de IA — grátis

Escreva e execute código real no seu navegador, obtenha ajuda instantânea de um tutor de IA 24/7 e continue de onde parou na web ou no app.

Cursos
51
Aulas
203
Começar a aprender grátisVer o curso completo

Perguntas Frequentes

A aula “Negociação de conteúdo e kotlinx.serialization” é grátis?

Sim — o texto completo de “Negociação de conteúdo e kotlinx.serialization” é grátis para ler aqui na web. Para praticá-la interativamente (um editor de código integrado e um tutor de IA 24/7) e desbloquear o restante do curso de Kotlin Academy, atualize para CoddyKit PRO. O curso de Kotlin Academy inclui 4 aulas no total.

O que vou aprender em “Negociação de conteúdo e kotlinx.serialization”?

Configure a serialização JSON e desserialize automaticamente os corpos das requisições. Você pratica Kotlin Academy com código prático que executa diretamente no navegador, e um tutor de IA 24/7 responde suas dúvidas enquanto trabalha na aula.

Preciso ter experiência prévia para começar Kotlin Academy?

Nenhuma experiência prévia é necessária. Kotlin Academy no CoddyKit é estruturado para alunos iniciantes até avançados, então você pode começar aqui ou desde o início e aprender no seu ritmo. Esta é a aula 3 de 4.

Quanto tempo leva a aula “Negociação de conteúdo e kotlinx.serialization”?

A maioria das aulas CoddyKit leva cerca de 5–10 minutos. Cada uma é compacta e interativa, então você faz progresso constante e retoma exatamente de onde parou entre web e app.

Posso escrever e executar código nesta aula de Kotlin Academy?

Sim. Cada aula de Kotlin Academy inclui um editor de código integrado, então você escreve e executa código real direto no navegador e recebe feedback de IA instantaneamente — nenhuma configuração local necessária.

Todas as aulas deste curso

  1. Configuração de projeto Ktor: embeddedServer e módulos de aplicação
  2. Roteamento e parâmetros tipados
  3. Negociação de conteúdo e kotlinx.serialization
  4. Plugins de autenticação: JWT e sessão
← Voltar para Kotlin Academy