前言

日常開發(fā)中虐块，下拉刷新列表是一個(gè)常見的不能再常見的需求了，github上也有很多成熟了下拉刷新庫(kù)可供學(xué)習(xí)嘉蕾，但如果要刷新的列表被ScrollView或者RecyclerView包圍贺奠，可能很多傳統(tǒng)的下拉刷新的實(shí)現(xiàn)就沒(méi)辦法使用了，那我們?nèi)绾卧谇短谆瑒?dòng)中和諧共處地實(shí)現(xiàn)下拉刷新呢错忱？

先看最終效果圖：

基礎(chǔ)知識(shí)——嵌套滾動(dòng)

按照使用習(xí)慣儡率，用戶會(huì)在手機(jī)屏幕上使用上下或者左右滑動(dòng)手勢(shì)來(lái)滾動(dòng)頁(yè)面或者列表，但如果在同一個(gè)界面有多個(gè)控件可以滑動(dòng)時(shí)以清，如何協(xié)調(diào)多個(gè)控件響應(yīng)用戶操作是一個(gè)頗為復(fù)雜的問(wèn)題儿普。一般來(lái)說(shuō)，我們可以在控件中實(shí)現(xiàn)dispatchTouchEvent(), onTouchEvent(), onInterceptTouchEvent()三連擊來(lái)控制滑動(dòng)操作掷倔，但這個(gè)實(shí)現(xiàn)方式有個(gè)漏洞眉孩，如果Touch事件傳遞過(guò)程中，某個(gè)View獲得處理Touch事件機(jī)會(huì)勒葱，那么其他View就再也沒(méi)有機(jī)會(huì)去處理這個(gè)Touch事件了浪汪，直到下一次手指再按下，也就是說(shuō)凛虽，這種方法無(wú)法讓多個(gè)View協(xié)同處理一個(gè)滑動(dòng)事件死遭。
這時(shí)候，Google霸霸就跳出來(lái)給我們指出了一條明路——NestedScrolling機(jī)制凯旋。NestedScrolling可以很好地解決嵌套控件中滑動(dòng)事件的攔截呀潭、分發(fā)和使用的問(wèn)題，使用NestedScrolling后的效果如下：

可以看到至非，頂部的AppBar和下面的ListView都是可以滑動(dòng)的钠署，使用了NestedScrolling后，只有ListView下滑到頂部時(shí)荒椭，AppBar才會(huì)響應(yīng)下滑事件谐鼎。
NestedScrolling的想法并不復(fù)雜，它會(huì)把嵌套的控件分為父View和子View戳杀，控件接收到的每個(gè)滑動(dòng)事件都分開幾個(gè)階段通知父View该面，父View決定事件的處理夭苗，并負(fù)責(zé)把處理完的事件分發(fā)給子View，層層傳遞下去隔缀，直到滑動(dòng)事件消耗完：

場(chǎng)景一：

• 子View：爸爸题造，我準(zhǔn)備在x軸方向滑動(dòng)50px，有什么吩咐沒(méi)
• 父View：好的猾瘸，沒(méi)什么吩咐的界赔，你滑吧。
• 子View：遵命牵触！滑動(dòng)ing...... 爸爸淮悼，我滑完了，總共滑了50px揽思。
• 父View：好的袜腥，記得每次都要提前匯報(bào)！

場(chǎng)景二：

• 子View：爸爸钉汗，我準(zhǔn)備在x軸方向滑動(dòng)50px羹令，有什么吩咐沒(méi)
• 父View：你x軸的50px我要全部沒(méi)收，你別動(dòng)了
• 子View：納尼 w(?Д?)w 好吧誰(shuí)讓你是爸爸...

具體到代碼實(shí)現(xiàn)损痰，Google提供了NestedScrollingParent和NestedScrollingChild兩個(gè)接口福侈，如果自定義的View要當(dāng)父親來(lái)嵌套子View，那么請(qǐng)實(shí)現(xiàn)NestedScrollingParent卢未，如果要當(dāng)兒子被父View包含肪凛，請(qǐng)實(shí)現(xiàn)NestedScrollingChild，大多數(shù)情況下辽社，我們自定義的View最好同時(shí)繼承NestedScrollingParent和NestedScrollingChild來(lái)提高使用時(shí)的靈活性伟墙。

我們先來(lái)看看NestedScrollingParent和NestedScrollingChild：

public interface NestedScrollingParent {

    boolean onStartNestedScroll(@NonNull View child, @NonNull View target, @ScrollAxis int axes);

