RecyclerView的自定义ItemDecoration与源码分析

1.概述

recyclerView的要实现分割线要继承RecyclerView.ItemDecoration抽象类。谷歌官方为我们提供实例DividerItemDecoration。ItmDecoration有三个重要的方法,如果只是想要设置分割线,只要getItemOffsets就可以。

方法 作用
getItemOffsets 设置item上下左右的距离
onDraw 可以通过它绘制分割线的颜色图片等,但它的区域超过item时会被item覆盖
onDrawOver 同样可以通过它绘制颜色和图片等,但它的区域会覆盖item

看看源码的注释:

 public abstract static class ItemDecoration {
        /**
         *将任何适当的装饰画到提供给RecyclerView的Canvas中。
         *用这种方法绘制的任何内容都将在绘制项目视图之前绘制,因此将出现在视图下
         */
        public void onDraw(@NonNull Canvas c, @NonNull RecyclerView parent, @NonNull State state) {
            onDraw(c, parent);
        }

        /**
         *将任何适当的装饰画到提供给RecyclerView的Canvas中。
         * 用这种方法绘制的任何内容都将在绘制项目视图之后绘制,并因此出现在视图上方。
         */
        public void onDrawOver(@NonNull Canvas c, @NonNull RecyclerView parent,
                @NonNull State state) {
            onDrawOver(c, parent);
        }

        /**
         *检索给定项目的所有偏移量。
         * outRect的每个字段指定插入项目视图的像素数,类似于填充或边距。
         *默认实现将outRect的边界设置为0并返回。
         *
         * <p>
         *如果需要访问适配器以获取其他数据,
         *则可以调用{@link RecyclerView#getChildAdapterPosition(View)}
         *以获取视图的适配器位置。
         */
        public void getItemOffsets(@NonNull Rect outRect, @NonNull View view,
                @NonNull RecyclerView parent, @NonNull State state) {
            getItemOffsets(outRect, ((LayoutParams) view.getLayoutParams()).getViewLayoutPosition(),
                    parent);
        }
    }

2.自定义ItemDecoration

自定一个ItemDecoration来实现一个可以吸顶效果的列表,看看效果图:


image.png

要实现这个效果,首先用onDraw绘制一个红色背景的分割线,第二就是用onDrawOver绘制吸顶的红色头部。

public class RecyclerViewDecoration extends RecyclerView.ItemDecoration {

  private int groupHeaderHeight;

  private Paint headPaint;
  private Paint textPaint;

  private Rect textRect;

  public StarDecoration(Context context) {
      groupHeaderHeight = dp2px(context, 100);
      
      //画吸顶的画笔
      headPaint = new Paint();
      headPaint.setColor(Color.RED);
      // 画文字的画笔
      textPaint = new Paint();
      textPaint.setTextSize(50);
      textPaint.setColor(Color.WHITE);
      textRect = new Rect();
  }

  @Override
  public void onDraw(@NonNull Canvas c, @NonNull RecyclerView parent, @NonNull RecyclerView.State state) {
      super.onDraw(c, parent, state);
      if (parent.getAdapter() instanceof StarAdapter) {
          StarAdapter adapter = (StarAdapter) parent.getAdapter();
          int left = parent.getPaddingLeft();
          int right = parent.getWidth() - parent.getPaddingRight();
          int count = parent.getChildCount(); // 当前屏幕的item个数
          for (int i = 0; i < count; i++) {
              // 获取对应i的View
              View view = parent.getChildAt(i);
              // 获取View的布局位置
              int position = parent.getChildLayoutPosition(view);
              // 是否绘制红色的头部分割线
              boolean isGroupHeader = adapter.isGourpHeader(position);
              
              if (isGroupHeader && view.getTop() - groupHeaderHeight - parent.getPaddingTop() >= 0) {
                  //在view的顶部画红色头部分割线
                  c.drawRect(left, view.getTop() - groupHeaderHeight, right, view.getTop(), headPaint);
                  //绘制文字
                  String groupName = adapter.getGroupName(position);
                  //得到文字需要的rect
                  textPaint.getTextBounds(groupName, 0, groupName.length(), textRect);
                  c.drawText(groupName, left + 20, view.getTop() -
                          groupHeaderHeight / 2 + textRect.height() / 2, textPaint);
              } else if (view.getTop() - groupHeaderHeight - parent.getPaddingTop() >= 0) {
                  // 绘制红色分割线
                  c.drawRect(left, view.getTop() - 4, right, view.getTop(), headPaint);
              }
          }
      }
  }

