วาง response ของ API หรือ JSON คอนฟิก แล้วจะได้โค้ด data class ของ Kotlin ที่มีโครงสร้างตรงกัน ออบเจ็กต์ที่ซ้อนกันและอาร์เรย์ของออบเจ็กต์จะกลายเป็นคลาสของตัวเอง และเลือกได้ว่าจะใช้ kotlinx.serialization หรือ Jackson
สร้างมาสำหรับตอนที่ต้องเชื่อม API ภายนอกในแอป Android หรือเซอร์วิส Ktor/Spring และอยากได้โครงโมเดลจาก response ตัวอย่างเดียวแทนการพิมพ์เอง การแปลงทำงานในเบราว์เซอร์ทั้งหมด การวาง response ของ API ภายในจึงไม่ถูกส่งไปที่ไหน
ชื่อไทป์ เป็นชื่อคลาสระดับบนสุด (ค่าเริ่มต้น Root) เช่น UserResponseไลบรารี serialize ให้ตรงกับที่โปรเจกต์ใช้อยู่{
"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
)
ออบเจ็กต์ในอาร์เรย์ items กลายเป็นคลาส Item แบบเอกพจน์ และ gift_wrap ที่มีแค่ในรายการที่สองกลายเป็น Boolean? = null ส่วน coupon มีแต่ค่า null จึงอนุมานไทป์ไม่ได้ และถูกปล่อยเป็น JsonElement? ให้คุณเปลี่ยนเป็นไทป์จริงเอง
@Serializable ทุกคลาส ใส่ @SerialName ที่ฟิลด์ซึ่งชื่อเปลี่ยน พร้อม import ที่จำเป็น@JsonProperty เฉพาะฟิลด์ที่ชื่อเปลี่ยนuser_name หรือ home-url กลายเป็นพร็อพเพอร์ตีแบบ camelCase (userName, homeUrl) และจับคู่กลับไปยังคีย์เดิมด้วย annotationclass หรือ val ถูกครอบด้วย backtick และคีย์ที่ขึ้นต้นด้วยตัวเลขได้คำนำหน้า nInt ค่าที่เกิน 32 บิตเป็น Long และถ้ามีทศนิยมแม้แต่ค่าเดียว ฟิลด์จะเป็น Double? = nulltypealias เช่น typealias Root = List<RootItem>วาง response ที่คัดลอกจาก Postman หรือ DevTools ของเบราว์เซอร์ แล้วจะได้คลาสที่พร้อมใช้กับ Call<Order> หรือ client.get<Order>() สำหรับ response ที่มีฟิลด์หลายสิบตัว จะเลี่ยงการพิมพ์ผิดและไทป์ผิดจากการคัดลอกเอง
เมื่อ backend ส่ง created_at ฝั่ง Kotlin จะอ่านเป็น createdAt ขณะที่ serial name ยังเก็บคีย์เดิมไว้ การจับคู่จึงเห็นได้ในแต่ละคลาส แทนที่จะพึ่ง naming strategy แบบ global
ถ้ากำลังย้ายโมเดล Gson หรือ Jackson ไป kotlinx.serialization ให้สร้างผลลัพธ์ทั้งสองแบบจาก JSON เดียวกัน เพื่อดูว่า annotation ไหนต้องเปลี่ยนบ้าง
? เอง2024-01-01T00:00:00Z ยังเป็น String ถ้าจะเปลี่ยนเป็น Instant ต้องเขียน serializer เองAny ไม่ได้ ค่าที่อนุมานไทป์ไม่ได้จึงเป็น JsonElement ในกรณีนั้น และเป็น Any เมื่อใช้ JacksonString? = null ไม่ใช่แค่ String??kotlinx.serialization โยน MissingFieldException เมื่อไม่มีคีย์และพร็อพเพอร์ตีไม่มีค่าเริ่มต้น การเติม = null ให้ฟิลด์ที่ขาดไปในบางรายการหรือมีค่า null ทำให้ response ที่ไม่มีคีย์นั้น decode ได้โดยไม่มีปัญหา
@SerialName ได้ไหม?เครื่องมือแปลงเป็น camelCase เสมอและใส่ annotation เฉพาะเมื่อชื่อต่างกัน คีย์ที่เป็น camelCase อยู่แล้วจึงออกมาโดยไม่มี annotation ถ้าอยากเก็บชื่อแบบ snake_case ให้เปลี่ยนชื่อพร็อพเพอร์ตีและลบ annotation หลังสร้างโค้ด
ต้องใช้ data class ที่สร้างขึ้นไม่มี constructor แบบไม่มีอาร์กิวเมนต์ Jackson จึงต้องลงทะเบียน jackson-module-kotlin เพื่อ bind ค่าผ่านพารามิเตอร์ของ constructor (Spring Boot ลงทะเบียนให้อัตโนมัติเมื่อมี dependency นี้)
ตัวเลือก serializer มี kotlinx.serialization กับ Jackson สำหรับ Gson ให้นำผลลัพธ์ของ Jackson มาเปลี่ยน @JsonProperty เป็น @SerializedName ส่วน Moshi ใช้ @Json(name = ...) โครงสร้างคลาสยังเหมือนเดิม