非同期初期化が必要なRiverpodプロバイダの初期化方法

@Riverpod(keepAlive: true)
Future<SharedPreferences> sharedPreferences(Ref ref) async {
  return SharedPreferences.getInstance();
}

// Futureとしてインスタンスを取得する場合。
final sp = await ref.read(sharedPreferencesProvider.future);
// SharedPreferencesのインスタンスを通じた値の取得だけなら非同期処理である必要はない。
final value = sp.getString('some_key');

// AsyncValueとしてインスタンスを取得する場合。
final asyncValue = ref.watch(sharedPreferencesProvider);
asyncValue.when(
  loading: () => CircularProgressIndicator(),
  error: (e, s) => Text('error: $e'),
  data: (sp) => SomeWidget(title: sp.getString('key')),
);

@Riverpod(keepAlive: true)
SharedPreferences sharedPreferences(Ref ref) {
  // 上書きを忘れた場合は例外が投げられるようにしておくのがオススメ。
  throw UnimplementedError();
}

// awaitを使用するためにmain関数を非同期関数として宣言する。
Future<void> main() async {
  late final SharedPreferences sp;
  late final PackageInfo pi;
  // 並列実行。Recordsを使った書き方でも可。
  await Future.wait([
    // awaitを使ってインスタンスを取得。
    Future(() async => sp = await SharedPreferences.getInstance()),
    Future(() async => pi = await PackageInfo.fromPlatform()),
  ]);

  runApp(
    ProviderScope(
      overrides: [
        // 先ほどawaitして取得したインスタンスでプロバイダを上書き。
        sharedPreferencesProvider.overrideWithValue(sp),
        packageInfoProvider.overrideWithValue(pi),
      ],
      child: MyApp(),
    ),
  );
}

final sp = ref.read(sharedPreferencesProvider);
final value = sp.getString('some_key');

@Riverpod(keepAlive: true)
Future<void> initialization(Ref ref) async {
  ref.onDispose(() {
    // ref.invalidate(initializationProvider);
    // を実行した時に諸々のプロバイダも破棄するようにする。
    // ログアウト時などに使う想定。
    ref
      ..invalidate(sharedPreferencesProvider)
      ..invalidate(packageProvider);
  });
  // 並列実行しても良い初期化処理はここに書く。
  await Future.wait([
    ref.watch(sharedPreferencesProvider.future),
    ref.watch(packageProvider.future),
  ]);
  // 他、任意の初期化処理を行う。
}

/// アプリで最初に表示するFlutterページ
class InitializationPage extends ConsumerWidget {
  const InitializationPage({super.key, required this.onInitialized});

  final WidgetBuilder onInitialized;

  @override
  Widget build(BuildContext context, WidgetRef ref) {
    final asyncValue = ref.watch(initializationProvider);
    return asyncValue.when(
      // 初期化中に表示するWidgetを指定。
      loading: () => const _LoadingPage(),
      // 初期化処理でエラーが発生した場合はエラーページを表示してリトライボタンも設置したい。
      error: (e, st) => _ErrorPage(
        message: e.toString(),
        // 初期化でエラーが発生した場合は初期化用プロバイダを再読み込みする。
        onRetry: () => ref.invalidate(initializationProvider),
      ),
      // 初期化が成功した場合は、引数で指定されたWidgetを表示できるようにしています。
      data: (_) => onInitialized(context),
    );
  }
}

void main() {
  runApp(
    const ProviderScope(
      child: MaterialApp(
        home: InitializationPage(
          onInitialized: () => MainApp(),
        ),
      ),
    )
  );
}

final sp = ref.read(sharedPreferencesProvider).requireValue;
final someValue = sp.getString('some_key');

import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:package_info_plus/package_info_plus.dart';
import 'package:riverpod_annotation/riverpod_annotation.dart';

part 'package_info_provider.g.dart';

/// 初期化用のプロバイダ。
@Riverpod(keepAlive: true)
Future<PackageInfo> packageInfoInitializing(Ref ref) async =>
    PackageInfo.fromPlatform();

/// 初期化後、アプリで実際に使用するプロバイダ。
@Riverpod(keepAlive: true)
PackageInfo packageInfo(Ref ref) =>
    ref.watch(packageInfoInitializingProvider).requireValue;

@Riverpod(keepAlive: true)
Future<void> initialization(Ref ref) async {
  ref.onDispose(() {
    // 初期化用のプロバイダを破棄する。
    // 実際に使用するプロバイダも、初期化用プロバイダに依存しているので破棄される。
    ref
      ..invalidate(sharedPreferencesInitializingProvider)
      ..invalidate(packageInfoInitializingProvider)
      ..invalidate(userDeviceInitializingProvider);
  });
  await Future.wait([
    ref.watch(sharedPreferencesInitializingProvider.future),
    ref.watch(packageInfoInitializingProvider.future),
    ref.watch(userDeviceInitializingProvider.future),
  ]);
  // 他、任意の初期化処理を行う。
}

final sp = ref.read(sharedPreferencesProvider);
final someValue = sp.getString('some_key');

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

  @override
  Widget build(BuildContext context, WidgetRef ref) {
    return MaterialApp.router(
      routerConfig: ref.watch(routerProvider),
      builder: (context, child) {
        return InitializationPage(onInitialized: (_) => child!);
      },
    );
  }
}