I-convert ang JSON sa Kotlin data class!

Maglagay ng JSON para gumawa ng Kotlin data class code, kasama ang mga nested object! Sinusuportahan ang kotlinx.serialization @Serializable, @SerialName, Jackson.
JSON
Resulta
 

I-convert ang JSON sa Kotlin data class!

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.

Paano gamitin

  1. I-paste ang JSON sa input box. Mas maganda ang type inference sa isang buo at totoong response kaysa sa pinaikli.
  2. I-set ang Pangalan ng type sa pangalan ng top-level class (default Root), halimbawa UserResponse.
  3. Piliin ang kotlinx.serialization o Jackson sa ilalim ng Serializer, ayon sa gamit na ng project mo.
  4. Kopyahin ang na-generate na code papunta sa model file mo. Nananatili sa URL ang type name at serializer, kaya binubuksan ulit ng bookmark ang parehong setup.

Halimbawa

Input (JSON)
{
  "orderId": "A-1024",
  "paid": true,
  "total": 39.9,
  "coupon": null,
  "items": [
    { "sku": "TSHIRT-M", "qty": 2 },
    { "sku": "CAP", "qty": 1, "gift_wrap": true }
  ]
}
Output (Kotlin · kotlinx.serialization)
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.

Mga sinusuportahang feature

  • kotlinx.serialization: @Serializable sa bawat class, @SerialName sa mga field na nagbago ang pangalan, kasama ang mga kailangang import.
  • Jackson: @JsonProperty lang sa mga field na nagbago ang pangalan.
  • Nagiging camelCase na property (userName, homeUrl) ang mga key gaya ng user_name o home-url, na naka-map pabalik sa orihinal na key gamit ang annotation.
  • Binabalot ng backtick ang mga Kotlin keyword gaya ng class o val; nilalagyan ng prefix na n ang mga key na nagsisimula sa digit.
  • Mga numero: nagiging Int ang mga integer, Long ang mga value na lampas sa 32-bit, at ginagawang Double ng anumang decimal ang field.
  • Pinagsasama sa iisang class mula sa lahat ng item ang mga array ng object; nagiging ? = null ang mga field na nasa ilang item lang.
  • Kapag array o primitive ang top level, typealias ang lumalabas, hal. typealias Root = List<RootItem>.

Mga gamit

Mga response model para sa Retrofit o Ktor client

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.

Pag-map ng snake_case na API sa Kotlin naming

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.

Paglipat sa kotlinx.serialization

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.

Mga paalala at limitasyon

  • Mula lang sa sample na i-paste mo ini-infer ang mga type. Lumalabas na non-null ang field na nasa bawat sample item, kaya ikaw na ang magdagdag ng ? sa mga field na sinasabi ng API docs na puwedeng wala.
  • Nananatiling String ang mga date string gaya ng 2024-01-01T00:00:00Z; kailangan ng sarili mong serializer para lumipat sa Instant.
  • Hindi kayang i-serialize ng kotlinx.serialization ang Any, kaya nagiging JsonElement doon ang mga value na walang ma-infer na type at Any naman sa Jackson.
  • Walang ginagawang enum, sealed class o default value (gaya ng empty list). Sulit gawing enum pagkatapos ang mga field na may fixed na set ng value.
  • Nasa iisang block ang lahat ng class; ikaw na ang bahala sa package declaration at sa paghahati sa mga file.

Mga madalas itanong

Bakit 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.

Puwede ko bang panatilihin ang mga JSON key bilang property name nang walang @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.

Kailangan ko ba ng jackson-module-kotlin kapag Jackson ang pinili?

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).

Kaya ba nitong gumawa ng Moshi o Gson model?

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.