Flutter快速启动与配置插件wahyz_bootstrap的使用

本文档将详细介绍如何快速启动并配置 wahyz_bootstrap 插件。通过以下步骤，您可以轻松集成该插件到您的 Flutter 项目中。

1. 初始化 Flutter 项目

首先，确保您的 Flutter 环境已正确安装，并创建一个新的 Flutter 项目：

flutter create wahyz_bootstrap_example
cd wahyz_bootstrap_example

2. 添加依赖项

在 pubspec.yaml 文件中添加 wahyz_bootstrap 和其他必要的依赖项：

dependencies:
  flutter:
    sdk: flutter
  hooks_riverpod: ^2.0.0 # Riverpod 状态管理库
  firebase_core: ^2.0.0 # Firebase 核心库
  wahyz_bootstrap: ^1.0.0 # wahyz_bootstrap 插件

运行以下命令以更新依赖项：

flutter pub get

3. 配置 Firebase

在项目的根目录下，初始化 Firebase 并生成配置文件：

firebase init

根据提示选择您的项目，并下载生成的配置文件（如 google-services.json 或 GoogleService-Info.plist），将其放置在项目的 android/app 或 ios/Runner 目录中。

在 main.dart 中初始化 Firebase：

import 'package:firebase_core/firebase_core.dart';
import 'package:flutter/material.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Firebase.initializeApp();
  runApp(MyApp());
}

4. 使用 wahyz_bootstrap 插件

在 main.dart 文件中，配置 wahyz_bootstrap 插件。以下是完整的示例代码：

// 引入必要的包
import 'package:flutter/material.dart';
import 'package:hooks_riverpod/hooks_riverpod.dart';
import 'package:wahyz_bootstrap/domain/models/base/model_registry.dart';
import 'package:wahyz_bootstrap/domain/models/concrete_model_factory/firestore_user_factory.dart';
import 'package:wahyz_bootstrap/domain/models/concrete_model_factory/reservation_factory.dart';
import 'package:wahyz_bootstrap/domain/models/firestore_user.dart';
import 'package:wahyz_bootstrap/domain/models/reservation.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // 初始化 Firebase
  await Firebase.initializeApp();

  // 启动应用
  runApp(const ProviderScope(child: MyApp()));
}

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

  @override
  Widget build(BuildContext context, WidgetRef ref) {
    // 注册模型工厂
    ref.watch(baseModelGeneralRegistryProvider.notifier)
      ..register<Reservation>(
        factory: ref.watch(reservationFactoryProvider.notifier),
      )
      ..register<Ksmer>(
        factory: ref.watch(ksmerFactoryProvider.notifier),
      )
      ..register<Vehicle>(
        factory: ref.watch(vehicleFactoryProvider.notifier),
      )
      ..register<FirestoreUser>(
        factory: ref.watch(firestoreUserFactoryProvider.notifier),
      );

    // 获取路由配置
    final goRouter = ref.watch(goRouterProvider);

    // 打印所有路由配置
    debugPrint("[[goRouter]]: ${goRouter.configuration.routes}");

    return _EagerInitialization(
      child: MaterialApp.router(
        debugShowCheckedModeBanner: false,
        title: 'KSM Omniverse App',
        routerConfig: goRouter,
        theme: ThemeData(
          colorScheme: ColorScheme.fromSeed(seedColor: Colors.blue),
          useMaterial3: true,
        ),
      ),
    );
  }
}

// 确保所有 Provider 在应用启动时被初始化
class _EagerInitialization extends ConsumerWidget {
  const _EagerInitialization({required this.child});
  final Widget child;

  @override
  Widget build(BuildContext context, WidgetRef ref) {
    // 调用 Providers 以确保它们不会被释放
    debugPrint("[[baseModelRegistryProvider]]: ${ref.watch(baseModelGeneralRegistryProvider)}");
    return child;
  }
}

5. 运行应用

确保所有依赖项已正确配置后，运行应用：

flutter run