2. 程式人生 > >Jetpack 架構組件 Paging 分頁加載 MD

Jetpack 架構組件 Paging 分頁加載 MD

阿新 • • 發佈：2019-04-08
工廠 ger string tlist false pip 意圖 tab turn

Markdown版本筆記 我的GitHub首頁 我的博客 我的微信 我的郵箱
MyAndroidBlogs baiqiantao baiqiantao bqt20094 [email protected]

目錄

目錄
Paging
簡介
使用步驟
PageKeyedDataSource
Java版案例
PagingActivity
PagingAdapter
PagingViewModel
User
UserDao
UserDb

Paging

官方文檔
官方案例

簡介

Paging 是什麽？
Paging

可以使開發者更輕松在 RecyclerView 中 分頁加載數據。

implementation "android.arch.paging:runtime:1.0.1" //Paging
implementation "android.arch.paging:rxjava2:1.0.1" //Paging對RxJava2的支持

原理示意圖：https://upload-images.jianshu.io/upload_images/7293029-27facf0a399c66b8.gif?imageMogr2/auto-orient/

組成部分：

  • DataSource：數據源，數據的改變會驅動列表的更新
    ，因此，數據源是很重要的
  • PageList：核心類，它從數據源取出數據，同時，它負責控制第一次默認加載多少數據，之後每一次加載多少數據，如何加載等等，並將數據的變更反映到UI上。
  • PagedListAdapter：適配器，RecyclerView的適配器，通過分析數據是否發生了改變，負責處理UI展示的邏輯（增加/刪除/替換等）。

使用步驟

創建數據源
在Paging中，數據源被抽象為 DataSource , 其獲取需要依靠 DataSource 的內部工廠類 DataSource.Factory ，通過create()方法就可以獲得DataSource 的實例：

public abstract static class Factory<Key, Value> {
     public abstract DataSource<Key, Value> create();
}

數據源一般有兩種選擇，遠程服務器請求或者讀取本地持久化數據，這些並不重要，本文我們以Room數據庫為例:

@Query("SELECT * FROM table_user")
DataSource.Factory<Integer, User> getAllUserDataSource();
DataSource.Factory<Integer, User> factory = UserDb.get(getApplication()).userDao().getAllUserDataSource();

Paging可以獲得Room的原生支持，因此作為示例非常合適，當然我們更多獲取數據源是通過API網絡請求，其實現方式可以參考 官方Sample。

PS：如果通過API網絡請求獲取DataSource，相比使用Room來說要麻煩很多

配置PageList
PageList的作用：

  • 從數據源取出數據
  • 負責控制第一次默認加載多少數據，之後每一次加載多少數據，如何加載等等
  • 將數據的變更反映到UI上

PageList提供了 PagedList.Config 類供我們進行實例化配置，其提供了5個可選配置:

public static final class Builder {
    //  省略Builder其他內部方法 
    private int mPageSize = -1;    //每次加載多少數據
    private int mPrefetchDistance = -1;   //距底部還有幾條數據時，加載下一頁數據
    private int mInitialLoadSizeHint = -1; //第一次加載多少數據，必須是分頁加載數量的倍數
    private boolean mEnablePlaceholders = true; //是否啟用占位符，若為true，則視為固定數量的item
    private int mMaxSize = MAX_SIZE_UNBOUNDED; //默認Integer.MAX_VALUE，Defines how many items to keep loaded at once.
}

配置Adapter
就像我們平時配置 RecyclerView 差不多，我們配置了 ViewHolder 和 RecyclerView.Adapter，略微不同的是，我們需要繼承PagedListAdapter，並且我們需要傳一個 DifffUtil.ItemCallback 的實例。

DifffUtil.ItemCallback的意義是，我需要知道怎麽樣的比較，才意味著數據源的變化，並根據變化再進行的UI刷新操作。

監聽數據源的變更，並響應在UI上
這個就很簡單了

//每當觀察到數據源中數據的變化，我們就把最新的數據交給Adapter去展示
viewModel.getRefreshLiveData().observe(this, pagedList -> {
    Log.i("bqt", "【數據發生改變】" + pagedList.size() + " "
        + pagedList.getPositionOffset() + " " + pagedList.getLoadedCount() + " " + pagedList.getLastKey() + " "
        + pagedList.isImmutable() + " " + pagedList.isDetached());
    adapter.submitList(pagedList); //將數據的變化反映到UI上 Set the new list to be displayed
});

