Tampal response API atau JSON konfigurasi dan dapatkan kod data class Kotlin yang mencerminkan strukturnya. Objek bersarang dan array objek masing-masing menjadi kelas tersendiri, dan anda boleh memilih sasaran kotlinx.serialization atau Jackson.
Ia dibina untuk saat anda menyambungkan API luar dalam aplikasi Android atau perkhidmatan Ktor/Spring dan mahukan rangka model daripada satu sampel response tanpa perlu menaipnya. Penukaran berjalan sepenuhnya dalam pelayar anda, jadi menampal response API dalaman tidak menghantarnya ke mana-mana.
Nama jenis kepada nama kelas peringkat atas (lalai Root), contohnya UserResponse.Penyiri, mengikut apa yang sudah digunakan dalam projek anda.{
"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
)
Objek di dalam array items menjadi kelas tunggal Item, dan gift_wrap, yang hanya muncul dalam item kedua, menjadi Boolean? = null. coupon hanya pernah bernilai null, jadi jenisnya tidak dapat disimpulkan dan ia dibiarkan sebagai JsonElement? untuk anda gantikan dengan jenis sebenar.
@Serializable pada setiap kelas, @SerialName pada field yang namanya berubah, serta import yang diperlukan.@JsonProperty hanya pada field yang namanya berubah.user_name atau home-url menjadi property camelCase (userName, homeUrl) yang dipetakan semula kepada kunci asal melalui anotasi.class atau val dibalut dengan backtick; kunci yang bermula dengan digit diberi awalan n.Int, nilai melebihi 32-bit menjadi Long, dan sebarang perpuluhan menjadikan field itu Double.? = null.typealias, cth. typealias Root = List<RootItem>.Tampal response yang disalin daripada Postman atau DevTools pelayar dan anda mendapat kelas yang sedia untuk Call<Order> atau client.get<Order>(). Untuk response yang mempunyai berpuluh-puluh field, ini mengelakkan salah taip dan jenis yang salah akibat menyalin secara manual.
Apabila backend menghantar created_at, bahagian Kotlin membaca createdAt manakala serial name mengekalkan kunci asal. Pemetaan kekal kelihatan bagi setiap kelas, bukannya bergantung pada strategi penamaan global.
Jika anda memindahkan model Gson atau Jackson ke kotlinx.serialization, jana kedua-dua output daripada JSON yang sama untuk melihat dengan tepat anotasi mana yang berubah.
? sendiri untuk field yang menurut dokumentasi API boleh ditinggalkan.2024-01-01T00:00:00Z kekal sebagai String; menukar kepada Instant memerlukan serializer anda sendiri.Any, jadi nilai yang jenisnya tidak dapat disimpulkan menjadi JsonElement di sana dan Any dengan Jackson.String? = null dan bukan sekadar String??kotlinx.serialization membaling MissingFieldException apabila sesuatu kunci tiada dan property itu tiada nilai lalai. Menambah = null pada field yang tiada dalam sesetengah item atau mengandungi null membolehkan response tanpa kunci itu di-decode dengan lancar.
@SerialName?Alat ini sentiasa menukar kepada camelCase dan hanya menambah anotasi apabila nama berbeza, jadi kunci yang sudah camelCase dikeluarkan tanpa anotasi. Untuk mengekalkan nama snake_case, namakan semula property dan buang anotasi selepas menjana.
Ya. data class yang dijana tiada no-arg constructor, jadi Jackson memerlukan jackson-module-kotlin didaftarkan untuk bind nilai melalui parameter constructor (Spring Boot mendaftarkannya secara automatik apabila dependency itu ada).
Pilihan penyiri ialah kotlinx.serialization dan Jackson. Untuk Gson, ambil output Jackson dan gantikan @JsonProperty dengan @SerializedName; untuk Moshi, gunakan @Json(name = ...). Struktur kelas kekal sama.