JSON in Dart-class umwandeln!

Gib JSON ein, um Dart-class-Code inklusive verschachtelter Objekte zu erzeugen! Unterstützt Flutter, fromJson, toJson.
JSON
Ergebnis
 

JSON in Dart-class umwandeln!

Mach aus JSON Dart-Klassen mit einer fromJson-Factory und einer toJson-Methode. Der Code ist reines Dart ohne Codegenerierungs-Pakete, es gibt also keinen build_runner-Schritt.

Das passt zu Flutter-Apps, die rohe Map<String, dynamic>-Antworten von http oder dio an Widgets durchreichen und stattdessen richtige Modellklassen wollen, oder zu kleinen Projekten, die funktionierende Serialisierung brauchen, bevor sie json_serializable einführen.

So funktioniert es

  1. Füge das umzuwandelnde JSON ein.
  2. Gib in Typname den Namen der obersten Klasse ein (zum Beispiel Store).
  3. Füge die Ausgabe in eine Datei unter lib/models/ ein; Imports sind nicht nötig.
  4. Erzeuge Objekte mit Store.fromJson(jsonDecode(response.body) as Map<String, dynamic>) und sende sie mit jsonEncode(store.toJson()).

Beispiel

Eingabe (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 }
  ]
}
Ausgabe (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,
      };
}

Die Elemente des Arrays menuItems werden zu einer Klasse MenuItem, die in fromJson mit .map(...).toList() umgewandelt wird. rating wird als (json['rating'] as num).toDouble() gelesen, damit auch ein ganzzahliger Wert sicher ist, und spicy, das nur bei manchen Menüpunkten vorkommt, ist int? ohne required im Konstruktor.

Unterstützte Funktionen

  • Alle Felder sind final; Konstruktoren verwenden benannte Parameter ({required this.x}).
  • Handgeschriebene factory X.fromJson(Map<String, dynamic> json) und Map<String, dynamic> toJson() ohne Paketabhängigkeiten.
  • Verschachtelte Objekte und Objekt-Arrays rufen fromJson / toJson der Kindklasse auf.
  • double-Felder werden über (as num).toDouble() gelesen, sodass eine JSON-Ganzzahl wie 4 keinen Cast-Fehler auslöst.
  • Felder, die in manchen Elementen fehlen oder null enthalten, werden nullable (int?) und reichen in fromJson null durch.
  • Werte mit gemischtem Typ sind dynamic; reservierte Wörter von Dart wie class oder is bekommen einen angehängten Unterstrich.
  • Ein Array auf oberster Ebene erzeugt typedef Root = List<RootItem>;.

Anwendungsfälle

API-Modelle für Flutter-Screens

Eine Map, die durch FutureBuilder oder Riverpod/Bloc-State gereicht wird, versteckt Tippfehler in Keys bis zur Laufzeit. Mit generierten Klassen bekommst du Autovervollständigung und Typprüfung bei store.menuItems.first.price.

Lokales Caching

Speichere jsonEncode(store.toJson()) in shared_preferences oder einer Datei und stelle es beim Start mit fromJson wieder her, schon hast du einen Cache in wenigen Zeilen.

Ein Entwurf vor json_serializable

Kläre zuerst Feldliste und Typen; wenn das Projekt wächst, ergänzt du @JsonSerializable() an denselben Feldern und steigst auf Codegenerierung um.

Hinweise und Einschränkungen

  • Typen werden mit dem JSON-Parser des Browsers abgeleitet, der 5000.0 als Ganzzahl 5000 liest. jsonDecode in Dart behält 5000.0 aber als double, und as int wirft dann einen Fehler. Stelle Preis- oder Koordinatenfelder, die einen Dezimalpunkt haben können, auf double um.
  • toJson schreibt nullable Felder auch dann, wenn sie null sind ('spicy': null). Lehnt dein Server null-Keys ab, lass sie bedingt weg.
  • Datums-Strings bleiben String; wandle sie selbst mit DateTime.parse(json['createdAt'] as String) um.
  • Es werden weder copyWith noch ==/hashCode oder toString erzeugt. Zieh freezed oder equatable in Betracht, wenn du sie brauchst.
  • dynamic-Felder halten Werte ungeprüft; ersetze sie, sobald du den echten Typ kennst.

Häufige Fragen

Kann es json_serializable- oder freezed-Code erzeugen?

Die Ausgabe ist fromJson/toJson im handgeschriebenen Stil ohne Pakete. Übernimm die Felddeklarationen, ergänze @JsonSerializable() und part 'store.g.dart'; und führe dart run build_runner build aus, um auf Codegenerierung umzusteigen.

Ich bekomme type 'int' is not a subtype of type 'double'.

Das passiert, wenn Code mit as double castet und der JSON-Wert eine Ganzzahl ist. Generierte double-Felder verwenden (as num).toDouble(), um das zu vermeiden; wende dasselbe Muster auf jedes Feld an, das du von Hand bearbeitet hast.

Wie dekodiere ich eine Listenantwort ([ {...}, {...} ])?

Ein Array auf oberster Ebene ergibt ein typedef und eine Elementklasse. Rufe fromJson pro Element auf: (jsonDecode(body) as List<dynamic>).map((e) => RootItem.fromJson(e as Map<String, dynamic>)).toList().

Funktioniert es in alten Projekten ohne Null Safety?

Die Ausgabe verwendet die Syntax von Sound Null Safety (int?, required) ab Dart 2.12. In Projekten vor Null Safety müssen ? und required entfernt werden, damit der Code kompiliert.