  @Override
  public void onDrawOver(@NonNull Canvas c, @NonNull RecyclerView parent, @NonNull RecyclerView.State state) {
      super.onDrawOver(c, parent, state);
      if (parent.getAdapter() instanceof StarAdapter) {
          StarAdapter adapter = (StarAdapter) parent.getAdapter();
          // 返回可见区域内的第一个item的position
          int position = ((LinearLayoutManager) parent.getLayoutManager()).findFirstVisibleItemPosition();
          // 获取对应position的View
          View itemView = parent.findViewHolderForAdapterPosition(position).itemView;
          
          int left = parent.getPaddingLeft();
          int right = parent.getWidth() - parent.getPaddingRight();
          int top = parent.getPaddingTop();
          // 当第二个是组的头部的时候
          boolean isGroupHeader = adapter.isGourpHeader(position + 1);
          //下一个红色吸顶头部位于第一个位置
          if (isGroupHeader) {
              int bottom = Math.min(groupHeaderHeight, itemView.getBottom() - parent.getPaddingTop());
              c.drawRect(left, top, right, top + bottom, headPaint);//上一个不断缩短
              String groupName = adapter.getGroupName(position);
              c.clipRect(left, top, right, top + bottom);
              textPaint.getTextBounds(groupName, 0, groupName.length(), textRect);
              c.drawText(groupName, left + 20, top + bottom
                      - groupHeaderHeight / 2 + textRect.height() / 2, textPaint);
          } else {
              //绘制一个吸顶的红色头部
              c.drawRect(left, top, right, top + groupHeaderHeight, headPaint);
              //绘制文字
              String groupName = adapter.getGroupName(position);
              textPaint.getTextBounds(groupName, 0, groupName.length(), textRect);
              c.drawText(groupName, left + 20, top + groupHeaderHeight / 2 + textRect.height() / 2, textPaint);
          }

      }
  }

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

      if (parent.getAdapter() instanceof StarAdapter) {
          StarAdapter adapter = (StarAdapter) parent.getAdapter();
          int position = parent.getChildLayoutPosition(view);
          boolean isGroupHeader = adapter.isGourpHeader(position);
          // 怎么判断 itemView是头部
          if (isGroupHeader) {
              // 如果是头部,预留更大的地方
              outRect.set(0, groupHeaderHeight, 0, 0);
          } else {
              // 1像素
              outRect.set(0, 4, 0, 0);
          }
      }
  }

  private int dp2px(Context context, float dpValue) {
      float scale = context.getResources().getDisplayMetrics().density;
      return (int) (dpValue * scale * 0.5f);
  }
}

通过代码可以分为三步

  1. 通过getItemOffsets设置Item大和小的分割线
  2. onDraw中为每个大小分割线绘制成红色,有文字的绘制文字
  3. onDrawOver绘制一个吸顶红色头部,然后在下一个红色头部的前一个item变成第一个可见时,吸顶红色头部在[100,0]区间不断的缩小。

3.ItemDecoration的原理

要搞懂ItemDecoration的原理,主要有两方面:

1. ItemDecoration是怎样实现ItemView之间的间距的
2. ItemDecoration是如何绘制的

3.1 ItemDecoration如何实现间距

要理解ItemDecoration的间距,还要从RecyclerView的测量和ItemView的布局开始。测量主要是通过LayoutManagermeasureChildWithMargins方法

      public void measureChildWithMargins(@NonNull View child, int widthUsed, int heightUsed) {
          final LayoutParams lp = (LayoutParams) child.getLayoutParams();
          //拿到全部分割线的左右上下全部总和
          final Rect insets = mRecyclerView.getItemDecorInsetsForChild(child);
           //将需要的分割线总和大小加到宽高中
          widthUsed += insets.left + insets.right;
          heightUsed += insets.top + insets.bottom;
        
          //确定总宽高
          final int widthSpec = getChildMeasureSpec(getWidth(), getWidthMode(),
                  getPaddingLeft() + getPaddingRight()
                          + lp.leftMargin + lp.rightMargin + widthUsed, lp.width,
                  canScrollHorizontally());
          final int heightSpec = getChildMeasureSpec(getHeight(), getHeightMode(),
                  getPaddingTop() + getPaddingBottom()
                          + lp.topMargin + lp.bottomMargin + heightUsed, lp.height,
                  canScrollVertically());
          if (shouldMeasureChild(child, widthSpec, heightSpec, lp)) {
              child.measure(widthSpec, heightSpec);
          }
      }

