【flutter】ListView.builder封装各个页面通用的无限加载列表

flutter当中提供了无限加载的组件,再此基础上又做了一层封装。
这个可复用的无限加载列表包括以下特点:

  • 上滑加载
  • 数据不满足加载条件,提示到达底部
  • 根据具体参数的变化,搜索并重新加载数据(可以轻松跟filter和search结合)
  • 不同的列表只需要传入任意定义的RowItem即可
  • 根据RESTFUL当中limit,offset分页机制加载

组件封装当中比较复杂一点的就是dart如何进行泛型实例化。

  • RowItem父类
import 'package:flutter/widgets.dart';

abstract  class ListItemWidget extends StatelessWidget {
    const ListItemWidget(
      {Key key, this.item}
    ):super(key:key);

  final Map item;
  call(Map item)=>this;
}
  • 无线加载列表组件
import 'dart:async';

import 'package:flutter/material.dart';
import 'package:flutter/widgets.dart';
import 'package:flutter_easyrefresh/easy_refresh.dart';
import 'package:flutter_easyrefresh/material_header.dart';
import 'package:flutter_lim/common/http.dart';
import 'package:flutter_lim/widgets/listItem.dart';

typedef RequestCallback = Stream<dynamic> Function({Map paramObj});
typedef S ItemCreator<S extends ListItemWidget>(dynamic item); // new T()泛型实例化实现

// 无限加载列表
//使用InheritedWidget,每个列表管理自己的搜索参数
class ShareParams extends InheritedWidget {
  ShareParams(
      {@required this.specialParams, this.data, this.count, Widget child})
      : super(child: child);

  final Map<String, dynamic> specialParams;
  final List<dynamic> data;
  final int count;

  static ShareParams of(BuildContext context) {
    return context.dependOnInheritedWidgetOfExactType<ShareParams>();
  }

  @override
  bool updateShouldNotify(ShareParams oldWidget) {
    Map<String, dynamic> oldParams = oldWidget.specialParams;
    bool isUpdate = false;
    if (this.specialParams.keys.length != oldParams.length) {
      isUpdate = true;
    } else {
      for (String key in this.specialParams.keys) {
        if (oldParams[key] == null ||
            oldParams[key] != this.specialParams[key]) {
          isUpdate = true;
          break;
        }
      }
    }

    return isUpdate;
  }
}

@immutable
class InfiniteListViewWidget<T extends ListItemWidget> extends StatefulWidget {
  final RequestCallback request; //数据请求路径
  final List<dynamic> data; //初始化数据
  final int count; //列表总个数
  final ItemCreator<T> creator; //列表Item泛型实例化
  final Map<String, dynamic> specialParam; //特殊请求参数,若无须共享参数,传值
  final Function refresh;
  InfiniteListViewWidget(this.request, this.data, this.count, this.creator,
      {this.specialParam, this.refresh});

  @override
  _InfiniteListViewWidgetState<T> createState() =>
      new _InfiniteListViewWidgetState<T>(
          this.request, this.data, this.count, this.creator,
          specialParam: this.specialParam, refresh: this.refresh);
}

