Paging Library(分頁加載庫)用于逐步從數(shù)據(jù)源加載信息,而不會(huì)耗費(fèi)過多的設(shè)備資源或者等待太長的時(shí)間。
總體概覽
一個(gè)常見的需求是獲取很多數(shù)據(jù),但是同時(shí)也只展示其中的一小部分?jǐn)?shù)據(jù)。這就會(huì)引起很多問題,比如浪費(fèi)資源和流量等。
現(xiàn)有的Android APIs可以提供分頁加載的功能,但是也帶來了顯著的限制和缺點(diǎn):
- CursorAdapter,使得從數(shù)據(jù)庫加載數(shù)據(jù)到ListView變得非常容易。但是這是在主線程中查詢數(shù)據(jù)庫,并且分頁的內(nèi)容使用低效的 Cursor返回。更多使用CursorAdapter帶來的問題參考Large Database Queries on Android。
- AsyncListUtil提供基于位置的( position-based)分頁加載到 RecyclerView中,但是無法使用不基于位置(non-positional)的分頁加載,而且還強(qiáng)制把null作為占位符。
paging library就是為了解決上述的問題而提出的。
提供的類
DataSource
數(shù)據(jù)源。根據(jù)你想要訪問數(shù)據(jù)的方式,可以有兩種子類可供選擇:
- KeyedDataSource用于加載從第N到N+1數(shù)據(jù)。
- TiledDataSource 用于從任意位置的分頁數(shù)據(jù)。
例如使用 Room persistence library 就可以自動(dòng)創(chuàng)建返回 TiledDataSource類型的數(shù)據(jù):
@Query("select * from users WHERE age > :age order by name DESC, id ASC")
TiledDataSource<User> usersOlderThan(int age);
從DataSource獲取指定數(shù)量的數(shù)據(jù),并且可以制定預(yù)取多少數(shù)據(jù)。這樣可以最大程度減少加載數(shù)據(jù)的時(shí)間。這個(gè)類可以提供更新信息給其他類比如RecyclerView.Adapter來更新 RecyclerView的UI。
這個(gè)類是 RecyclerView.Adapter的一個(gè)實(shí)現(xiàn)類,用于當(dāng)數(shù)據(jù)加載完畢時(shí),通知 RecyclerView數(shù)據(jù)已經(jīng)到達(dá)。 RecyclerView就可以把數(shù)據(jù)填充進(jìn)來,取代原來的占位元素。
PagedListAdapter使用后臺(tái)線程來計(jì)算 PagedList 的改變。
從數(shù)據(jù)源中產(chǎn)生 LiveData<PagedList>。此外如果使用的是 Room persistence library,DAO還能使用 TiledDataSource生成 LivePagedListProvider。示例代碼:
@Query("SELECT * from users order WHERE age > :age order by name DESC, id ASC")
public abstract LivePagedListProvider<Integer, User> usersOlderThan(int age);
通過上面的類的配合使用,paging library從后臺(tái)線程獲取數(shù)據(jù)流,再在UI線程中展示。例如,當(dāng)新的item別插入到數(shù)據(jù)庫, DataSource被更新, LivePagedListProvider在后臺(tái)線程產(chǎn)生了新的 PagedList
詳細(xì)的流程如下圖:

新生成的 PagedList在主線程中被發(fā)送到PagedListAdapter, PagedListAdapter在后臺(tái)線程使用 DiffUtil計(jì)算新的list和原來的list的差距。當(dāng)比較完畢, PagedListAdapter調(diào)用RecyclerView.Adapter.notifyItemInserted()來通知數(shù)據(jù)刷新。
下面的示例代碼展示了這些類如何配合工作:
@Dao
interface UserDao {
@Query("SELECT * FROM user ORDER BY lastName ASC")
public abstract LivePagedListProvider<Integer, User> usersByLastName();
}
class MyViewModel extends ViewModel {
public final LiveData<PagedList<User>> usersList;
public MyViewModel(UserDao userDao) {
usersList = userDao.usersByLastName().create(
/* initial load position */ 0,
new PagedList.Config.Builder()
.setPageSize(50)
.setPrefetchDistance(50)
.build());
}
}
class MyActivity extends AppCompatActivity {
@Override
public void onCreate(Bundle savedState) {
super.onCreate(savedState);
MyViewModel viewModel = ViewModelProviders.of(this).get(MyViewModel.class);
RecyclerView recyclerView = findViewById(R.id.user_list);
UserAdapter<User> adapter = new UserAdapter();
viewModel.usersList.observe(this, pagedList -> adapter.setList(pagedList));
recyclerView.setAdapter(adapter);
}
}
class UserAdapter extends PagedListAdapter<User, UserViewHolder> {
public UserAdapter() {
super(DIFF_CALLBACK);
}
@Override
public void onBindViewHolder(UserViewHolder holder, int position) {
User user = getItem(position);
if (user != null) {
holder.bindTo(user);
} else {
// Null defines a placeholder item - PagedListAdapter will automatically invalidate
// this row when the actual object is loaded from the database
holder.clear();
}
}
public static final DiffCallback<User> DIFF_CALLBACK = new DiffCallback<User>() {
@Override
public boolean areItemsTheSame(@NonNull User oldUser, @NonNull User newUser) {
// User properties may have changed if reloaded from the DB, but ID is fixed
return oldUser.getId() == newUser.getId();
}
@Override
public boolean areContentsTheSame(@NonNull User oldUser, @NonNull User newUser) {
// NOTE: if you use equals, your object must properly override Object#equals()
// Incorrectly returning false here will result in too many animations.
return oldUser.equals(newUser);
}
}
}
好了,整個(gè)Android Architecture Components系列都介紹完了(并沒有,還有一篇WorkManager相關(guān)的文章,感興趣的可以看看),感謝各位大佬的閱讀。
整個(gè)系列的后兩篇文章相對(duì)介紹的比較粗糙一點(diǎn),主要還是因?yàn)闀r(shí)間比較緊張,還有其實(shí)Room和Paging Library更像是一個(gè)第三方庫,主要還是需要大家去寫一遍感受可能會(huì)更清晰一點(diǎn)。
PS.鑒于大家的都建議給一個(gè)整體框架的demo,這里可以提供一個(gè)更好的方案:Google Android Architecture Components,這是Google官方提供的樣例可以用來參考。
相關(guān)文章:
理解Android Architecture Components系列(一)
理解Android Architecture Components系列(二)
理解Android Architecture Components系列之Lifecycle(三)
理解Android Architecture Components系列之LiveData(四)
理解Android Architecture Components系列之ViewModel(五)
理解Android Architecture Components系列之Room(六)
理解Android Architecture Components系列之Paging Library(七)
理解Android Architecture Components系列之WorkManager(八)