解決RecyclerView執行動畫后item邊距錯誤的問題

cover

原文鏈接:kyleduo.com

RecyclerView和StaggeredGradLayoutManager可以方便的實現瀑布流效果,但是在使用中會遇到一個問題:如果使用ItemDecoration設置offset,在觸發動畫之后,如果一個item從一個span移動到另一個span(比如插入一條數據),會出現位置偏移的情況。

wrong_position

上圖中紅色虛線的位置是Item原本應該在的位置。(忽略下面的文字)

出現這個偏移的原因,是RecyclerView會緩存child的offset,當span發生變化時,又沒有更新,所以使用了動畫之前的offset。

我們可以通過設置offset的左右值相等,來規避這個問題。但是規避終歸并沒有解決這個問題。這篇文章就來尋找一種方便的解決方法。

保存和更新

offset存儲在RecyclerView.LayoutParams.mDecorInsets這個屬性中,后文也是用mDecorInsets來表示。

和它關聯的,還有mInsetsDirty這個變量,用來標記是否需要更新mDecorInsets

mDecorInsets在RecyclerView.getItemDecorInsetsForChild方法中被更新賦值,這個方法在measureChildmeasureChildWithMargins中調用。RecyclerView.getItemDecorInsetsForChild方法會判斷mInsetsDirty標記位是否為true,如果為false將直接使用緩存的值而不重新計算。

布局流程

RecyclerView的布局流程分為三步完成,對應三個方法:

  1. dispatchLayoutStep1
  2. dispatchLayoutStep2
  3. dispatchLayoutStep3

動畫統一在dispatchLayoutStep3中執行,動畫的起始值和結束值分別在dispatchLayoutStep1dispatchLayoutStep3中儲存。而
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的位置插入一條數據,可以得到如下結果:

log

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方法觸發的,所以自然就找到了入口,然后按照調用路徑去尋找最終影響動畫的各個因素。

當然閱讀源碼時不能光看代碼,合理的斷點和調試也是必不可少的。畢竟最初編寫代碼的人,也一定不是一氣呵成寫完,也是按照功能點逐步填充這個類的。不要把自己當成閱讀者,而要延著代碼的邏輯思考問題。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,283評論 6 530
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 97,947評論 3 413
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,094評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,485評論 1 308
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,268評論 6 405
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,817評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,906評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,039評論 0 285
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,551評論 1 331
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,502評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,662評論 1 366
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,188評論 5 356
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,907評論 3 345
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,304評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,563評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,255評論 3 389
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,637評論 2 370

推薦閱讀更多精彩內容