Android RecyclerView自定义ItemDecoration

从来不跌倒不算光彩，每次跌倒后能再站起来，才是最大的荣耀。

添加分割线

在上一篇中，我们讲解了RecyclerView的基本使用方法
，但有个问题：为什么Item之间没有分割线呢？其实，给RecyclerView添加分割线也非常简单，只需要添加上一句话：

DividerItemDecoration  mDivider = new DividerItemDecoration(this,DividerItemDecoration.VERTICAL);
mRecyclerView.addItemDecoration(mDivider);

完整的代码如下：

protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_linear);
    
    generateDatas();
    RecyclerView mRecyclerView = (RecyclerView) findViewById(R.id.linear_recycler_view);

    //线性布局
    LinearLayoutManager linearLayoutManager = new LinearLayoutManager(this);
    linearLayoutManager.setOrientation(LinearLayoutManager.VERTICAL);
    mRecyclerView.setLayoutManager(linearLayoutManager);

    //初始化分隔线、添加分隔线
    DividerItemDecoration mDivider = new DividerItemDecoration(this, DividerItemDecoration.VERTICAL);
    mRecyclerView.addItemDecoration(mDivider);

    RecyclerAdapter adapter = new RecyclerAdapter(this, mDatas);
    mRecyclerView.setAdapter(adapter);
}

可以看到，这里只需要添加一句: mRecyclerView.addItemDecoration(mDivider);就可以给底部添加了一条横线，那什么是ItemDecoration呢？首先，我们肯定理解什么是Item，在这个布局中，每个Item都单独占一行。下面红线框中就是一个Item:


什么是ItemDecoration

那ItemDecoration与Item是什么关系呢？对于英语来讲，Decoration是装饰的意思，ItemDecoration就是Item的装饰。在Item的四周，我们可以给它添加上自定义的装饰，比如刚才的横线，就是在底部给它添加一个横线的装饰。同样的，我们也可以在Item的上下左右各添加装饰，而且这些装饰是允许我们自定义的。系统只给我们提供了一个现成的Decoration类就是刚才使用的DividerItemDecoration，如果我们想实现其它的装饰效果，就需要自定义了。下面这些漂亮的效果都可以使用自定义ItemDecoration来实现：


getItemOffsets的意义

当我们要重写ItemDecoration时，主要涉及到三个函数：

public class LinearItemDecoration extends RecyclerView.ItemDecoration {
    @Override
    public void onDraw(Canvas c, RecyclerView parent, RecyclerView.State state) {
        super.onDraw(c, parent, state);
    }

    @Override
    public void onDrawOver(Canvas c, RecyclerView parent, RecyclerView.State state) {
        super.onDrawOver(c, parent, state);
    }

    @Override
    public void getItemOffsets(Rect outRect, View view, RecyclerView parent, RecyclerView.State state) {
        super.getItemOffsets(outRect, view, parent, state);
    }
}

这三个函数我们会逐个讲解，首先，我们来看看getItemOffsets：
getItemOffsets的主要作用就是给item的四周加上边距，实现的效果类似于margin，将item的四周撑开一些距离，在撑开这些距离后，我们就可以利用上面的onDraw函数，在这个距离上进行绘图了。在了解了getItemOffsets的作用之后，我们来看看这个函数本身：
getItemOffsets(Rect outRect, View view, RecyclerView parent, RecyclerView.State state)

  • Rect outRect：这个是最难理解的部分，outRect就是表示在item的上下左右所撑开的距离。这个值默认是0
  • View view：是指当前Item的View对象
  • RecyclerView parent： 是指RecyclerView 本身
  • RecyclerView.State state:通过State可以获取当前RecyclerView的状态，也可以通过State在RecyclerView各组件间传递参数，具体的文档，大家可以参考：https://developer.android.com/reference/android/support/v7/widget/RecyclerView.State

getItemOffsets示例

我们知道，想要实现分隔线，有一种方法是在Item的上方空出一像素的间隔，这样就会漏出底线，看起来就是分割线了。所以我们回到刚才的示例，去掉DividerItemDecoration，改为自定义的LinearItemDecoration。
首先，给整个Activity添加上一个红色的背景色：

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:background="#ff0000"
    tools:context=".MainActivity">

    <androidx.recyclerview.widget.RecyclerView
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        android:id="@+id/linearRv"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

