Android源码系列(1) -- View事件分发

Posted by phantomVK on October 18, 2016

前言

最近看View的事件分发源码,并做了一些笔记。笔记以注释的形式插入到代码中,请仔细阅读文章中给出的源码。源码基于Android 6.0,或有错漏之处,欢迎指正。

一、代码构建

1.1 自定义Button

继承 Button 类观察事件调用方法,并重载 dispatchTouchEvent()onTouchEvent()

public class MyButton extends Button {

    private static final String TAG = "MyButton";

    public MyButton(Context context, AttributeSet attrs) {
        super(context, attrs);
    }
    
    @Override
    public boolean dispatchTouchEvent(MotionEvent event) {
        int action = event.getAction();
        switch (action) {
            case MotionEvent.ACTION_DOWN:
                Log.e(TAG, "dispatchTouchEvent ACTION_DOWN");
                break;

            case MotionEvent.ACTION_MOVE:
                Log.e(TAG, "dispatchTouchEvent ACTION_MOVE");
                break;

            case MotionEvent.ACTION_UP:
                Log.e(TAG, "dispatchTouchEvent ACTION_UP");
                break;

            default:
                break;
        }
        return super.dispatchTouchEvent(event);
    }

    @Override
    public boolean onTouchEvent(MotionEvent event) {
        int action = event.getAction();
        switch (action) {
            case MotionEvent.ACTION_DOWN:
                Log.e(TAG, "onTouchEvent ACTION_DOWN");
                break;

            case MotionEvent.ACTION_MOVE:
                Log.e(TAG, "onTouchEvent ACTION_MOVE");
                break;

            case MotionEvent.ACTION_UP:
                Log.e(TAG, "onTouchEvent ACTION_UP");
                break;

            default:
                break;
        }  
        return super.onTouchEvent(event);
    }
}

1.2 xml布局

main_activity.xml 使用自定义 MyButton

<RelativeLayout 
    xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <com.corevk.demoproject.MyButton
        android:id="@+id/MyButton"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"/>    
</RelativeLayout>

1.3 初始化

绑定按钮并给按钮设置一个监听器 OnTouchListener ,下文会说明这个监听器的作用。

public class MainActivity extends AppCompatActivity {

    private static final String TAG = "MainActivity";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        Button mButton = (Button) findViewById(R.id.MyButton);
        mButton.setOnTouchListener(new View.OnTouchListener() {
            @Override
            public boolean onTouch(View v, MotionEvent event) {
                int action = event.getAction();
                switch (action) {
                    case MotionEvent.ACTION_DOWN:
                        Log.e(TAG, "onTouch ACTION_DOWN");
                        break;

                    case MotionEvent.ACTION_MOVE:
                        Log.e(TAG, "onTouch ACTION_MOVE");
                        break;

                    case MotionEvent.ACTION_UP:
                        Log.e(TAG, "onTouch ACTION_UP");
                        break;

                    default:
                        break;
                }
                return false; // 返回值会影响事件分发行为
            }
        });
    }
}

二、运行结果

2.1 OnTouchListener 返回 false

View.OnTouchListener 返回 false ,点击按钮马上放开。

如果手指一直在屏幕上滑动,Log的 ACTION_DOWNACTION_UP 之间会报告 ACTION_MOVE 的信息。我们并不关心 ACTION_MOVE 的状态,所以忽略它的消息。

可见,结果按照 dispatchTouchEvent() -> onTouch() -> onTouchEvent() 的顺序出现

10-13 23:53:29.382 17840-17840/? E/MyButton: dispatchTouchEvent ACTION_DOWN
10-13 23:53:29.382 17840-17840/? E/MainActivity: onTouch ACTION_DOWN
10-13 23:53:29.382 17840-17840/? E/MyButton: onTouchEvent ACTION_DOWN

10-13 23:53:29.414 17840-17840/? E/MyButton: dispatchTouchEvent ACTION_UP
10-13 23:53:29.414 17840-17840/? E/MainActivity: onTouch ACTION_UP
10-13 23:53:29.414 17840-17840/? E/MyButton: onTouchEvent ACTION_UP

2.2 OnTouchListener 返回 true

View.OnTouchListener 返回 true ,点击按钮马上放开: dispatchTouchEvent() -> onTouch()

10-13 23:55:32.523 18106-18106/? E/MyButton: dispatchTouchEvent ACTION_DOWN
10-13 23:55:32.523 18106-18106/? E/MainActivity: onTouch ACTION_DOWN

10-13 23:55:32.554 18106-18106/? E/MyButton: dispatchTouchEvent ACTION_UP
10-13 23:55:32.554 18106-18106/? E/MainActivity: onTouch ACTION_UP

