แปลง JSON เป็น struct ของ Swift ที่ใช้ Codable พร็อพเพอร์ตีประกาศด้วย let และเปลี่ยนชื่อเป็น camelCase ส่วน enum CodingKeys จะถูกสร้างเฉพาะใน struct ที่มีชื่อต่างจากคีย์ JSON
ใช้เมื่อแอป iOS หรือ macOS ต้องการโมเดลสำหรับ decode response ของ URLSession ด้วย JSONDecoder หรือเมื่ออยากได้ไทป์ที่ตรงกับ mock JSON ที่อยู่เบื้องหลัง SwiftUI preview
ชื่อไทป์ เป็นชื่อ struct ระดับบนสุด (เช่น EpisodePage)import Foundation ให้แล้วtry JSONDecoder().decode(EpisodePage.self, from: data){
"podcast": "Swift Talk",
"episodes": [
{ "id": 301, "title": "Async Sequences", "duration": 1840, "explicit": false },
{ "id": 302, "title": "Macros", "duration": 2215.5, "explicit": false, "guest_name": "Chris" }
],
"total_count": 2
}import Foundation
struct EpisodePage: Codable {
let podcast: String
let episodes: [Episode]
let totalCount: Int
enum CodingKeys: String, CodingKey {
case podcast
case episodes
case totalCount = "total_count"
}
}
struct Episode: Codable {
let id: Int
let title: String
let duration: Double
let explicit: Bool
let guestName: String?
enum CodingKeys: String, CodingKey {
case id
case title
case duration
case explicit
case guestName = "guest_name"
}
}
สมาชิกของอาร์เรย์ episodes กลายเป็น struct Episode duration มีทั้งจำนวนเต็ม (1840) และทศนิยม (2215.5) จึงเป็น Double ส่วน guest_name ที่พบแค่ในตอนที่สองเป็น guestName: String? struct ใดที่มีฟิลด์ถูกเปลี่ยนชื่อจะได้ enum CodingKeys ที่ระบุคีย์ทั้งหมดของ struct นั้น
Codable และพร็อพเพอร์ตีเป็น let ที่เปลี่ยนค่าไม่ได้enum CodingKeys: String, CodingKey พร้อมคีย์เดิมString, Int, Double, Bool และ [T] สำหรับอาร์เรย์null เป็น Optional (String?) คีย์ที่ไม่มีจึงยัง decode ได้JSONValue ที่สร้างขึ้นและ decode ได้default, class หรือ self ถูกครอบด้วย backticktypealias Root = [RootItem]จาก response ตัวอย่างเดียวก็ได้โมเดลที่ decode ได้ในบรรทัดถัดจาก let (data, _) = try await URLSession.shared.data(from: url)
เพิ่ม Identifiable ให้ struct ที่สร้างขึ้น (เมื่อมีฟิลด์ id) แล้วส่งเข้า List(page.episodes) { ... } ได้โดยตรง
ใส่ JSON ตัวอย่างจากช่วงออกแบบไว้ใน app bundle แล้ว decode ด้วยโมเดลเดียวกัน จะได้สร้างหน้าจอก่อนที่ API จริงจะพร้อม
String ถ้าต้องการ Date ให้เปลี่ยนไทป์ของพร็อพเพอร์ตีและตั้ง strategy อย่าง decoder.dateDecodingStrategy = .iso8601DecodingError.keyNotFound ให้เติม ? ที่ฟิลด์ที่ API อาจไม่ส่งมา แม้ในตัวอย่างจะมีเสมอก็ตามlet ถ้าเป็นโมเดลที่แก้ไขในฐานะ view state ให้เปลี่ยนเป็น varIdentifiable หรือ HashableJSONValue เป็นโค้ดช่วยสำหรับไทป์ที่ปนกัน ถ้าโปรเจกต์มีไทป์ที่ทำหน้าที่เดียวกันอยู่แล้ว ให้ลบออกแล้วใช้ของคุณkeyDecodingStrategy = .convertFromSnakeCase จะลบ CodingKeys ได้ไหม?ได้ decoder จะแปลง guest_name ↔ guestName ให้เอง แต่อย่าใช้ทั้งสองอย่างพร้อมกัน เพราะ decoder แปลงคีย์เป็น camelCase ก่อน แล้วจึงเทียบกับ raw value "guest_name" ใน CodingKeys ทำให้จับคู่ไม่ได้
การถือว่าโมเดล response เป็น value type เป็นธรรมเนียมปกติของ Swift และ struct ได้ memberwise initializer มาฟรี ทำให้สร้างข้อมูลทดสอบได้ง่าย ถ้าต้องการ reference semantics ให้เปลี่ยนเป็น final class แล้วเพิ่ม initializer
Doubleเมื่อคีย์หนึ่งมีทั้งจำนวนเต็มและทศนิยม Double จะเลี่ยงการสูญเสียความแม่นยำ ในทางกลับกัน ถ้าค่าตัวอย่างทั้งหมดเป็นแบบ 4.0 JSON parser ของเบราว์เซอร์จะอ่านเป็นจำนวนเต็ม และคุณอาจได้ Int จึงควรเช็กค่าจริงจาก API
CodingKeys ถูกใช้ตอน encode ด้วย JSONEncoder จึงเขียน guest_name กลับมาเหมือนเดิม พร็อพเพอร์ตี optional ที่เป็น nil จะถูกตัดออกจากผลลัพธ์