Flutter Firebase Admin管理插件dart_firebase_admin_plus的使用

Flutter Firebase Admin管理插件dart_firebase_admin_plus的使用

欢迎使用此项目！这是一个将 Node 的 Firebase Admin SDK 移植到 Dart 的项目。

⚠️ 注意：该项目仍处于早期阶段，某些功能可能缺失或存在错误。目前仅支持 Firestore，更多功能（如认证）即将推出。

目录

• Dart Firebase Admin
• 开始使用
• Firestore
• 认证
• 可用功能
• 消息传递

开始使用

在使用 Firebase 之前，我们首先需要进行身份验证。

目前有两种选择：

• 使用环境变量连接
• 指定一个 service-account.json 文件

使用环境变量连接

要通过环境变量连接，你需要安装 Firebase CLI。

完成后，你可以运行：

firebase login

然后登录到你选择的项目。

从那里，你可以让你的 Dart 程序通过环境变量进行身份验证：

import 'package:dart_firebase_admin/dart_firebase_admin.dart';

void main() {
  final admin = FirebaseAdminApp.initializeApp(
    '<你的项目名称>',
    // 这将从环境中获取身份验证信息
    Credential.fromApplicationDefaultCredentials(),
  );

  // TODO 使用 Admin SDK
  final firestore = Firestore(admin);
  firestore.doc('hello/world').get();
}

使用 service-account.json 文件连接

另外，你可以选择使用 service-account.json 文件。

此文件可以在 Firebase 控制台中获得。访问以下 URL：

https://console.firebase.google.com/u/0/project/<你的项目名称>/settings/serviceaccounts/adminsdk

确保将 <你的项目名称> 替换为你的项目名称。在那里，按照步骤下载文件并将其放置在你的项目中的任何位置。

⚠️ 注意： 此文件应保持私密。不要将其提交到公共仓库。

完成后，你可以在 Dart 程序中使用以下方式认证：

import 'package:dart_firebase_admin/dart_firebase_admin.dart';

Future<void> main() async {
  final admin = FirebaseAdminApp.initializeApp(
    '<你的项目名称>',
    // 使用新下载的文件登录。
    Credential.fromServiceAccount(
      File('<路径到你的 service-account.json 文件>'),
    ),
  );

  // TODO 使用 Admin SDK
  final firestore = Firestore(admin);
  firestore.doc('hello/world').get();

  // 别忘了在程序结束时关闭 Admin SDK
  await admin.close();
}

Firestore

使用方法

首先，确保遵循 如何认证 的步骤。你应该现在有一个 FirebaseAdminApp 对象的实例。

你可以使用该对象创建一个 Firestore 对象，如下所示：

// 在前面的步骤中获得
FirebaseAdminApp admin;
final firestore = Firestore(admin);

从此以后，使用 Firestore 与 Admin SDK 类似于使用 FlutterFire。

使用此 Firestore 对象，你会找到常见的集合/查询/文档对象。

例如，你可以执行 where 查询：

// 以下列出了所有年龄大于18岁的用户
final collection = firestore.collection('users');
final adults = collection.where('age', WhereFilter.greaterThan, 18);

final adultsSnapshot = await adults.get();

for (final adult in adultsSnapshot.docs) {
  print(adult.data()['age']);
}

复合查询也受支持：

// 列出名字为John或Jack的用户
firestore
  .collection('users')
  .whereFilter(
    Filter.or([
      Filter.where('firstName', WhereFilter.equal, 'John'),
      Filter.where('firstName', WhereFilter.equal, 'Jack'),
    ]),
  );

你也可以获取特定文档：

// 打印ID为"123"的用户的年龄
final user = await firestore.doc('users/123').get();
print(user.data()?['age']);

支持的功能

认证

使用方法

首先，确保遵循 如何认证 的步骤。你应该现在有一个 FirebaseAdminApp 对象的实例。

你可以使用该对象创建一个 Auth 对象，如下所示：

// 在前面的步骤中获得
FirebaseAdminApp admin;
final auth = Auth(admin);

然后，你可以使用这个 Auth 对象执行各种认证操作。例如，你可以生成密码重置链接：

final link = await auth.generatePasswordResetLink(
  'hello@example.com',
);

支持的功能

可用功能

消息传递

使用方法

首先，确保遵循 如何认证 的步骤。你应该现在有一个 FirebaseAdminApp 对象的实例。

然后，你可以创建一个 Messaging 实例，如下所示：

// 在前面的步骤中获得
FirebaseAdminApp admin;
final messaging = Messaging(admin);

然后，你可以使用这个 Messaging 对象与 Firebase 消息传递进行交互。例如，如果你想向特定设备发送通知，可以这样做：

await messaging.send(
  TokenMessage(
    // 目标设备的token
    // 这个token可以通过使用FlutterFire的firebase_messaging获得：
    // https://pub.dev/documentation/firebase_messaging/latest/firebase_messaging/FirebaseMessaging/getToken.html
    token: "<目标设备的token>",
    notification: Notification(
      // 通知的内容
      title: 'Hello',
      body: 'World',
    ),
  ),
);

支持的功能

完整示例

以下是完整的示例代码：

import 'package:dart_firebase_admin/dart_firebase_admin.dart';
import 'package:dart_firebase_admin/firestore.dart';
import 'package:dart_firebase_admin/messaging.dart';

Future<void> main() async {
  final admin = FirebaseAdminApp.initializeApp(
    'dart-firebase-admin',
    Credential.fromApplicationDefaultCredentials(),
  );

  // // admin.useEmulator();

  final messaging = Messaging(admin);

  final result = await messaging.send(
    TokenMessage(
      token:
          'e8Ap1n9UTQenyB-UEjNQt9:APA91bHhgc9RZYDcCKb7U1scQo1K0ZTSMItop8IqctrOcgvmN__oBo4vgbFX-ji4atr1PVw3Loug-eOCBmj4HVZjUE0aQBA0mGry7uL-7JuMaojhtl13MpvQtbZptvX_8f6vDcqei88O',
      notification: Notification(
        title: 'Hello',
        body: 'World',
      ),
    ),
  );

  print(result);

  final firestore = Firestore(admin);

  final collection = firestore.collection('users');

  await collection.doc('123').set({
    'name': 'John Doe',
    'age': 30,
  });

  final snapshot = await collection.get();

  for (final doc in snapshot.docs) {
    print(doc.data());
  }

  await admin.close();
}