对比2.1节的日志,onTouchEvent() 没有触发,说明事件没有分发到 onTouchEvent()

三、源码分析

3.1 dispatchTouchEvent

先看 dispatchTouchEvent 源码,这是所有 View 最先接收触摸事件的方法。

public boolean dispatchTouchEvent(MotionEvent event) {
    if (event.isTargetAccessibilityFocus()) {
        if (!isAccessibilityFocusedViewOrHost()) {
            return false;
        }
        event.setTargetAccessibilityFocus(false);
    }

    boolean result = false; // 默认为false
    
    // 输入事件验证器
    if (mInputEventConsistencyVerifier != null) {
        mInputEventConsistencyVerifier.onTouchEvent(event, 0);
    }

    final int actionMasked = event.getActionMasked();
    if (actionMasked == MotionEvent.ACTION_DOWN) {
        // Defensive cleanup for new gesture
        stopNestedScroll();
    }

    if (onFilterTouchEventForSecurity(event)) {
        ListenerInfo li = mListenerInfo; // 这里获取mListenerInfo
        
        // 所有条件成立执行此语句块:
        //    1. mListenerInfo不为空,且已设置OnTouchListener;
        //    2. View模式是Enable,表明控件可用;
        //    3. mOnTouchListener.onTouch()尝试消费事件;
        if (li != null && li.mOnTouchListener != null
                && (mViewFlags & ENABLED_MASK) == ENABLED
                && li.mOnTouchListener.onTouch(this, event)) {
            // li.mOnTouchListener.onTouch()消费该事件
            result = true;
        }
        
        // 若li.mOnTouchListener.onTouch()没有执行
        // 或消费事件后返回false,事件将交给onTouchEvent()处理
        if (!result && onTouchEvent(event)) {
            result = true;
        }
    }

    // li.mOnTouchListener.onTouch()和onTouchEvent(event)都没有消费事件
    if (!result && mInputEventConsistencyVerifier != null) {
        mInputEventConsistencyVerifier.onUnhandledEvent(event, 0);
    }
    
    if (actionMasked == MotionEvent.ACTION_UP ||
            actionMasked == MotionEvent.ACTION_CANCEL ||
            (actionMasked == MotionEvent.ACTION_DOWN && !result)) {
        stopNestedScroll();
    }

    return result;
}

从上述源码可知,点击事件进入 dispatchTouchEvent() ,在此方法内先给 mOnTouchListener() 消费事件。如果 mOnTouchListener() 不消费该事件,则继续下发给 onTouchEvent(event)

流程图解:

View_dispatchTouchEvent

3.2 li.mOnTouchListener

那么 li.mOnTouchListener 在哪里设定呢?从下面这段截取的代码可知:

ListenerInfo li = mListenerInfo;

if (li != null && li.mOnTouchListener != null
        && (mViewFlags & ENABLED_MASK) == ENABLED
        && li.mOnTouchListener.onTouch(this, event)) {
    result = true;
}  

li.mOnTouchListener 依赖 mButton.setOnTouchListener ,不设置后者则前者为空。

MainActivity.onCreate() 中给 mButton.setOnTouchListener() 创建一个 OnTouchListener 实例的同时,这个实例会保存在 getListenerInfo().mOnTouchListener

public void setOnTouchListener(OnTouchListener l) {
    getListenerInfo().mOnTouchListener = l;
}

getListenInfo() 里面判断 mListenerInfo 非空返回结果,否则创建新 ListenerInfo

ListenerInfo getListenerInfo() {
    if (mListenerInfo != null) {
        return mListenerInfo;
    }
    mListenerInfo = new ListenerInfo();
    return mListenerInfo;
}

3.3 onTouchEvent

上文提到 View.OnTouchListener() 的返回值决定事件是否继续分发给 onTouchEvent 。假如 OnTouchListener() 返回 false ,则 onTouchEvent 接收事件。