    void onNestedScrollAccepted(@NonNull View child, @NonNull View target, @ScrollAxis int axes);

    void onStopNestedScroll(@NonNull View target);

    void onNestedScroll(@NonNull View target, int dxConsumed, int dyConsumed,
            int dxUnconsumed, int dyUnconsumed);

    void onNestedPreScroll(@NonNull View target, int dx, int dy, @NonNull int[] consumed);

    boolean onNestedFling(@NonNull View target, float velocityX, float velocityY, boolean consumed);

    boolean onNestedPreFling(@NonNull View target, float velocityX, float velocityY);

    @ScrollAxis
    int getNestedScrollAxes();
}

public interface NestedScrollingChild {

    void setNestedScrollingEnabled(boolean enabled);

    boolean isNestedScrollingEnabled();

    boolean startNestedScroll(@ScrollAxis int axes);

    void stopNestedScroll();

    boolean hasNestedScrollingParent();

    boolean dispatchNestedScroll(int dxConsumed, int dyConsumed,
            int dxUnconsumed, int dyUnconsumed, @Nullable int[] offsetInWindow);

    boolean dispatchNestedPreScroll(int dx, int dy, @Nullable int[] consumed,
            @Nullable int[] offsetInWindow);

    boolean dispatchNestedFling(float velocityX, float velocityY, boolean consumed);

    boolean dispatchNestedPreFling(float velocityX, float velocityY);
}

可以看出Parent和Child很多方法名都是接近的，Google霸霸怕我們處理不好這些事件的分發(fā)爹袁，還貼心的給我們提供了兩個(gè)對(duì)應(yīng)的輔助類：NestedScrollingParentHelper和NestedScrollingChildHelper远荠，如果要寫一個(gè)簡(jiǎn)單的NestedScrolling對(duì)象矮固，只需要調(diào)用NestedScrollingHelper對(duì)應(yīng)的方法就可以了失息，例如：

class NestedScrollingView extends ViewGroup implements NestedScrollingChild{

    private NestedScrollingChildHelper mChildHelper = new NestedScrollingChildHelper(this);
    
    //...
    
    @Override
    boolean dispatchNestedScroll(int dxConsumed, int dyConsumed,
                              int dxUnconsumed, int dyUnconsumed, @Nullable  int[] offsetInWindow){
        return mChildHelper.dispatchNestedScroll(dxConsumed, dyConsumed,
                dxUnconsumed, dyUnconsumed,offsetInWindow)
    }
}

滑動(dòng)事件傳遞簡(jiǎn)要流程圖如下(不包含F(xiàn)ling事件)：

關(guān)于NestedScrollingParent和NestedScrollingChild方法參數(shù)和返回值的詳細(xì)說(shuō)明可以參考這里，接下來(lái)會(huì)結(jié)合下拉刷新的需求來(lái)實(shí)現(xiàn)具體代碼档址。
Lollipop及以上版本的所有View都已經(jīng)支持了NestedScroll機(jī)制盹兢，Lollipop之前版本可以通過(guò)Support包進(jìn)行向前兼容。

此外守伸，26.0.0中NestedScroll得到了加強(qiáng)绎秒，對(duì)嵌套滾動(dòng)的API做了些改進(jìn)，出現(xiàn)了新的接口NestedScrollingParent2和NestedScrollingChild2尼摹。新的接口在部分方法之上添加了一個(gè)新的參數(shù) type 见芹，type參數(shù)告訴你是什么類型的輸入在驅(qū)動(dòng)scroll事件剂娄，目前可以是這兩種選項(xiàng)之一：ViewCompat.TYPE_TOUCH 和ViewCompat.TYPE_NON_TOUCH。詳細(xì)可以參考這里玄呛，下文將使用新的API阅懦。

實(shí)現(xiàn)需求——下拉刷新

要在NestScrolling的基礎(chǔ)上實(shí)現(xiàn)下拉刷新功能，我們首先定義一個(gè)繼承ViewGroup的CustomRefreshLayout控件徘铝，并重寫其中的onMeasure和onLayout方法耳胎，實(shí)現(xiàn)對(duì)滑動(dòng)控件和刷新控件的寬高測(cè)量和具體布局工作：
注：下面的代碼使用了Kotlin語(yǔ)言編寫，語(yǔ)法不復(fù)雜不會(huì)影響閱讀體驗(yàn)惕它，了解更多關(guān)于Kotlin的內(nèi)容可以看我這篇文章

