Skip to content

RecyclerView使用入门

更新日期 2021-9-1
  • 2021-9-1 更新格式
  • 2020-8-19 创建文档

本文介绍RecyclerView的使用入门。这里给出一种比较常见的使用方式。

想必读者朋友对列表的表现形式已经不再陌生。手机上有联系人列表,文件列表,短信列表等等。 本文讲述的是在Android开发中用RecyclerView来实现列表效果。

使用步骤

引入RecyclerView

在app的build.gradle文件中添加引用。我们使用的是androidx包。

gradle
dependencies {
    // ...
    implementation 'androidx.recyclerview:recyclerview:1.1.0'
}

数据准备

先确定一下要显示什么样的数据。是用户信息,联系人,或是文件。这里以字符为例。 写代码前,我们先考虑一下需求,就是要如何显示,怎么显示数据。日常工作中,一般会有UI效果图。而本文中的美术设计就由我们自己发挥了。

比如显示 a97

ViewHolder与layout

现在要显示的数据已经确定了。来设计UI表现。layout与ViewHolder紧密相关。在设计Adapter类前,先写ViewHolder类会比较好。

新建定义item(列表子项)的布局文件item_letter.xml

item_letter.xml
<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="horizontal">

    <TextView
        android:id="@+id/tv1"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:textColor="#000000" />

    <TextView
        android:id="@+id/tv2"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:textColor="#000000" />

</LinearLayout>

这里使用内部类,把ViewHolder类写在Activity类里面。

创建VH类
private class VH extends RecyclerView.ViewHolder {
    TextView tv1;
    TextView tv2;

    public VH(@NonNull View itemView) {
        super(itemView);
        tv1 = itemView.findViewById(R.id.tv1);
        tv2 = itemView.findViewById(R.id.tv2);
    }
}

从上面可以看出,ViewHolder和item的layout是紧密相关的。 layout里面的id写的比较简单。实际项目中可以给一些更有意义的id命名。

在activity的layout文件中,添加RecyclerView

layout中添加RecyclerView
<androidx.recyclerview.widget.RecyclerView
    android:id="@+id/re_view"
    android:layout_width="match_parent"
    android:layout_height="wrap_content" />

设计Adapter

设计一个适配器继承自RecyclerView.Adapter<VH>

这里的VH是我们上面写好的ViewHolder。

LetterAdapter中持有它自己的数据列表。需要实现3个方法。

  • onCreateViewHolder方法,要求返回VH对象。
    • 这里就是创建VH对象并返回。而VH构造器要求传入一个View,我们利用LayoutInflater创建一个view给它。当然,创建的根据就是前面设计好的item_letter
  • onBindViewHolder是把数据交给对应的VH来显示。
  • getItemCount方法要求返回数据的数量。
LetterAdapter
private class LetterAdapter extends RecyclerView.Adapter<VH> {

    private List<Character> dataList;

    public LetterAdapter(List<Character> dataList) {
        this.dataList = dataList;
    }

    @NonNull
    @Override
    public VH onCreateViewHolder(@NonNull ViewGroup parent, int viewType) {
        return new VH(LayoutInflater.from(parent.getContext()).inflate(R.layout.item_letter, parent, false));
    }

    @Override
    public void onBindViewHolder(@NonNull VH holder, int position) {
        Character c = dataList.get(position);
        holder.tv1.setText(c.toString());
        holder.tv2.setText(String.valueOf(Integer.valueOf(c)));
    }

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

粗心大意的时候,可能会忘记初始化adapter里的dataList。会报一个null pointer异常。

设置RecyclerView

在Activity的onCreate方法里进行了初始化。

RecyclerView需要2项设置,适配器与LayoutManager。适配器就是我们上面定的那个。 LayoutManager这里用LinearLayoutManager,指定为垂直方向,这样我们会得到一个上下滑动的列表。

使用LinearLayoutManager
List<Character> characterList = new ArrayList<>();
for (char c = 'a'; c <= 'z'; c++) {
    characterList.add(c);
}

mLetterAdapter = new LetterAdapter(characterList);
RecyclerView letterReView = findViewById(R.id.re_view);
letterReView.setAdapter(mLetterAdapter);
letterReView.setLayoutManager(new LinearLayoutManager(this, RecyclerView.VERTICAL, false));

观察运行结果

运行到手机或者模拟器上,打开这个activity。有的朋友就发现,为啥屏幕里一个子项item就占满了整个屏幕?

因为我们前面设置的item占满屏幕。回到item_letter.xml,看一下根layout的设置。 把layout_height="match_parent"里的设置改为wrap_content。 重新编译运行一下再看看结果。

我们也可以给根layout设置固定的高度。具体视美术设计和需求而定。

小结

到这里我们掌握了RecyclerView的基本使用方式。

接下来还要了解如何自定义它的表现形式。

例如点击或长按item的反应拖动调整顺序,侧滑删除;item之间添加分割线;增/删/改数据;使用瀑布流样式等等。也可以查看滑动距离

RecyclerView使用了适配器模式

可以查看一个使用示例,显示一列数据。如果要显示不同类型的数据,这里有实现方式

可以参考官方的RecyclerView文档

示例代码

作者: RustFisher
联系: rf.cs@foxmail.com
博客: rustfisher.com | RustFisher cnblog
示例: AndroidTutorial Gitee, Tutorial Github
链接: https://www.an.rustfisher.com/android/ui/view/recyclerView/intro/
一家之言,仅当抛砖引玉。如有错漏,还请指出。