玩轉(zhuǎn)Android嵌套滾動
在Android UI開發(fā)過程中，經(jīng)常會遇到嵌套滾動的需求，所謂嵌套滾動，就是父view可以滾動的情況下子view也可以滾動，例如下拉刷新(PullToRefresh)。在微信讀書之前的版本中，書籍討論圈有一個(gè)比較復(fù)雜的嵌套滾動的例子，我把它抽取出來作為今天講解的例子：
這個(gè)例子的嵌套比較復(fù)雜，上方的header為書籍封面，下方是一個(gè)ViewPager+TabLayout組成的容器(下文簡稱VT容器)，ViewPager中的三個(gè)item為三個(gè)列表，也是可以滾動的。業(yè)務(wù)需求是：
- VT容器可以滾動;
- 書籍封面可以滾動，并且有視差;
- 當(dāng)VT容器滾動到頂部時(shí)，滾動列表，并且滾動可以銜接。
- 當(dāng)列表滾動到頂部時(shí)，可以滾動書籍封面以及VT容器，并且滾動可以銜接
邏輯清楚了，接下來就看如何實(shí)現(xiàn)了。在android5以前，對于這種滾動，我們只能選擇自己去攔截事件并處理，但在后面的某個(gè)版本，android推出了NestingScroll機(jī)制，開發(fā)者的日子就好過多了，并且android提供了一個(gè)非常好的容器類：CoordinatorLayout，極大的簡化了開發(fā)者的工作。當(dāng)然我們也需要投入精力去學(xué)習(xí)并運(yùn)用這些新的Api了。
當(dāng)然，我們也要知道如果沒有這些API，我們應(yīng)當(dāng)如何去實(shí)現(xiàn)這些效果。因此本文會用三種方式去實(shí)現(xiàn)這個(gè)效果：
- 純事件攔截與派發(fā)方案
- 基于NestingScroll機(jī)制的實(shí)現(xiàn)方案
- 基于CoordinatorLayout與Behavior方案的實(shí)現(xiàn)
示例代碼放在Github上，可以clone下來結(jié)合文章觀看
純事件攔截與派發(fā)方案
這是最為原始的方案，當(dāng)然也靈活性***的了。其它的方案原理上都是系統(tǒng)基于它提供的封裝。使用這種方案時(shí)，我們需要解決以下幾個(gè)問題：
- view的滾動(Scroller);
- view的速度追蹤(VelocityTracker);
- 當(dāng)VT容器滾動到頂部時(shí)，我們?nèi)绾螌⑹录鬟f給ListView?
- 當(dāng)ListView滾動到頂部時(shí)，VT容器如何攔截到事件?
1、2兩點(diǎn)屬于滾動的基礎(chǔ)知識，這里不會做細(xì)致的講解。而第3點(diǎn)為何會出現(xiàn)呢?因?yàn)閍ndroid系統(tǒng)在事件派發(fā)時(shí)，如果事件被攔截，那么之后的事件都將不會傳遞給子view了。其解決方案也很簡單：在滾動到頂部時(shí)主動派發(fā)一次Down事件：
- if (mTargetCurrentOffset + dy <= mTargetEndOffset) {
- moveTargetView(dy);
- // 重新dispatch一次down事件，使得列表可以繼續(xù)滾動
- int oldAction = ev.getAction();
- ev.setAction(MotionEvent.ACTION_DOWN);
- dispatchTouchEvent(ev);
- ev.setAction(oldAction);
- } else {
- moveTargetView(dy);
- }
那么第4點(diǎn)是什么問題呢?這里就需要清楚一個(gè)坑點(diǎn)了：不是所用的事件都會走入onInterceptTouchEvent。有一種情況是子View主動調(diào)用parent.requestDisallowInterceptTouchEvent(true)來告訴系統(tǒng)說：這個(gè)事件我要了，父View不要攔截了。這就是所謂的內(nèi)部攔截法。在ListView的某些時(shí)刻它會去調(diào)用這個(gè)方法。因此一旦事件傳遞給了ListView，外部容器就拿不到這個(gè)事件了。因此我們要打破它的內(nèi)部攔截：
- @Override
- public void requestDisallowInterceptTouchEvent(boolean b) {
- // 去掉默認(rèn)行為，使得每個(gè)事件都會經(jīng)過這個(gè)Layout
- }
方法如上，把requestDisallowInterceptTouchEvent的實(shí)現(xiàn)干掉就可以了。
主要的技術(shù)點(diǎn)已近提出來了。那么下面就看具體實(shí)現(xiàn)，首先看使用xml:
- <org.cgspine.nestscroll.one.EventDispatchPlanLayout
- android:id="@+id/scrollLayout"
- android:layout_marginTop="?attr/actionBarSize"
- android:layout_width="match_parent"
- android:layout_height="match_parent"
- app:header_view="@+id/book_header"
- app:target_view="@+id/scroll_view"
- app:header_init_offset="30dp"
- app:target_init_offset="70dp">
- <View
- android:id="@id/book_header"
- android:layout_width="120dp"
- android:layout_height="150dp"
- android:background="@color/gray"/>
- <org.cgspine.nestscroll.one.EventDispatchTargetLayout
- android:id="@id/scroll_view"
- android:layout_width="match_parent"
- android:layout_height="match_parent"
- android:orientation="vertical"
- android:background="@color/white">
- <android.support.design.widget.TabLayout
- android:id="@+id/tab_layout"
- android:background="@drawable/list_item_bg_with_border_top_bottom"
- android:layout_width="match_parent"
- android:layout_height="@dimen/tab_layout_height"
- android:fillViewport="true"/>
- <android.support.v4.view.ViewPager
- android:id="@+id/viewpager"
- android:layout_width="match_parent"
- android:layout_height="0dp"
- android:layout_weight="1"/>
- </org.cgspine.nestscroll.one.EventDispatchTargetLayout>
- </org.cgspine.nestscroll.one.EventDispatchPlanLayout>
EventDispatchTargetLayout實(shí)現(xiàn)了自定義接口ITargetView:
- public interface ITargetView {
- boolean canChildScrollUp();
- void fling(float vy);
- }
這是因?yàn)榕c具體業(yè)務(wù)抽離，我并不清楚內(nèi)層盒子是怎樣的(有可能就是ListView了，也有可能是ViewPager包裹ListView)
主要的實(shí)現(xiàn)在EventDispatchPlanLayout，使用時(shí)在xml中指定header_init_offset、target_init_offset等變量就可以了，基本上與業(yè)務(wù)邏輯獨(dú)立。
其重點(diǎn)實(shí)現(xiàn)邏輯在onInterceptTouchEvent與onTouchEvent中了。個(gè)人不是很建議去動dispatchTouchEvent,雖然所有事件都會經(jīng)過這里，但是這也明顯會增加代碼處理復(fù)雜度：
- public boolean onInterceptTouchEvent(MotionEvent ev) {
- ensureHeaderViewAndScrollView();
- final int action = MotionEventCompat.getActionMasked(ev);
- int pointerIndex;
- // 不阻斷事件的快路徑：如果目標(biāo)view可以往上滾動或者`EventDispatchPlanLayout`不是enabled
- if (!isEnabled() || mTarget.canChildScrollUp()) {
- Log.d(TAG, "fast end onIntercept: isEnabled = " + isEnabled() + "; canChildScrollUp = "
- + mTarget.canChildScrollUp());
- return false;
- }
- switch (action) {
- case MotionEvent.ACTION_DOWN:
- mActivePointerId = ev.getPointerId(0);
- mIsDragging = false;
- pointerIndex = ev.findPointerIndex(mActivePointerId);
- if (pointerIndex < 0) {
- return false;
- }
- // 在down的時(shí)候記錄初始的y值
- mInitialDownY = ev.getY(pointerIndex);
- break;
- case MotionEvent.ACTION_MOVE:
- pointerIndex = ev.findPointerIndex(mActivePointerId);
- if (pointerIndex < 0) {
- Log.e(TAG, "Got ACTION_MOVE event but have an invalid active pointer id.");
- return false;
- }
- final float y = ev.getY(pointerIndex);
- // 判斷是否dragging
- startDragging(y);
- break;
- case MotionEventCompat.ACTION_POINTER_UP:
- // 雙指邏輯處理
- onSecondaryPointerUp(ev);
- break;
- case MotionEvent.ACTION_UP:
- case MotionEvent.ACTION_CANCEL:
- mIsDragging = false;
- mActivePointerId = INVALID_POINTER;
- break;
- }
- return mIsDragging;
- }
代碼邏輯很清晰，應(yīng)該不用多說。接下來看onTouchEvent的處理邏輯。
- public boolean onTouchEvent(MotionEvent ev) {
- final int action = MotionEventCompat.getActionMasked(ev);
- int pointerIndex;
- if (!isEnabled() || mTarget.canChildScrollUp()) {
- Log.d(TAG, "fast end onTouchEvent: isEnabled = " + isEnabled() + "; canChildScrollUp = "
- + mTarget.canChildScrollUp());
- return false;
- }
- // 速度追蹤
- acquireVelocityTracker(ev);
- switch (action) {
- case MotionEvent.ACTION_DOWN:
- mActivePointerId = ev.getPointerId(0);
- mIsDragging = false;
- break;
- case MotionEvent.ACTION_MOVE: {
- pointerIndex = ev.findPointerIndex(mActivePointerId);
- if (pointerIndex < 0) {
- Log.e(TAG, "Got ACTION_MOVE event but have an invalid active pointer id.");
- return false;
- }
- final float y = ev.getY(pointerIndex);
- startDragging(y);
- if (mIsDragging) {
- float dy = y - mLastMotionY;
- if (dy >= 0) {
- moveTargetView(dy);
- } else {
- if (mTargetCurrentOffset + dy <= mTargetEndOffset) {
- moveTargetView(dy);
- // 重新dispatch一次down事件，使得列表可以繼續(xù)滾動
- int oldAction = ev.getAction();
- ev.setAction(MotionEvent.ACTION_DOWN);
- dispatchTouchEvent(ev);
- ev.setAction(oldAction);
- } else {
- moveTargetView(dy);
- }
- }
- mLastMotionY = y;
- }
- break;
- }
- case MotionEventCompat.ACTION_POINTER_DOWN: {
- pointerIndex = MotionEventCompat.getActionIndex(ev);
- if (pointerIndex < 0) {
- Log.e(TAG, "Got ACTION_POINTER_DOWN event but have an invalid action index.");
- return false;
- }
- mActivePointerId = ev.getPointerId(pointerIndex);
- break;
- }
- case MotionEventCompat.ACTION_POINTER_UP:
- onSecondaryPointerUp(ev);
- break;
- case MotionEvent.ACTION_UP: {
- pointerIndex = ev.findPointerIndex(mActivePointerId);
- if (pointerIndex < 0) {
- Log.e(TAG, "Got ACTION_UP event but don't have an active pointer id.");
- return false;
- }
- if (mIsDragging) {
- mIsDragging = false;
- // 獲取瞬時(shí)速度
- mVelocityTracker.computeCurrentVelocity(1000, mMaxVelocity);
- final float vy = mVelocityTracker.getYVelocity(mActivePointerId);
- finishDrag((int) vy);
- }
- mActivePointerId = INVALID_POINTER;
- //釋放速度追蹤
- releaseVelocityTracker();
- return false;
- }
- case MotionEvent.ACTION_CANCEL:
- releaseVelocityTracker();
- return false;
- }
- return mIsDragging;
- }
或許有人會說：為何與onInterceptTouchEvent與有很多重復(fù)代碼?這是因?yàn)槿绻录淮驍?，并且子類不處理，就會走進(jìn)onTouchEvent邏輯，所以這些重復(fù)處理是有意義的(其實(shí)是抄SwipeRefreshLayout的)。里面主要的邏輯就是兩個(gè)：
- 滾動容器
- TouchUp時(shí)滾動到特定位置以及fling傳遞
滾動容器的邏輯：
- private void moveTargetViewTo(int target) {
- target = Math.max(target, mTargetEndOffset);
- // 用offsetTopAndBottom來偏移view
- ViewCompat.offsetTopAndBottom(mTargetView, target - mTargetCurrentOffset);
- mTargetCurrentOffset = target;
- // 滾動書籍封面view,根據(jù)TargetView進(jìn)行定位
- int headerTarget;
- if (mTargetCurrentOffset >= mTargetInitOffset) {
- headerTarget = mHeaderInitOffset;
- } else if (mTargetCurrentOffset <= mTargetEndOffset) {
- headerTarget = mHeaderEndOffset;
- } else {
- float percent = (mTargetCurrentOffset - mTargetEndOffset) * 1.0f / mTargetInitOffset - mTargetEndOffset;
- headerTarget = (int) (mHeaderEndOffset + percent * (mHeaderInitOffset - mHeaderEndOffset));
- }
- ViewCompat.offsetTopAndBottom(mHeaderView, headerTarget - mHeaderCurrentOffset);
- mHeaderCurrentOffset = headerTarget;
- }
TouchUp的滾動邏輯：
- private void finishDrag(int vy) {
- Log.i(TAG, "TouchUp: vy = " + vy);
- if (vy > 0) {
- // 向下觸發(fā)fling,需要滾動到Init位置
- mNeedScrollToInitPos = true;
- mScroller.fling(0, mTargetCurrentOffset, 0, vy,
- 0, 0, mTargetEndOffset, Integer.MAX_VALUE);
- invalidate();
- } else if (vy < 0) {
- // 向上觸發(fā)fling,需要滾動到End位置
- mNeedScrollToEndPos = true;
- mScroller.fling(0, mTargetCurrentOffset, 0, vy,
- 0, 0, mTargetEndOffset, Integer.MAX_VALUE);
- invalidate();
- } else {
- // 沒有觸發(fā)fling,就近原則
- if (mTargetCurrentOffset <= (mTargetEndOffset + mTargetInitOffset) / 2) {
- mNeedScrollToEndPos = true;
- } else {
- mNeedScrollToInitPos = true;
- }
- invalidate();
- }
- }
當(dāng)然這里會打上一些標(biāo)志位，具體實(shí)現(xiàn)是在computeScroll中，這屬于Scroller的功能，這里就不展開了。
這樣大體邏輯就講述清楚了，其它細(xì)節(jié)就請看官直接看源碼了。
基于NestingScroll機(jī)制的實(shí)現(xiàn)方案
NestingScroll機(jī)制是在某個(gè)版本support包加入的，不過外界極少有文章介紹，所以應(yīng)該大多數(shù)人并不知道這個(gè)機(jī)制。NestingScroll主要有兩個(gè)接口：
- NestedScrollingParent
- NestedScrollingChild
當(dāng)我們需要使用NestingScroll特性時(shí)，我們?nèi)?shí)現(xiàn)這兩個(gè)接口就好了。NestingScroll本質(zhì)是內(nèi)部攔截發(fā)然后將相應(yīng)的接口開給外界。因此實(shí)現(xiàn)NestedScrollingChild接口是有難度的，不過像RecyclerView這些控件，官方已經(jīng)幫我們實(shí)現(xiàn)好了NestedScrollingChild，要完成我們的需求，我們直接拿來用就好了(ListView就沒辦法使用了，當(dāng)然你也可以去實(shí)現(xiàn)NestedScrollingChild接口)。并且NestedScrollingChild與NestedScrollingParent只要有嵌套關(guān)系就行了，并不一定NestedScrollingChild是直接的子View。
我們來來看看NestedScrollingParent的定義：
- public interface NestedScrollingParent {
- // 是否接受NestingScroll
- public boolean onStartNestedScroll(View child, View target, int nestedScrollAxes);
- // 接受NestingScroll的Hook鉤子
- public void onNestedScrollAccepted(View child, View target, int nestedScrollAxes);
- // NestingScroll結(jié)束
- public void onStopNestedScroll(View target);
- // NestingScroll進(jìn)行中。重要參數(shù)dxUnconsumed， dyUnconsumed： 用于表示沒有被消耗的滾動量，一般是列表滾動到頭了，就會產(chǎn)生未消耗量
- public void onNestedScroll(View target, int dxConsumed, int dyConsumed, int dxUnconsumed, int dyUnconsumed);
- // NestingScroll滾動之前。重要參數(shù)consumed： 是用于告訴子View我消耗了多少。如果位全部消耗dy,那么子view就可以消耗了。
- public void onNestedPreScroll(View target, int dx, int dy, int[] consumed);
- // fling時(shí)
- public boolean onNestedFling(View target, float velocityX, float velocityY, boolean consumed);
- // fling之前：可以由父元素消耗這次fling事件
- public boolean onNestedPreFling(View target, float velocityX, float velocityY);
- // 獲取滾動軸： x軸或y軸
- public int getNestedScrollAxes();
- }
接口是非常豐富的。有一個(gè)很重要的概念：消耗量。 比如我滑動了10dp，那么父元素先看看可以消耗多少(例如4dp)，然后會把未消耗量傳遞給子View(6dp)。這就把嵌套滾動的問題轉(zhuǎn)換為資源分配的問題了。非常機(jī)智。除此以外，官方提供了NestedScrollingParentHelper類幫我實(shí)現(xiàn)了一些公共方法并做好了低版本兼容，我們應(yīng)當(dāng)拿來用。
寫在***
雖然google提供了很多新穎好玩的接口。但這需要花費(fèi)部分精力去實(shí)踐這些新技術(shù)。這是非常有意義的投入。多看、多寫，才能幫助我們用更少的時(shí)間寫更好的代碼。
