Android.Arch.Paging: 分页加载的新选项

一、概述

在很久很久以前,加载并展示大量数据就已成为各家应用中必不可少的业务场景,分页加载也就成了必不可少的方案。在现有的Android API中也已存在支持分页加载内容的方案, 比如:

  • CursorAdapter:它简化了数据库中数据到ListView中Item的映射, 仅查询需要展示的数据,但是查询的过程是在UI线程中执行。
  • SupportV7包中的AsyncListUtil支持基于position的数据集分页加载到RecyclerView中,但不支持不基于position的数据集,而且它强制一个有限数据集中的null项必须展示Placeholder.

针对现有方案所存在的一些问题,Google推出了Android架构组件中的Paging Library, 不过目前还是alpha版本。Paging Library主要由3个部分组成:DataSourcePagedListPagedListAdapter

二、Paging Libray介绍

DataSource, PagedList, PagedAdapter三者之间的关系以及加载数据到展示数据的流程如下图所示:

Paging Libraray Diagram

2.1 Datasource

顾名思义,Datasource<Key, Value>是数据源相关的类,其中Key对应加载数据的条件信息,Value对应返回结果, 针对不同场景,Paging提供了三种Datasource:

  • PageKeyedDataSource<Key, Value> :适用于目标数据根据页信息请求数据的场景,即Key 字段是页相关的信息。比如请求的数据的参数中包含类似next/previous的信息。
  • ItemKeyedDataSource<Key, Value> :适用于目标数据的加载依赖特定item的信息, 即Key字段包含的是Item中的信息,比如需要根据第N项的信息加载第N+1项的数据,传参中需要传入第N项的ID时,该场景多出现于论坛类应用评论信息的请求。
  • PositionalDataSource<T>:适用于目标数据总数固定,通过特定的位置加载数据,这里Key是Integer类型的位置信息,TValue。 比如从数据库中的1200条开始加在20条数据。

以上三种Datasource都是抽象类, 使用时需实现请求数据的方法。三种Datasource都需要实现loadInitial()方法, 各自都封装了请求初始化数据的参数类型LoadInitialParams。 不同的是分页加载数据的方法,PageKeyedDataSourceItemKeyedDataSource比较相似, 需要实现loadBefore()loadAfter()方法,同样对请求参数做了封装,即LoadParams<Key>PositionalDataSource需要实现loadRange(),参数的封装类为LoadRangeParams

如果项目中使用Android架构组件中的Room, Room可以创建一个产出PositionalDataSourceDataSource.Factory

@Query("select * from users WHERE age > :age order by name DESC, id ASC")
DataSource.Factory<Integer, User> usersOlderThan(int age);

总的来说,Datasource就像是一个抽水泵,而不是真正的水源,它负责从数据源加载数据,可以看成是Paging Library与数据源之间的接口。

2.2 PagedList

如果将Datasource比作抽水泵,那PagedList就像是一个蓄水池,但不仅仅如此。PagedList是List的子类,支持所有List的操作, 除此之外它主要有五个成员:

  • mMainThreadExecutor: 一个主线程的Excutor, 用于将结果post到主线程。

  • mBackgroundThreadExecutor: 后台线程的Excutor.

  • BoundaryCallback:加载Datasource中的数据加载到边界时的回调.

  • Config: 配置PagedList从Datasource加载数据的方式, 其中包含以下属性:

    • pageSize:设置每页加载的数量
    • prefetchDistance:预加载的数量
    • initialLoadSizeHint:初始化数据时加载的数量
    • enablePlaceholders:当item为null是否使用PlaceHolder展示
  • PagedStorage<T>: 用于存储加载到的数据,它是真正的蓄水池所在,它包含一个ArrayList<List<T>> 对象mPages,按页存储数据。

PagedList会从Datasource中加载数据,更准确的说是通过Datasource加载数据, 通过Config的配置,可以设置一次加载的数量以及预加载的数量。 除此之外,PagedList还可以向RecyclerView.Adapter发送更新的信号,驱动UI的刷新。

