JSON کو Dart class میں تبدیل کریں!

JSON درج کریں اور nested objects سمیت Dart class کوڈ بنائیں! Flutter, fromJson, toJson سپورٹ۔
JSON
نتیجہ
 

JSON کو Dart class میں تبدیل کریں!

JSON کو fromJson factory اور toJson method والی Dart کلاسز میں بدلیں۔ کوڈ سادہ Dart ہے جس میں کوئی code-generation packages نہیں، اس لیے build_runner والا مرحلہ نہیں۔

یہ ان Flutter ایپس کے لیے موزوں ہے جو http یا dio کے خام Map<String, dynamic> responses widgets تک پہنچاتی ہیں اور ان کی جگہ مناسب ماڈل کلاسز چاہتی ہیں، یا ان چھوٹے پروجیکٹس کے لیے جنہیں json_serializable اپنانے سے پہلے کام کرنے والی serialization چاہیے۔

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

  1. تبدیل کرنے والا JSON پیسٹ کریں۔
  2. ٹائپ کا نام میں سب سے اوپر والی کلاس کا نام لکھیں (مثلاً Store)۔
  3. آؤٹ پٹ کو lib/models/ کے نیچے کسی فائل میں پیسٹ کریں؛ کسی import کی ضرورت نہیں۔
  4. Store.fromJson(jsonDecode(response.body) as Map<String, dynamic>) سے objects بنائیں اور jsonEncode(store.toJson()) سے بھیجیں۔

مثال

ان پٹ (JSON)
{
  "storeId": 77,
  "storeName": "Mapo Kimbap",
  "isOpen": true,
  "rating": 4.7,
  "menuItems": [
    { "name": "Tuna Kimbap", "price": 4500, "soldOut": false },
    { "name": "Ramyeon", "price": 5000, "soldOut": true, "spicy": 2 }
  ]
}
آؤٹ پٹ (Dart)
class Store {
  final int storeId;
  final String storeName;
  final bool isOpen;
  final double rating;
  final List<MenuItem> menuItems;

  Store({
    required this.storeId,
    required this.storeName,
    required this.isOpen,
    required this.rating,
    required this.menuItems,
  });

  factory Store.fromJson(Map<String, dynamic> json) => Store(
        storeId: json['storeId'] as int,
        storeName: json['storeName'] as String,
        isOpen: json['isOpen'] as bool,
        rating: (json['rating'] as num).toDouble(),
        menuItems: (json['menuItems'] as List<dynamic>).map((e) => MenuItem.fromJson(e as Map<String, dynamic>)).toList(),
      );

  Map<String, dynamic> toJson() => {
        'storeId': storeId,
        'storeName': storeName,
        'isOpen': isOpen,
        'rating': rating,
        'menuItems': menuItems.map((e) => e.toJson()).toList(),
      };
}

class MenuItem {
  final String name;
  final int price;
  final bool soldOut;
  final int? spicy;

  MenuItem({
    required this.name,
    required this.price,
    required this.soldOut,
    this.spicy,
  });

  factory MenuItem.fromJson(Map<String, dynamic> json) => MenuItem(
        name: json['name'] as String,
        price: json['price'] as int,
        soldOut: json['soldOut'] as bool,
        spicy: json['spicy'] as int?,
      );

  Map<String, dynamic> toJson() => {
        'name': name,
        'price': price,
        'soldOut': soldOut,
        'spicy': spicy,
      };
}

menuItems array کے elements، MenuItem کلاس بنتے ہیں، جو fromJson کے اندر .map(...).toList() سے تبدیل ہوتے ہیں۔ rating کو (json['rating'] as num).toDouble() سے پڑھا جاتا ہے تاکہ integer value بھی محفوظ رہے، اور صرف کچھ menu items میں موجود spicy، constructor میں required کے بغیر int? ہے۔

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

  • تمام فیلڈز final ہیں؛ constructors named parameters ({required this.x}) استعمال کرتے ہیں۔
  • ہاتھ سے لکھے انداز کے factory X.fromJson(Map<String, dynamic> json) اور Map<String, dynamic> toJson()، بغیر کسی package dependency کے۔
  • nested objects اور objects کی arrays، child کلاس کا fromJson / toJson کال کرتی ہیں۔
  • double فیلڈز (as num).toDouble() سے پڑھے جاتے ہیں، اس لیے 4 جیسا JSON integer cast error نہیں دیتا۔
  • کچھ items میں غائب یا null والے فیلڈز nullable (int?) بنتے ہیں اور fromJson میں null آگے بڑھا دیتے ہیں۔
  • ملی جلی type والی values، dynamic ہوتی ہیں؛ class یا is جیسے Dart reserved words کے آخر میں underscore لگتا ہے۔
  • سب سے اوپر کی array سے typedef Root = List<RootItem>; بنتا ہے۔

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

