RecyclerView之自定義LayoutManager和SnapHelper

時間  2019-11-07
標籤 recyclerview 自定義 layoutmanager snaphelper 简体版
原文   原文鏈接

主要是實現相似於抖音翻頁的效果，可是有有點不一樣，須要在底部漏出後面的view，這樣說可能很差理解，看下Demo，按頁滑動，後面的View有放大縮放的動畫，滑動速度太小時會有回到原位的效果，下滑也是按頁滑動的效果。css


有的小夥伴可能說這個用 SnapHelper就能夠了，沒錯，翻頁是要結合這個，可是也不是純粹靠這個，由於底部須要漏出來後面的view，因此LayoutManager就不能簡單的使用LinearLayoutManager,須要去自定義LayoutManager,而後再自定義SnapHelper。java

先看下自定義LayoutManager。緩存

1.自定義LayoutManager

Android系統給咱們提供了經常使用的幾個LayoutManager，好比LinearLayoutManager:用於水平或者豎直滑動
GridLayoutManager:用於表格佈局，一行能夠有多列
StaggeredGridLayoutManager：瀑布流佈局ide

可是在咱們上面那個界面就用不了，由於在第一頁界面底部須要漏出後面的Item，因此咱們就須要自定義。函數

通常自定義LayoutManager須要實現三個方法：佈局

第一個方法是generateDefaultLayoutParams，這個用來定義佈局參數的，通常寬高都WRAP_CONTENT就行。post

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

第二個方法根據須要水平或者豎直滑動區分，咱們這裏是豎直滑動，重寫canScrollVertically學習

@Override
    public boolean canScrollVertically() {
        return true;
    }
複製代碼

聰明的你確定已經知道若是水平滑動，就是重寫canScrollHorizontally.動畫

前面兩個方法都很簡單，最麻煩的就是第三個方法，重寫LayoutManager就是須要本身去佈局，因此須要重寫ui

@Override
    public void onLayoutChildren(RecyclerView.Recycler recycler, RecyclerView.State state) {
        if (state.getItemCount() == 0 || state.isPreLayout()) {
            return;
        }

        if (!hasChild) {
            hasChild = true;
        }

        mItemCount = getItemCount();
        // 滑動過的距離
        mScrollOffset = Math.min(Math.max(0, mScrollOffset), (mItemCount - 1) * itemHeight);

        layoutChild(recycler);
    }
複製代碼

首先若是沒有item或者第一次layout進來就直接返回，mScrollOffset是滑動過的距離，初始值爲0，滑動到最後一個就不能進行滑動，這裏其實能夠加個下拉刷新，之後有機會再加，不是今天的主題。

接下來大頭就是layoutChild.

