Sticky Headers RecyclerView 开源项目教程

项目介绍

Sticky Headers RecyclerView 是一个开源项目，旨在为 Android 的 RecyclerView 添加粘性标题功能。这个项目由 timehop 开发并维护，它允许开发者在列表滚动时保持某些项的标题始终可见，类似于通讯录中的字母索引效果。

项目快速启动

添加依赖

首先，在你的 build.gradle 文件中添加以下依赖：

dependencies {
    implementation 'com.timehop.stickyheadersrecyclerview:library:0.4.3'
}

基本使用

1. 创建数据模型和适配器：

public class Item {
    private String title;
    private String header;

    public Item(String title, String header) {
        this.title = title;
        this.header = header;
    }

    public String getTitle() {
        return title;
    }

    public String getHeader() {
        return header;
    }
}

public class MyAdapter extends RecyclerView.Adapter<MyAdapter.ViewHolder> implements StickyRecyclerHeadersAdapter<MyAdapter.HeaderViewHolder> {
    private List<Item> items;

    public MyAdapter(List<Item> items) {
        this.items = items;
    }

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

    @Override
    public void onBindViewHolder(ViewHolder holder, int position) {
        holder.textView.setText(items.get(position).getTitle());
    }

    @Override
    public int getItemCount() {
        return items.size();
    }

    @Override
    public long getHeaderId(int position) {
        return items.get(position).getHeader().charAt(0);
    }

    @Override
    public HeaderViewHolder onCreateHeaderViewHolder(ViewGroup parent) {
        View view = LayoutInflater.from(parent.getContext()).inflate(R.layout.header_layout, parent, false);
        return new HeaderViewHolder(view);
    }

    @Override
    public void onBindHeaderViewHolder(HeaderViewHolder holder, int position) {
        holder.headerTextView.setText(items.get(position).getHeader());
    }

    public static class ViewHolder extends RecyclerView.ViewHolder {
        public TextView textView;

        public ViewHolder(View itemView) {
            super(itemView);
            textView = itemView.findViewById(R.id.textView);
        }
    }

    public static class HeaderViewHolder extends RecyclerView.ViewHolder {
        public TextView headerTextView;

        public HeaderViewHolder(View itemView) {
            super(itemView);
            headerTextView = itemView.findViewById(R.id.headerTextView);
        }
    }
}

2. 设置 RecyclerView：

RecyclerView recyclerView = findViewById(R.id.recyclerView);
recyclerView.setLayoutManager(new LinearLayoutManager(this));

List<Item> items = new ArrayList<>();
items.add(new Item("Apple", "Fruits"));
items.add(new Item("Banana", "Fruits"));
items.add(new Item("Carrot", "Vegetables"));

MyAdapter adapter = new MyAdapter(items);
recyclerView.setAdapter(adapter);

StickyRecyclerHeadersDecoration headersDecor = new StickyRecyclerHeadersDecoration(adapter);
recyclerView.addItemDecoration(headersDecor);

应用案例和最佳实践

应用案例

Sticky Headers RecyclerView 可以广泛应用于需要分组显示数据的场景，例如：

• 通讯录：按字母顺序分组显示联系人。
• 商品分类：在电商应用中按类别分组显示商品。
• 音乐播放列表：按专辑或艺术家分组显示歌曲。

最佳实践

• 性能优化：确保数据量较大时，适配器的 getItemId 方法返回稳定且唯一的 ID，以利用 RecyclerView 的回收机制。
• 自定义样式：通过修改 header_layout.xml 和 item_layout.xml 来定制标题和列表项的外观。