แปลง JSON เป็น Codable struct ของ Swift!

ป้อน JSON เพื่อสร้างโค้ด Codable struct ของ Swift รวมถึงออบเจ็กต์ที่ซ้อนกัน! รองรับ Codable, CodingKeys, JSONDecoder, iOS
JSON
ผลลัพธ์
 

แปลง JSON เป็น Codable struct ของ Swift!

แปลง JSON เป็น struct ของ Swift ที่ใช้ Codable พร็อพเพอร์ตีประกาศด้วย let และเปลี่ยนชื่อเป็น camelCase ส่วน enum CodingKeys จะถูกสร้างเฉพาะใน struct ที่มีชื่อต่างจากคีย์ JSON

ใช้เมื่อแอป iOS หรือ macOS ต้องการโมเดลสำหรับ decode response ของ URLSession ด้วย JSONDecoder หรือเมื่ออยากได้ไทป์ที่ตรงกับ mock JSON ที่อยู่เบื้องหลัง SwiftUI preview

วิธีใช้

  1. วาง response body จาก API เช่นที่ดักไว้ด้วย Proxyman หรือ Charles
  2. ตั้ง ชื่อไทป์ เป็นชื่อ struct ระดับบนสุด (เช่น EpisodePage)
  3. วางผลลัพธ์ลงในไฟล์ Swift มี import Foundation ให้แล้ว
  4. decode ด้วย try JSONDecoder().decode(EpisodePage.self, from: data)

ตัวอย่าง

อินพุต (JSON)
{
  "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
}
เอาต์พุต (Swift · Codable)
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 นั้น

ฟีเจอร์ที่รองรับ

  • ทุก struct ใช้ Codable และพร็อพเพอร์ตีเป็น let ที่เปลี่ยนค่าไม่ได้
  • คีย์แบบ snake_case และ kebab-case กลายเป็นพร็อพเพอร์ตี camelCase และเฉพาะกรณีนั้นจึงเพิ่ม enum CodingKeys: String, CodingKey พร้อมคีย์เดิม
  • ไทป์: String, Int, Double, Bool และ [T] สำหรับอาร์เรย์
  • ฟิลด์ที่ขาดไปในบางรายการหรือมีค่า null เป็น Optional (String?) คีย์ที่ไม่มีจึงยัง decode ได้
  • ค่าที่ไทป์ปนกันใช้ enum JSONValue ที่สร้างขึ้นและ decode ได้
  • คำสงวนของ Swift อย่าง default, class หรือ self ถูกครอบด้วย backtick
  • อาร์เรย์ระดับบนสุดได้ typealias Root = [RootItem]

กรณีการใช้งาน

URLSession กับ async/await

จาก response ตัวอย่างเดียวก็ได้โมเดลที่ decode ได้ในบรรทัดถัดจาก let (data, _) = try await URLSession.shared.data(from: url)

หน้าจอรายการใน SwiftUI

เพิ่ม Identifiable ให้ struct ที่สร้างขึ้น (เมื่อมีฟิลด์ id) แล้วส่งเข้า List(page.episodes) { ... } ได้โดยตรง

mock data ที่แนบไปกับแอป

ใส่ JSON ตัวอย่างจากช่วงออกแบบไว้ใน app bundle แล้ว decode ด้วยโมเดลเดียวกัน จะได้สร้างหน้าจอก่อนที่ API จริงจะพร้อม

ข้อควรระวังและข้อจำกัด

  • สตริงวันที่ออกมาเป็น String ถ้าต้องการ Date ให้เปลี่ยนไทป์ของพร็อพเพอร์ตีและตั้ง strategy อย่าง decoder.dateDecodingStrategy = .iso8601
  • ถ้าคีย์ของพร็อพเพอร์ตีที่ไม่ใช่ optional หายไปจาก response การ decode จะโยน DecodingError.keyNotFound ให้เติม ? ที่ฟิลด์ที่ API อาจไม่ส่งมา แม้ในตัวอย่างจะมีเสมอก็ตาม
  • พร็อพเพอร์ตีทั้งหมดเป็น let ถ้าเป็นโมเดลที่แก้ไขในฐานะ view state ให้เปลี่ยนเป็น var
  • ไม่มีการใช้ protocol เพิ่มเติมอย่าง Identifiable หรือ Hashable
  • enum JSONValue เป็นโค้ดช่วยสำหรับไทป์ที่ปนกัน ถ้าโปรเจกต์มีไทป์ที่ทำหน้าที่เดียวกันอยู่แล้ว ให้ลบออกแล้วใช้ของคุณ

คำถามที่พบบ่อย

ถ้าใช้ keyDecodingStrategy = .convertFromSnakeCase จะลบ CodingKeys ได้ไหม?

ได้ decoder จะแปลง guest_name ↔ guestName ให้เอง แต่อย่าใช้ทั้งสองอย่างพร้อมกัน เพราะ decoder แปลงคีย์เป็น camelCase ก่อน แล้วจึงเทียบกับ raw value "guest_name" ใน CodingKeys ทำให้จับคู่ไม่ได้

ทำไมเป็น struct ไม่ใช่ class?

การถือว่าโมเดล response เป็น value type เป็นธรรมเนียมปกติของ Swift และ struct ได้ memberwise initializer มาฟรี ทำให้สร้างข้อมูลทดสอบได้ง่าย ถ้าต้องการ reference semantics ให้เปลี่ยนเป็น final class แล้วเพิ่ม initializer

ฟิลด์ที่คิดว่าจะเป็นจำนวนเต็มกลับออกมาเป็น Double

เมื่อคีย์หนึ่งมีทั้งจำนวนเต็มและทศนิยม Double จะเลี่ยงการสูญเสียความแม่นยำ ในทางกลับกัน ถ้าค่าตัวอย่างทั้งหมดเป็นแบบ 4.0 JSON parser ของเบราว์เซอร์จะอ่านเป็นจำนวนเต็ม และคุณอาจได้ Int จึงควรเช็กค่าจริงจาก API

encode กลับเป็น JSON แล้วยังได้คีย์เดิมไหม?

CodingKeys ถูกใช้ตอน encode ด้วย JSONEncoder จึงเขียน guest_name กลับมาเหมือนเดิม พร็อพเพอร์ตี optional ที่เป็น nil จะถูกตัดออกจากผลลัพธ์