Flutter插件faui的介绍与使用

Flutter插件faui的介绍与使用

faui 是一个用于 Flutter 的认证 UI 库。它通过 Firebase 安全服务（SECaaS）以电子邮件和密码的方式注册用户。该库提供了注册用户、验证电子邮件、登录、登出以及恢复密码的功能，并支持静默登录和访问 Firestore。

示例代码

以下是一个完整的示例代码，展示如何在 Flutter 中使用 faui 插件。

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

void main() async {
  // 在 runApp 之前初始化 Flutter binding
  WidgetsFlutterBinding.ensureInitialized();

  // 配置 Firebase API 密钥
  await fauiTrySignInSilently(firebaseApiKey: 'AIzaSyA3hshWKqeogfYiklVCCtDaWJW8TfgWgB4');

  runApp(MyApp());
}

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  @override
  Widget build(BuildContext context) {
    // 如果用户未登录，则显示认证屏幕
    if (fauiUser == null) {
      return fauiBuildAuthScreen(
        onExit: () {
          setState(() {});
        },
        firebaseApiKey: 'AIzaSyA3hshWKqeogfYiklVCCtDaWJW8TfgWgB4',
      );
    }

    // 用户已登录，显示主应用界面
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('主页面')),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              Text('欢迎回来，${fauiUser.email}！'),
              ElevatedButton(
                onPressed: () {
                  // 登出操作
                  fauiSignOut();
                },
                child: Text('登出'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}

步骤说明

1. 创建 Firebase 项目

   • 登录 Firebase 控制台。
   • 创建新项目并启用“电子邮件/密码”登录方式。
   • 获取项目的 Web API 密钥。

2. 添加依赖 在 pubspec.yaml 文件中添加 faui 依赖：

   dependencies:
     faui: ^最新版本号

   替换 <最新版本号> 为实际的最新版本号，可以在 pub.dev 上查看。

3. 初始化与配置 在 main() 函数中初始化 Flutter binding 并尝试静默登录：

   WidgetsFlutterBinding.ensureInitialized();
   await fauiTrySignInSilently(firebaseApiKey: '您的API密钥');

4. 构建认证屏幕 使用 fauiBuildAuthScreen 构建认证屏幕：

   fauiBuildAuthScreen(
     onExit: () {
       setState(() {});
     },
     firebaseApiKey: '您的API密钥',
   );

5. 获取用户信息 通过 fauiUser.email 获取当前用户的邮箱：

   fauiUser.email

6. 登出操作 使用 fauiSignOut() 执行登出操作：

   fauiSignOut();

7. 静默登录 在首次运行时调用 fauiTrySignInSilently 进行静默登录，并保存用户信息以便后续使用：

   WidgetsFlutterBinding.ensureInitialized();
   await fauiTrySignInSilently(firebaseApiKey: '您的API密钥');
   fauiSaveUserLocallyForSilentSignIn();

自定义布局和语言

如果需要自定义 UI 或语言，可以使用 fauiBuildCustomAuthScreen 方法。更多细节可以参考 GitHub 示例。

访问 Firestore 数据

要使用用户令牌访问 Firestore 数据，首先配置 Firestore 的安全规则，然后使用 FauiDbAccess 类。更多细节可以参考 GitHub 示例。

贡献代码

如果您想贡献代码，可以通过运行以下命令执行测试：

flutter pub run test