分页库使您可以更轻松地在应用程序的RecyclerView中逐步和优雅地加载数据。
许多应用程序使用包含大量项目的数据源中的数据，但一次只显示一小部分。
分页库可帮助您的应用观察并显示此数据的合理子集。 此功能有几个优点：
- 数据请求消耗的网络带宽更少，系统资源更少。 拥有计量或小数据计划的用户会欣赏这些具有数据意识的应用程序。
- 即使在数据更新和刷新期间，应用程序仍会继续快速响应用户输入。
如果您的应用已包含分页数据和显示列表的逻辑，我们就如何更新现有应用提供了指导。
本指南概述了如何使用分页库来请求和显示用户希望在更经济地消耗系统资源时看到的数据。 有关特定于应用程序体系结构层的指南，请参阅以下相关页面：
- UI组件和注意事项
- 数据组件和注意事项
注意：无论您是仅使用设备内部数据库还是从应用程序的后端获取信息，分页库都可以帮助您顺利地在UI列表容器中显示数据。
一、库架构
Paging Library的关键组件是PagedList类，它是一个异步加载应用程序数据块或页面的集合。 此类充当应用程序架构的其他部分之间的中介：
Data
PagedList的每个实例都从其DataSource加载应用程序数据的最新快照。 数据从应用程序的后端或数据库流入PagedList对象。
分页库支持各种应用程序体系结构，包括独立数据库和与后端服务器通信的数据库。
UI
PagedList类与PagedListAdapter一起使用，可以将项目加载到RecyclerView中。 这些类一起工作以在加载内容时获取和显示内容，预取视图外内容并动画内容更改。
分页库实现了应用程序体系结构指南中建议的观察者模式。 特别是，库的核心组件创建了一个UI可以观察的LiveData <PagedList>（或等效的基于RxJava2的类）的实例。 然后，您的应用程序的UI可以在生成PagedList对象时显示内容，同时尊重UI控制器的生命周期。
二、支持不同的数据架构
分页库支持应用程序体系结构，包括应用程序仅从后端服务器获取数据，仅从设备上数据库或两个源的组合获取数据的应用程序体系结构。 本节为每种情况提供建议。
我们提供了用于不同数据架构的推荐模式的示例。 要查看它们，请参阅GitHub上的PagingWithNetwork示例。
仅限网络
要显示来自后端服务器的数据，请使用Retrofit API的同步版本将信息加载到您自己的自定义DataSource对象中。
仅数据库
设置RecyclerView以观察本地存储，最好使用Room persistence library。 这样，无论何时在应用程序的数据库中插入或修改数据，这些更改都会自动反映在显示此数据的RecyclerView中。
网络和数据库
在开始观察数据库之后，可以使用PagedList.BoundaryCallback监听数据库何时没有数据。 然后，您可以从网络中获取更多项目并将其插入数据库。 如果您的UI正在观察数据库，那就是您需要做的。
以下代码段显示了边界回调的示例用法：
public class ConcertViewModel {
public ConcertSearchResult search(String query) {
ConcertBoundaryCallback boundaryCallback =
new ConcertBoundaryCallback(query, myService, myCache);
// Use a LiveData object to communicate your network's state back
// to your app's UI, as in the following example. Note that error
// handling isn't shown in this snippet.
// LiveData<NetworkState> loadingState =
// boundaryCallback.getLoadingState();
}
}
public class ConcertBoundaryCallback
extends PagedList.BoundaryCallback<Concert> {
private String mQuery;
private MyService mService;
private MyLocalCache mCache;
public ConcertBoundaryCallback(String query, MyService service,
MyLocalCache cache) {
mQuery = query;
// ...
}
// Requests initial data from the network, replacing all content currently
// in the database.
@Override
public void onZeroItemsLoaded() {
requestAndReplaceInitialData(mQuery);
}
// Requests additional data from the network, appending the results to the
// end of the database's existing data.
@Override
public void onItemAtEndLoaded(@NonNull Concert itemAtEnd) {
requestAndAppendData(mQuery, itemAtEnd.key);
}
}
三、处理网络错误
当使用网络获取或分页您正在使用分页库显示的数据时，重要的是不要将网络视为“可用”或“不可用”，因为许多连接是间歇性的或片状的：
- 特定服务器可能无法响应网络请求。
- 设备可能连接到缓慢或弱的网络。
相反，您的应用应检查每个失败请求，并在网络不可用的情况下尽可能优雅地恢复。 例如，您可以提供“重试”按钮，供用户选择数据刷新步骤是否不起作用。 如果在数据分页步骤期间发生错误，则最好自动重试分页请求。
四、更新现有应用
如果您的应用已经消耗了数据库或后端源中的数据，则可以直接升级到分页库提供的功能。 本节介绍如何升级具有通用现有设计的应用程序。
定制分页解决方案
如果使用自定义功能从应用程序的数据源加载小的数据子集，则可以将此逻辑替换为PagedList类中的逻辑。 PagedList的实例提供与公共数据源的内置连接。 这些实例还为您可能包含在应用程序UI中的RecyclerView对象提供适配器。
使用列表而不是页面加载数据
如果使用内存列表作为UI适配器的后备数据结构，请考虑如果列表中的项目数可能变大，则使用PagedList类观察数据更新。 PagedList的实例可以使用LiveData <PagedList>或Observable <List>将数据更新传递到应用程序的UI，从而最大限度地减少加载时间和内存使用量。 更好的是，在应用程序中用PagedList对象替换List对象不需要对应用程序的UI结构或数据更新逻辑进行任何更改。
使用CursorAdapter将数据光标与列表视图相关联
您的应用程序可能使用CursorAdapter将Cursor中的数据与ListView相关联。 在这种情况下，您通常需要从ListView迁移到RecyclerView作为应用程序的列表UI容器，然后将Cursor组件替换为Room或PositionalDataSource，具体取决于Cursor实例是否访问SQLite数据库。
在某些情况下，例如在处理Spinner实例时，您只提供适配器本身。 然后，库将获取加载到该适配器中的数据并为您显示数据。 在这些情况下，将适配器数据的类型更改为LiveData <PagedList>，然后在尝试让库类在UI中对这些项进行膨胀之前，将此列表包装在ArrayAdapter对象中。
使用AsyncListUtil异步加载内容
如果您使用AsyncListUtil对象异步加载和显示信息组，则分页库可让您更轻松地加载数据：
- 您的数据不需要是位置的。 分页库允许您使用网络提供的密钥直接从后端加载数据。
- 您的数据可能非常大。 使用分页库，您可以将数据加载到页面中，直到没有剩余数据。
- 您可以更轻松地观察数据。 Paging库可以显示应用程序的ViewModel在可观察数据结构中保存的数据。
五、数据库示例
以下代码片段显示了将所有部分协同工作的几种可能方法。
使用LiveData观察分页数据
以下代码段显示了所有协同工作。 随着在数据库中添加，删除或更改音乐会事件，RecyclerView中的内容将自动且有效地更新：
@Dao
public interface ConcertDao {
// The Integer type parameter tells Room to use a PositionalDataSource
// object, with position-based loading under the hood.
@Query("SELECT * FROM concerts ORDER BY date DESC")
DataSource.Factory<Integer, Concert> concertsByDate();
}
public class ConcertViewModel extends ViewModel {
private ConcertDao mConcertDao;
public final LiveData<PagedList<Concert>> concertList;
public ConcertViewModel(ConcertDao concertDao) {
mConcertDao = concertDao;
concertList = new LivePagedListBuilder<>(
mConcertDao.concertsByDate(), /* page size */ 20).build();
}
}
public class ConcertActivity extends AppCompatActivity {
@Override
public void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
ConcertViewModel viewModel =
ViewModelProviders.of(this).get(ConcertViewModel.class);
RecyclerView recyclerView = findViewById(R.id.concert_list);
ConcertAdapter adapter = new ConcertAdapter();
viewModel.concertList.observe(this, adapter::submitList);
recyclerView.setAdapter(adapter);
}
}
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);
if (concert != null) {
holder.bindTo(concert);
} else {
// Null defines a placeholder item - PagedListAdapter automatically
// invalidates this row when the actual object is loaded from the
// database.
holder.clear();
}
}
private static DiffUtil.ItemCallback<Concert> DIFF_CALLBACK =
new DiffUtil.ItemCallback<Concert>() {
// Concert details may have changed if reloaded from the database,
// but ID is fixed.
@Override
public boolean areItemsTheSame(Concert oldConcert, Concert newConcert) {
return oldConcert.getId() == newConcert.getId();
}
@Override
public boolean areContentsTheSame(Concert oldConcert,
Concert newConcert) {
return oldConcert.equals(newConcert);
}
};
}
使用RxJava2观察分页数据
如果您更喜欢使用RxJava2而不是LiveData，则可以创建一个Observable或Flowable对象：
public class ConcertViewModel extends ViewModel {
private ConcertDao mConcertDao;
public final Flowable<PagedList<Concert>> concertList;
public ConcertViewModel(ConcertDao concertDao) {
mConcertDao = concertDao;
concertList = new RxPagedListBuilder<>(
mConcertDao.concertsByDate(), /* page size */ 50)
.buildFlowable(BackpressureStrategy.LATEST);
}
}
然后，您可以使用以下代码段中的代码开始和停止观察数据：
public class ConcertActivity extends AppCompatActivity {
private ConcertAdapter mAdapter;
private ConcertViewModel mViewModel;
private CompositeDisposable mDisposable = new CompositeDisposable();
@Override
public void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
RecyclerView recyclerView = findViewById(R.id.concert_list);
mViewModel = ViewModelProviders.of(this).get(ConcertViewModel.class);
mAdapter = new ConcertAdapter();
recyclerView.setAdapter(mAdapter);
}
@Override
protected void onStart() {
super.onStart();
mDisposable.add(mViewModel.concertList.subscribe(
flowableList -> mAdapter.submitList(flowableList)
));
}
@Override
protected void onStop() {
super.onStop();
mDisposable.clear();
}
}
对于基于RxJava2的解决方案，ConcertDao和ConcertAdapter的代码与基于LiveData的解决方案的代码相同。
