如何在FirebaseRecyclerAdapter中实现分页或无限滚动功能

实现思路 #

Firebase分页核心是用游标锚定上一次加载的最后一条数据，结合limit限制每次拉取数量，通过滚动监听触发下一页加载，更新Adapter的查询条件后自动刷新列表数据。

前置依赖 #

确保项目已引入对应依赖，以下为Gradle配置示例：

// 若使用Firestore引入该依赖
implementation 'com.firebaseui:firebase-ui-firestore:8.0.2'
// 若使用Realtime Database引入该依赖
// implementation 'com.firebaseui:firebase-ui-database:8.0.2'
implementation 'androidx.recyclerview:recyclerview:1.3.2'

具体实现步骤 #

1. 定义全局变量 #

// 分页配置
private static final int PAGE_SIZE = 10;
private int currentLoadedCount = PAGE_SIZE;
// Firestore用DocumentSnapshot做锚点，Realtime Database用DataSnapshot
private DocumentSnapshot lastVisibleItem;
private boolean isLoading = false;

// 组件实例
private FirebaseRecyclerAdapter<你的数据实体类, 你的ViewHolder类> adapter;
private RecyclerView recyclerView;
private LinearLayoutManager layoutManager;

2. 初始化首次查询与Adapter #

首次默认拉取10条数据，构建初始Query后初始化Adapter，同时在数据回调中记录分页锚点：

// Firestore初始查询示例，排序规则可根据需求调整
Query initialQuery = FirebaseFirestore.getInstance()
        .collection("你的数据集合名")
        .orderBy("排序字段", Query.Direction.DESCENDING)
        .limit(PAGE_SIZE);

// Realtime Database初始查询示例
// Query initialQuery = FirebaseDatabase.getInstance()
//         .getReference("你的数据节点")
//         .orderByChild("排序字段")
//         .limitToFirst(PAGE_SIZE);

// 构建Adapter配置
FirebaseRecyclerOptions<你的数据实体类> options = new FirebaseRecyclerOptions.Builder<你的数据实体类>()
        .setQuery(initialQuery, 你的数据实体类.class)
        .build();

// 初始化Adapter
adapter = new FirebaseRecyclerAdapter<你的数据实体类, 你的ViewHolder类>(options) {
    @Override
    protected void onBindViewHolder(@NonNull 你的ViewHolder类 holder, int position, @NonNull 你的数据实体类 model) {
        // 原有绑定逻辑不变
    }

    @NonNull
    @Override
    public 你的ViewHolder类 onCreateViewHolder(@NonNull ViewGroup parent, int viewType) {
        // 原有创建ViewHolder逻辑不变
    }

    @Override
    protected void onDataChanged() {
        super.onDataChanged();
        // 每次加载完成后更新最后一条数据锚点，重置加载状态
        if (getItemCount() > 0) {
            lastVisibleItem = getSnapshots().getSnapshot(getItemCount() - 1);
        }
        isLoading = false;
    }
};

// 绑定Adapter到RecyclerView
recyclerView.setAdapter(adapter);
recyclerView.setLayoutManager(layoutManager);

3. 添加RecyclerView滚动监听 #

监听滚动到底部的事件，触发下一页加载逻辑：

recyclerView.addOnScrollListener(new RecyclerView.OnScrollListener() {
    @Override
    public void onScrolled(@NonNull RecyclerView recyclerView, int dx, int dy) {
        super.onScrolled(recyclerView, dx, dy);
        // 仅响应向下滚动操作
        if (dy > 0) {
            int totalItemCount = layoutManager.getItemCount();
            int lastVisiblePosition = layoutManager.findLastCompletelyVisibleItemPosition();
            
            // 满足不在加载中、滚动到最后一条、还有更多数据可加载的条件时触发分页
            if (!isLoading && lastVisiblePosition == totalItemCount - 1 && totalItemCount >= currentLoadedCount) {
                isLoading = true;
                loadMoreData();
            }
        }
    }
});

4. 实现加载更多逻辑 #

private void loadMoreData() {
    // Firestore下一页查询示例，排序规则必须和初始查询完全一致
    Query nextQuery = FirebaseFirestore.getInstance()
            .collection("你的数据集合名")
            .orderBy("排序字段", Query.Direction.DESCENDING)
            .startAfter(lastVisibleItem)
            .limit(PAGE_SIZE);

    // Realtime Database下一页查询示例
    // Query nextQuery = FirebaseDatabase.getInstance()
    //         .getReference("你的数据节点")
    //         .orderByChild("排序字段")
    //         .startAfter(lastVisibleItem.child("排序字段").getValue())
    //         .limitToFirst(PAGE_SIZE);

    // 更新Adapter查询条件，自动刷新列表
    adapter.updateOptions(new FirebaseRecyclerOptions.Builder<你的数据实体类>()
            .setQuery(nextQuery, 你的数据实体类.class)
            .build());
    
    // 更新已加载总数
    currentLoadedCount += PAGE_SIZE;
}

注意事项 #

• 所有分页查询的排序规则必须和初始查询完全一致，否则会出现数据重复、漏加载的问题
• 不要忘记在Activity/Fragment的onStart()中调用adapter.startListening()，onStop()中调用adapter.stopListening()，保证数据同步正常
• 可以自行添加底部加载占位符，在isLoading为true时显示，加载完成后隐藏，优化用户体验
• 已经加载完全部数据时可添加标记拦截不必要的加载请求

内容的提问来源于stack exchange，提问作者Mazidul Islam