理解Android Architecture Components系列之Paging Library（七）

Paging Library（分页加载库）用于逐步从数据源加载信息，而不会耗费过多的设备资源或者等待太长的时间。

总体概览

一个常见的需求是获取很多数据，但是同时也只展示其中的一小部分数据。这就会引起很多问题，比如浪费资源和流量等。
现有的Android APIs可以提供分页加载的功能，但是也带来了显著的限制和缺点：

• CursorAdapter，使得从数据库加载数据到ListView变得非常容易。但是这是在主线程中查询数据库，并且分页的内容使用低效的 Cursor返回。更多使用CursorAdapter带来的问题参考Large Database Queries on Android。
• AsyncListUtil提供基于位置的（ position-based）分页加载到 RecyclerView中，但是无法使用不基于位置（non-positional）的分页加载，而且还强制把null作为占位符。

paging library就是为了解决上述的问题而提出的。

提供的类

DataSource
数据源。根据你想要访问数据的方式，可以有两种子类可供选择：

• KeyedDataSource用于加载从第N到N+1数据。
• TiledDataSource 用于从任意位置的分页数据。

例如使用 Room persistence library 就可以自动创建返回 TiledDataSource类型的数据：

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

PagedList

从DataSource获取指定数量的数据，并且可以制定预取多少数据。这样可以最大程度减少加载数据的时间。这个类可以提供更新信息给其他类比如RecyclerView.Adapter来更新 RecyclerView的UI。

PagedListAdapter

这个类是 RecyclerView.Adapter的一个实现类，用于当数据加载完毕时，通知 RecyclerView数据已经到达。 RecyclerView就可以把数据填充进来，取代原来的占位元素。
PagedListAdapter使用后台线程来计算 PagedList 的改变。

LivePagedListProvider

从数据源中产生 LiveData。此外如果使用的是 Room persistence library，DAO还能使用 TiledDataSource生成 LivePagedListProvider。示例代码：

@Query("SELECT * from users order WHERE age > :age order by name DESC, id ASC")
public abstract LivePagedListProvider usersOlderThan(int age);

通过上面的类的配合使用，paging library从后台线程获取数据流，再在UI线程中展示。例如，当新的item别插入到数据库， DataSource被更新， LivePagedListProvider在后台线程产生了新的 PagedList

详细的流程如下图：

paging-threading.gif

新生成的 PagedList在主线程中被发送到PagedListAdapter， PagedListAdapter在后台线程使用 DiffUtil计算新的list和原来的list的差距。当比较完毕， PagedListAdapter调用RecyclerView.Adapter.notifyItemInserted()来通知数据刷新。
下面的示例代码展示了这些类如何配合工作：

@Dao
interface UserDao {
    @Query("SELECT * FROM user ORDER BY lastName ASC")
    public abstract LivePagedListProvider usersByLastName();
}

class MyViewModel extends ViewModel {
    public final LiveData> 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 adapter = new UserAdapter();
        viewModel.usersList.observe(this, pagedList -> adapter.setList(pagedList));
        recyclerView.setAdapter(adapter);
    }
}

class UserAdapter extends PagedListAdapter {
    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 DIFF_CALLBACK = new DiffCallback() {
        @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);
        }
    }
}

好了，整个Android Architecture Components系列都介绍完了(并没有，还有一篇WorkManager相关的文章，感兴趣的可以看看)，感谢各位大佬的阅读。

整个系列的后两篇文章相对介绍的比较粗糙一点，主要还是因为时间比较紧张，还有其实Room和Paging Library更像是一个第三方库，主要还是需要大家去写一遍感受可能会更清晰一点。

PS.鉴于大家的都建议给一个整体框架的demo，这里可以提供一个更好的方案：Google Android Architecture Components，这是Google官方提供的样例可以用来参考。

相关文章：
理解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（八）