Flutter插件altologic的使用_ Altogic 客户端库所有功能的访问

Flutter插件altologic的使用_ Altogic 客户端库所有功能的访问

Altogic Dart

Altogic Dart 是一个用于 Altogic 客户端库的 Dart 客户端，它提供了对 Altogic 客户端库所有功能的访问。该包除了包含 altogic_dart 包外，还包含了一些 Flutter 依赖项。

快速入门

这个快速入门指南将向您展示如何使用客户端库的关键模块在后端应用中执行命令。对于更深入的覆盖，请参阅 Client API 参考。

Flutter 指南和示例

• 您可以查看 快速入门指南 中的身份验证基础。
• 您可以尝试所有方法并在 示例/测试应用程序 中查看代码块。
• 您还可以查看 示例 TO-DO 应用程序 中的基础知识。

额外功能

默认本地存储

AltogicClient 需要一个本地存储实现来保存会话和用户信息。此包提供了一个默认的本地存储实现，使用的是 shared_preferences 包。

import 'package:altogic_dart_flutter/altogic_dart_flutter.dart';

final altogic = createClient(
    'your env url', // 替换为您的环境URL
    'your client key' // 替换为您的客户端密钥
);

自动打开提供商登录URL

AltogicClient 可以自动打开提供商登录URL。您可以使用 AuthManager.signInWithProvider 方法直接打开提供商登录页面。

altogic.auth.signInWithProvider('google'); // 使用Google进行登录

处理重定向URL

在许多身份验证流程/操作中，Altogic 会将用户重定向到特定的URL。例如，在OAuth2流程中，用户通过提供商登录页面登录后，Altogic 会将用户重定向到您在 Altogic Designer > App Settings > Authentication 中指定的重定向URL。

您可以在网站上通过获取打开站点的路径来处理重定向URL。在移动或桌面应用程序中，您可以使用深度链接从重定向URL打开应用程序。

深度链接配置

如果您在应用程序的根部使用 AltogicState，则 AltogicState 将在整个应用程序生命周期内“挂载”。因此，我们可以监听应用程序恢复或通过深度链接启动时的深度链接。

当应用程序通过深度链接打开时，AltogicState 不能同步通知您深度链接。相反，您可以重写在深度链接打开应用程序时调用的方法。

可用的重写方法包括：onEmailVerificationLink、onMagicLink、onPasswordResetLink、onEmailChangeLink 和 onOauthProviderLink。

AltogicState 提供了一个名为 navigatorObserver 的 getter 来观察导航事件。您可以将 BuildContext 作为参数传递给深度链接方法。如果使用 navigatorObserver，例如 onMagicLink 被调用时带有 context；否则，这些方法中的 BuildContext 将为 null。

class AltogicAuthExampleApp extends StatefulWidget {
  const AltogicAuthExampleApp({Key? key}) : super(key: key);

  [@override](/user/override)
  State<AltogicAuthExampleApp> createState() => _AltogicAuthExampleAppState();
}

class _AltogicAuthExampleAppState extends AltogicState<AltogicAuthExampleApp> {
  [@override](/user/override)
  void onEmailVerificationLink(BuildContext? context, EmailVerificationRedirect redirect) {
    // 处理电子邮件验证链接
  }

  [@override](/user/override)
  void onMagicLink(BuildContext? context, MagicLinkRedirect redirect) {
    // 处理魔法链接
  }

  [@override](/user/override)
  void onPasswordResetLink(BuildContext? context, PasswordResetRedirect redirect) {
    // 处理密码重置链接
  }

  [@override](/user/override)
  void onEmailChangeLink(BuildContext? context, ChangeEmailRedirect redirect) {
    // 处理电子邮件更改链接
  }

  [@override](/user/override)
  void onOauthProviderLink(BuildContext? context, OauthRedirect redirect) {
    // 处理OAuth提供商链接
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      navigatorObservers: [navigatorObserver], // 添加导航观察者
      // ...
    );
  }
}

应用程序未运行时

通常，在应用程序的第一次运行中，许多开发者会显示一个启动屏幕。在这种情况下，如果应用程序通过深度链接启动，AuthState.onX 方法会被触发，并且可能会将用户导航到另一个页面。同时，启动屏幕也会尝试导航到另一个页面，这会导致冲突。

为了避免这种冲突，您可以使用 AltogicState.applicationInitialRedirect 静态 getter：

Future<void> init() async {
  // 检查应用程序是否通过深度链接启动
  var launchedRedirect = await AltogicState.applicationInitialRedirect;
  if (launchedRedirect != null) {
    return;
  }
  // 现在进行导航
}

您可以使用 AltogicState.applicationInitialRedirect getter 代替 AltogicState.onX 方法。但您必须手动监听 ApplicationLifecycle 事件以处理深度链接。

恢复身份验证会话

AltogicClient 可以从本地存储中恢复会话。为此，您可以使用 AltogicClient.restoreAuthSession 方法。

如果应用程序未运行并通过深度链接启动，restoreAuthSession 方法会检查应用程序是否通过深度链接启动。如果应用程序通过深度链接启动，restoreAuthSession 方法将不会从本地存储中恢复会话。（必要时避免冲突）

await altogic.restoreAuthSession();

示例Demo

以下是一个完整的示例 Demo，展示了如何使用 Altogic Dart 插件进行身份验证和处理深度链接。

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

void main() async {
  // 创建 Altogic 客户端实例
  final altogic = createClient(
    'your env url', // 替换为您的环境URL
    'your client key' // 替换为您的客户端密钥
  );

  // 恢复身份验证会话
  await altogic.restoreAuthSession();

  runApp(const MyApp());
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return const MaterialApp(
      home: AltogicAuthExampleApp(),
    );
  }
}

class AltogicAuthExampleApp extends StatefulWidget {
  const AltogicAuthExampleApp({Key? key}) : super(key: key);

  [@override](/user/override)
  State<AltogicAuthExampleApp> createState() => _AltogicAuthExampleAppState();
}

class _AltogicAuthExampleAppState extends AltogicState<AltogicAuthExampleApp> {
  [@override](/user/override)
  void onEmailVerificationLink(BuildContext? context, EmailVerificationRedirect redirect) {
    // 处理电子邮件验证链接
    print('Handling email verification link');
  }

  [@override](/user/override)
  void onMagicLink(BuildContext? context, MagicLinkRedirect redirect) {
    // 处理魔法链接
    print('Handling magic link');
  }

  [@override](/user/override)
  void onPasswordResetLink(BuildContext? context, PasswordResetRedirect redirect) {
    // 处理密码重置链接
    print('Handling password reset link');
  }

  [@override](/user/override)
  void onEmailChangeLink(BuildContext? context, ChangeEmailRedirect redirect) {
    // 处理电子邮件更改链接
    print('Handling email change link');
  }

  [@override](/user/override)
  void onOauthProviderLink(BuildContext? context, OauthRedirect redirect) {
    // 处理OAuth提供商链接
    print('Handling OAuth provider link');
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Altogic Auth Example'),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            ElevatedButton(
              onPressed: () async {
                // 使用Google进行登录
                await altogic.auth.signInWithProvider('google');
              },
              child: const Text('Sign in with Google'),
            ),
            ElevatedButton(
              onPressed: () async {
                // 使用Apple进行登录
                await altogic.auth.signInWithProvider('apple');
              },
              child: const Text('Sign in with Apple'),
            ),
          ],
        ),
      ),
    );
  }
}