Flutter分页查询Firestore插件paginate_firestore_plus的使用

Flutter分页查询Firestore插件paginate_firestore_plus的使用

该插件是原始paginate_firestore的更新版本。原始插件由Venkatesh Prasad开发，现已不再维护。我们已经接手并更新了此插件，以确保其与最新版本的Firestore及其依赖项兼容。

安装

在你的pubspec.yaml文件中添加以下依赖：

dependencies:
  paginate_firestore_plus: # 最新版本

然后运行flutter pub get来安装它。

导入

在你的Dart文件中导入插件：

import 'package:paginate_firestore/paginate_firestore_plus.dart';

使用

基本用法

在你的应用中实现分页查询：

PaginateFirestore(
  // item builder类型是必须的。
  itemBuilder: (context, documentSnapshots, index) {
    final data = documentSnapshots[index].data() as Map?;
    return ListTile(
      leading: CircleAvatar(child: Icon(Icons.person)),
      title: data == null ? Text('Error in data') : Text(data['name']),
      subtitle: Text(documentSnapshots[index].id),
    );
  },
  // orderBy是必须的以启用分页
  query: FirebaseFirestore.instance.collection('users').orderBy('name'),
  // 更改类型
  itemBuilderType: PaginateBuilderType.listView,
  // 获取实时数据
  isLive: true,
),

使用刷新监听器

如果你想在用户下拉刷新时刷新数据，可以使用PaginateRefreshedChangeListener：

PaginateRefreshedChangeListener refreshChangeListener = PaginateRefreshedChangeListener();

RefreshIndicator(
  child: PaginateFirestore(
    itemBuilder: (context, documentSnapshots, index) => ListTile(
      leading: CircleAvatar(child: Icon(Icons.person)),
      title: Text(documentSnapshots[index].data()['name']),
      subtitle: Text(documentSnapshots[index].id),
    ),
    // orderBy是必须的以启用分页
    query: FirebaseFirestore.instance.collection('users').orderBy('name'),
    listeners: [
      refreshChangeListener,
    ],
  ),
  onRefresh: () async {
    refreshChangeListener.refreshed = true;
  },
)

示例代码

以下是一个完整的示例代码，展示了如何在Flutter应用中使用paginate_firestore_plus插件进行分页查询Firestore。

import 'package:flutter/material.dart';
import 'package:paginate_firestore_plus/paginate_firestore.dart';
import 'package:cloud_firestore/cloud_firestore.dart';
import 'package:firebase_core/firebase_core.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Firebase.initializeApp();
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Firestore pagination library',
      theme: ThemeData(
        primarySwatch: Colors.yellow,
        visualDensity: VisualDensity.adaptivePlatformDensity,
        brightness: Brightness.dark,
      ),
      home: const HomePage(),
    );
  }
}

class HomePage extends StatelessWidget {
  const HomePage({Key? key}) : super(key: key);

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: const Text('Firestore pagination example'),
        centerTitle: true,
      ),
      body: Scrollbar(
        // isAlwaysShown: true,
        child: PaginateFirestore(
          // 使用SliverAppBar在头部使其粘性
          header: const SliverToBoxAdapter(child: Text('HEADER')),
          footer: const SliverToBoxAdapter(child: Text('FOOTER')),
          // item builder类型是必须的
          itemBuilderType: PaginateBuilderType.listView, // 更改类型
          itemBuilder: (context, documentSnapshots, index) {
            final data = documentSnapshots[index].data() as Map?;
            return ListTile(
              leading: const CircleAvatar(child: Icon(Icons.person)),
              title: data == null
                  ? const Text('Error in data')
                  : Text(data['name']),
              subtitle: Text(documentSnapshots[index].id),
            );
          },
          // orderBy是必须的以启用分页
          query: FirebaseFirestore.instance.collection('users').orderBy('name'),
          itemsPerPage: 5,
          // 获取实时数据
          isLive: true,
        ),
      ),
    );
  }
}