显示分页列表

本指南基于 Paging 库概览,介绍了如何在应用的界面中向用户呈现信息列表,尤其是在这些信息发生变化时。

将您的界面连接到视图模型

您可以将 LiveData<PagedList> 实例连接到 PagedListAdapter,如以下代码段所示:

Kotlin

class ConcertActivity : AppCompatActivity() {
    private val adapter = ConcertAdapter()

    // Use the 'by viewModels()' Kotlin property delegate
    // from the activity-ktx artifact
    private val viewModel: ConcertViewModel by viewModels()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState);
        viewModel.concerts.observe(this, Observer { adapter.submitList(it) })
    }
}

Java

public class ConcertActivity extends AppCompatActivity {
    private ConcertAdapter adapter = new ConcertAdapter();
    private ConcertViewModel viewModel;

    @Override
    public void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        viewModel = new ViewModelProvider(this).get(ConcertViewModel.class);
        viewModel.concertList.observe(this, adapter::submitList);
    }
}

当数据源提供 PagedList 的新实例时,Activity 会将这些对象发送到适配器。PagedListAdapter 实现定义了更新的计算方式,它会自动处理分页和列表差异计算。因此,您的 ViewHolder 只需绑定到特定提供的项

Kotlin

class ConcertAdapter() :
        PagedListAdapter<Concert, ConcertViewHolder>(DIFF_CALLBACK) {
    override fun onBindViewHolder(holder: ConcertViewHolder, position: Int) {
        val concert: Concert? = getItem(position)

        // Note that "concert" is a placeholder if it's null.
        holder.bindTo(concert)
    }

    companion object {
        private val DIFF_CALLBACK = ... // See Implement the diffing callback section.
    }
}

Java

public class ConcertAdapter
        extends PagedListAdapter<Concert, ConcertViewHolder> {
    protected ConcertAdapter() {
        super(DIFF_CALLBACK);
    }

    @Override
    public void onBindViewHolder(@NonNull ConcertViewHolder holder,
            int position) {
        Concert concert = getItem(position);

        // Note that "concert" can be null if it's a placeholder.
        holder.bindTo(concert);
    }

    private static DiffUtil.ItemCallback<Concert> DIFF_CALLBACK
            = ... // See Implement the diffing callback section.
}

PagedListAdapter 使用 PagedList.Callback 对象处理页面加载事件。当用户滚动时,PagedListAdapter 会调用 PagedList.loadAround() 来向底层 PagedList 提供关于它应该从 DataSource 获取哪些项的提示。

实现差异回调

以下示例展示了 areContentsTheSame() 的手动实现,它比较了相关的对象字段

Kotlin

private val DIFF_CALLBACK = object : DiffUtil.ItemCallback<Concert>() {
    // The ID property identifies when items are the same.
    override fun areItemsTheSame(oldItem: Concert, newItem: Concert) =
            oldItem.id == newItem.id

    // If you use the "==" operator, make sure that the object implements
    // .equals(). Alternatively, write custom data comparison logic here.
    override fun areContentsTheSame(
            oldItem: Concert, newItem: Concert) = oldItem == newItem
}

Java

private static DiffUtil.ItemCallback<Concert> DIFF_CALLBACK =
        new DiffUtil.ItemCallback<Concert>() {

    @Override
    public boolean areItemsTheSame(Concert oldItem, Concert newItem) {
        // The ID property identifies when items are the same.
        return oldItem.getId() == newItem.getId();
    }

    @Override
    public boolean areContentsTheSame(Concert oldItem, Concert newItem) {
        // Don't use the "==" operator here. Either implement and use .equals(),
        // or write custom data comparison logic here.
        return oldItem.equals(newItem);
    }
};

由于您的适配器包含了您对项比较的定义,因此当加载新的 PagedList 对象时,适配器会自动检测这些项的变化。因此,适配器会在您的 RecyclerView 对象中触发高效的项动画。

使用不同的适配器类型进行差异比较

如果您选择不从 PagedListAdapter 继承(例如,当您使用的库提供了自己的适配器时),您仍然可以通过直接使用 AsyncPagedListDiffer 对象来使用 Paging 库适配器的差异比较功能。

在界面中提供占位符

如果您希望在应用完成数据提取之前,界面就显示列表,您可以向用户显示占位符列表项。PagedList 通过将列表项数据呈现为 null 来处理这种情况,直到数据加载完成。

占位符具有以下优点:

  • 支持滚动条: PagedListPagedListAdapter 提供列表项的数量。此信息允许适配器绘制一个滚动条,以显示列表的完整大小。当新页面加载时,滚动条不会跳动,因为您的列表大小不会改变。
  • 无需加载微调器: 由于列表大小已已知,因此无需提醒用户正在加载更多项。占位符本身就传达了这些信息。

但是,在添加占位符支持之前,请记住以下先决条件:

  • 需要可计数数据集: 来自 Room 持久性库DataSource 实例可以高效地计数其项。但是,如果您使用自定义本地存储解决方案或仅网络数据架构,确定数据集包含多少项可能代价高昂甚至不可能。
  • 要求适配器考虑未加载的项: 您用于准备列表以进行膨胀的适配器或呈现机制需要处理 null 列表项。例如,在将数据绑定到 ViewHolder 时,您需要提供默认值来表示未加载的数据。
  • 要求相同大小的项视图: 如果列表项大小会根据其内容(例如社交网络更新)而改变,那么项之间的交叉淡入淡出效果不会很好看。在这种情况下,我们强烈建议禁用占位符。

提供反馈

通过这些资源与我们分享您的反馈和想法:

问题跟踪器
报告问题,以便我们修复 bug。

其他资源

要了解有关 Paging 库的更多信息,请查阅以下资源。

示例

Codelabs

视频