Android中如何使用FirestoreRecyclerAdapter实现文档按日期分组

1. 前置准备 #

你需要先准备两类布局文件：日期分组头部布局、普通业务条目布局，同时定义通用列表项数据结构区分两种条目类型：

// 通用列表项密封类
sealed class ListItem {
    // 日期头部类型，存储要展示的日期文本
    data class DateHeader(val dateText: String) : ListItem()
    // 普通内容类型，存储Firestore返回的文档实体
    data class ContentItem(val docModel: YourDocModel) : ListItem()
}

上述代码中YourDocModel是你原本对应Firestore单条文档的实体类，必须包含可用于分组的日期字段，推荐存储为Timestamp类型避免格式化歧义。

2. 配置Firestore查询规则 #

首先确保查询结果按日期字段排序，保证同日期的文档连续返回，避免出现重复日期头部：

val query = FirebaseFirestore.getInstance()
    .collection("你的业务集合名")
    .orderBy("date字段名", Query.Direction.DESCENDING) // 按日期倒序，最新的排在最前

3. 自定义分组Adapter #

直接改造FirestoreRecyclerAdapter，增加数据预处理逻辑插入日期头部，支持多类型视图渲染：

class GroupedFirestoreAdapter(
    options: FirestoreRecyclerOptions<YourDocModel>
) : FirestoreRecyclerAdapter<YourDocModel, RecyclerView.ViewHolder>(options) {

    // 视图类型常量
    private val VIEW_TYPE_HEADER = 0
    private val VIEW_TYPE_CONTENT = 1
    // 预处理后的混合列表（包含头部+内容）
    private val groupedList = mutableListOf<ListItem>()

    // 数据更新时重新生成分组列表
    override fun onDataChanged() {
        super.onDataChanged()
        groupedList.clear()
        var lastGroupDate = ""

        // 遍历原始查询结果，插入日期头部
        for (i in 0 until super.getItemCount()) {
            val currentDoc = getItem(i)
            // 将Timestamp转换为你需要的展示格式，比如"yyyy年MM月dd日"
            val currentDate = formatTimestampToStr(currentDoc.dateField)
            // 日期变化时插入头部
            if (currentDate != lastGroupDate) {
                groupedList.add(ListItem.DateHeader(currentDate))
                lastGroupDate = currentDate
            }
            groupedList.add(ListItem.ContentItem(currentDoc))
        }
        notifyDataSetChanged()
        // 数据量较大时可替换为DiffUtil实现局部刷新，提升性能
    }

    // 根据位置返回对应视图类型
    override fun getItemViewType(position: Int): Int {
        return when (groupedList[position]) {
            is ListItem.DateHeader -> VIEW_TYPE_HEADER
            is ListItem.ContentItem -> VIEW_TYPE_CONTENT
        }
    }

    // 根据视图类型创建对应的ViewHolder
    override fun onCreateViewHolder(parent: ViewGroup, viewType: Int): RecyclerView.ViewHolder {
        val inflater = LayoutInflater.from(parent.context)
        return if (viewType == VIEW_TYPE_HEADER) {
            val view = inflater.inflate(R.layout.item_date_header, parent, false)
            DateHeaderHolder(view)
        } else {
            val view = inflater.inflate(R.layout.item_content, parent, false)
            ContentHolder(view)
        }
    }

    // 绑定数据到视图
    override fun onBindViewHolder(holder: RecyclerView.ViewHolder, position: Int) {
        when (val item = groupedList[position]) {
            is ListItem.DateHeader -> (holder as DateHeaderHolder).bind(item.dateText)
            is ListItem.ContentItem -> (holder as ContentHolder).bind(item.docModel)
        }
    }

    // 返回预处理后的列表总长度，替换原生的原始数据长度
    override fun getItemCount(): Int = groupedList.size

    // 日期头部ViewHolder实现
    inner class DateHeaderHolder(itemView: View) : RecyclerView.ViewHolder(itemView) {
        fun bind(dateText: String) {
            itemView.tv_date.text = dateText
        }
    }

    // 普通内容ViewHolder实现
    inner class ContentHolder(itemView: View) : RecyclerView.ViewHolder(itemView) {
        fun bind(doc: YourDocModel) {
            // 正常绑定业务字段即可
        }
    }

    // 日期格式化工具方法，按需调整格式
    private fun formatTimestampToStr(timestamp: Timestamp): String {
        val sdf = SimpleDateFormat("yyyy年MM月dd日", Locale.CHINA)
        return sdf.format(timestamp.toDate())
    }
}

4. 初始化使用 #

和原生FirestoreRecyclerAdapter使用逻辑一致，直接绑定到RecyclerView即可：

val options = FirestoreRecyclerOptions.Builder<YourDocModel>()
    .setQuery(query, YourDocModel::class.java)
    .build()
val adapter = GroupedFirestoreAdapter(options)
recyclerView.adapter = adapter
// 生命周期绑定
adapter.startListening() //  onStart中调用
adapter.stopListening() // onStop中调用

内容的提问来源于stack exchange，提问作者Amit chaudhary