PageKeyedDataSource

參考

技術分享圖片

基本結構：

//這個數據源主要需要傳遞Int型的PageNum作為參數實現每一頁數據的請求
public class PagingDataSource extends PageKeyedDataSource<Integer, User> {

    @Override
    public void loadInitial(@NonNull LoadInitialParams<Integer> params, @NonNull LoadInitialCallback<Integer, User> callback) {
        //requestedLoadSize為加載的數據量，placeholdersEnabled是是否顯示占位；callback為數據加載完成的回調
        //LoadInitialCallback的onResult方法有三個參數，第一個為數據，後面兩個即為上一頁和下一頁
        Log.i("bqt", "【loadInitial】" + params.requestedLoadSize + " " + params.placeholdersEnabled);//初始加載數據

        //if(滿足條件) 請求一批數據，數據處理後通過callback返回
        //callback.onResult(List<Value> data, Key previousPageKey, Key nextPageKey);
    }

    @Override
    public void loadBefore(@NonNull LoadParams<Integer> params, @NonNull LoadCallback<Integer, User> callback) {
        Log.i("bqt", "【loadBefore】" + params.key + " " + params.requestedLoadSize);//向前分頁加載數據
        //key即為DataSource<Key, Value>中的key，在這裏即為頁數；同樣，callback為數據加載完成的回調
        //LoadParams中的key即為我們要加載頁的數據，加載完後回調中告知下一次加載數據頁數+1或者-1
    }

    @Override
    public void loadAfter(@NonNull LoadParams<Integer> params, @NonNull LoadCallback<Integer, User> callback) {
        Log.i("bqt", "【loadAfter】" + params.key + " " + params.requestedLoadSize);//向後分頁加載數據
        //if(滿足條件) 再請求一批數據，數據處理後通過callback返回
        //callback.onResult(List<Value> data, Key adjacentPageKey);
    }
}

繼承自PageKeyedDataSource後需要實現以下三個方法：

  • loadInitial 初始加載數據
  • loadAfter 向後分頁加載數據
  • loadBefore 向前分頁加載數據

這三個方法都有兩個參數，一個params和一個callback 。

  • params包裝了分頁加載的參數：
    • loadInitial中的params為LoadInitialParams包含了requestedLoadSize和placeholdersEnabled兩個屬性，requestedLoadSize為加載的數據量，placeholdersEnabled是是否顯示占位及當數據為null時顯示占位的view
    • loadBefore和loadAfter中的params為LoadParams包含了key和requestedLoadSize，key即為DataSource<Key, Value>中的key，在這裏即為頁數
  • callback為數據加載完成的回調，loadInitial中調用調用IPVTApiPresenter加載數據，然後調用callback.onResult告訴調用者數據加載完成。

onResult有三個參數，第一個為數據，後面兩個即為上一頁和下一頁。

如果我們當前頁為第一頁即沒有上一頁，則上一頁為null，下一頁為2，此時加載的時候會加載當前頁和調用loadAfter加載第二頁，但不會調用loadBefore，因為沒有上一頁，即previousPageKey為null不會加載上一頁

如果我們初始加載的是第三頁，則上一頁是2，下一頁是4，此時加載的時候會加載當前頁和調用loadAfter加載第4頁，調用loadBefore加載第二頁

分頁加載的時候會將previousPageKey或nextPageKey傳遞到loadAfter或loadBefore中的params.key

loadAfter 、loadBefore中的params中的key即為我們要加載頁的數據，加載完後回調中告知下一次加載數據頁數+1或者-1

Java版案例

參考 此博客，原文為Kotlin版案例，我將其轉為Java版實現，並在其基礎上添加了一些邏輯。

PagingActivity

public class PagingActivity extends AppCompatActivity {

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        setContentView(R.layout.activity_paging);
        RecyclerView recyclerView = findViewById(R.id.recyclerView);

        DiffUtil.ItemCallback<User> itemCallback = new DiffUtil.ItemCallback<User>() {
            @Override
            public boolean areItemsTheSame(@NonNull User oldItem, @NonNull User newItem) {
                return oldItem.uid == newItem.uid;
            }

            @Override
            public boolean areContentsTheSame(@NonNull User oldItem, @NonNull User newItem) {
                return oldItem == newItem;
            }
        };
        PagingAdapter adapter = new PagingAdapter(itemCallback);