public boolean onTouchEvent(MotionEvent event) {
    // 获取动作点击屏幕的坐标
    final float x = event.getX();
    final float y = event.getY();

    final int viewFlags = mViewFlags;
    final int action = event.getAction();
    
    // View为Disable
    if ((viewFlags & ENABLED_MASK) == DISABLED) {
        if (action == MotionEvent.ACTION_UP
                && (mPrivateFlags & PFLAG_PRESSED) != 0) {
            setPressed(false);
        }  
         
        // 点击或长按仅消费事件,不触发具体动作
       	return (((viewFlags & CLICKABLE) == CLICKABLE
                || (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)
                || (viewFlags & CONTEXT_CLICKABLE) == CONTEXT_CLICKABLE);
    }  
 
    // 触摸代理处理事件
    if (mTouchDelegate != null) {
        if (mTouchDelegate.onTouchEvent(event)) {
            // 代理处理成功
            return true;
        }
    }
    
    // 如果View可点击,根据具体行为作出处理
    if (((viewFlags & CLICKABLE) == CLICKABLE ||
            (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) ||
            (viewFlags & CONTEXT_CLICKABLE) == CONTEXT_CLICKABLE) {
        switch (action) { 
            // 请看下一节               
        } 
        return true;
    }
    
    // OnTouchEvent没有消费事件,最终dispatchTouchEvent()返回false
    return false;
}

四、MotionEvent详解

Android触摸消息时长有三种类别:

  1. Prepress:轻触(tap)屏幕,时长小于TAP_TIMEOUT;
  2. Press:点击(press)屏幕,时长介于TAP_TIMEOUT和LONG_PRESS_TIMEOUT之间;
  3. Long press:长按(long press)屏幕,时长大于DEFAULT_LONG_PRESS_TIMEOUT或LONG_PRESS_TIMEOUT;

img

不同版本的Android API时间值可能不同,Android 6.0(23) TAP_TIMEOUT是100ms,部分旧版本是115ms,这里按照最新值解说。

定义子组件点击状态时长:

private static final int PRESSED_STATE_DURATION = 64;

定义观察触摸事件是否轻击或是滚动时长,在此时间段内没有移动则判断为轻击:

private static final int TAP_TIMEOUT = 100;

从点击变为长按确认时长

private static final int DEFAULT_LONG_PRESS_TIMEOUT = 500;

4.1 MotionEvent.ACTION_DOWN

// 长按事件默认为false
mHasPerformedLongPress = false;

if (performButtonActionOnTouchDown(event)) {
    break;
}

//检查是否在滚动容器内
boolean isInScrollingContainer = isInScrollingContainer();

// 在可滚动的视图中会增加点击的检查
if (isInScrollingContainer) {
    // 增加PREPRESSED标志
    mPrivateFlags |= PFLAG_PREPRESSED;

    // 创建CheckForTap()实例
    if (mPendingCheckForTap == null) {
        mPendingCheckForTap = new CheckForTap();
    }
    mPendingCheckForTap.x = event.getX();
    mPendingCheckForTap.y = event.getY();
    
    // 100ms后检查能否达到PRESSED状态
    postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout());
} else {
    // 不在滚动容器就改变PRESSED状态
    setPressed(true, x, y);
    // 开始检测长按动作
    checkForLongClick(0);
}

在上面的代码中,调用时先经过100ms的延时,再使用CheckForTap

private final class CheckForTap implements Runnable {
    public float x; // mPendingCheckForTap.x
    public float y; // mPendingCheckForTap.y

    @Override
    public void run() {
        // 取消PFLAG_PREPRESSED标志
        mPrivateFlags &= ~PFLAG_PREPRESSED;
        
        // 触摸位置没有变化,状态变为PRESSED
        setPressed(true, x, y);
        
        // 开始长按检查
        checkForLongClick(ViewConfiguration.getTapTimeout());
    }
}

checkForLongClick

仅在View支持长按时有效,否则直接退出方法

private void checkForLongClick(int delayOffset) {
    if ((mViewFlags & LONG_CLICKABLE) == LONG_CLICKABLE) {
        mHasPerformedLongPress = false;

        if (mPendingCheckForLongPress == null) {
            mPendingCheckForLongPress = new CheckForLongPress();
        }

        // View重新attach到Window的次数
        mPendingCheckForLongPress.rememberWindowAttachCount();
        
        // 减去Prepress已经延迟的100ms
        postDelayed(mPendingCheckForLongPress,
            ViewConfiguration.getLongPressTimeout() - delayOffset);
    }
}

CheckForLongPress

private final class CheckForLongPress implements Runnable {
    private int mOriginalWindowAttachCount;

    @Override
    public void run() {
        // 需要检查是否已到达PRESSED状态
        if (isPressed() && (mParent != null)
                && mOriginalWindowAttachCount == mWindowAttachCount) { 
                // 长按条件满足,执行长按逻辑  
                if (performLongClick()) {
                    mHasPerformedLongPress = true;
            }
        }
    }
    
    // View重新attach到Window的次数
    public void rememberWindowAttachCount() {
        mOriginalWindowAttachCount = mWindowAttachCount;
    }
}

在run里面调用的performLongClick(),设置的长按监听在以下方法调用。方法返回handled值,直接控制CheckForLongPress()mHasPerformedLongPress

public boolean performLongClick() {
    sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_LONG_CLICKED);

    boolean handled = false;
    ListenerInfo li = mListenerInfo;
    // 获取ListenerInfo,执行li.mOnLongClickListener
    if (li != null && li.mOnLongClickListener != null) {
        handled = li.mOnLongClickListener.onLongClick(View.this);
    }
    // 如果没有长按操作,就展示上下文菜单ContextMenu()
    if (!handled) {
        handled = showContextMenu();
    }
    // 如果长按操作或上下文菜单成功执行,触发一个长按震动反馈给用户
    if (handled) {
        performHapticFeedback(HapticFeedbackConstants.LONG_PRESS);
    }
    return handled;
}

