Chuyển JSON thành Codable struct Swift!

Nhập JSON để tạo mã Codable struct Swift, kể cả các object lồng nhau! Hỗ trợ Codable, CodingKeys, JSONDecoder, iOS.
JSON
Kết quả
 

Chuyển JSON thành Codable struct Swift!

Chuyển JSON thành các struct Swift tuân theo Codable. Property được khai báo bằng let và đổi tên sang camelCase, và enum CodingKeys chỉ được tạo cho những struct có tên khác với key JSON.

Dùng nó khi app iOS hay macOS cần model để decode response của URLSession bằng JSONDecoder, hoặc khi bạn muốn có kiểu khớp với JSON giả đứng sau một SwiftUI preview.

Cách sử dụng

  1. Dán body response từ API của bạn, ví dụ bắt được bằng Proxyman hoặc Charles.
  2. Đặt Tên kiểu là tên struct cấp cao nhất (ví dụ EpisodePage).
  3. Dán kết quả vào một file Swift; import Foundation đã có sẵn.
  4. Decode bằng try JSONDecoder().decode(EpisodePage.self, from: data).

Ví dụ

Đầu vào (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
}
Đầu ra (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"
    }
}

Phần tử của mảng episodes thành struct Episode. duration trộn số nguyên (1840) và số thập phân (2215.5) nên là Double; guest_name, chỉ có ở tập thứ hai, là guestName: String?. Struct nào có field bị đổi tên đều nhận enum CodingKeys liệt kê toàn bộ key của nó.

Tính năng hỗ trợ

  • Mọi struct tuân theo Codable; property là let bất biến.
  • Key snake_case và kebab-case thành property camelCase, và chỉ khi đó enum CodingKeys: String, CodingKey mới được thêm vào cùng các key gốc.
  • Kiểu: String, Int, Double, Bool, và [T] cho mảng.
  • Field thiếu ở một số phần tử hoặc chứa null là Optional (String?), nên key bị thiếu vẫn decode được.
  • Giá trị có kiểu lẫn lộn dùng một enum JSONValue được tạo kèm, có thể decode.
  • Từ khóa Swift như default, class hay self được bọc trong backtick.
  • Mảng ở cấp cao nhất cho ra typealias Root = [RootItem].

Trường hợp sử dụng

URLSession với async/await

Chỉ từ một response mẫu, bạn có model để decode ngay ở dòng sau let (data, _) = try await URLSession.shared.data(from: url).

Màn hình danh sách SwiftUI

Thêm Identifiable vào struct được tạo (khi nó có field id) và truyền thẳng vào List(page.episodes) { ... }.

Dữ liệu giả đóng gói kèm app

Đưa JSON mẫu từ giai đoạn thiết kế vào app bundle và decode bằng cùng model đó, để dựng màn hình trước khi API thật sẵn sàng.

Lưu ý và giới hạn

  • Chuỗi ngày tháng ra dạng String. Để có Date, đổi kiểu property và đặt chiến lược như decoder.dateDecodingStrategy = .iso8601.
  • Nếu key của property không optional bị thiếu trong response, việc decode ném DecodingError.keyNotFound. Hãy thêm ? cho field mà API có thể bỏ qua, kể cả khi mẫu của bạn luôn có chúng.
  • Mọi property là let; đổi sang var cho model bạn thay đổi như view state.
  • Không tuân theo protocol bổ sung nào như Identifiable hay Hashable.
  • Enum JSONValue là code hỗ trợ cho kiểu lẫn lộn; nếu dự án đã có kiểu tương đương, hãy xóa nó và dùng cái của bạn.

Câu hỏi thường gặp

Khi dùng keyDecodingStrategy = .convertFromSnakeCase, có xóa CodingKeys được không?

Được, khi đó decoder tự chuyển guest_name ↔ guestName. Nhưng đừng kết hợp cả hai: decoder chuyển key sang camelCase trước rồi mới so với raw value "guest_name" trong CodingKeys, nên việc so khớp thất bại.

Vì sao là struct mà không phải class?

Coi model response là value type là quy ước thông thường của Swift, và struct có sẵn memberwise initializer, giúp dựng dữ liệu test dễ dàng. Nếu cần ngữ nghĩa tham chiếu, hãy đổi thành final class và thêm initializer.

Một field tôi tưởng là số nguyên lại ra Double.

Khi một key chứa cả số nguyên lẫn số thập phân, Double tránh mất độ chính xác. Ngược lại, nếu mọi giá trị mẫu đều như 4.0, JSON parser của trình duyệt đọc nó thành số nguyên và bạn có thể nhận Int, nên hãy kiểm tra giá trị thật của API.

Encode ngược lại thành JSON có giữ key gốc không?

CodingKeys cũng được dùng khi encode, nên JSONEncoder lại ghi ra guest_name. Property optional đang là nil bị bỏ khỏi output.