</androidx.constraintlayout.widget.ConstraintLayout>

之后，给每个Item添加上默认的背景色白色，这样有白色的地方就不会透出背景色的红色了，而没有白色的地方就会露出红色：

<?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="wrap_content"
    android:background="@android:color/white">

    <TextView
        android:id="@+id/item_tv"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:gravity="center"
        android:padding="10dp" />

</LinearLayout>

然后就是自定义LinearItemDecoration ：

package com.example.myrecyclerview;

import android.graphics.Canvas;
import android.graphics.Rect;
import android.view.View;

import androidx.annotation.NonNull;
import androidx.recyclerview.widget.RecyclerView;

public class LinearItemDecoration extends RecyclerView.ItemDecoration {

    @Override
    public void onDraw(@NonNull Canvas c, @NonNull RecyclerView parent, @NonNull RecyclerView.State state) {
        super.onDraw(c, parent, state);
    }

    @Override
    public void onDrawOver(@NonNull Canvas c, @NonNull RecyclerView parent, @NonNull RecyclerView.State state) {
        super.onDrawOver(c, parent, state);
    }

    @Override
    public void getItemOffsets(Rect outRect, View view, RecyclerView parent, RecyclerView.State state) {
        super.getItemOffsets(outRect, view, parent, state);
        outRect.top = 1;
    }
}

在这里，我们将item上方面所撑开的距离硬编码为1px，最后，将LinearItemDecoration添加进RecyclerView:

 LinearItemDecoration linearItemDecoration = new LinearItemDecoration();
        mRv.addItemDecoration(linearItemDecoration);

可以看到每个Item的上方都出现了一条红线。尤其从第一个Item可以看出来。同样的，如果我们改为底部1px，左侧50px,右侧100px：

@Override
    public void getItemOffsets(Rect outRect, View view, RecyclerView parent, RecyclerView.State state) {
        super.getItemOffsets(outRect, view, parent, state);
        outRect.left = 50;
        outRect.right = 100;
        outRect.bottom = 1;
    }

从第一个Item可以看出，顶部是没有红线的，因为我们没有设置outRect.top，所以它默认是0，因为outRect.right=100,而outRect.left=50，明显可以看出右侧的红色宽度是左侧的两倍。

onDraw的用法

在理解了getItemOffsets的用法以后，我们再来看看onDraw函数：

public void onDraw(Canvas c, RecyclerView parent, RecyclerView.State state) {
    super.onDraw(c, parent, state);
}

onDraw函数有三个参数，RecyclerView parent, RecyclerView.State state的意义与getItemOffsets的相同。而Canvas c: 是指通过getItemOffsets撑开的空白区域所对应的画布，通过这个canvas对象，可以在getItemOffsets所撑出来的区域任意绘图。那这个就厉害了，我们知道Canvas是有非常丰富的绘图函数的，那我们先来个简单的，通过getItemOffsets将Item的左侧撑出来200px的距离，然后在中间画一个圆形：

package com.example.myrecyclerview;

import android.graphics.Canvas;
import android.graphics.Color;
import android.graphics.Paint;
import android.graphics.Rect;
import android.view.View;

import androidx.recyclerview.widget.RecyclerView;

public class LinearItemDecoration extends RecyclerView.ItemDecoration {

    private Paint mPaint;

    public LinearItemDecoration() {
        mPaint = new Paint();
        mPaint.setColor(Color.GREEN);
    }

    @Override
    public void onDraw(Canvas c, RecyclerView parent, RecyclerView.State state) {
        super.onDraw(c, parent, state);
        int childCount = parent.getChildCount();
        for (int i = 0; i < childCount; i++) {
            View child = parent.getChildAt(i);
            int cx = 100;
            int cy = child.getTop() + child.getHeight() / 2;
            c.drawCircle(cx, cy, 20, mPaint);
        }
    }

    @Override
    public void onDrawOver(Canvas c, RecyclerView parent, RecyclerView.State state) {
        super.onDrawOver(c, parent, state);
    }

    @Override
    public void getItemOffsets(Rect outRect, View view, RecyclerView parent, RecyclerView.State state) {
        super.getItemOffsets(outRect, view, parent, state);
        outRect.left = 200;
        outRect.bottom = 1;
    }
}

首先，在getItemOffsets中，将左侧撑出200px的距离，同样底部留出1px的空间以显示底部分割线。
然后在onDraw中，在每个Item的左侧中间画上半径为20的绿色圆形。


