5. Repository

Bundling DB reads and writes in one place

Goals of this chapter

1

Create Repositories

Reading/writing users and sessions

2

Connect the list to the DB

Survives app restarts

3

Detail screen

Show the measurement history

What is a Repository?

  • Only Repositories write drift queries (select / into, etc.)
  • The ViewModel just calls getAll() or create(...)
  • With @DriftAccessor, the tables it handles can be used by names like users

flowchart LR
  VM["ViewModel"] -- "getAll()" --> R["UserRepository"]
  R -- "select(users)" --> DB[("AppDatabase")]

UserRepository

lib/repository/user/user_repository.dart
import 'package:drift/drift.dart';
import 'package:motion_app/infrastructure/database/app_database.dart';
import 'package:motion_app/infrastructure/database/tables.dart';
import 'package:uuid/uuid.dart';

part 'user_repository.g.dart';

@DriftAccessor(tables: [Users])
class UserRepository extends DatabaseAccessor<AppDatabase>
    with _$UserRepositoryMixin {
  UserRepository(super.attachedDatabase);

  Future<List<User>> getAll() =>
      (select(users)..orderBy([(t) => OrderingTerm.asc(t.createdAt)])).get();

  Future<User?> getById(String id) =>
      (select(users)..where((t) => t.id.equals(id))).getSingleOrNull();

  Future<User> create({required String name}) async {
    final user = User(
      id: const Uuid().v4(),
      name: name,
      createdAt: DateTime.now(),
    );
    await into(users).insert(user);
    return user;
  }

  // Renamed because the parent class already has delete(table)
  Future<void> deleteUser(String id) =>
      (delete(users)..where((t) => t.id.equals(id))).go();
}

The names update / delete can’t be used

The parent class has methods with the same names, so use a different name such as deleteUser.

SessionRepository

lib/repository/session/session_repository.dart
import 'package:drift/drift.dart';
import 'package:motion_app/infrastructure/database/app_database.dart';
import 'package:motion_app/infrastructure/database/tables.dart';
import 'package:uuid/uuid.dart';

part 'session_repository.g.dart';

@DriftAccessor(tables: [Sessions])
class SessionRepository extends DatabaseAccessor<AppDatabase>
    with _$SessionRepositoryMixin {
  SessionRepository(super.attachedDatabase);

  Future<void> add({
    required String userId,
    required double durationSec,
    required int sampleCount,
    required double peakGyro1,
    required double peakGyro2,
    required double peakAcc1,
    required double peakAcc2,
  }) {
    return into(sessions).insert(SessionsCompanion.insert(
      id: const Uuid().v4(),
      userId: userId,
      durationSec: durationSec,
      sampleCount: sampleCount,
      peakGyro1: peakGyro1,
      peakGyro2: peakGyro2,
      peakAcc1: peakAcc1,
      peakAcc2: peakAcc2,
      recordedAt: DateTime.now(),
    ));
  }

  // newest first
  Future<List<Session>> getByUser(String userId) => (select(sessions)
        ..where((t) => t.userId.equals(userId))
        ..orderBy([(t) => OrderingTerm.desc(t.recordedAt)]))
      .get();
}

Register them as Providers

lib/provider/providers.dart
import 'package:riverpod_annotation/riverpod_annotation.dart';
import 'package:motion_app/infrastructure/database/app_database.dart';
import 'package:motion_app/repository/session/session_repository.dart';
import 'package:motion_app/repository/user/user_repository.dart';

part 'providers.g.dart';

@Riverpod(keepAlive: true)
AppDatabase appDatabase(Ref ref) {
  final db = AppDatabase();
  ref.onDispose(db.close);
  return db;
}

@Riverpod(keepAlive: true)
UserRepository userRepository(Ref ref) =>
    UserRepository(ref.watch(appDatabaseProvider));

@Riverpod(keepAlive: true)
SessionRepository sessionRepository(Ref ref) =>
    SessionRepository(ref.watch(appDatabaseProvider));
  • Don’t forget the imports (if any are missing, providers.g.dart isn’t generated and errors cascade)

Connect the list ViewModel to the DB

lib/ui/user_list/view_model/user_list_view_model.dart
import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';
import 'package:motion_app/infrastructure/database/app_database.dart';
import 'package:motion_app/provider/providers.dart';

part 'user_list_view_model.g.dart';
part 'user_list_view_model.freezed.dart';

