Flutter での JSON の手動シリアライゼーション

目次

• コアガイドライン
• ワークフロー: シリアライズ可能なモデルの実装
• ワークフロー: JSON の取得とパース
• 例

コアガイドライン

• dart:convert をインポート: Flutter の組み込み dart:convert ライブラリを使用して、JSON エンコード (jsonEncode) とデコード (jsonDecode) を手動で行う。
• 型安全性を強制: jsonDecode() が返す dynamic の結果を常に期待される型（通常はオブジェクトの場合は Map<String, dynamic>、配列の場合は List<dynamic>）にキャストする。
• シリアライゼーションロジックをカプセル化: JSON 構造に対応するプロパティを含むプレーンなモデルクラスを定義する。モデル内に fromJson ファクトリコンストラクタと toJson メソッドを実装する。
• バックグラウンドパースを処理: 大きな JSON ドキュメント（実行時間 > 16ms）をパースする場合は、Flutter の compute() 関数を使用してパースロジックを別の isolate にオフロードして、UI のカクカクを防ぐ。
• 失敗時に例外をスロー: HTTP レスポンスを処理する際、ステータスコードが成功していない場合（例：200 OK や 201 Created ではない）は例外をスローする。null を返さない。

ワークフロー: シリアライズ可能なモデルの実装

このチェックリストを使用して、データモデルの手動 JSON シリアライゼーションを実装する。

タスク進行状況:

• プレーンなモデルクラスを final プロパティで定義する。
• factory Model.fromJson(Map<String, dynamic> json) コンストラクタを実装する。
• Map<String, dynamic> toJson() メソッドを実装する。
• 両方のシリアライゼーションメソッドのユニットテストを書く。
• バリデータを実行 → 型不一致エラーを確認 → キャスティングロジックを修正する。

1. モデルを定義: JSON キーに対応するプロパティを持つクラスを作成する。
2. fromJson を実装: Map から値を抽出して適切な Dart 型にキャストする。パターンマッチングまたは明示的なキャストを使用する。
3. toJson を実装: クラスのプロパティを JSON 文字列キーにマップバックして Map<String, dynamic> を返す。
4. バリデート: ユニットテストを実行して、型安全性、自動補完、コンパイル時例外処理が正しく機能することを確認する。

ワークフロー: JSON の取得とパース

ネットワークリクエストから JSON を取得してパースする場合、この条件付きワークフローを使用する。

タスク進行状況:

• HTTP リクエストを実行する。
• レスポンスのステータスコードを検証する。
• パース戦略を決定（同期 vs. Isolate）。
• JSON をデコードしてモデルにマップする。

1. リクエストを実行: http パッケージを使用してネットワークコールを実行する。
2. レスポンスを検証:
   • response.statusCode == 200（POST の場合は 201）の場合、パースに進む。
   • ステータスコードがエラーを示す場合、Exception をスローする。
3. パース戦略を決定:
   • 小さいペイロード（例：単一オブジェクト）をパースする場合、メインスレッドで同期的にパースする。
   • 大きいペイロード（例：数千のオブジェクトの配列）をパースする場合、compute(parseFunction, response.body) を使用してバックグラウンド isolate でパースする。
4. デコードしてマップ: デコード済みの JSON をモデルの fromJson コンストラクタに渡す。

例

高忠実度モデル実装

import 'dart:convert';

class User {
  final int id;
  final String name;
  final String email;

  const User({
    required this.id,
    required this.name,
    required this.email,
  });

  // Factory constructor for deserialization
  factory User.fromJson(Map<String, dynamic> json) {
    return switch (json) {
      {
        'id': int id,
        'name': String name,
        'email': String email,
      } => 
        User(
          id: id,
          name: name,
          email: email,
        ),
      _ => throw const FormatException('Failed to load User.'),
    };
  }

  // Method for serialization
  Map<String, dynamic> toJson() {
    return {
      'id': id,
      'name': name,
      'email': email,
    };
  }
}

同期パース（小さいペイロード）

import 'dart:convert';
import 'package:http/http.dart' as http;

Future<User> fetchUser(http.Client client, int userId) async {
  final response = await client.get(
    Uri.parse('https://api.example.com/users/$userId'),
    headers: {'Accept': 'application/json'},
  );

  if (response.statusCode == 200) {
    // Decode returns dynamic, cast to Map<String, dynamic>
    final Map<String, dynamic> jsonMap = jsonDecode(response.body) as Map<String, dynamic>;
    return User.fromJson(jsonMap);
  } else {
    throw Exception('Failed to load user');
  }
}

バックグラウンドパース（大きいペイロード）

import 'dart:convert';
import 'package:flutter/foundation.dart';
import 'package:http/http.dart' as http;

// Top-level function required for compute()
List<User> parseUsers(String responseBody) {
  final parsed = (jsonDecode(responseBody) as List<dynamic>).cast<Map<String, dynamic>>();
  return parsed.map<User>((json) => User.fromJson(json)).toList();
}

Future<List<User>> fetchUsers(http.Client client) async {
  final response = await client.get(
    Uri.parse('https://api.example.com/users'),
    headers: {'Accept': 'application/json'},
  );

  if (response.statusCode == 200) {
    // Offload expensive parsing to a background isolate
    return compute(parseUsers, response.body);
  } else {
    throw Exception('Failed to load users');
  }
}