你可能誤會了！原來自定義LayoutManager能夠這麼簡單

參考資料

參考資料1;
參考資料2；
參考資料3；
參考資料4；

背景介紹

RecyclerView因爲其強大的擴展性，如今已經逐步的取代了ListView和GridView了。爲了實現不一樣的佈局效果，咱們會用到官方提供的LinearLayoutManager、GridLayoutManager和StaggeredGridLayoutManager。但這些佈局只能知足平常需求，在一些比較複雜的佈局中，它們就力不從心了，強行拼湊實現，帶來的後果就是較差的體驗和性能。因此可以自定義LayoutManager仍是十分必要的，它可以解放創造力，構造複雜的、流暢的滑動列表。上面幾篇參考資料中就實現了一些不尋常的效果，咱們能夠看到，這些效果若是用常規的方案去實現將會十分蹩腳。

揭開LayoutManager中鮮爲人知的祕密

自定義LayoutManager主要要求咱們完成三件事情：

• 計算每一個ItemView的位置；
• 處理滑動事件；
• 緩存並重用ItemView；

而咱們比較重要的工做是在onLayoutChildern()這個回調方法中完成的。

下面咱們就來一一解析。

預先準備

當咱們extends RecyclerView.LayoutManager是，咱們會被強制要求重寫generateDefaultLayoutParams()方法，如方法名字同樣，咱們須要提供一個默認的LayoutParams，這裏爲咱們的每一個ItemView提供默認的LayoutParams，因此它可以直接影響到咱們的佈局效果，這裏咱們設置成WRAP_CONTENT，讓ItemView得到決定權。

@Override
  public RecyclerView.LayoutParams generateDefaultLayoutParams() {
    return new RecyclerView.LayoutParams(RecyclerView.LayoutParams.WRAP_CONTENT,
        RecyclerView.LayoutParams.WRAP_CONTENT);
  }

計算ItemView的位置

1.實現簡單的LayoutManager

先看效果圖:

簡單LayoutManager

再看代碼：

 

@Override
  public void onLayoutChildren(RecyclerView.Recycler recycler, RecyclerView.State state) {
    super.onLayoutChildren(recycler, state);
    // 先把全部的View先從RecyclerView中detach掉，而後標記爲"Scrap"狀態，表示這些View處於可被重用狀態(非顯示中)。
    // 實際就是把View放到了Recycler中的一個集合中。
    detachAndScrapAttachedViews(recycler);
    calculateChildrenSite(recycler);
  }

  private void calculateChildrenSite(RecyclerView.Recycler recycler) {
    totalHeight = 0;
    for (int i = 0; i < getItemCount(); i++) {
      // 遍歷Recycler中保存的View取出來
      View view = recycler.getViewForPosition(i);
      addView(view); // 由於剛剛進行了detach操做，因此如今能夠從新添加
      measureChildWithMargins(view, 0, 0); // 通知測量view的margin值
      int width = getDecoratedMeasuredWidth(view); // 計算view實際大小，包括了ItemDecorator中設置的偏移量。
      int height = getDecoratedMeasuredHeight(view);
      
      Rect mTmpRect = new Rect();
      //調用這個方法可以調整ItemView的大小，以除去ItemDecorator。
      calculateItemDecorationsForChild(view, mTmpRect);
      
      // 調用這句咱們指定了該View的顯示區域，並將View顯示上去，此時全部區域都用於顯示View，
      //包括ItemDecorator設置的距離。
      layoutDecorated(view, 0, totalHeight, width, totalHeight + height);
      totalHeight += height;
    }
  }

這段代碼邏輯簡單，它實現的其實就是一個簡單的垂直線性佈局，固然如今還不能滑動，也沒有緩存機制。在這段代碼中，咱們先調用detachAndScrapAttachedViews(recycler);將全部的ItemView標記爲Scrap狀態，而後在挨個取出來，計算他們應該佈局到什麼位置，並用成員變量totalHeight記錄總高度，最後依次調用layoutDecorated()將ItemView佈局上去。

2.兩列式的LayoutManager

先看效果圖：

效果圖

有了上例的基礎，咱們只須要稍做調整，直接看下面代碼，注意註釋部分。

 

private void calculateChildrenSite(RecyclerView.Recycler recycler) {
    totalHeight = 0;
    for (int i = 0; i < getItemCount(); i++) {
      View view = recycler.getViewForPosition(i);
      addView(view);
      //咱們本身指定ItemView的尺寸。
      measureChildWithMargins(view, DisplayUtils.getScreenWidth() / 2, 0); 
      int width = getDecoratedMeasuredWidth(view);
      int height = getDecoratedMeasuredHeight(view);
      Rect mTmpRect = new Rect();
      calculateItemDecorationsForChild(view, mTmpRect);
      if (i % 2 == 0) { //當i能被2整除時，是左，不然是右。
        //左
        layoutDecoratedWithMargins(view, 0, totalHeight, DisplayUtils.getScreenWidth() / 2,
            totalHeight + height);
      } else {
        //右，須要換行
        layoutDecoratedWithMargins(view, DisplayUtils.getScreenWidth() / 2, totalHeight,
            DisplayUtils.getScreenWidth(), totalHeight + height);
        totalHeight = totalHeight + height;
        LogUtils.e(i + "->" + totalHeight);
      }
    }
  }

