Flutter云数据库CRUD操作插件woo_firestore_crud的使用

Flutter云数据库CRUD操作插件woo_firestore_crud的使用

简介

woo_firestore_crud 是一个用于处理 Firestore 数据库基本 CRUD 操作的 Flutter 插件。通过该插件，您可以轻松实现创建、读取、更新和删除文档及集合的功能。

类的使用

首先，您需要初始化 WooFirestore 实例来调用插件提供的功能。以下是如何设置和使用 WooFirestore 的示例：

// 导入必要的包
import 'package:woo_firestore_crud/woo_firestore_crud.dart';

// 创建一个测试类
class ClassTest {
    // 初始化 WooFirestore 实例
    final WooFirestore wooFirestore = WooFirestore.instance;
}

注意：所有函数都需要通过 wooFirestore 变量调用。

函数详解

1. add

用于向集合中添加新文档。

void addDocument() async {
    try {
        // 调用 add 方法并传入集合路径和数据
        String documentId = await wooFirestore.add(
            collectionPath: 'users', // 集合路径
            data: {               // 文档数据
                'name': 'John Doe',
                'age': 25,
                'email': 'johndoe@example.com'
            }
        );

        print('新文档已创建，ID: $documentId');
    } catch (e) {
        print('错误: $e');
    }
}

2. set

用于创建或替换已存在的文档。

void setDocument() async {
    try {
        // 调用 set 方法并传入集合路径、文档 ID 和数据
        await wooFirestore.set(
            collectionPath: 'users',
            documentId: '12345', // 文档 ID
            data: {
                'name': 'Jane Doe',
                'age': 30,
                'email': 'janedoe@example.com'
            }
        );

        print('文档已更新');
    } catch (e) {
        print('错误: $e');
    }
}

3. update

用于更新现有文档的部分字段。

void updateDocument() async {
    try {
        // 调用 update 方法并传入集合路径、文档 ID 和更新的数据
        await wooFirestore.update(
            collectionPath: 'users',
            documentId: '12345',
            data: {
                'age': 31 // 更新年龄字段
            }
        );

        print('文档已更新');
    } catch (e) {
        print('错误: $e');
    }
}

4. delete

用于删除指定文档。

void deleteDocument() async {
    try {
        // 调用 delete 方法并传入集合路径和文档 ID
        await wooFirestore.delete(
            collectionPath: 'users',
            documentId: '12345'
        );

        print('文档已删除');
    } catch (e) {
        print('错误: $e');
    }
}

5. getCol

用于获取集合中的所有文档。

void getCollectionDocuments() async {
    try {
        // 调用 getCol 方法并传入集合路径
        List<Map<String, dynamic>> documents = await wooFirestore.getCol(
            collectionPath: 'users'
        );

        // 打印所有文档
        documents.forEach((doc) {
            print(doc);
        });
    } catch (e) {
        print('错误: $e');
    }
}

6. getDoc

用于获取单个文档。

void getSingleDocument() async {
    try {
        // 调用 getDoc 方法并传入集合路径和文档 ID
        Map<String, dynamic> document = await wooFirestore.getDoc(
            collectionPath: 'users',
            documentId: '12345'
        );

        print('文档内容: $document');
    } catch (e) {
        print('错误: $e');
    }
}

7. streamCol

用于监听集合的变化。

void listenToCollectionChanges() {
    // 调用 streamCol 方法并传入集合路径
    Stream<List<Map<String, dynamic>>> stream = wooFirestore.streamCol(
        collectionPath: 'users'
    );

    stream.listen((documents) {
        // 打印集合中的所有文档
        documents.forEach((doc) {
            print(doc);
        });
    });
}

8. streamDoc

用于监听单个文档的变化。

void listenToDocumentChanges() {
    // 调用 streamDoc 方法并传入集合路径和文档 ID
    Stream<Map<String, dynamic>> stream = wooFirestore.streamDoc(
        collectionPath: 'users',
        documentId: '12345'
    );

    stream.listen((document) {
        print('文档更新: $document');
    });
}

完整示例

以下是一个完整的示例，展示了如何使用 woo_firestore_crud 插件进行基本的 CRUD 操作。

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

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

class MyApp extends StatelessWidget {
    @override
    Widget build(BuildContext context) {
        return MaterialApp(
            home: Scaffold(
                appBar: AppBar(title: Text('woo_firestore_crud 示例')),
                body: Center(
                    child: ElevatedButton(
                        onPressed: () {
                            testCrudOperations();
                        },
                        child: Text('测试 CRUD 操作'),
                    ),
                ),
            ),
        );
    }

    void testCrudOperations() async {
        // 初始化 WooFirestore 实例
        final WooFirestore wooFirestore = WooFirestore.instance;

        try {
            // 添加文档
            String newDocId = await wooFirestore.add(
                collectionPath: 'users',
                data: {
                    'name': 'Alice',
                    'age': 22,
                    'email': 'alice@example.com'
                }
            );
            print('添加文档成功，ID: $newDocId');

            // 获取集合中的所有文档
            List<Map<String, dynamic>> users = await wooFirestore.getCol(
                collectionPath: 'users'
            );
            print('集合中的文档: $users');

            // 更新文档
            await wooFirestore.update(
                collectionPath: 'users',
                documentId: newDocId,
                data: {'age': 23}
            );
            print('文档已更新');

            // 获取单个文档
            Map<String, dynamic> user = await wooFirestore.getDoc(
                collectionPath: 'users',
                documentId: newDocId
            );
            print('单个文档内容: $user');

            // 监听集合变化
            Stream<List<Map<String, dynamic>>> stream = wooFirestore.streamCol(
                collectionPath: 'users'
            );
            stream.listen((docs) {
                print('集合更新: $docs');
            });

            // 删除文档
            await wooFirestore.delete(
                collectionPath: 'users',
                documentId: newDocId
            );
            print('文档已删除');
        } catch (e) {
            print('错误: $e');
        }
    }
}