Android源碼進階之ViewDragHelper原理機制解析
作者： Android開發編程
tryCaptureView(View child, int pointerId) 這是一個抽象類，必須去實現，也只有在這個方法返回true的時候下面的方法才會生效。
本文轉載自微信公眾號「Android開發編程」，作者Android開發編程 。轉載本文請聯系Android開發編程公眾號。
前言
ViewDragHelper類，是用來處理View邊界拖動相關的類;
主要功能處理在View上的觸摸事件，記錄觸摸點、計算距離、滾動動畫、狀態回調等，如果我們自己手動實現自然會很麻煩還可能出錯，而這個類會幫助我們大大簡化工作量;
今天我們就來分析一波;
一、ViewDragHelper的中主要API介紹
1、ViewDragHelper create(ViewGroup forParent, Callback cb)
一個靜態的創建方法;
- 參數1：出入的是相應的ViewGroup;
- 參數2：是一個回掉，需要自己實現;
2、shouldInterceptTouchEvent(MotionEvent ev)
處理事件分發的(怎么說這個方法呢?主要是將ViewGroup的事件分發，委托給ViewDragHelper進行處理);
- 參數1：MotionEvent ev 主要是ViewGroup的事件;
3、processTouchEvent(MotionEvent event)
處理相應TouchEvent的方法，這里要注意一個問題，處理相應的TouchEvent的時候要將結果返回為true，消費本次事件,否則將無法使用ViewDragHelper處理相應的拖拽事件;
4、ViewDragHelper.Callback的API
tryCaptureView(View child, int pointerId) 這是一個抽象類，必須去實現，也只有在這個方法返回true的時候下面的方法才會生效;
onViewDragStateChanged(int state) 當狀態改變的時候回調，返回相應的狀態(這里有三種狀態);
- STATE_IDLE 閑置狀態;
- STATE_DRAGGING 正在拖動;
- STATE_SETTLING 放置到某個位置;
onViewPositionChanged(View changedView, int left, int top, int dx, int dy) 當你拖動的View位置發生改變的時候回調;
- 參數1：你當前拖動的這個View
- 參數2：距離左邊的距離
- 參數3：距離右邊的距離
- 參數4：x軸的變化量
- 參數5：y軸的變化量
onViewCaptured(View capturedChild, int activePointerId)捕獲View的時候調用的方法
- 參數1：捕獲的View(也就是你拖動的這個View);
- 參數2：這個參數我也不知道什么意思API中寫的一個什么指針，這里沒有到也沒有注意;
onViewReleased(View releasedChild, float xvel, float yvel) 當View停止拖拽的時候調用的方法
- 參數1：你拖拽的這個View
- 參數2：x軸的速率
- 參數3：y軸的速率
clampViewPositionVertical(View child, int top, int dy) 豎直拖拽的時候回調的方法
- 參數1：拖拽的View
- 參數2：距離頂部的距離
- 參數3：變化量
clampViewPositionHorizontal(View child, int left, int dx) 水平拖拽的時候回調的方法
- 參數1：拖拽的View
- 參數2：距離左邊的距離
- 參數3：變化量
二、實現原理介紹
1、初始化
- private ViewDragHelper(Context context, ViewGroup forParent, Callback cb) {
- ...
- mParentView = forParent;//BaseView
- mCallback = cb;//callback
- final ViewConfiguration vc = ViewConfiguration.get(context);
- final float density = context.getResources().getDisplayMetrics().density;
- mEdgeSize = (int) (EDGE_SIZE * density + 0.5f);//邊界拖動距離范圍
- mTouchSlop = vc.getScaledTouchSlop();//拖動距離閾值
- mScroller = new OverScroller(context, sInterpolator);//滾動器
- }
- mParentView是指基于哪個View進行觸摸處理;
- mCallback是觸摸處理的各個階段的回調;
- mEdgeSize是指在邊界多少距離內算作拖動，默認為20dp;
- mTouchSlop指滑動多少距離算作拖動，用的系統默認值;
- mScroller是View滾動的Scroller對象，用于處理釋觸摸放后，View的滾動行為，比如滾動回原始位置或者滾動出屏幕;
2.攔截事件處理
該類提供了boolean shouldInterceptTouchEvent(MotionEvent)方法：
- override fun onInterceptTouchEvent(ev: MotionEvent?) =
- dragHelper?.shouldInterceptTouchEvent(ev) ?: super.onInterceptTouchEvent(ev)
該方法用于處理mParentView是否攔截此次事件
- public boolean shouldInterceptTouchEvent(MotionEvent ev) {
- ...
- switch (action) {
- ...
- case MotionEvent.ACTION_MOVE: {
- if (mInitialMotionX == null || mInitialMotionY == null) break;
- // First to cross a touch slop over a draggable view wins. Also report edge drags.
- final int pointerCount = ev.getPointerCount();
- for (int i = 0; i < pointerCount; i++) {
- final int pointerId = ev.getPointerId(i);
- // If pointer is invalid then skip the ACTION_MOVE.
- if (!isValidPointerForActionMove(pointerId)) continue;
- final float x = ev.getX(i);
- final float y = ev.getY(i);
- final float dx = x - mInitialMotionX[pointerId];
- final float dy = y - mInitialMotionY[pointerId];
- final View toCapture = findTopChildUnder((int) x, (int) y);
- final boolean pastSlop = toCapture != null && checkTouchSlop(toCapture, dx, dy);
- ...
- //判斷pointer的拖動邊界
- reportNewEdgeDrags(dx, dy, pointerId);
- ...
- }
- saveLastMotion(ev);
- break;
- }
- ...
- }
- return mDragState == STATE_DRAGGING;
- }
攔截事件的前提是mDragState為STATE_DRAGGING，也就是正在拖動狀態下才會攔截，那么什么時候會變為拖動狀態呢?當ACTION_MOVE時，調用reportNewEdgeDrags方法:
- private void reportNewEdgeDrags(float dx, float dy, int pointerId) {
- int dragsStarted = 0;
- //判斷是否在Left邊緣進行滑動
- if (checkNewEdgeDrag(dx, dy, pointerId, EDGE_LEFT)) {
- dragsStarted |= EDGE_LEFT;
- }
- if (checkNewEdgeDrag(dy, dx, pointerId, EDGE_TOP)) {
- dragsStarted |= EDGE_TOP;
- }
- ...
- if (dragsStarted != 0) {
- mEdgeDragsInProgress[pointerId] |= dragsStarted;
- //回調拖動的邊
- mCallback.onEdgeDragStarted(dragsStarted, pointerId);
- }
- }
- private boolean checkNewEdgeDrag(float delta, float odelta, int pointerId, int edge) {
- final float absDelta = Math.abs(delta);
- final float absODelta = Math.abs(odelta);
- //是否支持edge的拖動以及是否滿足拖動距離的閾值
- if ((mInitialEdgesTouched[pointerId] & edge) != edge || (mTrackingEdges & edge) == 0
- || (mEdgeDragsLocked[pointerId] & edge) == edge
- || (mEdgeDragsInProgress[pointerId] & edge) == edge
- || (absDelta <= mTouchSlop && absODelta <= mTouchSlop)) {
- return false;
- }
- if (absDelta < absODelta * 0.5f && mCallback.onEdgeLock(edge)) {
- mEdgeDragsLocked[pointerId] |= edge;
- return false;
- }
- return (mEdgeDragsInProgress[pointerId] & edge) == 0 && absDelta > mTouchSlop;
- }
可以看到，當ACTION_MOVE時，會嘗試找到pointer對應的拖動邊界，這個邊界可以由我們來制定，比如側滑關閉頁面是從左側開始的，所以我們可以調用setEdgeTrackingEnabled(ViewDragHelper.EDGE_LEFT)來設置只支持左側滑動。而一旦有滾動發生，就會回調callback的onEdgeDragStarted方法，交由我們做如下操作：
- override fun onEdgeDragStarted(edgeFlags: Int, pointerId: Int) {
- super.onEdgeDragStarted(edgeFlags, pointerId)
- dragHelper?.captureChildView(getChildAt(0), pointerId)
- }
- 我們調用了ViewDragHelper的captureChildView方法：
- public void captureChildView(View childView, int activePointerId) {
- mCapturedView = childView;//記錄拖動view
- mActivePointerId = activePointerId;
- mCallback.onViewCaptured(childView, activePointerId);
- setDragState(STATE_DRAGGING);//設置狀態為開始拖動
- }
此時，就記錄了拖動的View，并將狀態置為拖動，那么在下次ACTION_MOVE的時候，該mParentView就會攔截事件，交由自己的onTouchEvent方法處理拖動了;
3.拖動事件處理
該類提供了void processTouchEvent(MotionEvent)方法，通常我們需要這么寫：
- override fun onTouchEvent(event: MotionEvent?): Boolean {
- dragHelper?.processTouchEvent(event)//交由ViewDragHelper處理
- return true
- }
該方法用于處理mParentView攔截事件后的拖動處理：
- public void processTouchEvent(MotionEvent ev) {
- ...
- switch (action) {
- ...
- case MotionEvent.ACTION_MOVE: {
- if (mDragState == STATE_DRAGGING) {
- // If pointer is invalid then skip the ACTION_MOVE.
- if (!isValidPointerForActionMove(mActivePointerId)) break;
- final int index = ev.findPointerIndex(mActivePointerId);
- final float x = ev.getX(index);
- final float y = ev.getY(index);
- //計算距離上次的拖動距離
- final int idx = (int) (x - mLastMotionX[mActivePointerId]);
- final int idy = (int) (y - mLastMotionY[mActivePointerId]);
- dragTo(mCapturedView.getLeft() + idx, mCapturedView.getTop() + idy, idx, idy);//處理拖動
- saveLastMotion(ev);//記錄當前觸摸點
- }...
- break;
- }
- ...
- case MotionEvent.ACTION_UP: {
- if (mDragState == STATE_DRAGGING) {
- releaseViewForPointerUp();//釋放拖動view
- }
- cancel();
- break;
- }...
- }
- }
(1)拖動
ACTION_MOVE時，會計算出pointer距離上次的位移，然后計算出capturedView的目標位置，進行拖動處理;
- private void dragTo(int left, int top, int dx, int dy) {
- int clampedX = left;
- int clampedY = top;
- final int oldLeft = mCapturedView.getLeft();
- final int oldTop = mCapturedView.getTop();
- if (dx != 0) {
- clampedX = mCallback.clampViewPositionHorizontal(mCapturedView, left, dx);//通過callback獲取真正的移動值
- ViewCompat.offsetLeftAndRight(mCapturedView, clampedX - oldLeft);//進行位移
- }
- if (dy != 0) {
- clampedY = mCallback.clampViewPositionVertical(mCapturedView, top, dy);
- ViewCompat.offsetTopAndBottom(mCapturedView, clampedY - oldTop);
- }
- if (dx != 0 || dy != 0) {
- final int clampedDx = clampedX - oldLeft;
- final int clampedDy = clampedY - oldTop;
- mCallback.onViewPositionChanged(mCapturedView, clampedX, clampedY,
- clampedDx, clampedDy);//callback回調移動后的位置
- }
- }
通過callback的clampViewPositionHorizontal方法決定實際移動的水平距離，通常都是返回left值，即拖動了多少就移動多少;
通過callback的onViewPositionChanged方法，可以對View拖動后的新位置做一些處理，如;
- override fun onViewPositionChanged(changedView: View?, left: Int, top: Int, dx: Int, dy: Int) {
- super.onViewPositionChanged(changedView, left, top, dx, dy)
- //當新的left位置到達width時，即滑動除了界面，關閉頁面
- if (left >= width && context is Activity && !context.isFinishing) {
- context.finish()
- }
- }
(2)釋放
而ACTION_UP動作時，要釋放拖動View
- private void releaseViewForPointerUp() {
- ...
- dispatchViewReleased(xvel, yvel);
- }
- private void dispatchViewReleased(float xvel, float yvel) {
- mReleaseInProgress = true;
- mCallback.onViewReleased(mCapturedView, xvel, yvel);//callback回調釋放
- mReleaseInProgress = false;
- if (mDragState == STATE_DRAGGING) {
- // onViewReleased didn't call a method that would have changed this. Go idle.
- setDragState(STATE_IDLE);//重置狀態
- }
- }
通常在callback的onViewReleased方法中，我們可以判斷當前釋放點的位置，從而決定是要回彈頁面還是滑出屏幕
- override fun onViewReleased(releasedChild: View?, xvel: Float, yvel: Float) {
- super.onViewReleased(releasedChild, xvel, yvel)
- //滑動速度到達一定值時直接關閉
- if (xvel >= 300) {//滑動頁面到屏幕外，關閉頁面
- dragHelper?.settleCapturedViewAt(width, 0)
- } else {//回彈頁面
- dragHelper?.settleCapturedViewAt(0, 0)
- }
- //刷新，開始關閉或重置動畫
- invalidate()
- }
如滑動速度大于300時，我們調用settleCapturedViewAt方法將頁面滾動出屏幕，否則調用該方法進行回彈
(3)滾動
- public boolean settleCapturedViewAt(int finalLeft, int finalTop) {
- return forceSettleCapturedViewAt(finalLeft, finalTop,
- (int) mVelocityTracker.getXVelocity(mActivePointerId),
- (int) mVelocityTracker.getYVelocity(mActivePointerId));
- }
- private boolean forceSettleCapturedViewAt(int finalLeft, int finalTop, int xvel, int yvel) {
- //當前位置
- final int startLeft = mCapturedView.getLeft();
- final int startTop = mCapturedView.getTop();
- //偏移量
- final int dx = finalLeft - startLeft;
- final int dy = finalTop - startTop;
- ...
- final int duration = computeSettleDuration(mCapturedView, dx, dy, xvel, yvel);
- //使用Scroller對象開始滾動
- mScroller.startScroll(startLeft, startTop, dx, dy, duration);
- //重置狀態為滾動
- setDragState(STATE_SETTLING);
- return true;
- }
- 其內部使用的是Scroller對象：是View的滾動機制，其回調是View的computeScroll()方法，在其內部通過Scroller對象的computeScrollOffset方法判斷是否滾動完畢，如仍需滾動，需要調用invalidate方法進行刷新;
- ViewDragHelper據此提供了一個類似的方法continueSettling，需要在computeScroll中調用，判斷是否需要invalidate;
- public boolean continueSettling(boolean deferCallbacks) {
- if (mDragState == STATE_SETTLING) {
- //是否滾動結束
- boolean keepGoing = mScroller.computeScrollOffset();
- //當前滾動值
- final int x = mScroller.getCurrX();
- final int y = mScroller.getCurrY();
- //偏移量
- final int dx = x - mCapturedView.getLeft();
- final int dy = y - mCapturedView.getTop();
- //便宜操作
- if (dx != 0) {
- ViewCompat.offsetLeftAndRight(mCapturedView, dx);
- }
- if (dy != 0) {
- ViewCompat.offsetTopAndBottom(mCapturedView, dy);
- }
- //回調
- if (dx != 0 || dy != 0) {
- mCallback.onViewPositionChanged(mCapturedView, x, y, dx, dy);
- }
- //滾動結束狀態
- if (!keepGoing) {
- if (deferCallbacks) {
- mParentView.post(mSetIdleRunnable);
- } else {
- setDragState(STATE_IDLE);
- }
- }
- }
- return mDragState == STATE_SETTLING;
- }
在我們的View中
- override fun computeScroll() {
- super.computeScroll()
- if (dragHelper?.continueSettling(true) == true) {
- invalidate()
- }
- }
- 以上，就是ViewDragHelper的實現原理和使用方式
- override fun computeScroll() {
- super.computeScroll()
- if (dragHelper?.continueSettling(true) == true) {
- invalidate()
- }
- }
以上，就是ViewDragHelper的實現原理和使用方式
總結
ViewDragHelper本質上是對MotionEvent的分析及處理，并提供了一系列的監聽回調方法，來幫助我們減輕開發負擔，更為方便地處理控件的滑動拖拽邏輯;
是不是覺得很簡單，一起加油，各位老鐵們;
責任編輯：武曉燕
來源：
Android開發編程