處理滑動

先來看一下效果:

效果圖

 

滑動事件主要涉及到4個方法須要重寫，咱們直接來看代碼：

@Override
  public boolean canScrollVertically() {
    //返回true表示能夠縱向滑動
    return true;
  }

  @Override
  public int scrollVerticallyBy(int dy, RecyclerView.Recycler recycler, RecyclerView.State state) {
    //列表向下滾動dy爲正，列表向上滾動dy爲負，這點與Android座標系保持一致。
    //實際要滑動的距離
    int travel = dy;

    LogUtils.e("dy = " + dy);
    //若是滑動到最頂部
    if (verticalScrollOffset + dy < 0) {
      travel = -verticalScrollOffset;
    } else if (verticalScrollOffset + dy > totalHeight - getVerticalSpace()) {//若是滑動到最底部
      travel = totalHeight - getVerticalSpace() - verticalScrollOffset;
    }

    //將豎直方向的偏移量+travel
    verticalScrollOffset += travel;

    // 調用該方法通知view在y方向上移動指定距離
    offsetChildrenVertical(-travel);

    return travel;
  }

  private int getVerticalSpace() {
    //計算RecyclerView的可用高度，除去上下Padding值
    return getHeight() - getPaddingBottom() - getPaddingTop();
  }

  @Override
  public boolean canScrollHorizontally() {
    //返回true表示能夠橫向滑動
    return super.canScrollHorizontally();
  }

  @Override
  public int scrollHorizontallyBy(int dx, RecyclerView.Recycler recycler, RecyclerView.State state) {
    //在這個方法中處理水平滑動
    return super.scrollHorizontallyBy(dx, recycler, state);
  }

緩存並重用ItemView

在上面代碼的基礎上咱們稍做改動，加入緩存，先看下面的log信息，它顯示雖然有100個Item，但childCount穩定在26：

log

下面來看看代碼的變化，我展現了完整的代碼，留心註釋。

 

public class CustomLayoutManager extends RecyclerView.LayoutManager {
  /** 用於保存item的位置信息 */
  private SparseArray<Rect> allItemRects = new SparseArray<>();
  /** 用於保存item是否處於可見狀態的信息 */
  private SparseBooleanArray itemStates = new SparseBooleanArray();

  public int totalHeight = 0;
  private int verticalScrollOffset;

  @Override
  public RecyclerView.LayoutParams generateDefaultLayoutParams() {
    return new RecyclerView.LayoutParams(ViewGroup.LayoutParams.WRAP_CONTENT,
        ViewGroup.LayoutParams.WRAP_CONTENT);
  }

  @Override
  public void onLayoutChildren(RecyclerView.Recycler recycler, RecyclerView.State state) {
    if (getItemCount() <= 0 || state.isPreLayout()) {
      return;
    }
    super.onLayoutChildren(recycler, state);
    detachAndScrapAttachedViews(recycler);
    /* 這個方法主要用於計算並保存每一個ItemView的位置 */
    calculateChildrenSite(recycler);
    recycleAndFillView(recycler, state);
  }

  private void calculateChildrenSite(RecyclerView.Recycler recycler) {
    totalHeight = 0;
    for (int i = 0; i < getItemCount(); i++) {
      View view = recycler.getViewForPosition(i);
      addView(view);
      // 咱們本身指定ItemView的尺寸。
      measureChildWithMargins(view, DisplayUtils.getScreenWidth() / 2, 0);
      calculateItemDecorationsForChild(view, new Rect());
      int width = getDecoratedMeasuredWidth(view);
      int height = getDecoratedMeasuredHeight(view);

      Rect mTmpRect = allItemRects.get(i);
      if (mTmpRect == null) {
        mTmpRect = new Rect();
      }

      if (i % 2 == 0) { // 當i能被2整除時，是左，不然是右。
        // 左
        mTmpRect.set(0, totalHeight, DisplayUtils.getScreenWidth() / 2, totalHeight + height);
      } else {
        // 右，須要換行
        mTmpRect.set(DisplayUtils.getScreenWidth() / 2, totalHeight, DisplayUtils.getScreenWidth(),
            totalHeight + height);
        totalHeight = totalHeight + height;
      }

      // 保存ItemView的位置信息
      allItemRects.put(i, mTmpRect);
      // 因爲以前調用過detachAndScrapAttachedViews(recycler)，因此此時item都是不可見的
      itemStates.put(i, false);
    }
  }