private void layoutChild(RecyclerView.Recycler recycler) {
        if (getItemCount() == 0) {
            return;
        }
        int firstItemPosition = (int) Math.floor(mScrollOffset / itemHeight);
        if (firstItemPosition > commonAdapter.getItemCount() - 1) {
            return;
        }

        int firstItemScrolledHeight = mScrollOffset % itemHeight;
        final float firstItemScrolledHeightPercent = firstItemScrolledHeight * 1.0f / itemHeight;
        ArrayList<PageItemViewInfo> layoutInfos = new ArrayList<>();

        // 計算view位置
        int tmpCount = Math.min(VISIBLE_EMOTICON_COUNT, commonAdapter.getItemCount() - firstItemPosition - 1);
        for (int i = 0; i <= tmpCount; i++) {
            // 用於計算偏移量
            int tmp = i + 1;
            double maxOffset = (getVerticalSpace()
                    - itemHeight - firstItemScrolledHeightPercent) / 2 * Math.pow(0.65, tmp);
            if (maxOffset <= 0) {
                break;
            }
            int start;
            if (i == 0) {
                start = getPaddingTop() - firstItemScrolledHeight;
            } else {
                start = (int) (getPaddingTop() + i * maxOffset + i * ITEM_OFFSET);
            }
            float mScale = 0.95f;
            float scaleXY = (float) (Math.pow(mScale, i) * (1 - firstItemScrolledHeightPercent * (1 - mScale)));
            PageItemViewInfo info = new PageItemViewInfo(start, scaleXY);
            layoutInfos.add(0, info);
        }

        // 回收View
        int layoutCount = layoutInfos.size();
        final int endPos = firstItemPosition + VISIBLE_EMOTICON_COUNT;
        final int childCount = getChildCount();
        for (int i = childCount - 1; i >= 0; i--) {
            View childView = getChildAt(i);
            if (childView == null) {
                continue;
            }
            int pos;
            try {
                pos = getPosition(childView);
            } catch (NullPointerException e) {
                e.printStackTrace();
                continue;
            }

            if (pos > endPos + 1 || pos < firstItemPosition - 1) {
                removeAndRecycleView(childView, recycler);
            }
        }

        detachAndScrapAttachedViews(recycler);

        // 添加Item
        for (int i = layoutCount - 1; i >= 0; i--) {
            int pos = firstItemPosition + i;
            if (pos > commonAdapter.getItemCount() - 1) {
                break;
            }
            // If a ViewHolder must be constructed and not enough time remains, null is returned, 不進行layout
            View view;
            try {
                view = recycler.getViewForPosition(pos);
            } catch (IndexOutOfBoundsException e) {
                e.printStackTrace();
                return;
            }

            PageItemViewInfo layoutInfo = layoutInfos.get(layoutCount - 1 - i);
            view.setTag(pos);
            addView(view);
            measureChildWithExactlySize(view);
            int left = (getHorizontalSpace() - itemWidth) / 2;
            layoutDecoratedWithMargins(view, left,
                    layoutInfo.getTop(),
                    left + itemWidth,
                    layoutInfo.getTop() + itemHeight);
            view.setPivotX(view.getWidth() / 2);
            view.setPivotY(view.getHeight() / 2);
            view.setScaleX(layoutInfo.getScaleXY());
            view.setScaleY(layoutInfo.getScaleXY());
        }
    }
複製代碼

主要分紅三部分，

計算Item位置
回收Item
添加Item
下面分別看下。

計算Item位置

就是根據當前滑動過的距離來計算當前可見的幾個Item(這裏我設置爲3)的位置，這裏因爲寬高都定死的，因此須要的其實就是top位置。根據根據註釋看代碼應該比較簡單了。

// 第一個可見Item位置
        int firstItemPosition = (int) Math.floor(mScrollOffset / itemHeight);
        // 若是第一個可見Item位置是最後一個Item，返回
        if (firstItemPosition > commonAdapter.getItemCount() - 1) {
            return;
        }

        // 第一個可見Item劃過的距離，也就是不可見
        int firstItemScrolledHeight = mScrollOffset % itemHeight;

        // 第一個可見Item劃過的距離佔自身高度的百分比
        final float firstItemScrolledHeightPercent = firstItemScrolledHeight * 1.0f / itemHeight;
        ArrayList<PageItemViewInfo> layoutInfos = new ArrayList<>();

        // 計算view位置
        int tmpCount = Math.min(VISIBLE_EMOTICON_COUNT, commonAdapter.getItemCount() - firstItemPosition - 1);
        for (int i = 0; i <= tmpCount; i++) {
            // 用於計算偏移量
            int tmp = i + 1;
            double maxOffset = (getVerticalSpace()
                    - itemHeight - firstItemScrolledHeightPercent) / 2 * Math.pow(0.65, tmp);
            if (maxOffset <= 0) {
                break;
            }
            int start;
            if (i == 0) {
                start = getPaddingTop() - firstItemScrolledHeight;
            } else {
                start = (int) (getPaddingTop() + i * maxOffset + i * ITEM_OFFSET);
            }
            float mScale = 0.95f;
            float scaleXY = (float) (Math.pow(mScale, i) * (1 - firstItemScrolledHeightPercent * (1 - mScale)));
            PageItemViewInfo info = new PageItemViewInfo(start, scaleXY);
            layoutInfos.add(0, info);
        }
複製代碼

回收Item

RecyclerView提供了三級緩存，簡單看下Recycler

public final class Recycler {
        final ArrayList<ViewHolder> mAttachedScrap = new ArrayList<>();

        final ArrayList<ViewHolder> mCachedViews = new ArrayList<ViewHolder>();

        RecycledViewPool mRecyclerPool;
     ...
 }
複製代碼

其中

mAttachedScrap緩存當前屏幕上可見的ViewHolder,

mCachedViews緩存複用即將入屏的 item ，

