Tukar JSON kepada class Dart!

Masukkan JSON untuk menjana kod class Dart, termasuk objek bersarang! Menyokong Flutter, fromJson, toJson.
JSON
Hasil
 

Tukar JSON kepada class Dart!

Tukar JSON kepada kelas Dart dengan factory fromJson dan method toJson. Kodnya ialah Dart biasa tanpa package penjanaan kod, jadi tiada langkah build_runner.

Ia sesuai untuk aplikasi Flutter yang menghantar response Map<String, dynamic> mentah daripada http atau dio terus ke widget dan mahukan kelas model yang sebenar, atau projek kecil yang memerlukan serialization yang berfungsi sebelum menggunakan json_serializable.

Cara menggunakan

  1. Tampal JSON yang hendak ditukar.
  2. Masukkan nama kelas peringkat atas dalam Nama jenis (contohnya Store).
  3. Tampal output ke dalam fail di bawah lib/models/; tiada import diperlukan.
  4. Cipta objek dengan Store.fromJson(jsonDecode(response.body) as Map<String, dynamic>) dan hantarkannya dengan jsonEncode(store.toJson()).

Contoh

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,
      };
}

Elemen dalam array menuItems menjadi kelas MenuItem, yang ditukar di dalam fromJson dengan .map(...).toList(). rating dibaca sebagai (json['rating'] as num).toDouble() supaya nilai integer tetap selamat, dan spicy, yang hanya ada pada sesetengah item menu, ialah int? tanpa required dalam constructor.

Ciri yang disokong

  • Semua field ialah final; constructor menggunakan named parameter ({required this.x}).
  • factory X.fromJson(Map<String, dynamic> json) dan Map<String, dynamic> toJson() gaya tulisan tangan tanpa kebergantungan package.
  • Objek bersarang dan array objek memanggil fromJson / toJson kelas anak.
  • Field double dibaca melalui (as num).toDouble(), jadi integer JSON seperti 4 tidak mencetuskan ralat cast.
  • Field yang tiada dalam sesetengah item atau mengandungi null menjadi nullable (int?) dan meneruskan null dalam fromJson.
  • Nilai berjenis campuran ialah dynamic; kata simpanan Dart seperti class atau is diberi garis bawah di hujungnya.
  • Array peringkat atas menghasilkan typedef Root = List<RootItem>;.

Kes penggunaan

Model API untuk skrin Flutter

Membawa Map melalui FutureBuilder atau state Riverpod/Bloc menyembunyikan kesilapan taip kunci sehingga runtime. Dengan kelas yang dijana, anda mendapat autocomplete dan semakan jenis pada store.menuItems.first.price.

Caching tempatan

Simpan jsonEncode(store.toJson()) dalam shared_preferences atau fail dan pulihkannya dengan fromJson semasa aplikasi bermula untuk mendapatkan cache dalam beberapa baris sahaja.

Draf sebelum json_serializable

Pastikan senarai field dan jenisnya dahulu; apabila projek berkembang, tambah @JsonSerializable() pada field yang sama dan beralih kepada penjanaan kod.

Nota dan had

  • Jenis disimpulkan menggunakan parser JSON pelayar, yang membaca 5000.0 sebagai integer 5000. jsonDecode dalam Dart mengekalkan 5000.0 sebagai double, jadi as int akan gagal. Tukar field harga atau koordinat yang mungkin mempunyai titik perpuluhan kepada double.
  • toJson menulis field nullable walaupun nilainya null ('spicy': null). Jika server anda menolak kunci null, keluarkannya secara bersyarat.
  • String tarikh kekal sebagai String; tukarkannya sendiri dengan DateTime.parse(json['createdAt'] as String).
  • Tiada copyWith, ==/hashCode atau toString dijana. Pertimbangkan freezed atau equatable jika anda memerlukannya.
  • Field dynamic memegang nilai tanpa semakan; gantikannya apabila anda tahu jenis sebenar.

Soalan lazim

Bolehkah ia menjana kod json_serializable atau freezed?

Output ialah fromJson/toJson gaya tulisan tangan tanpa package. Ambil deklarasi field, tambah @JsonSerializable() dan part 'store.g.dart';, dan jalankan dart run build_runner build untuk beralih kepada penjanaan kod.

Saya mendapat type 'int' is not a subtype of type 'double'.

Ini berlaku apabila kod membuat cast dengan as double sedangkan nilai JSON ialah integer. Field double yang dijana menggunakan (as num).toDouble() untuk mengelakkannya; gunakan corak yang sama pada mana-mana field yang anda sunting sendiri.

Bagaimana saya decode response berbentuk senarai ([ {...}, {...} ])?

Array peringkat atas menghasilkan typedef dan kelas elemen. Panggil fromJson bagi setiap elemen: (jsonDecode(body) as List<dynamic>).map((e) => RootItem.fromJson(e as Map<String, dynamic>)).toList().

Adakah ia berfungsi dalam projek lama tanpa null safety?

Output menggunakan sintaks sound null safety (int?, required) daripada Dart 2.12 dan ke atas. Projek sebelum null safety perlu membuang ? dan required supaya boleh di-compile.