Chuyển JSON thành class Dart!

Nhập JSON để tạo mã class Dart, kể cả các object lồng nhau! Hỗ trợ Flutter, fromJson, toJson.
JSON
Kết quả
 

Chuyển JSON thành class Dart!

Biến JSON thành class Dart có factory fromJson và method toJson. Code là Dart thuần, không dùng package sinh code nào, nên không cần bước build_runner.

Nó hợp với app Flutter đang truyền thẳng Map<String, dynamic> từ response của http hay dio vào widget và muốn có class model đàng hoàng, hoặc dự án nhỏ cần serialization chạy được trước khi dùng json_serializable.

Cách sử dụng

  1. Dán JSON cần chuyển.
  2. Nhập tên class cấp cao nhất vào Tên kiểu (ví dụ Store).
  3. Dán output vào một file trong lib/models/; không cần import.
  4. Tạo object bằng Store.fromJson(jsonDecode(response.body) as Map<String, dynamic>) và gửi đi bằng jsonEncode(store.toJson()).

Ví dụ

Đầu vào (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 }
  ]
}
Đầu ra (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,
      };
}

Phần tử của mảng menuItems thành class MenuItem, được chuyển bên trong fromJson bằng .map(...).toList(). rating được đọc là (json['rating'] as num).toDouble() nên giá trị nguyên vẫn an toàn, còn spicy, chỉ có ở một số món, là int? và không có required trong constructor.

Tính năng hỗ trợ

  • Mọi field đều là final; constructor dùng named parameter ({required this.x}).
  • factory X.fromJson(Map<String, dynamic> json) và Map<String, dynamic> toJson() viết tay, không phụ thuộc package nào.
  • Object lồng nhau và mảng object gọi fromJson / toJson của class con.
  • Field double được đọc qua (as num).toDouble(), nên số nguyên JSON như 4 không gây lỗi cast.
  • Field thiếu ở một số phần tử hoặc chứa null thành nullable (int?) và truyền nguyên null trong fromJson.
  • Giá trị có kiểu lẫn lộn là dynamic; từ khóa của Dart như class hay is được thêm dấu gạch dưới ở cuối.
  • Mảng ở cấp cao nhất cho ra typedef Root = List<RootItem>;.

Trường hợp sử dụng

Model API cho màn hình Flutter

Truyền Map qua FutureBuilder hay state Riverpod/Bloc sẽ giấu lỗi gõ sai key cho tới lúc runtime. Với class được tạo, bạn có gợi ý code và kiểm tra kiểu trên store.menuItems.first.price.

Cache cục bộ

Lưu jsonEncode(store.toJson()) vào shared_preferences hoặc file và khôi phục bằng fromJson khi khởi động, có ngay cache chỉ với vài dòng.

Bản nháp trước khi dùng json_serializable

Xác nhận danh sách field và kiểu trước; khi dự án lớn lên, thêm @JsonSerializable() vào chính các field đó và chuyển sang sinh code.

Lưu ý và giới hạn

  • Kiểu được suy ra bằng JSON parser của trình duyệt, vốn đọc 5000.0 thành số nguyên 5000. jsonDecode của Dart giữ 5000.0 là double, nên as int sẽ ném lỗi. Hãy đổi các field giá tiền hay tọa độ có thể mang dấu thập phân thành double.
  • toJson ghi cả field nullable kể cả khi chúng là null ('spicy': null). Nếu server từ chối key null, hãy bỏ chúng ra có điều kiện.
  • Chuỗi ngày tháng vẫn là String; tự chuyển bằng DateTime.parse(json['createdAt'] as String).
  • Không tạo copyWith, ==/hashCode hay toString. Cân nhắc freezed hoặc equatable nếu bạn cần.
  • Field dynamic giữ giá trị mà không kiểm tra; hãy thay khi đã biết kiểu thật.

Câu hỏi thường gặp

Có tạo được code json_serializable hay freezed không?

Output là fromJson/toJson kiểu viết tay, không dùng package. Lấy phần khai báo field, thêm @JsonSerializable() và part 'store.g.dart';, rồi chạy dart run build_runner build để chuyển sang sinh code.

Tôi gặp lỗi type 'int' is not a subtype of type 'double'.

Lỗi này xảy ra khi code cast bằng as double mà giá trị JSON là số nguyên. Field double được tạo dùng (as num).toDouble() để tránh; hãy áp dụng cùng mẫu đó cho field bạn đã sửa tay.

Decode response dạng danh sách ([ {...}, {...} ]) thế nào?

Mảng ở cấp cao nhất cho ra một typedef và class phần tử. Gọi fromJson cho từng phần tử: (jsonDecode(body) as List<dynamic>).map((e) => RootItem.fromJson(e as Map<String, dynamic>)).toList().

Có chạy trên dự án cũ chưa có null safety không?

Output dùng cú pháp sound null safety (int?, required) từ Dart 2.12 trở đi. Dự án trước null safety cần bỏ ? và required mới compile được.