I-convert ang JSON sa Dart class!

Maglagay ng JSON para gumawa ng Dart class code, kasama ang mga nested object! Sinusuportahan ang Flutter, fromJson, toJson.
JSON
Resulta
 

I-convert ang JSON sa Dart class!

Gawing mga Dart class ang JSON na may fromJson factory at toJson method. Plain Dart ang code at walang code-generation package, kaya walang build_runner step.

Bagay ito sa mga Flutter app na nagpapasa ng raw na Map<String, dynamic> response mula sa http o dio papunta sa mga widget at gusto ng maayos na model class, o sa maliliit na project na kailangan ng gumaganang serialization bago gumamit ng json_serializable.

Paano gamitin

  1. I-paste ang JSON na iko-convert.
  2. Ilagay sa Pangalan ng type ang pangalan ng top-level class (halimbawa Store).
  3. I-paste ang output sa isang file sa ilalim ng lib/models/; walang kailangang import.
  4. Gumawa ng mga object gamit ang Store.fromJson(jsonDecode(response.body) as Map<String, dynamic>) at ipadala sila gamit ang jsonEncode(store.toJson()).

Halimbawa

Input (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 }
  ]
}
Output (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,
      };
}

Nagiging MenuItem class ang mga element ng array na menuItems, na kino-convert sa loob ng fromJson gamit ang .map(...).toList(). Binabasa ang rating bilang (json['rating'] as num).toDouble() kaya ligtas pa rin kahit integer ang value, at ang spicy, na nasa ilang menu item lang, ay int? na walang required sa constructor.

Mga sinusuportahang feature

  • final ang lahat ng field; named parameter ({required this.x}) ang gamit ng mga constructor.
  • Mano-manong istilong factory X.fromJson(Map<String, dynamic> json) at Map<String, dynamic> toJson() na walang package dependency.
  • Tinatawag ng mga nested object at object array ang fromJson / toJson ng child class.
  • Binabasa ang mga double field gamit ang (as num).toDouble(), kaya hindi nagta-throw ng cast error ang JSON integer gaya ng 4.
  • Nagiging nullable (int?) ang mga field na wala sa ilang item o may laman na null, at ipinapasa ang null sa fromJson.
  • dynamic ang mga value na halo ang type; nilalagyan ng underscore sa dulo ang mga Dart reserved word gaya ng class o is.
  • Kapag array ang top level, typedef Root = List<RootItem>; ang lumalabas.

Mga gamit

Mga API model para sa mga Flutter screen

Kapag Map ang dinadala sa FutureBuilder o sa Riverpod/Bloc state, nakatago hanggang runtime ang mga typo sa key. Sa mga na-generate na class, may completion at type check ka sa store.menuItems.first.price.

Local caching

I-store ang jsonEncode(store.toJson()) sa shared_preferences o sa isang file at i-restore ito gamit ang fromJson sa startup para sa cache na ilang linya lang.

Draft bago gumamit ng json_serializable

Kumpirmahin muna ang listahan ng field at mga type; habang lumalaki ang project, idagdag ang @JsonSerializable() sa parehong mga field at lumipat sa code generation.

Mga paalala at limitasyon

  • Ini-infer ang mga type gamit ang JSON parser ng browser, na binabasa ang 5000.0 bilang integer na 5000. Pinapanatili naman ng jsonDecode ng Dart ang 5000.0 bilang double, kaya nagta-throw ang as int. Palitan ng double ang mga field ng presyo o coordinate na puwedeng may decimal point.
  • Isinusulat ng toJson ang mga nullable field kahit null sila ('spicy': null). Kung tinatanggihan ng server mo ang mga null key, i-exclude sila nang may kondisyon.
  • Nananatiling String ang mga date string; ikaw na ang mag-convert gamit ang DateTime.parse(json['createdAt'] as String).
  • Walang ginagawang copyWith, ==/hashCode o toString. Isaalang-alang ang freezed o equatable kung kailangan mo sila.
  • Walang check ang mga value na hawak ng dynamic na field; palitan sila kapag alam mo na ang totoong type.

Mga madalas itanong

Kaya ba nitong gumawa ng json_serializable o freezed na code?

Mano-manong istilong fromJson/toJson na walang package ang output. Kunin ang mga field declaration, idagdag ang @JsonSerializable() at part 'store.g.dart';, at patakbuhin ang dart run build_runner build para lumipat sa code generation.

Lumalabas ang type 'int' is not a subtype of type 'double'.

Nangyayari iyon kapag nagka-cast ang code gamit ang as double at integer ang JSON value. Gumagamit ng (as num).toDouble() ang mga na-generate na double field para maiwasan ito; ganoon ding pattern ang i-apply sa anumang field na mano-mano mong in-edit.

Paano ko ide-decode ang list response ([ {...}, {...} ])?

Kapag array ang top level, may typedef at element class. Tawagin ang fromJson bawat element: (jsonDecode(body) as List<dynamic>).map((e) => RootItem.fromJson(e as Map<String, dynamic>)).toList().

Gumagana ba ito sa mga lumang project na walang null safety?

Gumagamit ang output ng sound null safety syntax (int?, required) mula Dart 2.12 pataas. Kailangang tanggalin ang ? at required para mag-compile sa mga project na bago pa ang null safety.