需要注意的是,getItemOffsets是针对每个Item都会走一次，也就是说每个Item的outRect都可以不同，但是onDraw和onDrawOver并不是针对每个Item都会走一次，所以我们需要在onDraw和onDrawOver中绘图时，一次性将所有Item的ItemDecoration绘制完成。从上面也可以看出，这里在onDraw函数中绘图时，通过for循环对每一个item画上一个绿色圆。

拓展：获取outRect的各个值
在上面的例子中，我们onDraw中使用到outRect的值时，都是直接使用的数字硬编码，比如在outRect是我们将左侧撑开的距离设置为200，所以画圆的中心点的X坐标就是100，所以在onDraw函数中直接使用了int cx = 100;很明显，在实际工作中要严格避免类似的硬编码，因为硬编码会使代码变得极其难以维护。那我们怎么在代码中获取到getItemOffsets中所设置的各个item的outRect的值呢？
可以通过LayoutManager来获取，方法如下：其中parent是指RecylerView本身，而child是指RecyclerView的Item的View对象

RecyclerView.LayoutManager manager = parent.getLayoutManager();
int left = manager.getLeftDecorationWidth(child);
int top = manager.getTopDecorationHeight(child);
int right = manager.getRightDecorationWidth(child);
int bottom = manager.getBottomDecorationHeight(child);

所以我们上面在onDraw函数中的硬编码，就可以用下面的动态获取代码来代替：

public void onDraw(Canvas c, RecyclerView parent, RecyclerView.State state) {
        super.onDraw(c, parent, state);
        int childCount = parent.getChildCount();
        RecyclerView.LayoutManager manager = parent.getLayoutManager();
        for (int i = 0; i < childCount; i++) {
            View child = parent.getChildAt(i);
            //动态获取outRect的left值
            int left = manager.getLeftDecorationWidth(child);
            int cx = left / 2;
            int cy = child.getTop() + child.getHeight() / 2;
            c.drawCircle(cx, cy, 20, mPaint);
        }
    }

到这，大家实现开头讲解的这个效果应该不难了：


该工程源码地址：https://github.com/vipulasri/Timeline-View ，他是通过自定义View来实现的，大家也可以尝试通过RecyclerView的ItemDecoration来实现出来。

onDraw的问题

如果我们在将上面画圆的例子修改下，将画圆改为绘制一个图片：


public class LinearItemDecoration extends RecyclerView.ItemDecoration {
    private Paint mPaint;
    private Bitmap mBmp;

    public LinearItemDecoration(Context context) {
        mPaint = new Paint();
        mPaint.setColor(Color.GREEN);
        BitmapFactory.Options options = new BitmapFactory.Options();
        options.inSampleSize = 2;
        mBmp = BitmapFactory.decodeResource(context.getResources(),R.mipmap.icon,options);
    }

    @Override
    public void onDraw(Canvas c, RecyclerView parent, RecyclerView.State state) {
        super.onDraw(c, parent, state);
        int childCount = parent.getChildCount();
        for (int i = 0; i < childCount; i++) {
            View child = parent.getChildAt(i);
            c.drawBitmap(mBmp,0,child.getTop(), mPaint);
        }
    }

    @Override
    public void onDrawOver(Canvas c, RecyclerView parent, RecyclerView.State state) {
        super.onDrawOver(c, parent, state);
    }

    @Override
    public void getItemOffsets(Rect outRect, View view, RecyclerView parent, RecyclerView.State state) {
        super.getItemOffsets(outRect, view, parent, state);
        outRect.left = 150;
        outRect.bottom = 1;
    }
}

首先，因为图片比较大，在LinearItemDecoration初始化的时候，通过options.inSampleSize参数将图片缩放小为原大小的1/2;在getItemOffsets中，将左侧边距设置为150px，底部预留一像素显示分割线。最后，在onDraw中，将图形在每个Item的左上角显示出来。

如果我们把bitmap缩放去掉：

    public LinearItemDecoration(Context context) {
        BitmapFactory.Options options = new BitmapFactory.Options();
        //options.inSampleSize = 2;
        mBmp = BitmapFactory.decodeResource(context.getResources(),R.mipmap.icon,options);
    }

