I-convert ang JSON sa Swift Codable struct!

Maglagay ng JSON para gumawa ng Swift Codable struct code, kasama ang mga nested object! Sinusuportahan ang Codable, CodingKeys, JSONDecoder, iOS.
JSON
Resulta
 

I-convert ang JSON sa Swift Codable struct!

I-convert ang JSON sa mga Swift struct na nag-a-adopt ng Codable. Dine-declare ang mga property gamit ang let at pinapalitan ang pangalan sa camelCase, at ginagawa lang ang CodingKeys enum para sa mga struct kung saan may pangalang iba sa JSON key nito.

Gamitin ito kapag kailangan ng isang iOS o macOS app ng model para i-decode ang URLSession response gamit ang JSONDecoder, o kapag gusto mo ng mga type na tugma sa mock JSON sa likod ng isang SwiftUI preview.

Paano gamitin

  1. I-paste ang response body mula sa API mo, halimbawa ang nakuha gamit ang Proxyman o Charles.
  2. I-set ang Pangalan ng type sa pangalan ng top-level struct (halimbawa EpisodePage).
  3. I-paste ang resulta sa isang Swift file; kasama na ang import Foundation.
  4. Mag-decode gamit ang try JSONDecoder().decode(EpisodePage.self, from: data).

Halimbawa

Input (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
}
Output (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"
    }
}

Nagiging Episode struct ang mga element ng array na episodes. Halo ang integer (1840) at decimal (2215.5) sa duration, kaya Double ito; ang guest_name, na nasa pangalawang episode lang, ay guestName: String?. Nakakakuha ng CodingKeys enum na naglilista ng lahat ng key nito ang anumang struct na may field na pinalitan ng pangalan.

Mga sinusuportahang feature

  • Nag-a-adopt ng Codable ang bawat struct; mga immutable na let ang mga property.
  • Nagiging camelCase na property ang mga snake_case at kebab-case na key, at saka lang idinadagdag ang enum CodingKeys: String, CodingKey kasama ang mga orihinal na key.
  • Mga type: String, Int, Double, Bool, at [T] para sa mga array.
  • Optional (String?) ang mga field na wala sa ilang item o may laman na null, kaya nade-decode pa rin kahit nawawala ang key.
  • Gumagamit ang mga value na halo ang type ng isang na-generate at decodable na JSONValue enum.
  • Binabalot ng backtick ang mga Swift keyword gaya ng default, class o self.
  • Kapag array ang top level, typealias Root = [RootItem] ang lumalabas.

Mga gamit

URLSession gamit ang async/await

Mula sa iisang sample response, makakakuha ka ng model na made-decode mo sa mismong linya pagkatapos ng let (data, _) = try await URLSession.shared.data(from: url).

Mga SwiftUI list screen

Idagdag ang Identifiable sa na-generate na struct (kapag may id field ito) at ipasa ito nang direkta sa List(page.episodes) { ... }.

Naka-bundle na mock data

Isama sa app bundle ang sample JSON mula sa design phase at i-decode ito gamit ang parehong model, para mabuo ang mga screen bago pa handa ang totoong API.

Mga paalala at limitasyon

  • String ang kinalalabasan ng mga date string. Para makakuha ng Date, palitan ang property type at mag-set ng strategy gaya ng decoder.dateDecodingStrategy = .iso8601.
  • Kung nawawala sa isang response ang key ng isang non-optional na property, nagta-throw ang decoding ng DecodingError.keyNotFound. Lagyan ng ? ang mga field na puwedeng hindi isama ng API, kahit laging nandoon sila sa sample mo.
  • let ang lahat ng property; ilipat sa var para sa mga model na binabago mo bilang view state.
  • Walang dagdag na protocol gaya ng Identifiable o Hashable na ina-adopt.
  • Helper code para sa halo-halong type ang JSONValue enum; kung may katumbas na type na ang project mo, burahin ito at gamitin ang sa iyo.

Mga madalas itanong

Kapag may keyDecodingStrategy = .convertFromSnakeCase, puwede ko bang burahin ang CodingKeys?

Oo, ang decoder na ang magko-convert ng guest_name ↔ guestName para sa iyo. Pero huwag pagsabayin ang dalawa: kino-convert muna ng decoder sa camelCase ang mga key at saka ikinukumpara sa raw value na "guest_name" sa CodingKeys, kaya pumapalya ang matching.

Bakit struct at hindi class?

Karaniwang convention sa Swift ang pagturing sa mga response model bilang value type, at libreng nakakakuha ang mga struct ng memberwise initializer, kaya madaling gumawa ng test data. Kung kailangan mo ng reference semantics, palitan ng final class at magdagdag ng initializer.

Lumabas na Double ang isang field na inaasahan kong integer.

Kapag may hawak na integer at decimal ang isang key, naiiwasan ng Double ang pagkawala ng precision. Sa kabaligtaran, kung mukhang 4.0 ang bawat sample value, binabasa ito ng JSON parser ng browser bilang integer at puwede kang makakuha ng Int, kaya i-check ang totoong API value.

Napapanatili ba ang mga orihinal na key kapag nag-encode pabalik sa JSON?

Ginagamit din ang CodingKeys sa encoding, kaya isinusulat ulit ng JSONEncoder ang guest_name. Hindi isinasama sa output ang mga optional na property na nil.