        UserDao dao = UserDb.get(this).userDao();
        adapter.setOnClick((user, position) -> {
            Log.i("bqt", "【position】" + position);
            new Thread(() -> {
                if (position % 2 == 0) dao.deleteUser(user);
                else dao.insertUser(new User("insert"));
            }).start();
        });

        recyclerView.setAdapter(adapter);
        recyclerView.setLayoutManager(new LinearLayoutManager(this));

        dao.getAllUser().observe(this, users -> Log.i("bqt", "【數據發生改變】" + users.size()));
        PagingViewModel viewModel = ViewModelProviders.of(this).get(PagingViewModel.class);

        //每當觀察到數據源中數據的變化，我們就把最新的數據交給Adapter去展示
        viewModel.getRefreshLiveData().observe(this, pagedList -> {
            Log.i("bqt", "【數據發生改變】" + pagedList.size() + " "
                + pagedList.getPositionOffset() + " " + pagedList.getLoadedCount() + " " + pagedList.getLastKey() + " "
                + pagedList.isImmutable() + " " + pagedList.isDetached());
            adapter.submitList(pagedList); //將數據的變化反映到UI上 Set the new list to be displayed
        });
    }
}

PagingAdapter

public class PagingAdapter extends PagedListAdapter<User, PagingAdapter.MyViewHolder> {

    PagingAdapter(DiffUtil.ItemCallback<User> itemCallback) {
        super(itemCallback);
    }

    @Override
    public void onCurrentListChanged(@Nullable PagedList<User> previousList, @Nullable PagedList<User> currentList) {
        super.onCurrentListChanged(previousList, currentList);
        Log.i("bqt", "【onCurrentListChanged】");
    }

    @NonNull
    @Override
    public MyViewHolder onCreateViewHolder(@NonNull ViewGroup parent, int viewType) {
        View view = LayoutInflater.from(parent.getContext()).inflate(R.layout.item_student, parent, false);
        return new MyViewHolder(view);
    }

    @Override
    public void onBindViewHolder(@NonNull MyViewHolder holder, int position) {
        Log.i("bqt", "【onBindViewHolder】" + position);
        User user = getItem(position);
        //items might be null if they are not paged in yet. PagedListAdapter will re-bind the ViewHolder when Item is loaded.
        if (user != null) {
            holder.nameView.setText(user.name);
            holder.nameView.setOnClickListener(v -> {
                if (onClick != null) {
                    onClick.onClick(user, position);
                }
            });
        }
    }

    class MyViewHolder extends RecyclerView.ViewHolder {
        TextView nameView;

        MyViewHolder(View view) {
            super(view);
            nameView = view.findViewById(R.id.name);
        }
    }

    private OnClick onClick;

    void setOnClick(OnClick onClick) {
        this.onClick = onClick;
    }

    interface OnClick {
        void onClick(User user, int position);
    }
}

PagingViewModel

public class PagingViewModel extends AndroidViewModel {

    public PagingViewModel(@NonNull Application application) {
        super(application);
    }

    public LiveData<PagedList<User>> getRefreshLiveData() {
        DataSource.Factory<Integer, User> dataSourceFactory = UserDb.get(getApplication()).userDao().getAllUserDataSource();

        PagedList.Config config = new PagedList.Config.Builder()
            .setInitialLoadSizeHint(10)  //第一次加載多少數據，必須是分頁加載數量的倍數
            .setPageSize(5)  //每次加載多少數據
            .setMaxSize(Integer.MAX_VALUE) //Defines how many items to keep loaded at once.
            .setPrefetchDistance(5) //距底部還有幾條數據時，加載下一頁數據
            .setEnablePlaceholders(true) //是否啟用占位符，若為true，則視為固定數量的item
            .build();

        LivePagedListBuilder<Integer, User> livePagedListBuilder = new LivePagedListBuilder<>(dataSourceFactory, config)
            .setFetchExecutor(Executors.newSingleThreadExecutor()) //設置獲取數據源的線程
            .setInitialLoadKey(0) //可通過 pagedList.getLastKey() 獲取此值，默認值當然為 Key(這裏為Integer)類型的初始化值()這裏為0
            .setBoundaryCallback(new PagedList.BoundaryCallback<User>() {
                @Override
                public void onZeroItemsLoaded() { //沒有數據被加載
                    super.onZeroItemsLoaded();
                    Log.i("bqt", "【onZeroItemsLoaded】");
                }

                @Override
                public void onItemAtFrontLoaded(@NonNull User itemAtFront) { //加載第一個
                    super.onItemAtFrontLoaded(itemAtFront);
                    Log.i("bqt", "【onItemAtFrontLoaded】" + itemAtFront.name);
                }

                @Override
                public void onItemAtEndLoaded(@NonNull User itemAtEnd) { //加載最後一個
                    super.onItemAtEndLoaded(itemAtEnd);
                    Log.i("bqt", "【onItemAtEndLoaded】" + itemAtEnd.name);
                }
            });
        return livePagedListBuilder.build();
    }
}

