正如我所标注的,List<ItemData>
中一个ItemData
对应了一个ItemView
——我认为为一个Header
或者Footer
单独创建对应一个Model
类型是完全值得的,它极大增强了代码的可读性,而且对于复杂的Header
而言,代表状态的Model
类也更容易让开发者对其进行渲染。
这种实现方式简单、易读而不失优雅,但是在Paging
中,这种思路一开始就被堵死了。
我们先看PagedListAdapter
类的声明:
// T泛型代表数据源的类型,即本文中的 Student
public abstract class PagedListAdapter<T, VH extends RecyclerView.ViewHolder>
extends RecyclerView.Adapter {
// …
}
因此,我们需要这样实现:
// 这里我们只能指定Student类型
class SimpleAdapter : PagedListAdapter<Student, RecyclerView.ViewHolder>(diffCallback) {
// …
}
有同学提出,我们可以将这里的Student
指定为某个接口(比如定义一个ItemData
接口),然后让Student
和Header
对应的Model
都去实现这个接口,然后这样:
class SimpleAdapter : PagedListAdapter<ItemData, RecyclerView.ViewHolder>(diffCallback) {
// …
}
看起来确实可行,但是我们忽略了一个问题,那就是本小节要阐述的:
我们并没有直接持有数据源。
回到初衷,我们知道,Paging
最大的亮点在于 自动分页加载,这是观察者模式的体现,配置完成后,我们并不关心 数据是如何被分页、何时被加载、如何被渲染 的,因此我们也不需要直接持有List<Student>
(实际上也持有不了),更无从谈起手动为其添加HeaderItem
和FooterItem
了。
以本文为例,实际上所有逻辑都交给了ViewModel
:
class CommonViewModel(app: Application) : AndroidViewModel(app) {
private val dao = StudentDb.get(app).studentDao()
fun getRefreshLiveData(): LiveData<PagedList> =
LivePagedListBuilder(dao.getAllStudent(), PagedList.Config.Builder()
.setPageSize(15) //配置分页加载的数量
.setInitialLoadSizeHint(40) //初始化加载的数量
.build()).build()
}
可以看到,我们并未直接持有List<Student>
,因此list.add(headerItem)
这种 持有并修改数据源 的方案几乎不可行(较真而言,其实是可行的,但是成本过高,本文不深入讨论)。
2.尝试直接实现列表
接下来我针对直接实现多类型列表进行尝试,我们先不讨论如何实现Footer
,仅以Header
而言,我们进行如下的实现:
class HeaderSimpleAdapter : PagedListAdapter<Student, RecyclerView.ViewHolder>(diffCallback) {
// 1.根据position为item分配类型
// 如果position = 1,视为Header
// 如果position != 1,视为普通的Student
override fun getItemViewType(position: Int): Int {
return when (position == 0) {
true -> ITEM_TYPE_HEADER
false -> super.getItemViewType(position)
}
}
// 2.根据不同的viewType生成对应ViewHolder
override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): RecyclerView.ViewHolder {
return when (viewType) {
ITEM_TYPE_HEADER -> HeaderViewHolder(parent)
else -> StudentViewHolder(parent)
}
}
// 3.根据holder类型,进行对应的渲染
override fun onBindViewHolder(holder: RecyclerView.ViewHolder, position: Int) {
when (holder) {
is HeaderViewHolder -> holder.renderHeader()
is StudentViewHolder -> holder.renderStudent(getStudentItem(position))
}
}
// 4.这里我们根据StudentItem的position,
// 获取position-1位置的学生
private fun getStudentItem(position: Int): Student? {
return getItem(position - 1)
}
// 5.因为有Header,item数量要多一个
override fun getItemCount(): Int {
return super.getItemCount() + 1
}
// 省略其他代码…
// 省略ViewHolder代码
}
代码和注释已经将我的个人思想展示的很清楚了,我们固定一个Header
在多类型列表的最上方,这也导致我们需要重写getItemCount()
方法,并且在对Item
进行渲染的onBindViewHolder()
方法中,对Sutdent
的获取进行额外的处理——因为多了一个Header,导致产生了数据源和列表的错位差—— 第n个数据被获取时,我们应该将其渲染在列表的第n+1个位置上。
我简单绘制了一张图来描述这个过程,也许更加直观易懂:
代码写完后,直觉告诉我似乎没有什么问题,让我们来看看实际的运行效果:
Gif也许展示并不那么清晰,简单总结下,问题有两个:
- 1.在我们进行下拉刷新时,因为
Header
更应该是一个静态独立的组件,但实际上它也是列表的一部分,因此白光一闪,除了Student
列表,Header
作为Item
也进行了刷新,这与我们的预期不符; - 2.下拉刷新之后,列表 并未展示在最顶部,而是滑动到了一个奇怪的位置。
导致这两个问题的根本原因仍然是Paging
计算列表的position
时出现的问题:
对于问题1,Paging
对于列表的刷新理解为 所有Item的刷新,因此同样作为Item
的Header
也无法避免被刷新;
问题2依然也是这个问题导致的,在Paging
获取到第一页数据时(假设第一页数据只有10条),Paging
会命令更新position in 0..9
的Item
,而实际上因为Header
的关系,我们是期望它能够更新第position in 1..10
的Item
,最终导致了刷新以及对新数据的展示出现了问题。
3.向Google和Github寻求答案
正如标题而言,我尝试求助于Google
和Github
,最终找到了这个链接:
PagingWithNetworkSample - PagedList RecyclerView scroll bug
如果您简单研究过PagedListAdapter
的源码的话,您应该了解,PagedListAdapter
内部定义了一个AsyncPagedListDiffer
,用于对列表数据的加载和展示,PagedListAdapter
更像是一个空壳,所有分页相关的逻辑实际都 委托 给了AsyncPagedListDiffer
:
public abstract class PagedListAdapter<T, VH extends RecyclerView.ViewHolder>
extends RecyclerView.Adapter {
final AsyncPagedListDiffer mDiffer;
public void submitList(@Nullable PagedList pagedList) {
mDiffer.submitList(pagedList);
}
protected T getItem(int position) {
return mDiffer.getItem(position);
}
public int getItemCount() {
return mDiffer.getItemCount();
}
public PagedList getCurrentList() {
return mDiffer.getCurrentList();
}
}
虽然Paging
中数据的获取和展示我们是无法控制的,但我们可以尝试 瞒过 PagedListAdapter
,即使Paging
得到了position in 0..9
的List<Data>
,但是我们让PagedListAdapter
去更新position in 1..10
的item不就可以了嘛?
因此在上方的Issue
链接中,onlymash 同学提出了一个解决方案:
重写PagedListAdapter
中被AsyncPagedListDiffer
代理的所有方法,然后实例化一个新的AsyncPagedListDiffer
,并让这个新的differ代理这些方法。
篇幅所限,我们只展示部分核心代码:
class PostAdapter: PagedListAdapter<Any, RecyclerView.ViewHolder>() {
private val adapterCallback = AdapterListUpdateCallback(this)
// 当第n个数据被获取,更新第n+1个position
private val listUpdateCallback = object : ListUpdateCallback {
override fun onChanged(position: Int, count: Int, payload: Any?) {
adapterCallback.onChanged(position + 1, count, payload)
}
override fun onMoved(fromPosition: Int, toPosition: Int) {
adapterCallback.onMoved(fromPosition + 1, toPosition + 1)
}
override fun onInserted(position: Int, count: Int) {
adapterCallback.onInserted(position + 1, count)
}
override fun onRemoved(position: Int, count: Int) {
adapterCallback.onRemoved(position + 1, count)
}
}
// 新建一个differ
private val differ = AsyncPagedListDiffer(listUpdateCallback,
AsyncDifferConfig.Builder(POST_COMPARATOR).build())
// 将所有方法重写,并委托给新的differ去处理
override fun getItem(position: Int): Any? {
return differ.getItem(position - 1)
}
// 将所有方法重写,并委托给新的differ去处理
override fun submitList(pagedList: PagedList?) {
differ.submitList(pagedList)
}
// 将所有方法重写,并委托给新的differ去处理
override fun getCurrentList(): PagedList? {
return differ.currentList
}
}
现在我们成功实现了上文中我们的思路,一图胜千言:
4.另外一种实现方式
上一小节的实现方案是完全可行的,但我个人认为美中不足的是,这种方案 对既有的Adapter
中代码改动过大。
我新建了一个AdapterListUpdateCallback
、一个ListUpdateCallback
以及一个新的AsyncPagedListDiffer
,并重写了太多的PagedListAdapter
的方法——我添加了数十行分页相关的代码,但这些代码和正常的列表展示并没有直接的关系。
当然,我可以将这些逻辑都抽出来放在一个新的类里面,但我还是感觉我 好像是模仿并重写了一个新的PagedListAdapter
类一样,那么是否还有其它的思路呢?
最终我找到了这篇文章:
Android RecyclerView + Paging Library 添加头部刷新会自动滚动的问题分析及解决
这篇文章中的作者通过细致分析Paging
的源码,得出了一个更简单实现Header
的方案,有兴趣的同学可以点进去查看,这里简单阐述其原理:
通过查看源码,以添加分页为例,Paging
对拿到最新的数据后,对列表的更新实际是调用了RecyclerView.Adapter
的notifyItemRangeInserted()
方法,而我们可以通过重写Adapter.registerAdapterDataObserver()
方法,对数据更新的逻辑进行调整:
// 1.新建一个 AdapterDataObserverProxy 类继承 RecyclerView.AdapterDataObserver
class AdapterDataObserverProxy extends RecyclerView.AdapterDataObserver {
RecyclerView.AdapterDataObserver adapterDataObserver;
int headerCount;
public ArticleDataObserver(RecyclerView.AdapterDataObserver adapterDataObserver, int headerCount) {
this.adapterDataObserver = adapterDataObserver;
this.headerCount = headerCount;
}
@Override
public void onChanged() {
adapterDataObserver.onChanged();
}
@Override
public void onItemRangeChanged(int positionStart, int itemCount) {
adapterDataObserver.onItemRangeChanged(positionStart + headerCount, itemCount);
}
@Override
public void onItemRangeChanged(int positionStart, int itemCount, @Nullable Object payload) {
adapterDataObserver.onItemRangeChanged(positionStart + headerCount, itemCount, payload);
}
// 当第n个数据被获取,更新第n+1个position
@Override
public void onItemRangeInserted(int positionStart, int itemCount) {
adapterDataObserver.onItemRangeInserted(positionStart + headerCount, itemCount);
}
@Override
public void onItemRangeRemoved(int positionStart, int itemCount) {
adapterDataObserver.onItemRangeRemoved(positionStart + headerCount, itemCount);
}
@Override
public void onItemRangeMoved(int fromPosition, int toPosition, int itemCount) {
super.onItemRangeMoved(fromPosition + headerCount, toPosition + headerCount, itemCount);
}
尾声
以薪资待遇为基础,以发展为最终目标,要在高薪资的地方,谋求最好的发展!
下面是有几位Android行业大佬对应上方技术点整理的一些进阶资料。
网上学习资料一大堆,但如果学到的知识不成体系,遇到问题时只是浅尝辄止,不再深入研究,那么很难做到真正的技术提升。
一个人可以走的很快,但一群人才能走的更远!不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人,都欢迎加入我们的的圈子(技术交流、学习资源、职场吐槽、大厂内推、面试辅导),让我们一起学习成长!
图片转存中…(img-wTzyb6Oh-1714400780968)]
网上学习资料一大堆,但如果学到的知识不成体系,遇到问题时只是浅尝辄止,不再深入研究,那么很难做到真正的技术提升。
一个人可以走的很快,但一群人才能走的更远!不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人,都欢迎加入我们的的圈子(技术交流、学习资源、职场吐槽、大厂内推、面试辅导),让我们一起学习成长!