可以看到当图片过大时，在超出getItemOffsets函数所设定的outRect范围的部分将是不可见的。这是因为在整个绘制流程中，是先调用ItemDecoration的onDraw函数，然后再调用Item的onDraw函数，最后调用ItemDecoration的onDrawOver函数。所以在ItemDecoration的onDraw函数中绘制的内容，当超出边界时，会被Item所覆盖。但是因为最后才调用ItemDecoration的OnDrawOver函数，所以在onDrawOver中绘制的内容就不受outRect边界的限制，可以覆盖Item的区域显示。

onDrawOver

上面我们已经提到，ItemDecoration与Item的绘制顺序为：
Decoration 的 onDraw------>Item的 onDraw------>Decoration 的 onDrawOver，这三者是依次发生的。
所以，onDrawOver 是绘制在最上层的，所以它的绘制位置并不受限制（当然，Decoration 的 onDraw 绘制范围也不受限制，只不过不可见，被Item所覆盖），所以利用 onDrawOver 可以做很多事情，例如为RecyclerView 整体顶部绘制一个蒙层、超出ItemDecoration的范围绘制图像。
比如，我们实现下面这样的效果：


在这个效果中，我们在最顶部绘制了一个渐变蒙版，而且每隔五个item绘制一个勋章。动图效果是这样的：


可见这个蒙层是一直显示在顶部的。下面我们就来看看具体 实现吧。

1、当然是将勋章图片(medal.png)加入res/mipmap文件夹中或者res/drawable文件夹中。

medal.png

2、初始化
然后在LinearItemDecoration初始化时，将图片转为bitmap对象：

public class LinearItemDecoration extends RecyclerView.ItemDecoration {
    private Paint mPaint;
    private Bitmap mMedalBmp;

    public LinearItemDecoration(Context context) {
        mPaint = new Paint();
        mPaint.setColor(Color.GREEN);
        BitmapFactory.Options options = new BitmapFactory.Options();
        mMedalBmp = BitmapFactory.decodeResource(context.getResources(), R.mipmap.medal);
    }
}

3、绘制勋章
在onDrawOver中将勋章每隔五个item绘制出来

public void onDrawOver(Canvas c, RecyclerView parent, RecyclerView.State state) {
    super.onDrawOver(c, parent, state);
    //画勋章
    RecyclerView.LayoutManager manager = parent.getLayoutManager();
    int childCount = parent.getChildCount();
    for (int i = 0; i < childCount; i++) {
        View child = parent.getChildAt(i);
        int index = parent.getChildAdapterPosition(child);
        int left = manager.getLeftDecorationWidth(child);
        if (index % 5 == 0) {
            c.drawBitmap(mMedalBmp, left - mMedalBmp.getWidth() / 2, child.getTop(), mPaint);
        }
    }
}

绘制勋章的时候，需要注意，我们需要将勋章的中间位置绘制item与decoration的交界处，所以它的X坐标就是left - mMedalBmp.getWidth() / 2
4、绘制渐变蒙版
因为蒙版同样是浮在item之上的，所以我们同样是在onDrawOver中绘制，在绘制勋章之后，绘制蒙版：

public void onDrawOver(Canvas c, RecyclerView parent, RecyclerView.State state) {
    super.onDrawOver(c, parent, state);
    //画勋章
    …………
    //画蒙版
    View temp = parent.getChildAt(0);
    LinearGradient gradient = new LinearGradient(parent.getWidth() / 2, 0, parent.getWidth() / 2, temp.getHeight() * 3,
            0xff0000ff, 0x000000ff, Shader.TileMode.CLAMP);
    mPaint.setShader(gradient);
    c.drawRect(0, 0, parent.getWidth(), temp.getHeight() * 3, mPaint);
}

创建一个LinearGradient对象，让它从蓝色不透明到蓝色全透明渐变。


项目地址 https://github.com/githubwwj/MyRecyclerView

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 212,294评论 6赞 493
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 90,493评论 3赞 385
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 157,790评论 0赞 348
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 56,595评论 1赞 284
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 65,718评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 49,906评论 1赞 290
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,053评论 3赞 410
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,797评论 0赞 268
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,250评论 1赞 303
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,570评论 2赞 327
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,711评论 1赞 341
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,388评论 4赞 332
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,018评论 3赞 316
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,796评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,023评论 1赞 266
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,461评论 2赞 360
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,595评论 2赞 350