User

@Entity(tableName = "table_user")
public class User {
    @PrimaryKey(autoGenerate = true) public int uid;
    @ColumnInfo(name = "user_name") public String name = "包青天";

    public User(String name) {
        this.name = name;
    }
}

UserDao

@Dao
public interface UserDao {

    @Insert
    List<Long> insertUser(User... users);

    @Insert
    List<Long> insertUser(List<User> users);

    @Delete
    int deleteUser(User user);

    @Query("SELECT * FROM table_user")
    LiveData<List<User>> getAllUser();

    @Query("SELECT * FROM table_user")
    DataSource.Factory<Integer, User> getAllUserDataSource();
}

UserDb

@Database(entities = {User.class}, version = 1)
public abstract class UserDb extends RoomDatabase {
    public abstract UserDao userDao(); //沒有參數的抽象方法，返回值所代表的類必須用@Dao註解

    private static UserDb db;

    public static UserDb get(Context context) {
        if (db == null) {
            db = Room.databaseBuilder(context.getApplicationContext(), UserDb.class, "dbname")
                .addCallback(new RoomDatabase.Callback() {
                    @Override
                    public void onCreate(@NonNull SupportSQLiteDatabase database) {
                        super.onCreate(database);
                        Log.i("bqt", "【onCreate】");
                        new Thread(() -> {
                            List<User> users = new ArrayList<>();
                            for (int i = 0; i < 50; i++) {
                                users.add(new User("bqt" + i));
                            }
                            get(context).userDao().insertUser(users);
                        }).start();
                    }
                })
                .build();
        }
        return db;
    }
}

2019-4-7

