Tukar JSON kepada Codable struct Swift!

Masukkan JSON untuk menjana kod Codable struct Swift, termasuk objek bersarang! Menyokong Codable, CodingKeys, JSONDecoder, iOS.
JSON
Hasil
 

Tukar JSON kepada Codable struct Swift!

Tukar JSON kepada struct Swift yang mematuhi Codable. Property diisytiharkan dengan let dan dinamakan semula kepada camelCase, dan enum CodingKeys hanya dijana untuk struct yang mempunyai nama berbeza daripada kunci JSON-nya.

Gunakannya apabila aplikasi iOS atau macOS memerlukan model untuk menyahkod respons URLSession dengan JSONDecoder, atau apabila anda mahukan jenis yang sepadan dengan JSON mock di sebalik pratonton SwiftUI.

Cara menggunakan

  1. Tampal badan respons daripada API anda, contohnya yang ditangkap dengan Proxyman atau Charles.
  2. Tetapkan Nama jenis kepada nama struct peringkat atas (contohnya EpisodePage).
  3. Tampal hasilnya ke dalam fail Swift; import Foundation sudah disertakan.
  4. Nyahkod dengan try JSONDecoder().decode(EpisodePage.self, from: data).

Contoh

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"
    }
}

Elemen tatasusunan episodes menjadi struct Episode. duration bercampur antara integer (1840) dan perpuluhan (2215.5), jadi ia Double; guest_name, yang hanya ditemui dalam episod kedua, ialah guestName: String?. Mana-mana struct yang mempunyai medan dinamakan semula mendapat enum CodingKeys yang menyenaraikan semua kuncinya.

Ciri yang disokong

  • Setiap struct mematuhi Codable; property ialah let yang tidak boleh diubah.
  • Kunci snake_case dan kebab-case menjadi property camelCase, dan hanya ketika itu enum CodingKeys: String, CodingKey ditambah bersama kunci asal.
  • Jenis: String, Int, Double, Bool, dan [T] untuk tatasusunan.
  • Medan yang tiada dalam sesetengah item atau mengandungi null ialah Optional (String?), jadi kunci yang hilang masih boleh dinyahkod.
  • Nilai berjenis bercampur menggunakan enum JSONValue yang dijana dan boleh dinyahkod.
  • Kata kunci Swift seperti default, class atau self dibalut dengan backtick.
  • Tatasusunan peringkat atas menghasilkan typealias Root = [RootItem].

Kes penggunaan

URLSession dengan async/await

Daripada satu sampel respons, anda mendapat model yang boleh dinyahkod pada baris sejurus selepas let (data, _) = try await URLSession.shared.data(from: url).

Skrin senarai SwiftUI

Tambah Identifiable pada struct yang dijana (jika ia mempunyai medan id) dan hantar terus ke List(page.episodes) { ... }.

Data mock dalam bundle

Sertakan sampel JSON dari fasa reka bentuk dalam bundle aplikasi dan nyahkodnya dengan model yang sama, supaya skrin boleh dibina sebelum API sebenar siap.

Nota dan had

  • Rentetan tarikh dijana sebagai String. Untuk mendapat Date, tukar jenis property dan tetapkan strategi seperti decoder.dateDecodingStrategy = .iso8601.
  • Jika kunci bagi property bukan optional tiada dalam respons, penyahkodan membaling DecodingError.keyNotFound. Tambah ? pada medan yang mungkin ditinggalkan API, walaupun sampel anda sentiasa mempunyainya.
  • Semua property ialah let; tukar kepada var bagi model yang anda ubah sebagai state view.
  • Tiada protokol tambahan seperti Identifiable atau Hashable dipatuhi.
  • Enum JSONValue ialah kod pembantu untuk jenis bercampur; jika projek anda sudah mempunyai jenis setara, padamkannya dan gunakan milik anda.

Soalan lazim

Dengan keyDecodingStrategy = .convertFromSnakeCase, bolehkah saya memadam CodingKeys?

Ya, decoder akan menukar guest_name ↔ guestName untuk anda. Namun jangan gabungkan kedua-duanya: decoder menukar kunci kepada camelCase dahulu kemudian membandingkannya dengan raw value "guest_name" dalam CodingKeys, jadi padanan gagal.

Mengapa struct dan bukan class?

Menganggap model respons sebagai value type ialah konvensyen biasa Swift, dan struct mendapat memberwise initializer secara percuma, yang memudahkan pembinaan data ujian. Jika anda perlukan semantik rujukan, tukar kepada final class dan tambah initializer.

Medan yang saya jangka integer keluar sebagai Double.

Apabila sesuatu kunci memegang integer dan perpuluhan, Double mengelakkan kehilangan ketepatan. Sebaliknya, jika setiap nilai sampel kelihatan seperti 4.0, penghurai JSON pelayar membacanya sebagai integer dan anda mungkin mendapat Int, jadi semak nilai API sebenar.

Adakah pengekodan semula ke JSON mengekalkan kunci asal?

CodingKeys digunakan untuk pengekodan juga, jadi JSONEncoder menulis guest_name semula. Property optional yang bernilai nil ditinggalkan daripada output.