RecycledViewPool能夠緩存多個RecyclerView須要共用的ViewHolder，內部維護了一個SparseArray, key爲ViewHolder的ViewType，也就是每一套ViewHolder都有本身的緩存數據，value爲ScrapData類型

public static class RecycledViewPool {
        private static final int DEFAULT_MAX_SCRAP = 5;
        static class ScrapData {
            ArrayList<ViewHolder> mScrapHeap = new ArrayList<>();
            int mMaxScrap = DEFAULT_MAX_SCRAP;
            long mCreateRunningAverageNs = 0;
            long mBindRunningAverageNs = 0;
        }
        SparseArray<ScrapData> mScrap = new SparseArray<>();
}
複製代碼

ArrayList 的默認大小被限制爲 5，可是這個值是能夠經過 RecycledViewPool#setMaxRecycledViews(viewType, max) 來替換

多個RecycledView複用能夠經過public void putRecycledView(ViewHolder scrap)向內主動填充數據。

關於緩存能夠參考手摸手第二彈，可視化 RecyclerView 緩存機制
上面簡單看了下RecyclerView的緩存機制，在這裏咱們須要都不在屏幕可見範圍內的Item進行回收，放到mCachedViews中，而後把屏幕可見範圍內的Item放到mAttachedScrap中，後面進行從新add。最後看下回收的代碼：

int layoutCount = layoutInfos.size();
        final int endPos = firstItemPosition + VISIBLE_EMOTICON_COUNT;
        final int childCount = getChildCount();
        for (int i = childCount - 1; i >= 0; i--) {
            View childView = getChildAt(i);
            if (childView == null) {
                continue;
            }
            int pos;
            try {
                pos = getPosition(childView);
            } catch (NullPointerException e) {
                e.printStackTrace();
                continue;
            }

            if (pos > endPos + 1 || pos < firstItemPosition - 1) {
                removeAndRecycleView(childView, recycler);
            }
        }

        detachAndScrapAttachedViews(recycler);
複製代碼

最後就是根據計算的位置從新addView就行，View從view = recycler.getViewForPosition(pos);中取出，RecyclerView會從緩存中拿。

// 添加Item
        for (int i = layoutCount - 1; i >= 0; i--) {
            int pos = firstItemPosition + i;
            if (pos > commonAdapter.getItemCount() - 1) {
                break;
            }
            // If a ViewHolder must be constructed and not enough time remains, null is returned, 不進行layout
            View view;
            try {
                view = recycler.getViewForPosition(pos);
            } catch (IndexOutOfBoundsException e) {
                e.printStackTrace();
                return;
            }

            PageItemViewInfo layoutInfo = layoutInfos.get(layoutCount - 1 - i);
            view.setTag(pos);
            addView(view);
            measureChildWithExactlySize(view);
            int left = (getHorizontalSpace() - itemWidth) / 2;
            layoutDecoratedWithMargins(view, left,
                    layoutInfo.getTop(),
                    left + itemWidth,
                    layoutInfo.getTop() + itemHeight);
            view.setPivotX(view.getWidth() / 2);
            view.setPivotY(view.getHeight() / 2);
            view.setScaleX(layoutInfo.getScaleXY());
            view.setScaleY(layoutInfo.getScaleXY());
        }
複製代碼

以上就是自定義LayoutManager的過程，如今的實現是Item會隨着手指移動，沒有按頁滑動的效果，要實現按頁滑動的效果就須要SnapHelper出場了。

2.自定義SnapHelper

SnapHelper有三個抽象方法須要實現：

@SuppressWarnings("WeakerAccess")
    @Nullable
    public abstract int[] calculateDistanceToFinalSnap(@NonNull LayoutManager layoutManager,
            @NonNull View targetView);

    @SuppressWarnings("WeakerAccess")
    @Nullable
    public abstract View findSnapView(LayoutManager layoutManager);

    public abstract int findTargetSnapPosition(LayoutManager layoutManager, int velocityX, int velocityY);
複製代碼

三個方法的做用：

findTargetSnapPosition用來找到最終的目標位置，在fling操做剛觸發的時候會根據速度計算一個最終目標位置，而後開始fling操做
calculateDistanceToFinalSnap 這個用來計算滑動到最終位置還須要滑動的距離，在一開始attachToRecyclerView或者targetView layout的時候會調用
findSnapView用來找到上面的targetView，就是須要對其的view，在calculateDistanceToFinalSnap 調用以前會調用該方法。

