Flutter统一认证插件uni_auth的使用

Flutter统一认证插件uni_auth的使用

由UNICODE团队开发

UniAuth 是一个为Flutter应用程序设计的包，用于处理认证模块。它集成了各种认证服务，主要专注于Firebase Auth进行认证和Unifonic用于发送和验证一次性密码（OTP）。

特性

• 使用Firebase Authentication实现无缝登录和注册。
• 集成Unifonic进行基于OTP的认证。
• 全面的错误处理和用户反馈。
• 高度可定制以适应各种认证场景。

开始使用

要在您的Flutter项目中使用UniAuth，请按照以下步骤操作：

安装

1. 在pubspec.yaml文件中添加UniAuth：

   dependencies:
     uni_auth: latest_version
   

2. 运行flutter pub get来安装包。

使用

在Dart文件中导入UniAuth：

import 'package:uni_auth/uni_auth.dart';

初始化UniAuth及其Firebase实例和baseUrl：

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  // 首先需要初始化你的firebase应用
  await Firebase.initializeApp(options: DefaultFirebaseOptions.currentPlatform);
  // 然后初始化UniAuth包和baseUrl以及本地语言选项
  UniAuth.init(
    auth: FirebaseAuth.instance,
    locale: const Locale('en'), // 可选
    baseUrl: 'YOUR_BASE_URL',
  );

  runApp(const MyApp());
}

一些方法示例

创建用户通过电子邮件和密码：

await UniAuthService.createUserWithEmail(
        authData: AuthData(
          email: 'YOUR_EMAIL', // 替换为实际邮箱
          password: 'YOUR_PASSWORD', // 替换为实际密码
        ),
      );

检查用户是否已登录：

UniAuthService.checkUserLoggedIn;

发送和验证OTP：

UniAuthService.sendOTP(AuthData());
UniAuthService.verifyOTP(AuthData());

通过令牌登录：

UniAuthService.loginWithToken(token: 'YOUR_TOKEN');

示例

下面是一个完整的示例演示如何使用UniAuth：

import 'package:firebase_auth/firebase_auth.dart';
import 'package:flutter/material.dart';
import 'package:uni_auth/uni_auth.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  // 初始化Firebase应用
  // await Firebase.initializeApp(options: DefaultFirebaseOptions.currentPlatform);
  UniAuth.init(
    auth: FirebaseAuth.instance,
    locale: const Locale('en'),
    baseUrl: 'YOUR_BASE_URL',
  );

  runApp(const MyApp());
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      debugShowCheckedModeBanner: false,
      title: 'Uni-Auth-Example',
      home: Scaffold(
        appBar: AppBar(
          backgroundColor: Colors.teal,
          title: const Text('Uni-Auth-Example',
              style: TextStyle(color: Colors.white)),
        ),
        body: Padding(
          padding: const EdgeInsets.all(14),
          child: Column(
            crossAxisAlignment: CrossAxisAlignment.start,
            children: [
              const Text('Create User With Email & Password'),
              ElevatedButton(
                onPressed: () async {
                  final result = await UniAuthService.createUserWithEmail(
                    authData: AuthData(
                      email: 'YOUR_EMAIL', // 替换为实际邮箱
                      password: 'YOUR_PASSWORD', // 替换为实际密码
                    ),
                  );
                  if (result.isSuccess) {
                    debugPrint('User Created : ${result.user}');
                  } else {
                    debugPrint('Error : ${result.errorMessage}');
                  }
                },
                child: const Text('Create User'),
              ),
              const Text('Check If User Logged In'),
              ElevatedButton(
                onPressed: () async {
                  final result = UniAuthService.checkUserLoggedIn;
                  debugPrint('User Logged In : $result');
                },
                child: const Text('Check If User Logged In'),
              ),
              const SizedBox(height: 10),
              CheckSignInState(
                holder: const Text('Check If User Logged In Wrapper Builder'),
                onLoggedIn: () {
                  debugPrint('User Logged In');
                },
                onNotLoggedIn: () {
                  debugPrint('User Not Logged In');
                },
              ),
            ],
          ),
        ),
      ),
    );
  }
}