2.3 PagedListAdapter

PagedListAdapte是RecyclerView.Adapter的实现,用于展示PagedList的数据。它本身实现的更多是Adapter的功能,但是它有一个小伙伴PagedListAdapterHelper<T>, PagedListAdapterHelper会负责监听PagedList的更新, Item数量的统计等功能。这样当PagedList中新一页的数据加载完成时, PagedAdapte就会发出加载完成的信号,通知RecyclerView刷新,这样就省略了每次loading后手动调一次notifyDataChanged().

除此之外,当数据源变动产生新的PagedList,PagedAdapter会在后台线程中比较前后两个PagedList的差异,然后调用notifyItem...()方法更新RecyclerView.这一过程依赖它的另一个小伙伴ListAdapterConfig, ListAdapterConfig负责主线程和后台线程的调度以及DiffCallback的管理,DiffCallback的接口实现中定义比较的规则,比较的工作则是由PagedStorageDiffHelper来完成。

三、加载数据

使用Paging Library加载数据主要有两种方式,一种是单一数据源的加载(本地数据或网络数据), 另一种是多个数据源的加载(本地数据+网络数据)。

3.1 加载单一数据源的数据

首先我们可以通过LivePagedListBuilder来创建LiveData<PagedList>为UI层提供数据。整个流程如下图所示:

single data source Diagram

如果数据源是DB,当数据发生变化,DB会推送(push)一个新的PagedList(这里会依赖LiveData的机制). 如果是网络数据,即客户端无法知道数据源的变化,可以通过诸如滑动刷新的方式将调用Datasource的invalidate()方法来拉去(pull)新的数据。

3.2 加载多个数据源的数据

这种场景一般是先加载本地数据,加载完成后再加载网络数据,比较适合需要本地做缓存的业务。比如IM中的聊天消息,当打开聊天界面时先加载本地数据库中的聊天消息,加载完了再加载网络的离线消息。这中场景的流程如下图所示:


multi data source Diagram

这种场景需要为PagedList设置BoundaryCallback来监听加载完本地数据的事件,触发加载网络数据,然后入库,此时LiveData<PagedList>会推送一个新的PagedList, 并触发界面刷新。

具体使用案例可以参考Google Sample的PagingWithNetworkSample项目。

四、小结

Paging Library作为Android架构组件库的一员,其特点主要还是在其架构思想上。Paging将分页的业务封装为一条完整的流水线,一个Pattern。其中各个组件之间存在联动的关系:

  • 当PagedList创建时会立即从Datasource加载数据(触发loadInitial()), DataSource加载到数据后会更新PagedList, PagedList更新会通知到PagedAdapter并刷新UI;

  • UI上的展示会触发PagedAdaptergetItem()随即触发PagedList的loadAround()方法从DataSource加载周围的数据...

整个过程Paging内部实现了线程的切换,数据的预加载,所有联动的关系都内聚到Paging中,这样使用时只需要关心加载数据的具体实现,并且在用户体验上,将会大大减少等待数据加载的时间和次数。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 143,048评论 1 300
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 61,330评论 1 256
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 94,541评论 0 213
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 41,042评论 0 176
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 48,821评论 1 255
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 38,795评论 1 176
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 30,413评论 2 271
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,173评论 0 167
  • 想象着我的养父在大火中拼命挣扎,窒息,最后皮肤化为焦炭。我心中就已经是抑制不住地欢快,这就叫做以其人之道,还治其人...
    爱写小说的胖达阅读 28,994评论 6 229
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 32,525评论 0 213
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,327评论 2 215
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 30,648评论 1 230
  • 白月光回国,霸总把我这个替身辞退。还一脸阴沉的警告我。[不要出现在思思面前, 不然我有一百种方法让你生不如死。]我...
    爱写小说的胖达阅读 24,248评论 0 31
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,142评论 2 214
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 31,521评论 3 204
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,622评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,025评论 0 166
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 33,543评论 2 230
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 33,636评论 2 231

推荐阅读更多精彩内容