使用分页架构组件调试分页
Debugging pagination with Paging Architecture Component
所以我使用 LiveData
和 Room 数据库用分页库编写了一个简单的笔记功能,但我没有看到它实际上对任何内容进行分页。也许我没有正确调试以确认分页正在发生。任何建议表示赞赏。
在我的 DAO 中:
@Query("SELECT * FROM notes ORDER BY id ASC")
fun allNotes(): DataSource.Factory<Int, NoteEntity>
然后在我的 NotesRepository
中,我从 NoteEntity
转换为 Note
以保持我的数据层实现细节和应用程序的其余部分分开(我是 Clean Architecture 的粉丝).所以结果是 DataSource.Factory<Int, Note>
:
override fun allNotes(): DataSource.Factory<Int, Note> =
notesDao.allNotes().map { mapper.fromDb(it) }
在我的 ViewModel
中 PAGE_SIZE
是 20:
val noteList: LiveData<PagedList<Note>> =
LivePagedListBuilder(
getNotesUseCase.allNotes(), PAGE_SIZE)
我的Note
就是:
data class Note(
val id: Long = 0,
val text: String
)
那我在RecyclerView
中显示注释。
我的 ViewHolder
包含:
class NoteViewHolder(parent: ViewGroup) : RecyclerView.ViewHolder(
LayoutInflater.from(parent.context).inflate(R.layout.note_item, parent, false)) {
private val idView = itemView.findViewById<TextView>(R.id.noteId)
private val nameView = itemView.findViewById<TextView>(R.id.noteText)
private var note: Note? = null
/**
* Items might be null if they are not paged in yet. PagedListAdapter will re-bind the
* ViewHolder when Item is loaded.
*/
fun bindTo(note: Note?) {
this.note = note
idView.text = note?.let { it.id.toString() } ?: ""
nameView.text = note?.text ?: ""
}
}
我的 Adapter
包含:
class NoteAdapter(
private val clickListener: ClickListener) : PagedListAdapter<Note, NoteViewHolder>(diffCallback) {
override fun onBindViewHolder(holder: NoteViewHolder, position: Int) {
Timber.d("Binding view holder at position $position")
val note = getItem(position)
with(holder) {
bindTo(note)
note?.let {
itemView.setOnClickListener {
clickListener(note)
}
}
}
}
override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): NoteViewHolder =
NoteViewHolder(parent)
companion object {
/**
* This diff callback informs the PagedListAdapter how to compute list differences when new
* PagedLists arrive.
*/
private val diffCallback = object : DiffUtil.ItemCallback<Note>() {
override fun areItemsTheSame(oldItem: Note, newItem: Note): Boolean =
oldItem.id == newItem.id
override fun areContentsTheSame(oldItem: Note, newItem: Note): Boolean =
oldItem == newItem
}
}
}
我的 Fragment
包含:
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
super.onViewCreated(view, savedInstanceState)
setupRecyclerView()
viewModel = ViewModelProviders.of(this, noteListViewModelFactory).get(NoteListViewModel::class.java)
viewModel.noteList.observe(this, Observer { pagedNoteList ->
pagedNoteList?.let { render(pagedNoteList) }
})
}
private fun render(pagedNoteList: PagedList<Note>) {
recyclerViewAdapter.submitList(pagedNoteList)
}
RecyclerView 中的数据加载成功,我看到了每个项目绑定时的调试日志。 我的理解是 PagedListAdapter
我在用户滚动时使用请求新页面并通过在后台线程上计算差异来处理新的 PagedList
s。
我的数据源包含 100 个项目,因此我希望页面大小为 20,在平均大小 phone 上进行测试时会调用 5 次数据。
如何调试以确保正确的调用次数?此外,在上面的实现中,是否默认使用其中之一(PositionalDataSource、ItemKeyedDataSource 或 PageKeyedDataSource)?
回答我自己的问题:
似乎默认使用 PositionalDataSource
房间。
通过在我的 NoteAdapter.onBindViewHolder()
中添加以下日志语句,我能够弄清楚我的笔记是如何分块加载的:
Log.d("NoteAdapter", currentList)
其中 currentList
是超级 class PagedListAdapter
的 属性。
/**
* Returns the PagedList currently being displayed by the Adapter.
* etc.
*/
@Nullable
public PagedList<T> getCurrentList() {
return mDiffer.getCurrentList();
}
随着用户滚动,新项目将绑定到视图持有者,并且日志会显示正在迭代的 currentList
的内容。
另请注意,当您将页面大小设置为 N
时,初始列表大小将包含计数 3 * N
。然后每次用户滚动浏览它们时,N
将有更多项目放入 currentList
。这是因为我在请求页面列表时使用了默认配置:
val noteList: LiveData<PagedList<Note>> =
LivePagedListBuilder(
getNotesUseCase.allNotes(), PAGE_SIZE)
.build()
相反,我可以做这样的事情来控制 initialLoadSizeHint:
private val pagedListConfig = PagedList.Config.Builder()
.setEnablePlaceholders(true)
.setInitialLoadSizeHint(INITIAL_LOAD_SIZE)
.setPageSize(PAGE_SIZE)
.build()
val noteList = LivePagedListBuilder<Int,Note>(getNotesUseCase.allNotes(), pagedListConfig).build()
默认情况下,initialLoadSizeHint 等于 PAGE_SIZE * 3.
所以我使用 LiveData
和 Room 数据库用分页库编写了一个简单的笔记功能,但我没有看到它实际上对任何内容进行分页。也许我没有正确调试以确认分页正在发生。任何建议表示赞赏。
在我的 DAO 中:
@Query("SELECT * FROM notes ORDER BY id ASC")
fun allNotes(): DataSource.Factory<Int, NoteEntity>
然后在我的 NotesRepository
中,我从 NoteEntity
转换为 Note
以保持我的数据层实现细节和应用程序的其余部分分开(我是 Clean Architecture 的粉丝).所以结果是 DataSource.Factory<Int, Note>
:
override fun allNotes(): DataSource.Factory<Int, Note> =
notesDao.allNotes().map { mapper.fromDb(it) }
在我的 ViewModel
中 PAGE_SIZE
是 20:
val noteList: LiveData<PagedList<Note>> =
LivePagedListBuilder(
getNotesUseCase.allNotes(), PAGE_SIZE)
我的Note
就是:
data class Note(
val id: Long = 0,
val text: String
)
那我在RecyclerView
中显示注释。
我的 ViewHolder
包含:
class NoteViewHolder(parent: ViewGroup) : RecyclerView.ViewHolder(
LayoutInflater.from(parent.context).inflate(R.layout.note_item, parent, false)) {
private val idView = itemView.findViewById<TextView>(R.id.noteId)
private val nameView = itemView.findViewById<TextView>(R.id.noteText)
private var note: Note? = null
/**
* Items might be null if they are not paged in yet. PagedListAdapter will re-bind the
* ViewHolder when Item is loaded.
*/
fun bindTo(note: Note?) {
this.note = note
idView.text = note?.let { it.id.toString() } ?: ""
nameView.text = note?.text ?: ""
}
}
我的 Adapter
包含:
class NoteAdapter(
private val clickListener: ClickListener) : PagedListAdapter<Note, NoteViewHolder>(diffCallback) {
override fun onBindViewHolder(holder: NoteViewHolder, position: Int) {
Timber.d("Binding view holder at position $position")
val note = getItem(position)
with(holder) {
bindTo(note)
note?.let {
itemView.setOnClickListener {
clickListener(note)
}
}
}
}
override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): NoteViewHolder =
NoteViewHolder(parent)
companion object {
/**
* This diff callback informs the PagedListAdapter how to compute list differences when new
* PagedLists arrive.
*/
private val diffCallback = object : DiffUtil.ItemCallback<Note>() {
override fun areItemsTheSame(oldItem: Note, newItem: Note): Boolean =
oldItem.id == newItem.id
override fun areContentsTheSame(oldItem: Note, newItem: Note): Boolean =
oldItem == newItem
}
}
}
我的 Fragment
包含:
override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
super.onViewCreated(view, savedInstanceState)
setupRecyclerView()
viewModel = ViewModelProviders.of(this, noteListViewModelFactory).get(NoteListViewModel::class.java)
viewModel.noteList.observe(this, Observer { pagedNoteList ->
pagedNoteList?.let { render(pagedNoteList) }
})
}
private fun render(pagedNoteList: PagedList<Note>) {
recyclerViewAdapter.submitList(pagedNoteList)
}
RecyclerView 中的数据加载成功,我看到了每个项目绑定时的调试日志。 我的理解是 PagedListAdapter
我在用户滚动时使用请求新页面并通过在后台线程上计算差异来处理新的 PagedList
s。
我的数据源包含 100 个项目,因此我希望页面大小为 20,在平均大小 phone 上进行测试时会调用 5 次数据。
如何调试以确保正确的调用次数?此外,在上面的实现中,是否默认使用其中之一(PositionalDataSource、ItemKeyedDataSource 或 PageKeyedDataSource)?
回答我自己的问题:
似乎默认使用 PositionalDataSource
房间。
通过在我的 NoteAdapter.onBindViewHolder()
中添加以下日志语句,我能够弄清楚我的笔记是如何分块加载的:
Log.d("NoteAdapter", currentList)
其中 currentList
是超级 class PagedListAdapter
的 属性。
/**
* Returns the PagedList currently being displayed by the Adapter.
* etc.
*/
@Nullable
public PagedList<T> getCurrentList() {
return mDiffer.getCurrentList();
}
随着用户滚动,新项目将绑定到视图持有者,并且日志会显示正在迭代的 currentList
的内容。
另请注意,当您将页面大小设置为 N
时,初始列表大小将包含计数 3 * N
。然后每次用户滚动浏览它们时,N
将有更多项目放入 currentList
。这是因为我在请求页面列表时使用了默认配置:
val noteList: LiveData<PagedList<Note>> =
LivePagedListBuilder(
getNotesUseCase.allNotes(), PAGE_SIZE)
.build()
相反,我可以做这样的事情来控制 initialLoadSizeHint:
private val pagedListConfig = PagedList.Config.Builder()
.setEnablePlaceholders(true)
.setInitialLoadSizeHint(INITIAL_LOAD_SIZE)
.setPageSize(PAGE_SIZE)
.build()
val noteList = LivePagedListBuilder<Int,Note>(getNotesUseCase.allNotes(), pagedListConfig).build()
默认情况下,initialLoadSizeHint 等于 PAGE_SIZE * 3.