I-paste ang isang API response o config JSON at makakakuha ka ng Kotlin data class code na sumasalamin sa istruktura nito. Nagiging sariling class ang bawat nested object at array ng object, at puwede kang mag-target ng kotlinx.serialization o Jackson.
Ginawa ito para sa sandaling nagkakabit ka ng external API sa isang Android app o Ktor/Spring service at gusto mo ang skeleton ng model mula sa isang sample response sa halip na i-type ito. Tumatakbo nang buo sa browser mo ang conversion, kaya hindi naipapadala kahit saan ang internal na API response na i-paste mo.
Pangalan ng type sa pangalan ng top-level class (default Root), halimbawa UserResponse.Serializer, ayon sa gamit na ng project mo.{
"orderId": "A-1024",
"paid": true,
"total": 39.9,
"coupon": null,
"items": [
{ "sku": "TSHIRT-M", "qty": 2 },
{ "sku": "CAP", "qty": 1, "gift_wrap": true }
]
}import kotlinx.serialization.Serializable
import kotlinx.serialization.SerialName
import kotlinx.serialization.json.JsonElement
@Serializable
data class Order(
val orderId: String,
val paid: Boolean,
val total: Double,
val coupon: JsonElement? = null,
val items: List<Item>
)
@Serializable
data class Item(
val sku: String,
val qty: Int,
@SerialName("gift_wrap") val giftWrap: Boolean? = null
)
Nagiging singular na Item class ang mga object sa loob ng array na items, at ang gift_wrap, na nasa pangalawang item lang, ay nagiging Boolean? = null. Laging null lang ang coupon, kaya hindi ma-infer ang type nito at iniiwan itong JsonElement? para ikaw ang magpalit sa totoong type.
@Serializable sa bawat class, @SerialName sa mga field na nagbago ang pangalan, kasama ang mga kailangang import.@JsonProperty lang sa mga field na nagbago ang pangalan.userName, homeUrl) ang mga key gaya ng user_name o home-url, na naka-map pabalik sa orihinal na key gamit ang annotation.class o val; nilalagyan ng prefix na n ang mga key na nagsisimula sa digit.Int ang mga integer, Long ang mga value na lampas sa 32-bit, at ginagawang Double ng anumang decimal ang field.? = null ang mga field na nasa ilang item lang.typealias ang lumalabas, hal. typealias Root = List<RootItem>.I-paste ang response na kinopya mula sa Postman o browser DevTools at makakakuha ka ng mga class na handa para sa Call<Order> o client.get<Order>(). Sa mga response na may dose-dosenang field, naiiwasan ang typo at maling type na dulot ng mano-manong pagkopya.
Kapag created_at ang ipinapadala ng backend, createdAt ang binabasa sa panig ng Kotlin habang napapanatili ng serial name ang orihinal na key. Nakikita ang mapping bawat class sa halip na umasa sa isang global naming strategy.
Kung inililipat mo ang mga Gson o Jackson model sa kotlinx.serialization, gumawa ng parehong output mula sa parehong JSON para makita nang eksakto kung aling mga annotation ang nagbabago.
? sa mga field na sinasabi ng API docs na puwedeng wala.String ang mga date string gaya ng 2024-01-01T00:00:00Z; kailangan ng sarili mong serializer para lumipat sa Instant.Any, kaya nagiging JsonElement doon ang mga value na walang ma-infer na type at Any naman sa Jackson.String? = null ang isang field sa halip na String? lang?Nagta-throw ang kotlinx.serialization ng MissingFieldException kapag wala ang key at walang default ang property. Sa pagdagdag ng = null sa mga field na wala sa ilang item o may laman na null, malinis na nade-decode ang mga response na walang ganoong key.
@SerialName?Laging kino-convert ng tool sa camelCase at nagdadagdag lang ng annotation kapag iba ang pangalan, kaya lumalabas nang walang annotation ang mga key na camelCase na. Para panatilihin ang mga snake_case na pangalan, palitan ang pangalan ng mga property at tanggalin ang mga annotation pagkatapos mag-generate.
Oo. Walang no-arg constructor ang na-generate na data class, kaya kailangan ng Jackson na naka-register ang jackson-module-kotlin para mag-bind ng mga value gamit ang mga constructor parameter (awtomatiko itong nire-register ng Spring Boot kapag nandoon ang dependency).
kotlinx.serialization at Jackson ang mga serializer option. Para sa Gson, kunin ang Jackson output at palitan ng @SerializedName ang @JsonProperty; para sa Moshi, gamitin ang @Json(name = ...). Hindi nagbabago ang istruktura ng class.