Dán response API hoặc JSON cấu hình để nhận code data class Kotlin phản ánh đúng cấu trúc của nó. Object lồng nhau và mảng object đều thành class riêng, và bạn có thể nhắm tới kotlinx.serialization hoặc Jackson.
Công cụ dành cho lúc bạn kết nối API bên ngoài trong app Android hay service Ktor/Spring và muốn có khung model từ một response mẫu thay vì gõ tay. Việc chuyển đổi chạy hoàn toàn trong trình duyệt, nên dán response của API nội bộ vào cũng không gửi đi đâu cả.
Tên kiểu là tên class cấp cao nhất (mặc định Root), ví dụ UserResponse.Thư viện tuần tự hóa, khớp với thứ dự án đang dùng.{
"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
)
Object trong mảng items thành class số ít Item, và gift_wrap, chỉ xuất hiện ở phần tử thứ hai, thành Boolean? = null. coupon chỉ toàn null nên không suy được kiểu và được để là JsonElement? để bạn thay bằng kiểu thật.
@Serializable trên mọi class, @SerialName trên field bị đổi tên, cùng các import cần thiết.@JsonProperty chỉ trên field bị đổi tên.user_name hay home-url thành property camelCase (userName, homeUrl), được ánh xạ về key gốc bằng annotation.class hay val được bọc trong backtick; key bắt đầu bằng chữ số nhận tiền tố n.Int, giá trị vượt 32 bit thành Long, và chỉ cần có số thập phân là field thành Double.? = null.typealias, ví dụ typealias Root = List<RootItem>.Dán response sao chép từ Postman hay DevTools của trình duyệt là có class sẵn cho Call<Order> hoặc client.get<Order>(). Với response có hàng chục field, cách này tránh được lỗi gõ sai và sai kiểu khi chép tay.
Khi backend gửi created_at, phía Kotlin đọc createdAt trong khi serial name giữ key gốc. Phép ánh xạ hiện rõ trên từng class thay vì phụ thuộc vào chiến lược đặt tên toàn cục.
Nếu bạn đang chuyển model Gson hay Jackson sang kotlinx.serialization, hãy tạo cả hai output từ cùng một JSON để thấy chính xác annotation nào thay đổi.
? cho field mà tài liệu API nói có thể vắng mặt.2024-01-01T00:00:00Z vẫn là String; chuyển sang Instant cần serializer riêng của bạn.Any, nên giá trị không suy ra được kiểu thành JsonElement ở đó và Any với Jackson.String? = null chứ không chỉ là String??kotlinx.serialization ném MissingFieldException khi thiếu key mà property không có giá trị mặc định. Thêm = null cho field thiếu ở một số phần tử hoặc chứa null giúp response không có key đó vẫn decode trơn tru.
@SerialName được không?Công cụ luôn chuyển sang camelCase và chỉ thêm annotation khi tên khác, nên key vốn đã là camelCase sẽ ra không có annotation. Để giữ tên snake_case, hãy đổi tên property và bỏ annotation sau khi tạo.
Có. data class được tạo không có constructor không tham số, nên Jackson cần đăng ký jackson-module-kotlin để bind giá trị qua tham số constructor (Spring Boot tự đăng ký khi có dependency này).
Các lựa chọn thư viện tuần tự hóa là kotlinx.serialization và Jackson. Với Gson, lấy output Jackson rồi thay @JsonProperty bằng @SerializedName; với Moshi, dùng @Json(name = ...). Cấu trúc class giữ nguyên.