Flutter云数据库交互插件papai_cloud_firestore_api的使用

papai_cloud_firestore_api 是一个用于在 Flutter 应用中与 Google Cloud Firestore 进行交互的插件。它提供了一个简化的 API，使得开发者可以更容易地进行数据的读取、写入和查询操作。

以下是使用 papai_cloud_firestore_api 插件的基本步骤和示例代码：

1. 添加依赖

首先，你需要在 pubspec.yaml 文件中添加 papai_cloud_firestore_api 插件的依赖：

dependencies:
  flutter:
    sdk: flutter
  papai_cloud_firestore_api: ^版本号 # 请替换为最新版本号

然后运行 flutter pub get 来安装依赖。

2. 初始化插件

在使用插件之前，你需要在 main.dart 文件中初始化它：

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

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await PapaiCloudFirestoreApi.initialize(); // 初始化插件
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Firestore Example',
      home: HomePage(),
    );
  }
}

3. 使用插件进行数据操作

在你的应用中进行数据操作，例如读取、写入和查询数据。

写入数据

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

class HomePage extends StatelessWidget {
  Future<void> addData() async {
    await PapaiCloudFirestoreApi.addDocument(
      collectionPath: 'users',
      data: {
        'name': 'John Doe',
        'email': 'john.doe@example.com',
        'age': 30,
      },
    );
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Firestore Example'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: addData,
          child: Text('Add Data'),
        ),
      ),
    );
  }
}

读取数据

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

class HomePage extends StatelessWidget {
  Future<void> readData() async {
    final documents = await PapaiCloudFirestoreApi.getDocuments(
      collectionPath: 'users',
    );
    for (var doc in documents) {
      print(doc.data());
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Firestore Example'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: readData,
          child: Text('Read Data'),
        ),
      ),
    );
  }
}

更新数据

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

class HomePage extends StatelessWidget {
  Future<void> updateData() async {
    await PapaiCloudFirestoreApi.updateDocument(
      collectionPath: 'users',
      documentId: 'document_id', // 替换为实际的文档ID
      data: {
        'age': 31,
      },
    );
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Firestore Example'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: updateData,
          child: Text('Update Data'),
        ),
      ),
    );
  }
}

删除数据

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

class HomePage extends StatelessWidget {
  Future<void> deleteData() async {
    await PapaiCloudFirestoreApi.deleteDocument(
      collectionPath: 'users',
      documentId: 'document_id', // 替换为实际的文档ID
    );
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Firestore Example'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: deleteData,
          child: Text('Delete Data'),
        ),
      ),
    );
  }
}

4. 查询数据

你可以使用 where 子句来进行查询：

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

class HomePage extends StatelessWidget {
  Future<void> queryData() async {
    final documents = await PapaiCloudFirestoreApi.queryDocuments(
      collectionPath: 'users',
      where: [
        PapaiCloudFirestoreApiWhere('age', isGreaterThan: 25),
      ],
    );
    for (var doc in documents) {
      print(doc.data());
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Firestore Example'),
      ),
      body: Center(
        child: ElevatedButton(
          onPressed: queryData,
          child: Text('Query Data'),
        ),
      ),
    );
  }
}

5. 监听数据变化

你还可以监听 Firestore 数据的变化：

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

class HomePage extends StatelessWidget {
  Stream<List<DocumentSnapshot>> listenToData() {
    return PapaiCloudFirestoreApi.listenToCollection(
      collectionPath: 'users',
    );
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Firestore Example'),
      ),
      body: StreamBuilder<List<DocumentSnapshot>>(
        stream: listenToData(),
        builder: (context, snapshot) {
          if (snapshot.connectionState == ConnectionState.waiting) {
            return Center(child: CircularProgressIndicator());
          }
          if (snapshot.hasError) {
            return Center(child: Text('Error: ${snapshot.error}'));
          }
          final documents = snapshot.data!;
          return ListView.builder(
            itemCount: documents.length,
            itemBuilder: (context, index) {
              final data = documents[index].data() as Map<String, dynamic>;
              return ListTile(
                title: Text(data['name']),
                subtitle: Text(data['email']),
              );
            },
          );
        },
      ),
    );
  }
}