RecyclerView之自定義LayoutManager和SnapHelper
接著上篇部落格 ofollow,noindex">RecyclerView之SnapHelper原始碼分析 ，整理了下做個總結，主要是實現類似於抖音翻頁的效果，但是有有點不同，需要在底部漏出後面的view，這樣說可能不好理解，看下Demo，按頁滑動，後面的View有放大縮放的動畫，滑動速度過小時會有回到原位的效果，下滑也是按頁滑動的效果。
recordcapture.gif
有的小夥伴可能說這個用 SnapHelper 就可以了，沒錯，翻頁是要結合這個，但是也不是純粹靠這個，因為底部需要漏出來後面的view，所以 LayoutManager 就不能簡單的使用 LinearLayoutManager ,需要去自定義 LayoutManager ,然後再自定義 SnapHelper 。
先看下自定義 LayoutManager 。
1.自定義LayoutManager
Android系統給我們提供了常用的幾個 LayoutManager ，比如 LinearLayoutManager :用於水平或者豎直滑動
GridLayoutManager :用於表格佈局，一行可以有多列
StaggeredGridLayoutManager ：瀑布流佈局
但是在我們上面那個介面就用不了，因為在第一頁介面底部需要漏出後面的Item，所以我們就需要自定義。
一般自定義LayoutManager需要實現三個方法：
第一個方法是 generateDefaultLayoutParams ，這個用來定義佈局引數的，一般寬高都 WRAP_CONTENT 就行。
@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 就是需要自己去佈局，所以需要重寫
@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 的原始碼分析可以參考我之前的部落格 RecyclerView之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還需要滑動的距離。
堅持寫部落格不容易，從網上部落格學到很多東西，所以也一再告訴自己要堅持下去。也要感謝家人的理解，寫部落格就是犧牲了一部分陪伴他們的時間，感謝@右傾傾。
歡迎點贊和關注哈！
本文完。