相關文章：

• 【翻譯】安卓架構組件(1)-App架構指導
• 【翻譯】安卓架構組件(2)-添加組件到你的項目中
• 【翻譯】安卓架構組件(3)-處理生命周期
• 【翻譯】安卓架構組件(4)-LiveData
• 【翻譯】安卓架構組件(5)-ViewModel
• 【翻譯】安卓架構組件(6)-Room持久化類庫

分頁庫使你的app能夠在需要從一個數(shù)據(jù)源逐步加載數(shù)據(jù)時更為輕松，避免了過度加載以及為了一個大型數(shù)據(jù)的查詢等待太多時間。

綜述

許多app伴隨著大量的數(shù)據(jù)，但是在任意時刻往往只需要加載和顯示其中的一小部分。一個app可能存在數(shù)以萬計的數(shù)據(jù)以供顯示，但在某一時刻僅僅需要訪問其中的幾十條。如果app沒有認真處理這個這個問題，會請求實際上并不需要的數(shù)據(jù)，并導致不必要的性能負擔和網(wǎng)絡帶寬。如果數(shù)據(jù)并沒有被存儲起來或同步到遠程數(shù)據(jù)庫，這同樣會減慢app的運行速度以及浪費用戶的流量。

當然現(xiàn)有的安卓API允許對內容進行分頁，它們伴有明顯的約束和缺點：

• CursorAdapter使得將數(shù)據(jù)庫查詢結果映射到ListView列表項更為輕松，但它會在UI線程執(zhí)行數(shù)據(jù)庫查詢，并且使用Cursor的分頁并不高效。對于使用CursorAdapter的更多缺陷，請查詢這里。
• AsyncListUtil允許將基于位置的分頁數(shù)據(jù)加載至RecyclerView，但是并不允許無位置的分頁，而且它會強迫使用空白占用位。

新的分頁庫致力于解決這些問題。這個類庫包含一些類，以流水線的方式處理你所需數(shù)據(jù)的請求過程。這些類也可以和已經(jīng)存在的架構類組件無縫結合，如Room。

類

分頁庫提供以下的類以及額外的支持類：

DataSource

使用這個類定義一個你用來分頁拉取的數(shù)據(jù)源。根據(jù)如何訪問你的數(shù)據(jù)，你可以集成以下兩個子類之一：

• KeyedDataSource 如果你需要從第N個數(shù)據(jù)項獲取第N+1個數(shù)據(jù)項。例如，如果你的線程在一個討論的app獲取評論，你可能需要傳遞一個評論的id來獲取下一個評論。
• TiledDataSource 如果你需要從你的數(shù)據(jù)源中獲取任意指定位置的分頁數(shù)據(jù)。這個類支持從你選擇的任何位置請求數(shù)據(jù)，例如：“返回從位置1200開始的20條數(shù)據(jù)”。

如果你使用Room來管理你的數(shù)據(jù)，它會自動創(chuàng)建一個TiledDataSource，例如：

@Query("select * from users WHERE age > :age order by name DESC, id ASC")
TiledDataSource<User> usersOlderThan(int age);

PagedList

這個類從DataSource加載數(shù)據(jù)。你可以配置在任何時刻該獲取多少數(shù)據(jù)，以及需要預加載多少數(shù)據(jù)，以最小化用戶等待數(shù)據(jù)被加載時等待的時間。這個類可以給其他類提供更新信號，例如RecyclerView.Adapter，允許當數(shù)據(jù)分頁加載時更新你的RecyclerView。

PagedListAdapter

這個類是RecyclerView.Adapter的子類，使得數(shù)據(jù)從PagedList中展現(xiàn)。例如，當新的一頁數(shù)據(jù)被加載時，PagedListAdapter通知RecyclerView數(shù)據(jù)已經(jīng)到達，這讓RecyclerView替換任何占位項，并展示合適的動畫效果。

PagedListAdapter使用后臺線程計算從一個PagedList到另一個的變化（例如，當數(shù)據(jù)庫的變更導致數(shù)據(jù)的更新），并調用notifyItem...()方法，并在需要時更新列表數(shù)據(jù)內容。之后RecyclerView展現(xiàn)必要的變化。例如，當一個數(shù)據(jù)項在不同的PagedList版本間變更位置時，RecyclerView動畫會展示數(shù)據(jù)項移動到新的位置。

LivePagedListProvider

這個生成從你提供的DataSource生成一個LiveData<PagedList>。此外，如果你使用Room持久化類庫來管理你的數(shù)據(jù)庫，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);

Integer參數(shù)告知Room基于位置加載的TiledDataSource。

分頁庫組件在后臺線程組織了數(shù)據(jù)流，并在UI線程展示。例如：當一個新的數(shù)據(jù)項被插入到你的數(shù)據(jù)庫時，DataSource會失效， 后臺線程產(chǎn)生一個新的PagedList。

圖1 分頁庫組件在后臺線程執(zhí)行大部分工作，因此并不會影響UI線程

新創(chuàng)建的PagedList在UI線程被發(fā)送到PagedListAdapter。之后PagedListAdapter使用DiffUtil在后臺線程計算當前列表和新列表的不同。當比較結束時，PagedListAdapter使用比較得到的差異信息適當?shù)卣{用RecyclerView.Adapter.notifyItemInserted()來通知新的數(shù)據(jù)項被插入。

RecyclerView在UI線程知道僅僅需要綁定一個新的數(shù)據(jù)項，并使用動畫展示在屏幕上。

下面的代碼示例顯示了所有相關部分的工作。當數(shù)據(jù)庫添加、刪除或者更新時，RecyclerView的內容自動且高效地更新：

@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(
                /* 初始化加載位置 */ 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時定義了一個占位項——當實際的對象被從數(shù)據(jù)庫加載時，PagedListAdapter會自動失效該行
            holder.clear();
        }
    }
    public static final DiffCallback<User> DIFF_CALLBACK = new DiffCallback<User>() {
        @Override
        public boolean areItemsTheSame(@NonNull User oldUser, @NonNull User newUser) {
            // 用戶屬性可能會在重新加載時變化，但id是固定的。
            return oldUser.getId() == newUser.getId();
        }
        @Override
        public boolean areContentsTheSame(@NonNull User oldUser, @NonNull User newUser) {
            // 注意：如果你使用equals，你的對象會重載Object.equals()方法
            // 如果不正確地返回false會導致許多動畫效果
            return oldUser.equals(newUser);
        }
    }
}