Flutter数据库管理插件spreeloop_database的使用

概述

Spreeloop Database 插件为与 Firebase 数据库交互提供了一种统一且抽象的方法。它提供了多种方法来管理和检索数据，确保灵活性和易于使用。该插件支持 Firebase Firestore 和用于测试目的的假数据库。

功能

• 统一接口适用于不同的数据库类型
• 图像检索和 URL 生成
• 文件上传和管理
• 记录创建、更新和删除
• 集合和文档查询（带过滤和排序）
• 通过流实现实时更新

安装

要安装 Spreeloop Database 插件，请将其添加到项目的依赖项中：

dependencies:
  spreeloop_database: ^0.0.1

使用

以下是有效使用 Spreeloop Database 插件的指南。

初始化

要初始化数据库，请使用 Database 工厂构造函数。您可以指定要使用的数据库类型，Firebase Firestore 是主要选项：

import 'package:spreeloop_database/spreeloop_database.dart';

// 初始化 Firestore 数据库
final db = Database(DatabaseType.firestore);

// 初始化假数据库以进行测试
final fakeDb = Database.fake({
  'users': {
    'user1': {'name': 'John Doe', 'age': 30},
  },
});

图像处理

从 Firebase 存储中检索图像：

Future<ImageProvider?> fetchImage(String imageRef) async {
  return await db.getImage(imageRef);
}

获取存储在 Firebase 中的文件的下载 URL：

Future<String?> fetchDownloadURL(String url) async {
  return await db.getDownloadURL(url);
}

文件管理

将文件上传到 Firebase 存储：

Future<bool> uploadFile(Uint8List fileData, String recordPath) async {
  return await db.setFile(fileData, recordPath);
}

记录管理

在 Firestore 中创建新记录：

Future<String?> createNewRecord(String collectionPath, Map<String, dynamic> recordMap) async {
  return await db.createRecord(collectionPath, recordMap);
}

在 Firestore 中更新或设置记录：

Future<bool> updateRecord(String documentPath, Map<String, dynamic> recordMap, {bool merge = true}) async {
  return await db.setRecord(documentPath: documentPath, recordMap: recordMap, merge: merge);
}

在 Firestore 中按路径删除记录：

Future<void> deleteRecords(String collectionPath, List<String> documentsIds) async {
  return await db.removeRecordsByPath(collectionPath, documentsIds);
}

在 Firestore 中按值删除记录：

Future<void> deleteRecordByValue(String collectionPath, List<DocumentQuery> documentQueries) async {
  return await db.removeRecordByValue(collectionPath, documentQueries);
}

查询数据

从 Firestore 中检索文档集合：

Future<Map<String, Map<dynamic, dynamic>>?> fetchCollection(String collectionPath, {List<DocumentQuery>? filters, DocumentOrderBy? orderBy, int? limit}) async {
  return await db.getCollection(collectionPath, filters: filters, orderBy: orderBy, limit: limit);
}

从 Firestore 中检索集合组：

Future<Map<String, Map<dynamic, dynamic>>?> fetchCollectionGroup(String collectionID, {List<DocumentQuery>? filters, int? limit, DocumentOrderBy? orderBy}) async {
  return await db.getCollectionGroup(collectionID, filters: filters, limit: limit, orderBy: orderBy);
}

实时数据

在 Firestore 中观察集合组以获取实时更新：

Stream<Map<String, Map<dynamic, dynamic>>?> watchCollectionGroupUpdates(String collectionID, {List<DocumentQuery>? filters, int? limit, DocumentOrderBy? orderBy}) {
  return db.watchCollectionGroup(collectionID, filters: filters, limit: limit, orderBy: orderBy);
}

在 Firestore 中观察集合以获取实时更新：

Stream<Map<String, Map<dynamic, dynamic>>?> watchCollectionUpdates(String collectionPath, {List<DocumentQuery>? filters, int? limit, DocumentOrderBy? orderBy}) {
  return db.watchCollection(collectionPath, filters: filters, limit: limit, orderBy: orderBy);
}

文档处理

在 Firestore 中按路径检索文档：

Future<Map<dynamic, dynamic>?> fetchDocument(String path) async {
  return await db.getRecordByDocumentPath(path);
}

在 Firestore 中观察文档以获取实时更新：

Stream<Map<dynamic, dynamic>?> watchDocumentUpdates(String path) {
  return db.watchRecordByDocumentPath(path);
}