3. ルーティング

go_router で画面を行き来する

この章のゴール

1

ホーム画面

ここから各機能へ進む

2

ルーターを定義

go_router を Riverpod で提供

3

詳細画面へ遷移

パラメータ付きのパス

画面の構成

flowchart LR
  H["/ ホーム"] --> U["/users<br/>ユーザー一覧"]
  U --> D["/users/:userId<br/>ユーザー詳細"]

  • 子ルートは親のパスにつながる(/users の子は /users/xxx)
  • :userId の部分はパラメータとして受け取れる

ルーターの定義

lib/router/router.dart
import 'package:go_router/go_router.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';
import 'package:motion_app/ui/home/view/home_page.dart';
import 'package:motion_app/ui/user_detail/view/user_detail_page.dart';
import 'package:motion_app/ui/user_list/view/user_list_page.dart';

part 'router.g.dart';

// パスは定数にまとめ、文字列の打ち間違いを防ぐ
abstract final class Routes {
  static const home = '/';
  static const users = '/users';
  static String userDetail(String userId) => '/users/$userId';
}

@Riverpod(keepAlive: true)
GoRouter router(Ref ref) {
  return GoRouter(
    initialLocation: Routes.home,
    routes: [
      GoRoute(
        path: Routes.home,
        builder: (context, state) => const HomePage(),
        routes: [
          GoRoute(
            path: 'users', // 子ルートは先頭に / を付けない
            builder: (context, state) => const UserListPage(),
            routes: [
              GoRoute(
                path: ':userId',
                builder: (context, state) => UserDetailPage(
                  userId: state.pathParameters['userId']!,
                ),
              ),
            ],
          ),
        ],
      ),
    ],
  );
}

アプリに組み込む

  • MaterialApp を MaterialApp.router に変える
  • routerConfig に Riverpod で作ったルーターを渡す
lib/app.dart
import 'package:flutter/material.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:motion_app/router/router.dart';

class App extends ConsumerWidget {
  const App({super.key});

  @override
  Widget build(BuildContext context, WidgetRef ref) {
    return MaterialApp.router(
      title: 'Motion Note',
      theme: ThemeData(colorSchemeSeed: Colors.teal),
      routerConfig: ref.watch(routerProvider),
    );
  }
}

ホーム画面

lib/ui/home/view/home_page.dart
import 'package:flutter/material.dart';
import 'package:go_router/go_router.dart';
import 'package:motion_app/router/router.dart';

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

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('Motion Note')),
      body: ListView(
        padding: const EdgeInsets.all(16),
        children: [
          Card(
            child: ListTile(
              leading: const Icon(Icons.people),
              title: const Text('ユーザー'),
              trailing: const Icon(Icons.chevron_right),
              onTap: () => context.push(Routes.users),
            ),
          ),
        ],
      ),
    );
  }
}

詳細画面

lib/ui/user_detail/view/user_detail_page.dart
import 'package:flutter/material.dart';

class UserDetailPage extends StatelessWidget {
  const UserDetailPage({super.key, required this.userId});

  final String userId;

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: const Text('ユーザー詳細')),
      body: Center(child: Text('ID: $userId')),
    );
  }
}

一覧から詳細へ進む

lib/ui/user_list/view/user_list_page.dart
import 'package:flutter/material.dart';
import 'package:flutter_hooks/flutter_hooks.dart';
import 'package:go_router/go_router.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:motion_app/router/router.dart';
import 'package:motion_app/ui/user_list/view_model/user_list_view_model.dart';

class UserListPage extends HookConsumerWidget {
  const UserListPage({super.key});

  @override
  Widget build(BuildContext context, WidgetRef ref) {
    final state = ref.watch(userListViewModelProvider);
    final notifier = ref.read(userListViewModelProvider.notifier);
    final nameController = useTextEditingController();

    return Scaffold(
      appBar: AppBar(title: const Text('ユーザー一覧')),
      body: Column(
        children: [
          Padding(
            padding: const EdgeInsets.all(16),
            child: Row(
              children: [
                Expanded(
                  child: TextField(
                    controller: nameController,
                    decoration: InputDecoration(
                      labelText: '名前',
                      errorText: state.errorMessage,
                    ),
                  ),
                ),
                const SizedBox(width: 16),
                FilledButton(
                  onPressed: () {
                    if (notifier.addUser(nameController.text)) {
                      nameController.clear();
                    }
                  },
                  child: const Text('追加'),
                ),
              ],
            ),
          ),
          Expanded(
            child: ListView(
              children: [
                for (final (i, name) in state.names.indexed)
                  ListTile(
                    leading: const Icon(Icons.person),
                    title: Text(name),
                    onTap: () => context.push(Routes.userDetail('$i')),
                  ),
              ],
            ),
          ),
        ],
      ),
    );
  }
}
  • .indexed で「何番目か(i)」と名前を同時に取り出し、番号を ID として渡す(5章で本物の ID に変える)

画面遷移の使い分け

やりたいこと 書き方
進む(戻るボタンで戻れる) context.push(Routes.users)
画面を切り替える(履歴を置き換え) context.go(Routes.home)
戻る context.pop()
戻り値を受け取る await context.push<bool>(...) / context.pop(true)

画面遷移は View で

ViewModel に BuildContext やルーターを渡さず、ViewModel は結果を返すだけ、遷移は View が行います。

チェックポイント

CHECK 0 / 3