Flutter集成Firebase服务插件firebase_service的使用

本文档介绍了如何在Flutter项目中使用firebase_service插件。该插件通过FirestoreService类为cloud_firestore API提供了类型化的抽象。

Getting Started（开始使用）

在你的Flutter项目中添加依赖：

dependencies:
  firebase_service: ^<version>

导入包：

import 'package:firebase_service/firebase_service.dart';

Usage（使用方法）

创建实例

final service = FirestoreService.instance;

写入文档

final path = 'collection/$id';
await service.set(path: path, data: {'id': id});

更新文档

final path = 'collection/$id';
await service.update(path: path, data: {'id': id});

删除文档

final path = 'collection/$id';
await service.delete(path: path);

获取单个文档

final path = 'collection/$id';
final res = await service.getDocument(
  path: path,
  builder: ((data, documentID) => data!), // 将数据转换为所需格式
);

监听单个文档的变化

final path = 'collection/$id';
final res = service.documentStream(
  path: path,
  builder: ((data, documentID) => data!), // 将数据转换为所需格式
);

监听集合的变化

final path = 'collection/$id';
final res = service.collectionStream(
  path: path,
  builder: ((data, documentID) => data!), // 将数据转换为所需格式
);

获取整个集合

final path = 'collection/$id';
final res = await service.getCollection(
  path: path,
  builder: ((data, documentID) => data!), // 将数据转换为所需格式
);

获取带限制条件的集合

final path = 'collection/$id';
final res = service.collectionStream(
  path: path,
  builder: ((data, documentID) => data!), // 将数据转换为所需格式
  limit: 20, // 添加限制条件
);

完整示例代码

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

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

void main() {
  runApp(const MyApp());
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Firebase Service Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const Home(),
    );
  }
}

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Firebase Service Demo'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: () async {
            // 初始化服务
            final service = FirestoreService.instance;

            // 写入文档
            final path = 'test_collection/test_id';
            await service.set(
              path: path,
              data: {'name': 'John Doe', 'age': 30},
            );

            // 获取文档
            final res = await service.getDocument(
              path: path,
              builder: (data, documentID) => data!,
            );

            // 打印结果
            print(res);

            // 删除文档
            await service.delete(path: path);
          },
          child: const Text('Test Firebase Service'),
        ),
      ),
    );
  }
}