附件列表

    Jetpack 架構組件 Paging 分頁加載 MD

    相關推薦

    Jetpack 架構組件 Paging 分頁加載 MD

    工廠 ger string tlist false pip 意圖 tab turn Markdown版本筆記 我的GitHub首頁 我的博客 我的微信 我的郵箱 MyAndroidBlogs baiqianta

    Element ui 中使用table組件實現分頁記憶選中

    ids select microsoft 調用 tid 直接 ont LIDS 彈窗 我們再用vue和element-ui，或者其他的表格的時候，可能需要能記憶翻頁勾選，那麽實現以下幾個方法就ok了 首先定義個data值 data () { return {

    Django組件之分頁器

    import dex 避免 ane ace top consola klist oss 如果數據太多單頁顯示過於繁雜，來使用分頁器來顯示 其他準備工作(如數據庫遷移)略 models.py 1: class Book(models.Model): 2: tit

    datagrid 修改分頁組件的分頁提示信息為中文

    def 希望 ati 獲取 message 順序 var image 默認 datagrid 修改分頁組件的分頁提示信息為中文 by:授客 QQ：1033553122 測試環境 jquery-easyui-1.5.3 問題描述 默認分頁組件為英文展示，

    js自動分頁加載所有數據

    分頁加載 oot con 加載 使用 ear last clas 執行 原理：通過循環執行scrollTo直至滾動到頁面頂部，循環只能通過setInterval的方式，不能使用for循環。 var cur,last = 0,i = 1; cur = document.g

    [轉]微信小程序之加載更多（分頁加載）實例 —— 微信小程序實戰系列（2）

    是否 底部 watermark water ongl 小程序教程 所有 空數組 osi 本文轉自;http://blog.csdn.net/michael_ouyang/article/details/56846185 loadmore 加載更多（分頁加載） 當

    Ajax方式分頁加載列表實現

    rst join appid subst getx ntp none sta oot 在前面： 　　最近需要用到這個功能，所以這幾天一直在研究這個，目前大致功能已實現，後續需要完善，但需要的功能點已完成，記錄下； 1、分頁功能引入bootstrap的分頁插件：

    組件庫按需加載 借助babel-plugin-import實現

    introduce 內容 com control ati intro tab style src 前段時間一直在基於webpack進行前端資源包的瘦身。在項目中基於路由進行代碼分離，http://www.cnblogs.com/legu/p/7251562.html。對

    Vue.js 子組件的異步加載及其生命周期控制

    creat vue nor 其中 pmo dem con tor pan 前端開發社區的繁榮，造就了很多優秀的基於 MVVM 設計模式的框架，而組件化開發思想也越來越深入人心。這其中不得不提到 Vue.js 這個專註於 VM 層的框架。 本文主要對 Vue.js 組件化開發

    Java日誌組件logback使用：加載非類路徑下的配置文件並設置定時更新

    arc .get courier sprint 日誌配置 microsoft poi con tag Java日誌組件logback使用：加載非類路徑下的配置文件並設置定時更新摘自： https://blog.csdn.net/johnson_moon/article/

    小程序中分頁加載問題

    ref 跳轉 amp lse NPU 帶來 16px length style 別的不說，直接貼分頁加載的代碼，看註釋就好 pasting//index.jsconst app = getApp()//分裝的require 函數，http.js見本人隨筆“解決小程序分裝的r

    micro 架構組件介紹

    java 行動 選擇器 開源 sage 中間 services 系統 界面 Micro 是什麽　　Micro 是微服務生態系統中專註於提供產品、服務和解決方案的一款軟件,使得在現代軟件企業中起到創新驅動。它計劃是可以將任何微服務相關的資源與即將使用此款軟件的公司結合起來，利

    分頁控件以及分頁控件風格

    size .net rstp weight sans current input aging 人的 原文發布時間為：2009-05-22 —— 來源於本人的百度文章 [由搬家工具導入]分页控件以S

    vue10行代碼實現上拉翻頁加載更多數據，純手寫js實現下拉刷新上拉翻頁不引用任何第三方插件

    each ray 如果 部分 list 插件 下拉 ast 頁面數據 vue10行代碼實現上拉翻頁加載更多數據，純手寫js實現下拉刷新上拉翻頁不引用任何第三方插件/庫 一提到移動端的下拉刷新上拉翻頁，你可能就會想到iScroll插件，沒錯iScroll是一個高性能，資源占用

    基於Metronic的Bootstrap開發框架經驗總結（18）-- 在代碼生成工具Database2Sharp中集成對Bootstrap-table插件的分頁及排序支持

    關註 基礎 表頭 數據 database 一定的 處理 tree的使用 適合 在我們開發系統界面，包括Web和Winform的都一樣，主要的界面就是列表展示主界面，編輯查看界面，以及一些輔助性的如導入界面，選擇界面等，其中列表展示主界面是綜合性的數據展示界面，一般往往需要對

    Android官方架構組件介紹之LifeCycle(一)

    mave 工程 視圖 平時 清理 star new 內部 serve Android官方架構組件介紹之LifeCycle 下面是官方提供的Android App開發的架構圖： 從上圖可以看到一些關鍵字：ViewModel,LiveData,Room等。其實看了上面視頻的

    Android官方架構組件介紹之ViewModel（三）

    gets use 時間管理 src context per and 發生 方法 ViewModel 像Activity，Fragment這類應用組件都有自己的生命周期並且是被Android的Framework所管理的。Framework可能會根據用戶的一些操作和設備的狀態對

    Android官方架構組件介紹之應用（四）

    怎麽 nbsp 註冊 bool 其他 info get inf prot 講一個項目常見的功能，友盟統計功能 例如一個項目有很多多modlue,每個裏面modlue都有Activity，Activity需要友盟統一，Fragment也需要友盟統計。一般做法就是繼承一個Bas

    系統架構組件

    統一 boot 監控 跨語言 進一步 consumer 抽象 系統架構 apach RPC Dubbo Dubbo是Alibaba開源的分布式服務框架，它最大的特點是按照分層的方式來架構，使用這種方式可以使各個層之間解耦合（或者最大限度地松耦合）。從服務模型的角度來看，

    Android官方架構組件:Lifecycle詳解&迪士尼彩樂園網站架設原理分析

    ner 觀察者 and 順序 觸發 組件 oncreate mcr save 我們先將重要的這些類挑選出來： LifecycleObserver接口（ Lifecycle觀察者）：實現該接口的類，通過註解的方式，可以通過被LifecycleOwner類的addObserve