一行代码完成分页模块数据更新——Paging 快捷分页模型

开发移动端页面遇到大量的下拉刷新上拉加载模块?

每次都需要维护当前页数还有数据更新后的总页数处理?

如果这些操作都可以用一行代码实现:

// 下拉刷新
pageViewModel.headerRefreshing();
// 上拉加载
pageViewModel.footerRefreshing();

感兴趣的同学可以先戳这个链接先行体验一下效果,也可以戳这个链接看一下源代码

接下来我们好好聊一聊怎么实现一行代码完成分页模块

功能分解

1、首先我们需要思考的是分页相关参数的处理

也就是 pageSize(单页数目)currentPage(当前页)totalPage(总页数)

我们需要一个实例来维护和更新这些参数

这里我设计了一个 class

class PagingViewModel<T> {
    private currentPage: Ref<number>;
    private totalPage: Ref<number>;
    private pageSize: number;
   // 状态变量
    refreshing: Ref<boolean>;
    loading: Ref<boolean>;
    finished: Ref<boolean>;

    constructor(opt: PagingOptions<T>) {
        this.pageSize = opt.pageSize ?? 20;
        this.currentPage = ref(1);
        this.totalPage = ref(1);
      
        this.refreshing = ref(false);
        this.loading = ref(false);
        this.finished = ref(false);
    }
}

使用 PagingViewModel 来管理这些参数,在触发刷新和加载行为之后实时更新,并且通过 3 个状态变量(刷新中、加载中、已全部加载)来标识此时的 Paging 加载状态

2、其次我们需要考虑数据的来源与更新

这里主要是体现在通过接口获取数据这一块

也就是 params(请求参数)requestFn(请求体)datas(用于渲染的数据源)

这里我们再将这些内容合并进上面的 class 中

class PagingViewModel<T> {
    private currentPage: Ref<number>;
    private totalPage: Ref<number>;
    private pageSize: number;
    // 新增属性
    private params: any;
    private datas: Ref<Array<T>>;
    private requestFn: (params: any) => Promise<any>;
    private responseCompletion?: (vm: PagingViewModel<T>, datas: Array<any>) => Array<any>;

    refreshing: Ref<boolean>;
    loading: Ref<boolean>;
    finished: Ref<boolean>;

    constructor(opt: PagingOptions<T>) {
        this.requestFn = opt.requestFn;
        this.params = opt.params || {};
        this.datas = opt.datas;
        this.pageSize = opt.pageSize ?? 20;

        this.currentPage = ref(1);
        this.totalPage = ref(1);
        this.refreshing = ref(false);
        this.loading = ref(false);
        this.finished = ref(false);
    }
}

现在我们的 class 已经初具雏形,可以为其增加行为 loadData()

/**
 * 加载数据
 */
loadData() {
    // 组合基本的请求参数
    const params = {
        currentPage: this.currentPage.value,
        pageSize: this.pageSize,
        ...this.params,
    };
   // 刷新时清空数据源
    if (this.currentPage.value === 1) {
        this.datas.value = [] as Array<T>;
    }
   // 网络请求主体
    this.requestFn(params).then((response) => {
        if (!response) {
            return;
        }
        // 记录总页数
        this.totalPage.value = response.totalPage;
        let resDatas = response.responseObject.items;
        if (this.responseCompletion) {
            // 需要特殊处理的数据源由该 hook 完成
            resDatas = this.responseCompletion(this, response.datas);
        }
        // 处理第一页和其他页数据组合
        if (this.currentPage.value === 1) {
            this.datas.value = resDatas;
        } else {
            this.datas.value = this.datas.value.concat(resDatas);
        }
        // 加载结束,更新状态
        this.didLoaded();
    });
}
/**
 * 加载结束,状态更新
 */
didLoaded() {
    // 处理第一页和其他页的状态
    if (this.currentPage.value === 1) {
        this.refreshing.value = false;
        this.finished.value = false;
    } else {
        this.loading.value = false;
    }
}

这里可能有小伙伴就有疑问了,如果我需要对网络请求拿到的数据源进行处理后才提供给界面渲染怎么办?

那我们就增加一个Hook (responseCompletion)来处理接口数据

剩下就是处理 currentPage 为 1 的情况和不为 1 的情况了

3、最后实现上拉加载和下拉刷新

/**
 * 下拉刷新
 */
headerRefreshing() {
    // 重置当前页并刷新数据
    this.currentPage.value = 1;
    this.loadData();
}
/**
 * 上拉加载
 */
footerRefreshing() {
    // 这里根据 totalPage 控制显示没有更多数据
    if (this.currentPage.value === this.totalPage.value) {
        this.finished.value = true;
        this.didLoaded();
        return;
    }
    // 当前页自增并请求下一页数据
    this.currentPage.value += 1;
    this.loadData();
}

到此,我们的 PagingViewModel 已经可以正常工作啦~

这里提供一下最基础的调用方式

// 网络请求
const requestFn = (params: any) => {
    return new Promise<any>((resolve) => {
        // 这里模拟请求数据
        const response = mockDatas(params.currentPage, params.pageSize);
        resolve(response);
    });
}
// 渲染数据源
const datas = ref<ResponseObject[]>([]);
// 分页vm
const pageViewModel = new PagingViewModel<any>({
    requestFn,
    datas,
    pageSize: 5,
});
// 刷新数据
pageViewModel.headerRefreshing();
// 加载数据
pageViewModel.footerRefreshing();

总结

这里想和大家分享的只是构建快捷分页模型的一个思路,具体细节的雕琢还需要深入思考

很多分页参数的命名定义可能会有所不同,返回值的数据结构也会有所不同

所以,大家领悟思路就好,可以根据这个思路做一套适合自己业务的分页模型

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,491评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,856评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,745评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,196评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,073评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,112评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,531评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,215评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,485评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,578评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,356评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,215评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,583评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,898评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,497评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,697评论 2 335