在LayoutManager中須要把SnapHelper和RecyclerView關聯起來：

@Override
    public void onAttachedToWindow(RecyclerView view) {
        super.onAttachedToWindow(view);
        this.snapHelper.attachToRecyclerView(view);
    }
複製代碼

在attachToRecyclerView中會調用snapToTargetExistingView方法：

void snapToTargetExistingView() {
        if (mRecyclerView == null) {
            return;
        }
        RecyclerView.LayoutManager layoutManager = mRecyclerView.getLayoutManager();
        if (layoutManager == null) {
            return;
        }
        View snapView = findSnapView(layoutManager);
        if (snapView == null) {
            return;
        }
        int[] snapDistance = calculateDistanceToFinalSnap(layoutManager, snapView);
        if (snapDistance[0] != 0 || snapDistance[1] != 0) {
            mRecyclerView.smoothScrollBy(snapDistance[0], snapDistance[1]);
        }
    }
複製代碼

一開始應該是不須要對齊的，會調用findSnapView找到須要對齊的View，看下log：

I: ===========attachToRecyclerView==========
    ===========snapToTargetExistingView==========
    ===========findSnapView==========
    pos = -1
複製代碼

返回-1就是沒有須要對齊的。

看下findSnapView的實現：

@Nullable
    @Override
    public View findSnapView(RecyclerView.LayoutManager layoutManager) {
        if (layoutManager instanceof SlidePageLayoutManager) {
            int pos = ((SlidePageLayoutManager) layoutManager).getFixedScrollPosition(mDirection);
            mDirection = 0;
            if (pos != RecyclerView.NO_POSITION) {
                View view = layoutManager.findViewByPosition(pos);
                return view;
            }
        }
        return null;
    }
複製代碼

其實就是調用layoutmanager得到位置pos, 代碼實現很簡單：

public int getFixedScrollPosition(int direction) {
        if (hasChild) {
            if (mScrollOffset % itemHeight == 0) {
                return RecyclerView.NO_POSITION;
            }
            float position = mScrollOffset * 1.0f / itemHeight;

            if (direction > 0) {
                position =  (int) Math.ceil(position);
            } else {
                position =  (int) Math.floor(position);
            }
            return (int) position;
        }
        return RecyclerView.NO_POSITION;
    }
複製代碼

第一次進來ScrollOffset爲0，因此返回-1.後面根據ScrollOffset計算位置，若是向下滑，那就向下取整，好比如今第一個滑動到一半，那麼position是小於1的小數，向下取整就獲得1，因此SnapView就是位置是1的ViewHolder。

而後手指按下滑動，此時scrollState狀態就是SCROLL_STATE_DRAGGING,看下log:

I: ===========onScrollStateChanged==========
    newState = 1
I: ===========******onFling******==========
I: ===========findTargetSnapPosition==========
    ===========getFixedScrollPosition==========
I: ScrollOffset = 461, itemHeight = 1116, position = 1.0, direction = 578
I: ===========onTargetFound==========
    targetView = 1
    ===========calculateDistanceToFinalSnap==========
    ===========calculateDistanceToPosition==========
I: targetPos = 1, distance = 655, scrollOffset = 461
    y = 655
    ===========onScrollStateChanged==========
    newState = 2
I: ===========onScrollStateChanged==========
    newState = 0
I: ===========snapToTargetExistingView==========
    ===========findSnapView==========
    ===========getFixedScrollPosition==========
I: pos = -1

複製代碼

而後就會觸發onFling狀態，首先會去回調另一個findTargetSnapPosition找到fling操做須要滾動到什麼位置，咱們這裏是按頁滑動，因此須要滾動到下一個View的位置，看下該方法實現

@Override
    public int findTargetSnapPosition(RecyclerView.LayoutManager layoutManager, int velocityX, int velocityY) {
        if (layoutManager.canScrollVertically()) {
            mDirection = velocityY;
            return ((SlidePageLayoutManager) layoutManager).getFixedScrollPosition(mDirection);
        } else {
            mDirection = velocityX;
        }

        return RecyclerView.NO_POSITION;
    }
複製代碼

調用的其實仍是getFixedScrollPosition計算獲得位置。經過log也能夠看出往下滑direction是正值，同時下一個位置就是1，由於咱們拖拽的是0位置。

