JSONをDartのclassに変換!

JSONを入力すると、ネストしたオブジェクトまでDartのclassコードに変換します!Flutter, fromJson, toJson 対応。
JSON
結果
 

JSONをDartのclassに変換!

JSON を、fromJson ファクトリーと toJson メソッドを持つ Dart クラスに変換します。コード生成パッケージを使わない素の Dart なので、build_runner の手順はありません。

http や dio から受け取った生の Map<String, dynamic> をそのままウィジェットに渡している Flutter アプリをきちんとしたモデルクラスにしたい場合や、json_serializable を導入する前にとりあえず動くシリアライズが必要な小さなプロジェクトに向いています。

使い方

  1. 変換する JSON を貼り付けます。
  2. 型名 にトップレベルのクラス名を入力します(例: Store)。
  3. 出力を lib/models/ 以下のファイルに貼り付けます。import は必要ありません。
  4. Store.fromJson(jsonDecode(response.body) as Map<String, dynamic>) でオブジェクトを作り、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 配列の要素は MenuItem クラスになり、fromJson の中で .map(...).toList() を使って変換されます。rating は (json['rating'] as num).toDouble() で読むので整数値でも安全で、一部のメニュー項目にしかない spicy は int? になり、コンストラクターで required が付きません。

対応機能

  • すべてのフィールドは final で、コンストラクターは名前付き引数({required this.x})を使います。
  • パッケージに依存しない手書きスタイルの factory X.fromJson(Map<String, dynamic> json) と Map<String, dynamic> toJson() を生成します。
  • ネストしたオブジェクトやオブジェクトの配列は、子クラスの fromJson / toJson を呼び出します。
  • double のフィールドは (as num).toDouble() で読むため、4 のような JSON の整数でもキャストエラーになりません。
  • 一部の要素にないフィールドや null を含むフィールドは null 許容(int?)になり、fromJson では null をそのまま渡します。
  • 型が混在する値は dynamic になり、class や is のような Dart の予約語には末尾にアンダースコアが付きます。
  • トップレベルが配列のときは typedef Root = List<RootItem>; を出力します。

利用シーン

Flutter 画面用の API モデル

FutureBuilder や Riverpod/Bloc の state で Map を持ち回ると、キーの打ち間違いが実行時まで隠れてしまいます。生成したクラスなら store.menuItems.first.price で補完と型チェックが効きます。

ローカルキャッシュ

jsonEncode(store.toJson()) を shared_preferences やファイルに保存し、起動時に fromJson で復元すれば、数行でキャッシュが作れます。

json_serializable 導入前の下書き

まずフィールドの一覧と型を確定させ、プロジェクトが大きくなったら同じフィールドに @JsonSerializable() を付けてコード生成に移行できます。

注意点と制限

  • 型はブラウザーの JSON パーサーで推論するため、5000.0 は整数の 5000 として読まれます。Dart の jsonDecode は 5000.0 を double のまま保つので、as int が例外を投げます。小数点が付く可能性のある価格や座標のフィールドは double に変えてください。
  • toJson は null 許容のフィールドを null のときも書き出します('spicy': null)。サーバーが null のキーを受け付けない場合は、条件付きで省いてください。
  • 日付の文字列は String のままです。DateTime.parse(json['createdAt'] as String) で自分で変換してください。
  • copyWith、==/hashCode、toString は生成しません。必要なら freezed や equatable を検討してください。
  • dynamic のフィールドは値を検査せずに保持します。実際の型がわかったら置き換えてください。

よくある質問

json_serializable や freezed のコードを生成できますか?

出力はパッケージを使わない手書きスタイルの fromJson/toJson です。フィールド宣言を取り出して @JsonSerializable() と part 'store.g.dart'; を追加し、dart run build_runner build を実行すればコード生成に切り替えられます。

type 'int' is not a subtype of type 'double' というエラーが出ます。

コードが as double でキャストしていて、JSON の値が整数だったときに起こります。生成された double のフィールドはそれを避けるため (as num).toDouble() を使っています。手で編集したフィールドにも同じパターンを当ててください。

リストのレスポンス([ {...}, {...} ])はどうデコードしますか?

トップレベルが配列だと、typedef と要素のクラスが出力されます。要素ごとに fromJson を呼んでください: (jsonDecode(body) as List<dynamic>).map((e) => RootItem.fromJson(e as Map<String, dynamic>)).toList()。

null safety 以前の古いプロジェクトでも使えますか?

出力は Dart 2.12 以降の sound null safety の構文(int?、required)を使っています。null safety 以前のプロジェクトでは、? と required を取り除かないとコンパイルできません。