Flutter分页加载插件fl_paging的使用

Flutter分页加载插件 fl_paging 的使用

fl_paging 是一个用于在 Flutter 应用中实现分页加载(如 ListView 和 GridView)的插件。它支持无限滚动加载,适用于需要从服务器或本地数据源获取大量数据的场景。

功能特点

  • 支持 ListViewGridView 的分页加载。
  • 提供了灵活的数据源接口 PageKeyedDataSource
  • 支持下拉刷新和上拉加载更多。

示例 Demo

以下是插件的效果示例:

ListView Demo GridView Demo Sliver Demo

数据源 DataSource

要使用 PagingListViewPagingGridView,你需要创建一个继承自 PageKeyedDataSource 的类,并重写以下两个方法:

  1. loadInitial(int pageSize):加载初始页面。
  2. loadPageAfter(int params, int pageSize):加载后续页面。

示例代码

class ListViewDataSource extends PageKeyedDataSource<int, Note> {
  final NoteRepository noteRepository;

  ListViewDataSource(this.noteRepository);

  [@override](/user/override)
  Future<Tuple2<List<Note>, int>> loadInitial(int pageSize) async {
    // 加载第一页数据
    return Tuple2(await noteRepository.getNotes(0), 1);
  }

  [@override](/user/override)
  Future<Tuple2<List<Note>, int>> loadPageAfter(int pageIndex, int pageSize) async {
    // 加载下一页数据
    return Tuple2(await noteRepository.getNotes(pageIndex), pageIndex + 1);
  }
}

在 UI 中显示

你可以使用 PagingListViewPagingGridView 来展示分页数据。下面是一个完整的示例:

完整示例 Demo

import 'dart:developer' as developer;

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

// 假设你有一个 Note 模型和 NoteRepository 类
import 'data/models/note.dart';
import 'data/note_repository.dart';
import 'widgets/note_widget.dart';

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

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        scaffoldBackgroundColor: Colors.grey[200],
        primarySwatch: Colors.blue,
        visualDensity: VisualDensity.adaptivePlatformDensity,
      ),
      home: ListViewPage(),
    );
  }
}

class ListViewPage extends StatefulWidget {
  static const ROUTE_NAME = 'ListViewPage';
  
  [@override](/user/override)
  _ListViewPageState createState() => _ListViewPageState();
}

class _ListViewPageState extends State<ListViewPage> {
  static const TAG = 'ListViewPage';
  final GlobalKey key = GlobalKey();
  late ListViewDataSource dataSource;

  [@override](/user/override)
  void initState() {
    super.initState();
    dataSource = ListViewDataSource(NoteRepository());
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    developer.log('build', name: 'ListViewPage');
    
    return Scaffold(
      appBar: AppBar(
        centerTitle: true,
        title: Text('Demo ListView'),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: () {
          setState(() {});
        },
        child: Icon(Icons.refresh),
      ),
      body: PagingListView<Note>(
        key: key,
        stylePullToRefresh: StylePullToRefresh.IOS,
        padding: EdgeInsets.all(16),
        itemBuilder: (context, data, child) {
          return NoteWidget(data);
        },
        pageDataSource: dataSource,
      ),
    );
  }
}

更多关于Flutter分页加载插件fl_paging的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter分页加载插件fl_paging的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然,下面是一个关于如何在Flutter中使用fl_paging插件进行分页加载的示例代码。fl_paging是一个用于分页加载数据的Flutter插件,它简化了分页逻辑的实现。

首先,确保你已经在pubspec.yaml文件中添加了fl_paging的依赖:

dependencies:
  flutter:
    sdk: flutter
  fl_paging: ^最新版本号 # 替换为实际的最新版本号

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

接下来是一个完整的示例,演示如何使用fl_paging插件来实现分页加载。

import 'package:flutter/material.dart';
import 'package:fl_paging/fl_paging.dart';
import 'dart:async';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Paging Example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final PagingController<int, MyData> _pagingController = PagingController(firstPageKey: 1);

  @override
  void initState() {
    super.initState();
    // Fetch the first page of data
    _fetchData();
  }

  @override
  void dispose() {
    _pagingController.dispose();
    super.dispose();
  }

  Future<void> _fetchData() async {
    try {
      final newItems = await fetchPage(_pagingController.pageKey);
      _pagingController.appendPagingItems(newItems);
    } catch (error) {
      // Handle error
      print(error);
    }
  }

  Future<List<MyData>> fetchPage(int pageKey) async {
    // Simulate a network call with a delay
    await Future.delayed(Duration(seconds: 1));

    // Return a list of dummy data
    return List.generate(10, (index) => MyData(id: pageKey * 10 + index + 1, name: "Item ${pageKey * 10 + index + 1}"));
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Flutter Paging Example'),
      ),
      body: Padding(
        padding: const EdgeInsets.all(8.0),
        child: PagingView<int, MyData>(
          pagingController: _pagingController,
          onLoadMore: _fetchData,
          builder: (context, data, index) {
            return ListTile(
              title: Text(data.name),
            );
          },
          errorWidget: (context, error, retry) {
            return Column(
              children: [
                Text('Failed to load data'),
                ElevatedButton(onPressed: retry, child: Text('Retry')),
              ],
            );
          },
          emptyWidget: Center(child: Text('No data to show')),
        ),
      ),
    );
  }
}

class MyData {
  final int id;
  final String name;

  MyData({required this.id, required this.name});
}

代码解释

  1. 依赖添加:确保在pubspec.yaml中添加了fl_paging依赖。

  2. 分页控制器:使用PagingController来管理分页状态。firstPageKey用于指定第一页的键(通常是一个数字)。

  3. 数据获取

    • _fetchData方法模拟了一个网络请求,使用fetchPage函数获取分页数据。
    • fetchPage函数返回一个模拟的数据列表。
  4. 分页视图

    • PagingView用于显示分页数据。
    • onLoadMore参数指定当需要加载更多数据时调用的方法(即_fetchData)。
    • builder参数用于构建每个数据项的UI。
    • errorWidgetemptyWidget分别用于显示错误和空数据的UI。
  5. 数据模型MyData类表示分页数据项的结构。

这个示例展示了如何使用fl_paging插件来实现分页加载,你可以根据自己的需求进行进一步的定制和扩展。

回到顶部