fromJsonコンストラクタ

CoddyのFlutterジャーニー「データとネットワーク」セクションの一部。レッスン 17/27。

画面のあちこちでuser['name'] as Stringを読み取っているとコードが煩雑になり、キーを一箇所でもタイプミスすると動かなくなります。一般的な解決策は、データ用のクラスを作り、JSONを扱うコンストラクターを用意することです。これはfromJsonと呼ばれます。

class User {
  User({required this.name, required this.age});

  final String name;
  final int age;

  factory User.fromJson(Map<String, dynamic> json) {
    return User(
      name: json['name'] as String,
      age: json['age'] as int,
    );
  }
}

User.fromJsonは名前付きコンストラクターであり、Userを作成するもう一つの方法です。factoryを使うと、コンストラクター内でコードを実行し、組み立てたオブジェクトをreturnできます。通常のコンストラクターは何もreturnできません。

これでJSONの読み取り処理を一箇所にまとめられます。アプリの残りの部分では、実際のUserを使えるようになり、user.nameはStringになります。また、タイプミスはnullになるのではなく、コンパイルエラーになります。

final body = await fetch('/user');
return User.fromJson(jsonDecode(body));

サーバーと通信するアプリのほとんどすべてに、受け取るデータの種類ごとにfromJsonがあります。

チャレンジ

難しい

プロフィールにはUnknownと表示されています。loadUserはJSONを無視しています。Userに、name、email、ageを読み取るfactory User.fromJson(Map<String, dynamic> json)を追加し、loadUserがUser.fromJson(jsonDecode(body))を返すようにしてください。dart:convertをインポートしてください。

自分で試してみよう

import 'package:flutter/material.dart';

import 'api.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(
      debugShowCheckedModeBanner: false,
      home: ProfileScreen(),
    );
  }
}

class ProfileScreen extends StatefulWidget {
  const ProfileScreen({super.key});

  @override
  State<ProfileScreen> createState() => _ProfileScreenState();
}

class _ProfileScreenState extends State<ProfileScreen> {
  late Future<User> _user;

  @override
  void initState() {
    super.initState();
    _user = loadUser();
  }

  Future<User> loadUser() async {
    final body = await fetch('/user');
    print(body);
    return User(name: 'Unknown', email: 'unknown', age: 0);
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Profile')),
      body: Center(
        child: FutureBuilder<User>(
          future: _user,
          builder: (context, snapshot) {
            if (snapshot.hasError) {
              return Text('Could not load: ${snapshot.error}');
            }
            if (snapshot.hasData) {
              final user = snapshot.data!;
              return Column(
                mainAxisSize: MainAxisSize.min,
                children: [
                  Text(
                    user.name,
                    style: const TextStyle(fontSize: 28, fontWeight: FontWeight.bold),
                  ),
                  const SizedBox(height: 8),
                  Text(user.email, style: const TextStyle(fontSize: 18)),
                  const SizedBox(height: 8),
                  Text('${user.age} years old'),
                ],
              );
            }
            return const CircularProgressIndicator();
          },
        ),
      ),
    );
  }
}

class User {
  User({required this.name, required this.email, required this.age});

  final String name;
  final String email;
  final int age;
}