public class CustomRefreshLayout : ViewGroup {

    private var mTarget: View? = null // 被滑動(dòng)的控件
    private var mSpinner: FrameLayout by Delegates.notNull() // 刷新控件

    init {
        mSpinner = FrameLayout(context)
        addView(mSpinner)
    }

    //...

    override fun onMeasure(widthMeasureSpec: Int, heightMeasureSpec: Int) {
        super.onMeasure(widthMeasureSpec, heightMeasureSpec)
        if (mTarget == null) {
            ensureTarget()
        }
        if (mTarget == null) {
            return
        }
        mTarget?.measure(MeasureSpec.makeMeasureSpec(
                measuredWidth - paddingLeft - paddingRight,
                MeasureSpec.EXACTLY), MeasureSpec.makeMeasureSpec(
                measuredHeight - paddingTop - paddingBottom, MeasureSpec.EXACTLY))
        mSpinner.measure(
                MeasureSpec.makeMeasureSpec(measuredWidth, MeasureSpec.AT_MOST),
                MeasureSpec.makeMeasureSpec(measuredHeight, MeasureSpec.AT_MOST))
        mOriginalSpinnerOffsetTop = -(mSpinner.measuredHeight)
        mSpinnerIndex = -1
        // 獲取刷新控件的序號(hào)
        for (index in 0 until childCount) {
            if (getChildAt(index) === mSpinner) {
                mSpinnerIndex = index
                break
            }
        }
    }

    override fun onLayout(changed: Boolean, l: Int, t: Int, r: Int, b: Int) {
        val width = measuredWidth
        val height = measuredHeight
        if (childCount == 0) {
            return
        }
        if (mTarget == null) {
            ensureTarget()
        }
        val child = mTarget ?: return
        val childLeft = paddingLeft
        var childTop = paddingTop
        val childWidth = width - paddingLeft - paddingRight
        val childHeight = height - paddingTop - paddingBottom
        child.layout(childLeft, childTop, childLeft + childWidth, childTop + childHeight)
        val spinnerWidth = mSpinner.measuredWidth
        val spinnerHeight = mSpinner.measuredHeight
        mSpinner.layout(width / 2 - spinnerWidth / 2, mCurrentSpinnerOffsetTop,
                width / 2 + spinnerWidth / 2, mCurrentSpinnerOffsetTop + spinnerHeight)
    }

    private fun ensureTarget() {
        // 確保要處理滑動(dòng)的控件存在
        if (mTarget == null) {
            for (i in 0 until childCount) {
                val child = getChildAt(i)
                if (child != mSpinner) {
                    mTarget = child
                    break
                }
            }
        }
    }
}

這其中有一個(gè)坑怕午，刷新控件mSpinner的位置可能不是ViewGroup的最后一個(gè)，所以在繪制時(shí)可能被滑動(dòng)控件覆蓋淹魄，要解決這問(wèn)題郁惜，可以重寫getChildDrawingOrder方法來(lái)指定繪制順序：

override fun getChildDrawingOrder(childCount: Int, i: Int): Int {
    return when {
        mSpinnerIndex < 0 -> i
        i == childCount - 1 -> // 最后一位繪制
            mSpinnerIndex
        i >= mSpinnerIndex -> // 提早一位繪制
            i + 1
        else -> // 保持原順序繪制
            i
    }
}

有了NestedScrolling后，我們可以不用關(guān)注觸摸事件甲锡，只需要處理滑動(dòng)事件中扳炬，所以讓CustomRefreshLayout實(shí)現(xiàn)NestedScrollingParent2和NestedScrollingChild2兩個(gè)接口。

public class CustomRefreshLayout : ViewGroup, NestedScrollingParent2, NestedScrollingChild2 {

    private val mParentHelper = NestedScrollingParentHelper(this)
    private val mChildHelper = NestedScrollingChildHelper(this)
    private var mStatus: Status = Status.Ready

    //...

    // NestedScrollingParent

    override fun onStartNestedScroll(child: View, target: View, nestedScrollAxes: Int, type: Int): Boolean {
        return (isEnabled && mStatus != Status.Refresh
                && nestedScrollAxes and ViewCompat.SCROLL_AXIS_VERTICAL != 0 //只接受垂直方向的滾動(dòng)
                && type == ViewCompat.TYPE_TOUCH)//只接受touch的滾動(dòng)搔体，不接受fling
    }