在咱們須要找的位置layout出來的時候(在這裏是1位置), 會回調onTargetFound方法，其中入參targetView就是上面找到的1位置對應的View，我在layout的時候給每一個View加了個其對應位置的tag，經過log也能夠看出targetView.getTag = 1。

在這裏咱們須要計算一個RecyclerView還須要滾動的距離給系統，這就須要實現最後一個抽象函數calculateDistanceToFinalSnap,把須要滾動的距離經過方法calculateTimeForDeceleration換算成時間，而後經過Action.update通知RecyclerView進行減速滾動到最終位置。

看下calculateDistanceToFinalSnap的實現：

@Nullable
    @Override
    public int[] calculateDistanceToFinalSnap(
            @NonNull RecyclerView.LayoutManager layoutManager,
            @NonNull View targetView) {
        if (layoutManager instanceof SlidePageLayoutManager) {
            int[] out = new int[2];
            if (layoutManager.canScrollHorizontally()) {
                out[0] = ((SlidePageLayoutManager) layoutManager).calculateDistanceToPosition(
                        layoutManager.getPosition(targetView));
                out[1] = 0;
            } else {
                out[0] = 0;
                out[1] = ((SlidePageLayoutManager) layoutManager).calculateDistanceToPosition(
                        layoutManager.getPosition(targetView));
            }
            LogUtils.LogSlide(null, new String[]{"y"}, out[1]);
            return out;
        }
        return null;
    }

    public int calculateDistanceToPosition(int targetPos) {
        int distance = itemHeight * targetPos - mScrollOffset;
        return distance;
    }
複製代碼

代碼炒雞簡單，就是經過下一個位置的layout位置減去當前已經滑動過的距離，就獲得RecyclerView剩下還須要滑動的距離，小學的計算題了你們一看就懂。

看下上面的log也能夠看出，當前已經滑動過的距離ScrollOffset是461，每一個item的高度是1116，那麼1116 - 461 = 655就是RecyclerView還須要滑動的距離。

不知不覺咱們已經把三個須要實現的抽象方法都實現了，onFling操做過程當中會把scrollstate設置爲2，就是SCROLL_STATE_SETTLING。滾動過上面計算獲得的距離後中止，狀態變爲0，就是SCROLL_STATE_IDLE。

再看下下滑的log：

I: ===========onScrollStateChanged==========
I: newState = 1
I: ===========******onFling******==========
I: ===========findTargetSnapPosition==========
I: ===========getFixedScrollPosition==========
    ScrollOffset = 579, itemHeight = 1116, position = 0.0, direction = -446
I: ===========onTargetFound==========
    targetView = 0
    ===========calculateDistanceToFinalSnap==========
I: ===========calculateDistanceToPosition==========
    targetPos = 0, distance = -579, scrollOffset = 579
    y = -579
    ===========onScrollStateChanged==========
    newState = 2
I: ===========onScrollStateChanged==========
I: newState = 0
    ===========snapToTargetExistingView==========
    ===========findSnapView==========
I: ===========getFixedScrollPosition==========
    pos = -1
複製代碼

scrollstate仍是差很少，先是1 = SCROLL_STATE_DRAGGING,而後進入Fling狀態，scrollstate變爲2 = SCROLL_STATE_SETTLING, 最後停下來狀態變爲0 = SCROLL_STATE_IDLE。
在Fling狀態開始的時候會經過findTargetSnapPosition，調用getFixedScrollPosition方法計算， direction = -446 < 0,因此向下取整獲得0，目標位置就是0位置了。
而後會回調onTargetFound,經過方法calculateDistanceToFinalSnap獲得滑動到0目標位置還須要滑動的距離。

自定義SnapHelper就是這樣，理清三個接口的做用就簡單了。

3.總結

由於要實現PM的需求因此有了這一次的自定義LayoutManager和SnapHelper之旅。自定義LayoutManager也是實現三個方法，最主要的是要實現onLayoutChildren,而後根據具體需求去layout每一個item。自定義SnapHelper也是主要實現三個方法，主要是告訴須要最終滑動到的位置，須要對齊的View，而後在最終位置對應的View在layout出來後RecyclerView還須要滑動的距離。

堅持寫博客不容易，從網上博客學到不少東西，因此也一再告訴本身要堅持下去。


+qq羣457848807：。獲取以上高清技術思惟圖，以及相關技術的免費視頻學習資料

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程