@SerialName e mappatura personalizzata dei campi

Le API reali amano chiavi come user_name, mentre Kotlin preferisce userName. @SerialName permette alle due convenzioni di non coincidere senza problemi.

Inserisca @SerialName sopra una proprietà per indicare al serializer a quale chiave JSON deve essere realmente associata.

Il codice mantiene nomi puliti in camelCase, mentre il formato di trasmissione conserva quelli scelti dal backend. Entrambi i lati ne traggono vantaggio.

Molte API JSON usano snake_case, quindi mappare created_at su una proprietà createdAt è uno degli utilizzi più frequenti.

Se JSON contiene una chiave come type che non si adatta al Suo stile, @SerialName Le permette di assegnare alla proprietà il nome più chiaro e naturale.

Può annotare tutte le proprietà che desidera, combinando campi rinominati e campi con il nome predefinito nella stessa data class.

@SerialName funziona anche sulle costanti degli enum, quindi una voce ACTIVE può essere serializzata come la stringa in minuscolo prevista dall'API.

Se ogni chiave è in snake_case, può impostare una volta sola una JsonNamingStrategy invece di annotare manualmente ogni campo.

Quando si applicano sia una strategia globale sia un @SerialName esplicito, per quel campo ha la precedenza l'annotazione.

I nomi personalizzati si applicano sia alla codifica sia alla decodifica, quindi un unico model annotato gestisce la lettura e la scrittura di JSON.

Mappare esplicitamente le chiavi significa che una loro rinomina nel backend richiede di modificare una sola annotation, non l'intera base di codice.

Come si mappa una chiave JSON su una proprietà Kotlin con un nome diverso?

Usi @SerialName per mappare chiavi JSON non corrispondenti su nomi Kotlin idiomatici nei campi e negli enum, oppure imposti una strategia di denominazione globale per interi modelli.