    override fun onNestedScrollAccepted(child: View, target: View, axes: Int, type: Int) {
        mParentHelper.onNestedScrollAccepted(child, target, axes, type)
        // 分發(fā)事件給Nested Parent
        startNestedScroll(axes and ViewCompat.SCROLL_AXIS_VERTICAL, type)
        // 重置計(jì)數(shù)
        mTotalUnconsumed = 0f
        mStatus = Status.Pull
    }

    override fun onNestedPreScroll(target: View, dx: Int, dy: Int, consumed: IntArray?, type: Int) {
        consumed ?: return

        // 如果在下拉過(guò)程中恨樟，直接響應(yīng)并消耗上滑距離，調(diào)整Spinner位置
        if (dy > 0 && mTotalUnconsumed > 0) {
            if (dy > mTotalUnconsumed) {
                consumed[1] = dy - mTotalUnconsumed.toInt()
                mTotalUnconsumed = 0f
            } else {
                mTotalUnconsumed -= dy.toFloat()
                consumed[1] = dy
            }
            moveSpinner(mTotalUnconsumed)
        }

        // 讓Nested Parent來(lái)處理剩下的滑動(dòng)距離
        val parentConsumed = mParentScrollConsumed
        if (dispatchNestedPreScroll(dx - consumed[0], dy - consumed[1], parentConsumed, null, type)) {
            consumed[0] += parentConsumed[0]
            consumed[1] += parentConsumed[1]
        }
    }

    override fun onStopNestedScroll(target: View, type: Int) {
        mParentHelper.onStopNestedScroll(target)
        // 如果有處理過(guò)滑動(dòng)事件疚俱，執(zhí)行滑動(dòng)停止后的操作
        if (mTotalUnconsumed > 0) {
            finishSpinner(mTotalUnconsumed)
            mTotalUnconsumed = 0f
        }
        // 分發(fā)事件給Nested Parent
        stopNestedScroll(type)
    }

    override fun onNestedScroll(target: View, dxConsumed: Int, dyConsumed: Int,
                                dxUnconsumed: Int, dyUnconsumed: Int, type: Int) {
        // 首先分發(fā)事件給Nested Parent
        dispatchNestedScroll(dxConsumed, dyConsumed, dxUnconsumed, dyUnconsumed,
                mParentOffsetInWindow, type)

        // 考慮到有時(shí)候可能被兩個(gè)nested scrolling view包圍劝术，這里計(jì)算滑動(dòng)距離時(shí)要加上Nested Parent滑動(dòng)的距離
        // 如果可以刷新，移動(dòng)刷新控件的位置
        val dy = dyUnconsumed + mParentOffsetInWindow[1]
        if (dy < 0 && !canChildScrollUp()) {
            mTotalUnconsumed += Math.abs(dy).toFloat()
            moveSpinner(mTotalUnconsumed)
        }
    }

    // NestedScrollingChild呆奕，全部交由Childer Helper來(lái)處理

    override fun startNestedScroll(axes: Int, type: Int): Boolean {
        return mChildHelper.startNestedScroll(axes, type)
    }

    override fun stopNestedScroll(type: Int) {
        mChildHelper.stopNestedScroll(type)
    }

    override fun hasNestedScrollingParent(type: Int): Boolean {
        return mChildHelper.hasNestedScrollingParent(type)
    }

    override fun dispatchNestedScroll(dxConsumed: Int, dyConsumed: Int, dxUnconsumed: Int,
                                      dyUnconsumed: Int, offsetInWindow: IntArray?, type: Int): Boolean {
        return mChildHelper.dispatchNestedScroll(dxConsumed, dyConsumed,
                dxUnconsumed, dyUnconsumed, offsetInWindow, type)
    }

    override fun dispatchNestedPreScroll(dx: Int, dy: Int, consumed: IntArray?, offsetInWindow: IntArray?, type: Int): Boolean {
        return mChildHelper.dispatchNestedPreScroll(
                dx, dy, consumed, offsetInWindow, type)
    }

    /**
     * 移動(dòng)刷新控件的垂直位置
     */
    private fun moveSpinner(overscrollTop: Float) {
        if (mSpinner.visibility != View.VISIBLE) {
            mSpinner.visibility = View.VISIBLE
        }
        val move = if (overscrollTop <= mRefreshSlop) {
            overscrollTop
        } else {
            mRefreshSlop + (overscrollTop - mRefreshSlop) / 2f
        }.toInt()
        val targetOffsetTop = mOriginalSpinnerOffsetTop + move
        setSpinnerOffsetTopAndBottom(targetOffsetTop - mCurrentSpinnerOffsetTop)
    }