  private void recycleAndFillView(RecyclerView.Recycler recycler, RecyclerView.State state) {
    if (getItemCount() <= 0 || state.isPreLayout()) {
      return;
    }

    // 當前scroll offset狀態下的顯示區域
    Rect displayRect= new Rect(0, verticalScrollOffset, getHorizontalSpace(),
        verticalScrollOffset + getVerticalSpace());

    /**
     * 將滑出屏幕的Items回收到Recycle緩存中
     */
    Rect childRect = new Rect();
    for (int i = 0; i < getChildCount(); i++) {
      //這個方法獲取的是RecyclerView中的View，注意區別Recycler中的View
      //這獲取的是實際的View
      View child = getChildAt(i);
      //下面幾個方法可以獲取每一個View佔用的空間的位置信息，包括ItemDecorator
      childRect.left = getDecoratedLeft(child);
      childRect.top = getDecoratedTop(child);
      childRect.right = getDecoratedRight(child);
      childRect.bottom = getDecoratedBottom(child);
      //若是Item沒有在顯示區域，就說明須要回收
      if (!Rect.intersects(displayRect, childRect)) {
        //移除並回收掉滑出屏幕的View
        removeAndRecycleView(child, recycler);
        itemStates.put(i, false); //更新該View的狀態爲未依附
      }
    }

    //從新顯示須要出如今屏幕的子View
    for (int i = 0; i < getItemCount(); i++) {
      //判斷ItemView的位置和當前顯示區域是否重合
      if (Rect.intersects(displayRect, allItemRects.get(i))) {
        //得到Recycler中緩存的View
        View itemView = recycler.getViewForPosition(i);
        measureChildWithMargins(itemView, DisplayUtils.getScreenWidth() / 2, 0);
        //添加View到RecyclerView上
        addView(itemView);
        //取出先前存好的ItemView的位置矩形
        Rect rect = allItemRects.get(i);
        //將這個item佈局出來
        layoutDecoratedWithMargins(itemView,
          rect.left,
          rect.top - verticalScrollOffset,  //由於如今是複用View，因此想要顯示在
          rect.right,
          rect.bottom - verticalScrollOffset);
        itemStates.put(i, true); //更新該View的狀態爲依附
      }
    }
    LogUtils.e("itemCount = " + getChildCount());
  }


  @Override
  public boolean canScrollVertically() {
    // 返回true表示能夠縱向滑動
    return true;
  }

  @Override
  public int scrollVerticallyBy(int dy, RecyclerView.Recycler recycler, RecyclerView.State state) {
    //每次滑動時先釋放掉全部的View，由於後面調用recycleAndFillView()時會從新addView()。
    detachAndScrapAttachedViews(recycler);
    // 列表向下滾動dy爲正，列表向上滾動dy爲負，這點與Android座標系保持一致。
    // 實際要滑動的距離
    int travel = dy;

    LogUtils.e("dy = " + dy);
    // 若是滑動到最頂部
    if (verticalScrollOffset + dy < 0) {
      travel = -verticalScrollOffset;
    } else if (verticalScrollOffset + dy > totalHeight - getVerticalSpace()) {// 若是滑動到最底部
      travel = totalHeight - getVerticalSpace() - verticalScrollOffset;
    }
    // 調用該方法通知view在y方向上移動指定距離
    offsetChildrenVertical(-travel);
    recycleAndFillView(recycler, state); //回收並顯示View
    // 將豎直方向的偏移量+travel
    verticalScrollOffset += travel;
    return travel;
  }

  private int getVerticalSpace() {
    // 計算RecyclerView的可用高度，除去上下Padding值
    return getHeight() - getPaddingBottom() - getPaddingTop();
  }

  @Override
  public boolean canScrollHorizontally() {
    // 返回true表示能夠橫向滑動
    return super.canScrollHorizontally();
  }

  @Override
  public int scrollHorizontallyBy(int dx, RecyclerView.Recycler recycler,
      RecyclerView.State state) {
    // 在這個方法中處理水平滑動
    return super.scrollHorizontallyBy(dx, recycler, state);
  }

  public int getHorizontalSpace() {
    return getWidth() - getPaddingLeft() - getPaddingRight();
  }
}

實現緩存最主要的就是先把每一個ItemView的位置信息保存起來，而後在滑動過程當中經過判斷每一個ItemView的位置是否和當前RecyclerView應該顯示的區域有重合，如有就顯示它，若沒有就移除並回收。

總結

實現本身的自定義LayoutManager主要的三個步驟：

• 計算每一個ItemView的位置；
• 添加滑動事件；
• 實現緩存。

咱們需根據代碼多理解，多思考，而後動手寫屬於本身的LayoutManager。

 

做者：CoorChice 連接：https://www.jianshu.com/p/715b59c46b74 來源：簡書 簡書著做權歸做者全部，任何形式的轉載都請聯繫做者得到受權並註明出處。