FireFlow #

• 版本 0.0 和版本 0.1 有很大的不同。特别是核心代码和集合结构发生了变化，因此版本 0.0 和 0.1 不兼容。本文档将随着当前 0.1.x 版本的开发和更新而频繁更新，请注意。

• Fireflow 是为了支持 FlutterFlow 而创建的。因此，尽可能多地与 FlutterFlow 兼容，并遵循 FlutterFlow 的概念。然而，在使用 Flutter 开发时，可以直接使用 Fireflow。

• 在版本 0.1 中提供了所有基本控件。因此，可以快速构建应用程序。首先将基本提供的控件连接到自定义控件，然后逐步进行 UI 定制。

• 如果您需要版本 0.0.x 的源代码，请参阅 0.0.x 分支。

• 聊天室相关功能开发暂时停止。

  • 无法通过 Firestore 实现聊天室功能。
  • 例如，如果聊天室有 1000 名用户，并且同时有 100 人在线聊天，则每次聊天都会导致大量更新，这会导致高昂的成本。
  • 考虑使用实时数据库来实现聊天功能。

编码指南 #

• 在各种对话框中，尽可能不自动关闭对话框，而是保留回调函数。这样可以在对话框打开后继续显示，并允许在父组件中关闭它。
  • 此时，回调函数应统一为 onError、onCancel 和 onSuccess。

初始化 #

• 在启动应用时，调用 AppService.instance.init()。此操作只需要在 navstack 的最底层页面（根页面）执行一次。

class _MyAppState extends State<MyApp> {
  [@override](/user/override)
  void initState() {
    super.initState();
    _router = createRouter();

    WidgetsBinding.instance.addPostFrameCallback((timeStamp) {
      navigatorKey = _router.routerDelegate.navigatorKey;

      AppService.instance.init(
        context: navigatorKey.currentContext,
        debug: true,
        moveUserPrivateDataTo: 'users_private_data',
        onChat: (UserModel user) => _router.pushNamed(
          ChatRoomScreen.routeName,
          queryParams: {
            'chatRoomDocumentId': ChatService.instance
                .getSingChatRoomReference(user.reference)
                .id,
          },
        ),
      );
    });
  }
}

示例代码

import 'package:example/firebase_options.dart';
import 'key.dart';
import 'package:example/router.dart';
import 'package:firebase_core/firebase_core.dart';
import 'package:fireflow/fireflow.dart';
import 'package:flutter/material.dart';
import 'package:flutter/scheduler.dart';
import 'package:supabase_flutter/supabase_flutter.dart';
import 'package:go_router/go_router.dart';

import 'package:flutter_localizations/flutter_localizations.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Firebase.initializeApp(options: DefaultFirebaseOptions.currentPlatform);

  await Supabase.initialize(
    url: 'https://crhqrbyjksnyqdrpqedr.supabase.co',
    anonKey: supabaseAnonKey,
  );
  runApp(const MyApp());
}

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

  [@override](/user/override)
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  [@override](/user/override)
  void initState() {
    super.initState();

    SchedulerBinding.instance.addPostFrameCallback((timeStamp) {
      AppService.instance.init(
        context: router.routerDelegate.navigatorKey.currentContext!,
        debug: true,
        displayError: true,
        noOfRecentPosts: 4,
        supabase: SupabaseOptions(
          usersPublicData: 'users_public_data',
          posts: 'posts',
          comments: 'comments',
          postsAndComments: 'posts_and_comments',
        ),
        messaging: MessagingOptions(
          foreground: true,
          background: true,
          onTap: (String initialPageName, Map<String, String> parameterData) {
            dog('on message tap: $initialPageName, Map<String, String> $parameterData');
            AppService.instance.context
                .pushNamed(initialPageName, queryParams: parameterData);
          },
        ),
      );
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp.router(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      routerConfig: router,
      locale: null,
      localizationsDelegates: const [
        GlobalMaterialLocalizations.delegate,
        GlobalWidgetsLocalizations.delegate,
        GlobalCupertinoLocalizations.delegate,
      ],
      supportedLocales: const [
        Locale('en'),
        Locale('ko'),
      ],
    );
  }
}

聊天功能示例

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

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

  static const String routeName = '/chatRoom';

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Chat Room'),
      ),
      body: ChatRoomMessageList(
        chatRoomDocumentReference: ChatService.instance.currentChatRoomReference,
        myMessageBuilder: (DocumentSnapshot snapshot) =>
            ChatRoomMessageMine(
          message: ChatRoomMessagesRecord.getDocumentFromData(
            snapshot.data()! as Map<String, dynamic>,
            snapshot.reference,
          ),
        ),
        otherMessageBuilder: (DocumentSnapshot snapshot) =>
            ChatRoomMessageOthers(
          message: ChatRoomMessagesRecord.getDocumentFromData(
            snapshot.data()! as Map<String, dynamic>,
            snapshot.reference,
          ),
        ),
        protocolMessageBuilder: (DocumentSnapshot snapshot) =>
            ChatRoomMessageProtocol(
          message: ChatRoomMessagesRecord.getDocumentFromData(
            snapshot.data()! as Map<String, dynamic>,
            snapshot.reference,
          ),
        ),
        onEmpty: const Text('No messages yet'),
      ),
    );
  }
}

使用者信息更新时重建小部件

import 'package:fireflow/fireflow.dart';

class MyDocWidget extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return AuthStream(
      login: (user) => Text('Logged in as ${user.displayName}'),
      logout: () => Text('Logged out'),
    );
  }
}