    /**
     * 停止下拉后的操作
     */
    private fun finishSpinner(overscrollTop: Float) {
        if (overscrollTop > mRefreshSlop) {
            setRefreshing(true, true /* notify */)
        } else {
            // cancel refresh
            mStatus = Status.Ready
            animateSpinnerToReady()
        }
    }

    /**
     * 設(shè)置刷新狀態(tài)
     * @param refreshing 是否在刷新
     * @param notify 是否通知listener
     */
    private fun setRefreshing(refreshing: Boolean, notify: Boolean) {
        val isRefreshing = mStatus == Status.Refresh
        if (isRefreshing != refreshing) {
            ensureTarget()
            if (refreshing) {
                mStatus = Status.Refresh
                animateSpinnerToRefresh()
                if (notify) {
                    mOnRefreshListener?.onRefresh()
                }
            } else {
                mStatus = Status.Ready
                animateSpinnerToReady()
            }
        }
    }

    /**
     * 設(shè)置Spinner的位置
     */
    private fun setSpinnerOffsetTopAndBottom(offset: Int) {
        mSpinner.bringToFront()
        ViewCompat.offsetTopAndBottom(mSpinner, offset)
        mCurrentSpinnerOffsetTop = mSpinner.top
        if (!mIsSpinnerOver) {
            ViewCompat.offsetTopAndBottom(mTarget, offset)
        }
    }
}

再為下拉刷新添加合適的動(dòng)畫效果养晋，比如說(shuō)簡(jiǎn)單的平移：

    /**
     * 讓Spinner帶動(dòng)畫移動(dòng)到準(zhǔn)備位置
     */
    private fun animateSpinnerToReady() {
        mAnimateFrom = mCurrentSpinnerOffsetTop
        mAnimateToReady.reset()
        mAnimateToReady.duration = ANIMATE_DURATION.toLong()
        mAnimateToReady.interpolator = ANIMATE_INTERPOLATOR
        mSpinner.clearAnimation()
        mSpinner.startAnimation(mAnimateToReady)
    }

    //移動(dòng)到準(zhǔn)備位置的動(dòng)畫
    private val mAnimateToReady = object : Animation() {
        public override fun applyTransformation(interpolatedTime: Float, t: Transformation) {
            val targetTop = mAnimateFrom + ((mOriginalSpinnerOffsetTop - mAnimateFrom) * interpolatedTime).toInt()
            val offset = targetTop - mCurrentSpinnerOffsetTop
            setSpinnerOffsetTopAndBottom(offset)
            updateProgress()
        }
    }

    /**
     * 讓Spinner帶動(dòng)畫移動(dòng)到刷新位置
     */
    private fun animateSpinnerToRefresh() {
        mAnimateFrom = mCurrentSpinnerOffsetTop
        mAnimateToRefresh.reset()
        mAnimateToRefresh.duration = ANIMATE_DURATION.toLong()
        mAnimateToRefresh.interpolator = ANIMATE_INTERPOLATOR
        mSpinner.clearAnimation()
        mSpinner.startAnimation(mAnimateToRefresh)
    }

    //移動(dòng)到刷新位置的動(dòng)畫
    private val mAnimateToRefresh = object : Animation() {
        public override fun applyTransformation(interpolatedTime: Float, t: Transformation) {
            val endTarget = mOriginalSpinnerOffsetTop + mRefreshSlop
            val targetTop = mAnimateFrom + ((endTarget - mAnimateFrom) * interpolatedTime).toInt()
            val offset = targetTop - mCurrentSpinnerOffsetTop
            setSpinnerOffsetTopAndBottom(offset)
            updateProgress()
        }
    }

核心功能完成后，在加上一些對(duì)外暴露的接口就大功告成了梁钾！完整代碼在這里绳泉，最終實(shí)現(xiàn)的效果是這樣的：

后記

文章實(shí)現(xiàn)的下拉刷新控件CustomRefreshLayout的原理其實(shí)和官方提供的SwipeRefreshLayout很類似，區(qū)別只在于SwipeRefreshLayout還處理了Touch事件姆泻，而CustomRefreshLayout沒(méi)有零酪，所以CustomRefreshLayout只可以與NestedScrollView或者RecyclerView等實(shí)現(xiàn)了NestedScrolling的控件協(xié)同使用，有興趣學(xué)習(xí)或者使用的同學(xué)可以根據(jù)需要再擴(kuò)展一下拇勃。