原文鏈接:kyleduo.com
RecyclerView和StaggeredGradLayoutManager可以方便的實現瀑布流效果,但是在使用中會遇到一個問題:如果使用ItemDecoration設置offset,在觸發動畫之后,如果一個item從一個span移動到另一個span(比如插入一條數據),會出現位置偏移的情況。
上圖中紅色虛線的位置是Item原本應該在的位置。(忽略下面的文字)
出現這個偏移的原因,是RecyclerView會緩存child的offset,當span發生變化時,又沒有更新,所以使用了動畫之前的offset。
我們可以通過設置offset的左右值相等,來規避這個問題。但是規避終歸并沒有解決這個問題。這篇文章就來尋找一種方便的解決方法。
保存和更新
offset存儲在RecyclerView.LayoutParams.mDecorInsets
這個屬性中,后文也是用mDecorInsets
來表示。
和它關聯的,還有mInsetsDirty
這個變量,用來標記是否需要更新mDecorInsets
。
mDecorInsets在RecyclerView.getItemDecorInsetsForChild
方法中被更新賦值,這個方法在measureChild
和measureChildWithMargins
中調用。RecyclerView.getItemDecorInsetsForChild
方法會判斷mInsetsDirty
標記位是否為true,如果為false將直接使用緩存的值而不重新計算。
布局流程
RecyclerView的布局流程分為三步完成,對應三個方法:
dispatchLayoutStep1
dispatchLayoutStep2
dispatchLayoutStep3
動畫統一在dispatchLayoutStep3
中執行,動畫的起始值和結束值分別在dispatchLayoutStep1
和dispatchLayoutStep3
中儲存。而
dispatchLayoutStep2
是真正對子View進行布局的地方,也就是這個方法確定了動畫的結束值。
dispatchLayoutStep2
中調用LayoutManager.onLayoutChildren
方法進行真正的布局,StaggeredGridLayoutManager.onLayoutChildren
最終調用fill
方法。
fill
方法中更新span,并調用measureChildWithDecorationsAndMargin
方法進行測量,而這個方法,就最終調用前文說的RecyclerView.getItemDecorInsetsForChild
方法獲取mDecorInsets
。
定位問題
你可能注意到了,既然是先設置span,后獲取mInsetsDirty,那怎么會出現偏差呢?
問題出在dispatchLayoutStep1中,這個方法包含這樣的邏輯:
private void dispatchLayoutStep1() {
// ......
if (mState.mRunPredictiveAnimations) {
// ......
// temporarily disable flag because we are asking for previous layout
mLayout.onLayoutChildren(mRecycler, mState);
// ......
}
// ......
}
processAdapterUpdatesAndSetAnimationFlags
也就是說當滿足mRunPredictiveAnimations
時,會調用一次onLayoutChildren
方法,兒dispatchLayoutStep2
中,還會無條件的再調用一次這個方法,這就導致onLayoutChildren
在一次布局流程中被調用兩次,而第二次調用時,更新了span,但是使用了緩存的mDecorInsets
,也就造成了偏差。
dispatchLayoutStep1
會調用processAdapterUpdatesAndSetAnimationFlags
方法,這個方法最終會調用RecyclerView.ViewHolder.offsetPosition
這個方法,這個方法中會將mInsetsDirty
設置為true。所以在dispatchLayoutStep1
中第一次調用onLayoutChildren
時,就會更新mDecorInsets
的值,而第二次進來的時候,就不會了。
通過調試,分別在設置span時和getItemDecorInsetsForChild
中打印log,然后在index==1的位置插入一條數據,可以得到如下結果:
1247341404是第一條數據,因為沒有變化,所以第一次layout也沒有更新
mDecorInsets
。1247341072是新添加的數據,因為第一次layout使用的是舊數據,所以并不包含這一條,而在第二次layout時獲取到
mDecorInsets
。觀察1247341250這條數據,第一次layout時span為1,第二次時變為0,但是沒更新
mDecorInsets
,所以出現了偏差。
解決問題
既然知道了問題所在,下面我們就解決它。既然第二次onLayoutChildren
時使用了緩存才導致mDecorInsets
沒有更新,那么我們就強制設置mInsetsDirty
為true,這樣在fill
方法中就會更新了。很遺憾RecyclerView并沒有提供public方法在做這件事,那就只有使用反射了。
StaggeredGridLayoutManager lm = new StaggeredGridLayoutManager(2, StaggeredGridLayoutManager.VERTICAL) {
private Method markItemDecorInsetsDirty = null;
private boolean reflectError = false;
@Override
public void onLayoutChildren(RecyclerView.Recycler recycler, RecyclerView.State state) {
if (markItemDecorInsetsDirty == null && !reflectError) {
try {
markItemDecorInsetsDirty = RecyclerView.class.getDeclaredMethod("markItemDecorInsetsDirty");
markItemDecorInsetsDirty.setAccessible(true);
} catch (NoSuchMethodException e) {
e.printStackTrace();
reflectError = true;
}
}
// 更新條件
if (markItemDecorInsetsDirty != null && state.willRunSimpleAnimations()) {
// noinspection TryWithIdenticalCatches
try {
markItemDecorInsetsDirty.invoke(mRecyclerView);
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (InvocationTargetException e) {
e.printStackTrace();
}
}
super.onLayoutChildren(recycler, state);
}
// 7.28 更新
@Override
public void requestSimpleAnimationsInNextLayout() {
super.requestSimpleAnimationsInNextLayout();
if (markItemDecorInsetsDirty != null) {
// noinspection TryWithIdenticalCatches
try {
markItemDecorInsetsDirty.invoke(mRecyclerView);
} catch (IllegalAccessException e) {
e.printStackTrace();
} catch (InvocationTargetException e) {
e.printStackTrace();
}
}
}
};
我們反射調用markItemDecorInsetsDirty
這個方法標記dirty,即可強制更新。但是我們并不想每次layout的時候都強制更新,這樣效率太低了。所以還要判斷state.willRunSimpleAnimations()
,這個標記表示將執行ItemAnimator動畫,也就是只有當觸發動畫時,才強制更新。這樣就解決問題了。
并不是只有修改數據時才會出現這個問題,當使用
GAP_HANDLING_MOVE_ITEMS_BETWEEN_SPANS
這個策略時,填充GAP時也會觸發動畫,所以也會有這個問題。使用上面的標記位即可涵蓋這兩種情況,并不會有多余調用。
7月28日更新
StaggeredGridLayoutManager在檢查GAP時,有兩種情況,一種是執行動畫移動child,另一種是需要重新layout。上面的邏輯只包含第一種情況,第二種情況需要再添加一些代碼。已經更新到上面的代碼塊兒里了。
因為如果
checkForGaps
方法返回true,調用的onLayoutChildren
為三個參數的私有方法,而不是我們覆寫的方法,所以不能在通過覆寫判斷標記為實現。但是checkForGaps
返回true之前,一定會調用requestSimpleAnimationsInNextLayout
方法(只在這個地方調用,所以也不會有額外性能損耗),而且這個方法是public的,所以我們可以覆寫這個方法,在里面標記mInsetsDirty
為true。
總結
我們在閱讀源碼,尤其是像RecyclerView這種邏輯復雜的類時,因為代碼量很大,邏輯分支多,不要逐行閱讀,否則一不小心就會“迷失”。正確的做法是在閱讀前先進行思考,拆成多個子功能逐個分析,比如Measure/Layout,Touch事件,Animation等等,每個子功能找到一個入口,按照調用關系去分析,比如Touch事件和布局相關功能可以在onXxx
回調方法中開始。
我在解決這個問題時,就是從Animation這個點切入,因為動畫是notifyXxx方法觸發的,所以自然就找到了入口,然后按照調用路徑去尋找最終影響動畫的各個因素。
當然閱讀源碼時不能光看代碼,合理的斷點和調試也是必不可少的。畢竟最初編寫代碼的人,也一定不是一氣呵成寫完,也是按照功能點逐步填充這個類的。不要把自己當成閱讀者,而要延著代碼的邏輯思考問題。