@freezed
abstract class UserListState with _$UserListState {
  const factory UserListState({
    @Default([]) List<User> users,
    @Default(true) bool isLoading,
    String? errorMessage,
  }) = _UserListState;
}

@riverpod
class UserListViewModel extends _$UserListViewModel {
  @override
  UserListState build() {
    Future.microtask(load); // load when the screen is shown
    return const UserListState();
  }

  Future<void> load() async {
    final users = await ref.read(userRepositoryProvider).getAll();
    if (!ref.mounted) return; // do nothing if the screen was closed while waiting
    state = state.copyWith(users: users, isLoading: false);
  }

  // true if added
  Future<bool> addUser(String name) async {
    final trimmed = name.trim();
    if (trimmed.isEmpty) {
      state = state.copyWith(errorMessage: '名前を入力してください');
      return false;
    }
    await ref.read(userRepositoryProvider).create(name: trimmed);
    if (!ref.mounted) return true;
    state = state.copyWith(errorMessage: null);
    await load();
    return true;
  }
}

Don’t forget ref.mounted

final users = await ref.read(userRepositoryProvider).getAll();
if (!ref.mounted) return; // do nothing if the screen was closed while waiting
state = state.copyWith(users: users, isLoading: false);
  • If the screen is closed while waiting on await, the ViewModel is disposed
  • Using state or ref after disposal causes an error
  • After await, check ref.mounted

The list screen

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: () async {
                    if (await notifier.addUser(nameController.text)) {
                      nameController.clear();
                    }
                  },
                  child: const Text('追加'),
                ),
              ],
            ),
          ),
          Expanded(
            child: state.isLoading
                ? const Center(child: CircularProgressIndicator())
                : ListView(
                    children: [
                      for (final user in state.users)
                        ListTile(
                          leading: const Icon(Icons.person),
                          title: Text(user.name),
                          onTap: () => context.push(Routes.userDetail(user.id)),
                        ),
                    ],
                  ),
          ),
        ],
      ),
    );
  }
}

The detail ViewModel (with an argument)

  • If build takes an argument, as in build(String userId), there is separate state per userId (family)
  • Screens use it as userDetailViewModelProvider(userId)
lib/ui/user_detail/view_model/user_detail_view_model.dart
import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';
import 'package:motion_app/infrastructure/database/app_database.dart';
import 'package:motion_app/provider/providers.dart';

part 'user_detail_view_model.g.dart';
part 'user_detail_view_model.freezed.dart';

@freezed
abstract class UserDetailState with _$UserDetailState {
  const factory UserDetailState({
    User? user,
    @Default([]) List<Session> sessions,
    @Default(true) bool isLoading,
  }) = _UserDetailState;
}

// Holds separate state per userId (family). Screens use it as userDetailViewModelProvider(userId)
@riverpod
class UserDetailViewModel extends _$UserDetailViewModel {
  @override
  UserDetailState build(String userId) {
    Future.microtask(load);
    return const UserDetailState();
  }

  Future<void> load() async {
    final user = await ref.read(userRepositoryProvider).getById(userId);
    final sessions = await ref.read(sessionRepositoryProvider).getByUser(userId);
    if (!ref.mounted) return;
    state = state.copyWith(user: user, sessions: sessions, isLoading: false);
  }
}

The detail screen

lib/ui/user_detail/view/user_detail_page.dart
import 'package:flutter/material.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:intl/intl.dart';
import 'package:motion_app/ui/user_detail/view_model/user_detail_view_model.dart';

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

  final String userId;

  @override
  Widget build(BuildContext context, WidgetRef ref) {
    final state = ref.watch(userDetailViewModelProvider(userId));

    return Scaffold(
      appBar: AppBar(title: Text(state.user?.name ?? '')),
      body: state.isLoading
          ? const Center(child: CircularProgressIndicator())
          : ListView(
              padding: const EdgeInsets.all(16),
              children: [
                const Text('測定履歴'),
                if (state.sessions.isEmpty) const Text('まだ測定していません'),
                for (final s in state.sessions)
                  ListTile(
                    leading: const Icon(Icons.timeline),
                    title: Text('最大角速度 ${s.peakGyro1.toStringAsFixed(0)} / '
                        '${s.peakGyro2.toStringAsFixed(0)} dps'),
                    subtitle: Text(
                        '${DateFormat('yyyy/MM/dd HH:mm').format(s.recordedAt)}'
                        '  ${s.durationSec.toStringAsFixed(1)}秒'),
                  ),
              ],
            ),
    );
  }
}

Checkpoint

CHECK 0 / 4