JSON کو Swift Codable struct میں تبدیل کریں!

JSON درج کریں اور nested objects سمیت Swift Codable struct کوڈ بنائیں! Codable, CodingKeys, JSONDecoder, iOS سپورٹ۔
JSON
نتیجہ
 

JSON کو Swift Codable struct میں تبدیل کریں!

JSON کو Codable اپنانے والے Swift structs میں تبدیل کریں۔ properties let سے ڈکلیئر ہوتی ہیں اور ان کے نام camelCase میں بدلے جاتے ہیں، اور CodingKeys enum صرف ان structs کے لیے بنتا ہے جہاں کوئی نام اپنی JSON key سے مختلف ہو۔

اسے تب استعمال کریں جب iOS یا macOS ایپ کو URLSession response کو JSONDecoder سے decode کرنے کے لیے ماڈل چاہیے، یا جب آپ SwiftUI preview کے پیچھے والے mock JSON سے میل کھانے والی types چاہیں۔

استعمال کا طریقہ

  1. اپنی API کی response body پیسٹ کریں، مثلاً Proxyman یا Charles سے پکڑی گئی۔
  2. ٹائپ کا نام کو سب سے اوپر والے struct کا نام دیں (مثلاً EpisodePage)۔
  3. نتیجہ کسی Swift فائل میں پیسٹ کریں؛ import Foundation شامل ہے۔
  4. try JSONDecoder().decode(EpisodePage.self, from: data) سے decode کریں۔

مثال

ان پٹ (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 array کے elements، Episode struct بنتے ہیں۔ duration میں integer (1840) اور decimal (2215.5) ملے ہیں، اس لیے یہ Double ہے؛ صرف دوسرے episode میں ملنے والا guest_name بنتا ہے guestName: String?۔ جس struct میں بھی کسی فیلڈ کا نام بدلا ہو اسے اپنی تمام keys کی فہرست والا CodingKeys enum ملتا ہے۔

معاون خصوصیات

  • ہر struct، Codable اپناتا ہے؛ properties ناقابلِ تبدیل let ہوتی ہیں۔
  • snake_case اور kebab-case keys، camelCase properties بنتی ہیں، اور صرف تبھی اصل keys کے ساتھ enum CodingKeys: String, CodingKey شامل کیا جاتا ہے۔
  • types: String، Int، Double، Bool، اور arrays کے لیے [T]۔
  • کچھ items میں غائب یا null والے فیلڈز Optionals (String?) ہوتے ہیں، اس لیے غائب keys کے ساتھ بھی decode ہو جاتا ہے۔
  • ملی جلی type والی values کے لیے ایک بنایا گیا، decode ہونے کے قابل JSONValue enum استعمال ہوتا ہے۔
  • default، class یا self جیسے Swift keywords کو backticks میں لپیٹا جاتا ہے۔
  • سب سے اوپر کی array سے typealias Root = [RootItem] بنتا ہے۔

استعمال کے کیس

async/await کے ساتھ URLSession

ایک نمونہ response سے آپ کو ایسا ماڈل ملتا ہے جسے آپ let (data, _) = try await URLSession.shared.data(from: url) کے فوراً بعد والی لائن پر decode کر سکتے ہیں۔

SwiftUI کی فہرست والی screens

بنائے گئے struct میں Identifiable شامل کریں (جب اس میں id فیلڈ ہو) اور اسے سیدھا List(page.episodes) { ... } کو دے دیں۔

bundle میں شامل mock ڈیٹا

ڈیزائن کے مرحلے والا نمونہ JSON ایپ bundle میں رکھیں اور اسی ماڈل سے decode کریں، تاکہ اصل API تیار ہونے سے پہلے screens بنائی جا سکیں۔

نوٹس اور حدود

  • تاریخیں String کے طور پر نکلتی ہیں۔ Date حاصل کرنے کے لیے property کی type بدلیں اور decoder.dateDecodingStrategy = .iso8601 جیسی strategy سیٹ کریں۔
  • اگر کسی غیر optional property کی key response سے غائب ہو تو decoding، DecodingError.keyNotFound throw کرتی ہے۔ جن فیلڈز کو API چھوڑ سکتی ہے ان پر ? لگائیں، چاہے آپ کے نمونے میں وہ ہمیشہ موجود تھے۔
  • تمام properties let ہیں؛ جن ماڈلز کو آپ view state کے طور پر بدلتے ہیں ان کے لیے var کر دیں۔
  • Identifiable یا Hashable جیسے اضافی protocols نہیں اپنائے جاتے۔
  • JSONValue enum ملی جلی types کے لیے مددگار کوڈ ہے؛ اگر آپ کے پروجیکٹ میں پہلے سے اس جیسی type ہے تو اسے مٹا کر اپنی استعمال کریں۔

عام سوالات

keyDecodingStrategy = .convertFromSnakeCase کے ساتھ کیا میں CodingKeys مٹا سکتا ہوں؟

جی ہاں، تب decoder آپ کے لیے guest_name ↔ guestName تبدیل کر دیتا ہے۔ لیکن دونوں کو ایک ساتھ استعمال نہ کریں: decoder پہلے keys کو camelCase میں بدلتا ہے اور پھر انہیں CodingKeys میں "guest_name" raw value سے ملاتا ہے، اس لیے matching ناکام ہو جاتی ہے۔

classes کے بجائے structs کیوں؟

response ماڈلز کو value types کے طور پر رکھنا Swift کا عام رواج ہے، اور structs کو memberwise initializer مفت ملتا ہے، جس سے test ڈیٹا بنانا آسان ہوتا ہے۔ اگر آپ کو reference semantics چاہئیں تو final class کر دیں اور initializer شامل کریں۔

جس فیلڈ کے integer ہونے کی توقع تھی وہ Double کی صورت میں آیا۔

جب کسی key میں integers اور decimals دونوں ہوں تو Double درستگی ضائع ہونے سے بچاتا ہے۔ اس کے برعکس، اگر ہر نمونہ value 4.0 جیسی ہو تو براؤزر کا JSON parser اسے integer پڑھتا ہے اور آپ کو Int مل سکتا ہے، اس لیے اصل API values چیک کریں۔

کیا واپس JSON میں encode کرنے پر اصل keys برقرار رہتی ہیں؟

CodingKeys encoding کے لیے بھی استعمال ہوتی ہیں، اس لیے JSONEncoder دوبارہ guest_name لکھتا ہے۔ جن optional properties کی value nil ہو وہ آؤٹ پٹ سے چھوڑ دی جاتی ہیں۔