JSONからDartへの変換ツール

JSONをNull Safety対応Dartモデルに変換する仕組み

Dart公式のdart:convertドキュメントでは、jsonDecode()が数値、文字列、Boolean、null、リスト、文字列キーのマップなど、JSONに対応する値を返すと説明されています。モデルクラスをそのままJSONにエンコードすることはできませんが、jsonEncode()はクラスのtoJson()メソッドを呼び出せます。このツールはjson_serializableのアノテーションや外部パッケージを追加せずに、この手動シリアライズ方式のコードを生成します。

たとえば、サンプルにネストした住所を持つユーザーが含まれているとします。生成されるUserにはfinalフィールドと名前付き引数のコンストラクタが含まれます。User.fromJson(Map<String, Object?> json)はスカラー値をキャストし、ネストしたオブジェクトにはUserAddress.fromJson()を呼び出します。いずれかのサンプルオブジェクトでaddressが欠落しているかnullの場合、型はUserAddress?となり、ファクトリは生成前にnullを確認します。toJsonを有効にすると、ネストしたモデルも再帰的にjsonEncode()が受け取れるマップへ変換されます。

このツールはルート配列の先頭項目だけでなく、すべてのオブジェクトを調べます。いずれかの項目にフィールドがない場合、または明示的にnullが入っている場合、そのフィールドはnullableになります。実際のAPIがサンプルより不規則な場合は、すべてのフィールドをnullableにすることもできます。DartのNull Safetyガイドにあるとおり、型は初期状態ではnullを許容せず、nullを受け入れるには?が必要です。

識別子の処理と型推論の限界

JSONキーは有効なDartメンバー名である必要がありません。句読点を取り除き、単語をlowerCamelCaseへ変換し、予約語には安全な接尾辞を付けます。名前が重複した場合は、結果が毎回変わらないよう数値の接尾辞を追加します。元のキーはjson['original-key']とtoJson()のマップ内にそのまま残ります。ネストしたクラス名には完全なパスを使うため、無関係な住所オブジェクトが意図せず同じクラスにまとめられることはありません。

1つのサンプルだけではAPIの仕様全体を証明できません。JSON文字列が日付、UUID、enumとして自動認識されることはなく、空の配列から要素型を判断することもできません。同じオブジェクトメンバー名が重複している場合も、JSONパーサーは通常最後の値だけを保持するため、往復変換の安全性は保証されません。本番環境で使う前に、生成モデルをAPIドキュメントやスキーマと照合してください。ブラウザでの処理量を抑えるため、入力サイズ、ネストの深さ、推論する宣言数、出力サイズには上限があります。