4.2 MotionEvent.ACTION_MOVE

drawableHotspotChanged(x, y); // 当前位置

// 移动到按钮的范围外就会执行
if (!pointInView(x, y, mTouchSlop)) {
    removeTapCallback(); // 移除PREPRESSED状态和对应回调
    
    // 是PRESSED就移除长按检测,并移除PRESSED状态
    if ((mPrivateFlags & PFLAG_PRESSED) != 0) {
        removeLongPressCallback();

        setPressed(false);
    }
}

setPressed

public void setPressed(boolean pressed) {
    // 如果状态不是PRESSED,更新标志位并刷新背景
    final boolean needsRefresh =
	    pressed != ((mPrivateFlags & PFLAG_PRESSED) == PFLAG_PRESSED);

    if (pressed) {
        mPrivateFlags |= PFLAG_PRESSED;
    } else {
        mPrivateFlags &= ~PFLAG_PRESSED;
    }

    if (needsRefresh) {
        refreshDrawableState();
    }
    dispatchSetPressed(pressed);
}

当触发时间不到100ms且触点移到控件外,移除PREPRESSED标志。

private void removeTapCallback() {
    if (mPendingCheckForTap != null) {
        mPrivateFlags &= ~PFLAG_PREPRESSED;
        removeCallbacks(mPendingCheckForTap);
    }
}

如果已经出发长按检测,就需要把长按检测移除。

private void removeLongPressCallback() {
    if (mPendingCheckForLongPress != null) {
      removeCallbacks(mPendingCheckForLongPress);
    }
}

4.3 MotionEvent.ACTION_UP

// 判断mPrivateFlags是否包含PREPRESSED
boolean prepressed = (mPrivateFlags & PFLAG_PREPRESSED) != 0;

// PRESSED或PREPRESSED有一个就执行
if ((mPrivateFlags & PFLAG_PRESSED) != 0 || prepressed) {
    // 在触摸模式,请求聚焦但还没有获得焦点
    boolean focusTaken = false;
    if (isFocusable() && isFocusableInTouchMode() && !isFocused()) {
        focusTaken = requestFocus();
    }

    if (prepressed) {
        // 若按钮在显示被按下之前就释放,为了保证用户看见这变化
        // 要把按钮按下的状态在Up动作里呈现出来
        setPressed(true, x, y);
    }
    
    // 没有长按且不忽略下一个抬起事件,就移除长按     
    if (!mHasPerformedLongPress && !mIgnoreNextUpEvent) {
        removeLongPressCallback();

        // 只有在按下的状态才执行点击操作
        if (!focusTaken) {
            // 用Runnable提交而不是直接执行是为了让其他可见View在点击操作开始之前更新
            if (mPerformClick == null) {
                mPerformClick = new PerformClick();
            }

            // 通过handler添加到消息队列尾部,失败就直接执行performClick()
            if (!post(mPerformClick)) {
                performClick();
            }
        }
    }

    if (mUnsetPressedState == null) {
        mUnsetPressedState = new UnsetPressedState();
    }
    
    if (prepressed) {
        postDelayed(mUnsetPressedState, 
                ViewConfiguration.getPressedStateDuration()); // 64ms
    } else if (!post(mUnsetPressedState)) {
        mUnsetPressedState.run(); // Post失败就取消按下状态
    }

    removeTapCallback();
}
mIgnoreNextUpEvent = false;

performClick()ACTION_UP的过程中被调用的,onClick事件是在这里执行。

public boolean performClick() {
    final boolean result;
    final ListenerInfo li = mListenerInfo;
    if (li != null && li.mOnClickListener != null) {
        playSoundEffect(SoundEffectConstants.CLICK); // 点击音效
        li.mOnClickListener.onClick(this); // 执行OnClickListener
        result = true;
    } else {
        result = false;
    }

    sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_CLICKED);
    return result;
}

取消Pressed状态

private final class UnsetPressedState implements Runnable {
    @Override
    public void run() {
        setPressed(false);
    }
}

五、参考资料