这里有个getItemDecorInsetsForChild方法,总要是拿到全部分割线上下左右全部相加的距离。 第二步是,把分割线的宽高总大小和ItemView宽高总大小进行相加,并跟可滑动的方向确定RecyclerView的宽高。所以,全部分割线所需要宽高已经加到RecyclerView的宽高中

Rect getItemDecorInsetsForChild(View child) {
      final LayoutParams lp = (LayoutParams) child.getLayoutParams();
      if (!lp.mInsetsDirty) {
          return lp.mDecorInsets;
      }

      final boolean positionWillChange =
              (lp.mViewHolder.getLayoutPosition() != lp.mViewHolder.getAbsoluteAdapterPosition());
      if (mState.isPreLayout()
              && (lp.isItemChanged() || lp.isViewInvalid() || positionWillChange)) {
          // changed/invalid items should not be updated until they are rebound.
          return lp.mDecorInsets;
      }
      final Rect insets = lp.mDecorInsets;
      insets.set(0, 0, 0, 0);
      final int decorCount = mItemDecorations.size();
      for (int i = 0; i < decorCount; i++) {
          mTempRect.set(0, 0, 0, 0);
          mItemDecorations.get(i).getItemOffsets(mTempRect, child, this, mState);
          insets.left += mTempRect.left;
          insets.top += mTempRect.top;
          insets.right += mTempRect.right;
          insets.bottom += mTempRect.bottom;
      }
      lp.mInsetsDirty = false;
      return insets;
  }

接下来,看看ItemView的布局。代码主要在LayoutManagerlayoutDecoratedWithMargins

public void layoutDecoratedWithMargins(@NonNull View child, int left, int top, int right,
              int bottom) {
          final LayoutParams lp = (LayoutParams) child.getLayoutParams();
         //拿到View的分割线大小
          final Rect insets = lp.mDecorInsets;
          //item布局时会在上下左右留出分割线的所需的大小
          child.layout(left + insets.left + lp.leftMargin, top + insets.top + lp.topMargin,
                  right - insets.right - lp.rightMargin,
                  bottom - insets.bottom - lp.bottomMargin);
      }

代码很简单,itemview在布局的时候,就已经留出分割线的大小了。所以我们的分割线的并不是onDraw onDrawOver绘制出来的,而是在ItemView布局时就根据getItemOffsets方法设置上下左右距离开始留出间距。所以我们自定义分割线时,只写getItemOffsets方法也可以绘制分割线效果。

3.2 ItemDecoration的绘制

RecyclerViewdraw绘制流程,主要就是绘制ItemDecorationonDraw onDrawOver,和绘制itemView

  @Override
  public void draw(Canvas c) {
      //通过调用onDraw绘制item和ItemDecoration的onDraw()
      super.draw(c);
     //绘制ItemDecoration的onDrawOver()
      final int count = mItemDecorations.size();
      for (int i = 0; i < count; i++) {
          mItemDecorations.get(i).onDrawOver(c, this, mState);
      }
      //padding滑动的处理
      // TODO If padding is not 0 and clipChildrenToPadding is false, to draw glows properly, we
      // need find children closest to edges. Not sure if it is worth the effort.
    }
  @Override
  public void onDraw(Canvas c) {
      super.onDraw(c);

      final int count = mItemDecorations.size();
      for (int i = 0; i < count; i++) {
          mItemDecorations.get(i).onDraw(c, this, mState);
      }
  }

代码比较简单,不作分析。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,602评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,442评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,878评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,306评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,330评论 5 373
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,071评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,382评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,006评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,512评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,965评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,094评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,732评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,283评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,286评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,512评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,536评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,828评论 2 345

推荐阅读更多精彩内容