@override
class _InfiniteListViewWidgetState<T extends ListItemWidget>
    extends State<InfiniteListViewWidget> {
  static const loadingTag = {"position": "bottom"}; //表尾标记
  Http http = new Http();
  InfiniteListParamObj infiParams;
  RequestCallback request; //数据请求
  int count; //列表数据总数量
  List<dynamic> data;
  ItemCreator<T> creator;
  @optionalTypeArgs
  Map<String, dynamic> specialParam; //特殊请求参数
  Function refresh;

  EasyRefreshController _refreshController = new EasyRefreshController();

  _InfiniteListViewWidgetState(
      this.request, this.data, this.count, this.creator,
      {this.specialParam, this.refresh});

  @override
  void initState() {
    super.initState();
  }

  void didChangeDependencies() {
    super.didChangeDependencies();
    if (ShareParams.of(context) != null) {
      print(
          'LISTEN PARAMS didChange=>${ShareParams.of(context).specialParams}');
      print('LISTEN PARAMS didChange=>${ShareParams.of(context).data}');
      this.specialParam = ShareParams.of(context).specialParams;
      this.data = ShareParams.of(context).data;
      this.count = ShareParams.of(context).count;
    }
    if (this.specialParam != null) {
      this._setInfiniteParams(this.specialParam);
    }
  }

  @override
  Widget build(BuildContext context) {
//EasyRefresh是下拉刷新组件,不需要的话可以直接去掉
    return EasyRefresh(
      header: MaterialHeader(),
      child: ListView.builder(
        itemCount: this.data.length,
        itemBuilder: (BuildContext context, int index) {
          var word = this.data[index];
          var nextWord;
          if (index == this.data.length - 1) {
            nextWord = null;
          } else {
            nextWord = this.data[index + 1];
          }
          if (nextWord == null && this.data.length == index + 1) {
            // 根据返回的count
            final curCount = this.data.length;
            if (curCount < this.count) {
              //offset + limit  >= count 的时候不再下拉
              this.infiParams.offset = this.data.length;
              //获取数据
              _retrieveData(this.resolveListData);
              //加载时显示loading
              return Column(
                children: <Widget>[
                  creator(word),
                  Container(
                    padding: const EdgeInsets.all(16.0),
                    alignment: Alignment.center,
                    child: SizedBox(
                        width: 24.0,
                        height: 24.0,
                        child: CircularProgressIndicator(strokeWidth: 2.0)),
                  )
                ],
              );
            } else {
              //加载数据总数已经超过count了不再加载
              return Column(
                children: <Widget>[
                  creator(word),
                  Container(
                      alignment: Alignment.center,
                      padding: EdgeInsets.all(16.0),
                      child: Text(
                        "没有更多了",
                        style: TextStyle(color: Colors.grey),
                      ))
                ],
              );
            }
          }
//由于build方法中返回的Widget必须实例化,所以要实现泛型实例化
          T item = creator(word);
          return item;
        },
      ),
      controller: _refreshController,
      onRefresh: () async {
        this.refresh == null
            ? _refreshController.finishRefresh(success: true)
            : this.refresh();
      },
    );
  }

  void _setInfiniteParams(Map<String, dynamic> specialParam,
      {int limit, int offset, String ordering}) {
    if (this.infiParams == null) {
      limit = limit != null ? limit : 10;
      offset = offset != null ? offset : 0;
      ordering = ordering != null ? ordering : '-create_time';
      this.infiParams =
          new InfiniteListParamObj(limit, offset, ordering, specialParam);
    } else {
      this.infiParams.paramsObj = specialParam;
    }
  }

  void _retrieveData(Function resovle) {
    Map<String, dynamic> paramObj = this.infiParams.getParams();
    request(paramObj: paramObj).listen(resovle);
  }

  void resolveListData(dynamic data) {
    this.count = data['count'];
    setListData(data['results']);
  }

  void setListData(dynamic list) {
    this.data.addAll(list);
    setState(() {});
  }
}
  • 列表默认参数,可以根据具体的设计修改
@override
class InfiniteListParamObj {
  int limit = 10;
  int offset = 0;
  String ordering = '';
  Map<String, dynamic> paramsObj = {};
  InfiniteListParamObj(this.limit, this.offset, this.ordering, this.paramsObj);
  Map<String, dynamic> getParams() {
    Map<String, dynamic> basic = {
      "limit": this.limit,
      "offset": this.offset,
      "ordering": this.ordering
    };
    basic.addAll(this.paramsObj);
    return basic;
  }

  void resetBasicParams() {
    this.limit = 10;
    this.offset = 0;
  }
}
  • 如何使用
 Expanded(
          child: ShareParams(
        specialParams: this.paramsObj,
        data: this.dataList,//数据列表
        count: this.count,//数据总count
        child: new InfiniteListViewWidget<ProductItem>(//ProductItem具体集成自ListItemWidget的列表项目
          getUniqueProdList,//数据加载url
          this.dataList,
          this.count,
          (item) => new ProductItem(item),
          specialParam: this.paramsObj,//列表搜索参数
          refresh: this.onRefresh,//自定义列表刷新的方法
        ),
      ));
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,001评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,210评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,874评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,001评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,022评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,005评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,929评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,742评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,193评论 1 309
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,427评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,583评论 1 346
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,305评论 5 342
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,911评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,564评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,731评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,581评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,478评论 2 352

推荐阅读更多精彩内容