Flutter screens کے لیے API ماڈلز

FutureBuilder یا Riverpod/Bloc state میں Map لے کر چلنے سے key کی ٹائپنگ غلطیاں runtime تک چھپی رہتی ہیں۔ بنائی گئی کلاسز کے ساتھ store.menuItems.first.price پر completion اور type checks ملتے ہیں۔

local caching

jsonEncode(store.toJson()) کو shared_preferences یا فائل میں محفوظ کریں اور startup پر fromJson سے بحال کریں، چند لائنوں میں cache تیار۔

json_serializable سے پہلے کا ڈرافٹ

پہلے فیلڈز کی فہرست اور types کی تصدیق کریں؛ جیسے جیسے پروجیکٹ بڑھے، انہی فیلڈز پر @JsonSerializable() لگا کر code generation پر منتقل ہو جائیں۔

نوٹس اور حدود

  • types کا اندازہ براؤزر کے JSON parser سے لگایا جاتا ہے، جو 5000.0 کو integer 5000 پڑھتا ہے۔ Dart کا jsonDecode، 5000.0 کو double ہی رکھتا ہے، اس لیے as int throw کرتا ہے۔ قیمت یا coordinates جیسے فیلڈز جن میں decimal point آ سکتا ہے انہیں double کر دیں۔
  • toJson، nullable فیلڈز کو null ہونے پر بھی لکھتا ہے ('spicy': null)۔ اگر آپ کا سرور null keys رد کرتا ہے تو انہیں شرط کے ساتھ چھوڑ دیں۔
  • تاریخ والی strings، String رہتی ہیں؛ انہیں DateTime.parse(json['createdAt'] as String) سے خود تبدیل کریں۔
  • کوئی copyWith، ==/hashCode یا toString نہیں بنتا۔ اگر یہ چاہئیں تو freezed یا equatable پر غور کریں۔
  • dynamic فیلڈز values کو بغیر جانچ کے رکھتے ہیں؛ اصل type معلوم ہوتے ہی انہیں بدل دیں۔

عام سوالات

کیا یہ json_serializable یا freezed کوڈ بنا سکتا ہے؟

آؤٹ پٹ packages کے بغیر ہاتھ سے لکھے انداز کا fromJson/toJson ہے۔ فیلڈ declarations لیں، @JsonSerializable() اور part 'store.g.dart'; شامل کریں، اور code generation پر جانے کے لیے dart run build_runner build چلائیں۔

مجھے type 'int' is not a subtype of type 'double' ملتا ہے۔

یہ تب ہوتا ہے جب کوڈ as double سے cast کرے اور JSON value integer ہو۔ بنائے گئے double فیلڈز اس سے بچنے کے لیے (as num).toDouble() استعمال کرتے ہیں؛ ہاتھ سے ایڈٹ کیے گئے کسی بھی فیلڈ پر یہی pattern لاگو کریں۔

فہرست والا response ([ {...}, {...} ]) کیسے decode کروں؟

سب سے اوپر کی array سے ایک typedef اور element کلاس ملتی ہے۔ ہر element پر fromJson کال کریں: (jsonDecode(body) as List<dynamic>).map((e) => RootItem.fromJson(e as Map<String, dynamic>)).toList()۔

کیا یہ null safety کے بغیر پرانے پروجیکٹس میں چلتا ہے؟

آؤٹ پٹ Dart 2.12 اور بعد والا sound null safety syntax (int?، required) استعمال کرتا ہے۔ null safety سے پہلے والے پروجیکٹس میں compile کرنے کے لیے ? اور required ہٹانے ہوں گے۔