事件分发机制是Android中一块比较重要的知识,了解和熟悉整套事件分发流程有助于我们解决各种滑动冲突问题,同时也有助于我们能够更好地实现各种自定义控件。本文主要从源码的角度来梳理一下事件分发的整个流程,而且源码版本基于Android 8.0。
一、预备知识
MotionEvent
MotionEvent是触摸动作的封装,它包含了触摸的坐标位置,点按的数量(手指的数量),时间点等信息,用于描述用户当前的具体动作,常见的MotionEvent有下面几种类型:
- ACTION_DOWN
- ACTION_MOVE
- ACTION_UP
- ACTION_CANCEL
其中,ACTION_DOWN、ACTION_MOVE、ACTION_UP就分别对应于上面的手指按下、手指滑动、手指抬起操作,即一个最简单的用户操作包含了一个ACTION_DOWN事件,若干个ACTION_MOVE事件和一个ACTION_UP事件。
事件分发流程涉及方法
- dispatchTouchEvent()方法: 用于事件的分发,由自己消费当前事件或者交由子View处理;
- onTouchEvent方法(): 用于事件的处理,返回true表示消费当前事件,false表示不消费;
- onInterceptTouchEvent()方法: ViewGroup中独有的方法,若返回true表示拦截当前事件,并交由自己的onTouchEvent()进行处理,返回false表示不拦截。
二、Activity中的事件分发
触摸事件传递给Activity时,会调用Activity的dispatchTouchEvent()方法,那么我们就从这个方法开始吧。
public boolean dispatchTouchEvent(MotionEvent ev) {
if (ev.getAction() == MotionEvent.ACTION_DOWN) {
onUserInteraction();
}
if (getWindow().superDispatchTouchEvent(ev)) {
return true;
}
return onTouchEvent(ev);
}
我们看到,在该方法中首先会判断当前触摸事件的类型,如果是ACTION_DOWN(即手指按下),则会去调用onUserInteraction()方法。但是,我们跟进这个方法的时候,会发现这个方法没有具体实现。不过根据文档注释,我们可以知道当有任意一个按键、触屏事件发生时,栈顶Activity的onUserInteraction会被触发。那么,我们其实就可以重写该方法来判断用户是不是在和设备进行交互。
然后,该方法中调用了getWindow()的superDispatchTouchEvent()方法。通过前面几篇文章的源码分析,我们可以知道getWindow()获取到的其实就是PhoneWindow对象。那么,这边最终调用的应该就是PhoneWindow的superDispatchTouchEvent()方法。
// PhoneWindow # superDispatchTouchEvent
@Override
public boolean superDispatchTouchEvent(MotionEvent event) {
return mDecor.superDispatchTouchEvent(event);
}
我们看到调用PhoneWindow的superDispatchTouchEvent()方法,其实会去调用mDecor的同名方法,而且这个mDecor就是DecorView对象。那么,我们来看一下DecorView的superDispatchTouchEvent()方法。
public boolean superDispatchTouchEvent(MotionEvent event) {
return super.dispatchTouchEvent(event);
}
那么,这边又去调用了DecorView父类的dispatchTouchEvent()方法。由源码我们很容易知道DecorView是继承自FrameLayout的,也就是要去调用FrameLayout的dispatchTouchEvent()方法。但是,FrameLayout并没有重写dispatchTouchEvent()方法,所以事件最终会交由ViewGroup的dispatchTouchEvent()开始分发。ViewGroup的事件分发将在下文单独讨论,这里暂且略过。
我们回到Activity的dispatchTouchEvent()方法,如果getWindow().superDispatchTouchEvent(ev)返回false,也就是说事件没有被任何一个子View消费,那么就会去调用Activity的onTouchEvent()方法。
public boolean onTouchEvent(MotionEvent event) {
if (mWindow.shouldCloseOnTouch(this, event)) {
finish();
return true;
}
return false;
}
由上述分析可知,触摸事件传递给Activity后,事件便由Activity传递给PhoneWindow,然后再由PhoneWindow传递给DecorView,接着DecorView交由子View处理。如果事件未被任何Activity的子View处理,将由Activity自己处理。
三、ViewGroup中的事件分发
通过上面的分析,我们知道当事件被传递到DecorView之后,经过一系列调用最终会来到ViewGroup的dispatchTouchEvent()方法。该方法的实现比较长,稍微做一下精简,把握主体流程。
// ViewGroup # dispatchTouchEvent
@Override
public boolean dispatchTouchEvent(MotionEvent ev) {
... ...
boolean handled = false;
if (onFilterTouchEventForSecurity(ev)) {
final int action = ev.getAction();
final int actionMasked = action & MotionEvent.ACTION_MASK;
... ...
// Check for interception.
final boolean intercepted;
if (actionMasked == MotionEvent.ACTION_DOWN
|| mFirstTouchTarget != null) {
final boolean disallowIntercept = (mGroupFlags & FLAG_DISALLOW_INTERCEPT) != 0;
if (!disallowIntercept) {
intercepted = onInterceptTouchEvent(ev);
ev.setAction(action); // restore action in case it was changed
} else {
intercepted = false;
}
} else {
// There are no touch targets and this action is not an initial down
// so this view group continues to intercept touches.
intercepted = true;
}
... ...
// Check for cancelation.
final boolean canceled = resetCancelNextUpFlag(this)
|| actionMasked == MotionEvent.ACTION_CANCEL;
... ...
if (!canceled && !intercepted) {
... ...
if (actionMasked == MotionEvent.ACTION_DOWN
|| (split && actionMasked == MotionEvent.ACTION_POINTER_DOWN)
|| actionMasked == MotionEvent.ACTION_HOVER_MOVE) {
... ...
final int childrenCount = mChildrenCount;
if (newTouchTarget == null && childrenCount != 0) {
... ...
for (int i = childrenCount - 1; i >= 0; i--) {
... ...
if (!canViewReceivePointerEvents(child)
|| !isTransformedTouchPointInView(x, y, child, null)) {
ev.setTargetAccessibilityFocus(false);
continue;
}
... ...
if (dispatchTransformedTouchEvent(ev, false, child, idBitsToAssign)) {
// Child wants to receive touch within its bounds.
... ...
mLastTouchDownX = ev.getX();
mLastTouchDownY = ev.getY();
newTouchTarget = addTouchTarget(child, idBitsToAssign);
alreadyDispatchedToNewTouchTarget = true;
break;
}
... ...
}
}
... ...
}
}
// Dispatch to touch targets.
if (mFirstTouchTarget == null) {
// No touch targets so treat this as an ordinary view.
handled = dispatchTransformedTouchEvent(ev, canceled, null,
TouchTarget.ALL_POINTER_IDS);
} else {
// Dispatch to touch targets, excluding the new touch target if we already
// dispatched to it. Cancel touch targets if necessary.
TouchTarget predecessor = null;
TouchTarget target = mFirstTouchTarget;
while (target != null) {
final TouchTarget next = target.next;
if (alreadyDispatchedToNewTouchTarget && target == newTouchTarget) {
handled = true;
} else {
final boolean cancelChild = resetCancelNextUpFlag(target.child)
|| intercepted;
if (dispatchTransformedTouchEvent(ev, cancelChild,
target.child, target.pointerIdBits)) {
handled = true;
}
if (cancelChild) {
if (predecessor == null) {
mFirstTouchTarget = next;
} else {
predecessor.next = next;
}
target.recycle();
target = next;
continue;
}
}
predecessor = target;
target = next;
}
}
// Update list of touch targets for pointer up or cancel, if needed.
if (canceled
|| actionMasked == MotionEvent.ACTION_UP
|| actionMasked == MotionEvent.ACTION_HOVER_MOVE) {
resetTouchState();
} else if (split && actionMasked == MotionEvent.ACTION_POINTER_UP) {
final int actionIndex = ev.getActionIndex();
final int idBitsToRemove = 1 << ev.getPointerId(actionIndex);
removePointersFromTouchTargets(idBitsToRemove);
}
}
if (!handled && mInputEventConsistencyVerifier != null) {
mInputEventConsistencyVerifier.onUnhandledEvent(ev, 1);
}
return handled;
}
(1)检查事件拦截
由源码可知,布尔变量intercepted是用于判断是否进行事件拦截的,而且触发判断的条件是当前触摸事件为ACTION_DOWN或者mFirstTouchTarget不为空。在判断过程中,布尔变量disallowIntercept表示是否禁用事件拦截功能,它的值可以可以通过requestDisallowInterceptTouchEvent()方法进行设置。
@Override
public void requestDisallowInterceptTouchEvent(boolean disallowIntercept) {
if (disallowIntercept == ((mGroupFlags & FLAG_DISALLOW_INTERCEPT) != 0)) {
// We're already in this state, assume our ancestors are too
return;
}
if (disallowIntercept) {
mGroupFlags |= FLAG_DISALLOW_INTERCEPT;
} else {
mGroupFlags &= ~FLAG_DISALLOW_INTERCEPT;
}
// Pass it up to our parent
if (mParent != null) {
mParent.requestDisallowInterceptTouchEvent(disallowIntercept);
}
}
有过自定义View经验的同学一定对该方法不陌生,我们在处理某些滑动冲突场景时,可以在子View中调用父View的requestDisallowInterceptTouchEvent()方法,阻止父View拦截事件。
好了,回到disallowIntercept,如果它的值为false,即不禁止事件拦截功能,那么是否需要禁止事件拦截就会交由onInterceptTouchEvent(ev)方法去判断,我们一起看一下。
public boolean onInterceptTouchEvent(MotionEvent ev) {
if (ev.isFromSource(InputDevice.SOURCE_MOUSE)
&& ev.getAction() == MotionEvent.ACTION_DOWN
&& ev.isButtonPressed(MotionEvent.BUTTON_PRIMARY)
&& isOnScrollbarThumb(ev.getX(), ev.getY())) {
return true;
}
return false;
}
我们可以看到,其实ViewGroup默认是不会进行事件拦截的。那么,ViewGroup的子类也可以重写这个方法,并且在内部判断拦截逻辑。
同时,我们可以看到如果明确要求拦截事件,或者事件是ACTION_DOWN的后续事件(如ACTION_MOVE、ACTION_UP等),并且在传递ACTION_DOWN事件过程中没有找到目标子View时,事件将会直接被拦截,交给ViewGroup自己处理。也就是会走如下代码:
if (mFirstTouchTarget == null) {
// No touch targets so treat this as an ordinary view.
handled = dispatchTransformedTouchEvent(ev, canceled, null,
TouchTarget.ALL_POINTER_IDS);
}
我们一起来看下dispatchTransformedTouchEvent()的具体实现。
private boolean dispatchTransformedTouchEvent(MotionEvent event, boolean cancel,
View child, int desiredPointerIdBits) {
final boolean handled;
... ...
// Perform any necessary transformations and dispatch.
if (child == null) {
handled = super.dispatchTouchEvent(transformedEvent);
} else {
... ...
handled = child.dispatchTouchEvent(transformedEvent);
}
// Done.
transformedEvent.recycle();
return handled;
}
我们注意到,此时传递进来的child参数就是null,那么很显然会去调用super.dispatchTouchEvent()方法,由于ViewGroup是View的子View,所以事件将会使用View的dispatchTouchEvent()方法判断是否消费事件。
(2)遍历子View进行事件分发
由源码可知,如果事件没有被取消,也没有被拦截,并且当前触摸事件是ACTION_DOWN,则会进入遍历子View进行事件分发流程。所以,如果事件是ACTION_DOWN的后续事件(如ACTION_MOVE、ACTION_UP事件),将不会进入遍历流程。进入遍历流程之后,依次获取子View,首先判断触摸点是不是在子View范围内,如果不在则直接跳过该子View。如果触摸点在子View范围内,则调用dispatchTransformedTouchEvent()方法,这个方法我们已经在上面分析过了,会调用child.dispatchTouchEvent()方法进行事件传递。如果dispatchTransformedTouchEvent()方法返回true,则表示事件被子View消费,会通过addTouchTarget()方法把mFirstTouchTarget设置为该子View,并将alreadyDispatchedToNewTouchTarget设置为true,然后跳出循环,事件不再继续传递给其他子View。
private TouchTarget addTouchTarget(@NonNull View child, int pointerIdBits) {
final TouchTarget target = TouchTarget.obtain(child, pointerIdBits);
target.next = mFirstTouchTarget;
mFirstTouchTarget = target;
return target;
}
上面就是addTouchTarget()方法的具体实现,主要就是对mFirstTouchTarget进行了赋值,使之不再是null。
如此,通过遍历子View,就可以找到需要消费该事件的目标子View(确实有的话),并将它赋值给mFirstTouchTarget。如果没有找到需要消费该事件的子View,那么mFirstTouchTarget仍然为null。
(3)ViewGroup自己或者目标子View进行事件处理
我们接着往下看,经过遍历子View,如果发现没有需要消费该事件的子View,即mFirstTouchTarget仍然为null,则事件交由ViewGroup自己处理。这个处理过程其实在上面的分析过程中已经阐述过了,这里不再进行赘述。
如果mFirstTouchTarget不为null,说明在遍历子View的过程中,找到了需要处理该事件的目标子View。此时,ACTION_DOWN的后续事件(如ACTION_MOVE、ACTION_UP等事件),都会传递至由mFirstTouchTarget保存的目标子View中。
由上述分析可知,对于ViewGroup的事件分发,其实脉络还是比较清晰的。首先会判断事件是否需要被拦截,如果需要拦截事件则ViewGroup自己处理该事件。如果事件不拦截,则会遍历子View寻找需要消费该事件的目标子View。如果发现需要消费该事件的目标子View,则后续事件也将交由目标子View处理。如果没有任何子View需要消费该事件,则事件将交由ViewGroup自己进行处理。从中我们也可以知道,如果一个View没有消费ACTION_DOWN事件,那么后续事件也不会传递进来。
四、View中的事件分发
通过上述ViewGroup事件分发流程的分析,我们知道在其中会遍历ViewGroup的所有子View,逐个分发事件。其主要就是通过dispatchTransformedTouchEvent()方法,去调用子View的dispatchTouchEvent()方法进行事件分发,若返回true则表示子View消费。我们关注到其根本还是调用了子View的dispatchTouchEvent()方法,那么这个子View可以是ViewGroup,当然也可以是View。如果子View是ViewGroup,那么就会去调用ViewGroup的dispatchTouchEvent()方法,这个我们已经讨论过了,不再赘述。如果子View是View,那么就会去调用View的dispatchTouchEvent()方法,接下来我们需要重点分析的就是该方法。
// View # dispatchTouchEvent
public boolean dispatchTouchEvent(MotionEvent event) {
... ...
boolean result = false;
... ...
if (onFilterTouchEventForSecurity(event)) {
... ...
//noinspection SimplifiableIfStatement
ListenerInfo li = mListenerInfo;
if (li != null && li.mOnTouchListener != null
&& (mViewFlags & ENABLED_MASK) == ENABLED
&& li.mOnTouchListener.onTouch(this, event)) {
result = true;
}
if (!result && onTouchEvent(event)) {
result = true;
}
}
... ...
return result;
}
精简代码,我们只关注重点部分。首先我们来看一下if (li != null && li.mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED && li.mOnTouchListener.onTouch(this, event))这个一长串条件判断。先来看第2个判断条件,判断ListenerInfo的成员变量mOnTouchListener是否为空,看它是在哪边赋值的。
public void setOnTouchListener(OnTouchListener l) {
getListenerInfo().mOnTouchListener = l;
}
从源码我们很容易知道mOnTouchListener是在setOnTouchListener()方法里面进行赋值的,也就是说我们只要给控件注册了Touch事件的监听,mOnTouchListener就不会为null。接着,我们再看下getListenerInfo()方法的具体实现。
ListenerInfo getListenerInfo() {
if (mListenerInfo != null) {
return mListenerInfo;
}
mListenerInfo = new ListenerInfo();
return mListenerInfo;
}
很明显,getListenerInfo()方法主要是用来创建一个ListenerInfo对象,并将其赋值给成员变量mListenerInfo。回到那个一长串判断的第1个条件,我们看到li变量就是由mListenerInfo进行赋值的,所以说只要给控件注册了Touch事件的监听,li也就不会为null。接着看第3个条件,这个比较简单,就是判断控件是否处于ENABLED状态,控件默认都是enable的,因此这个条件一般都为true。
最后,我们看下第4个判断条件,这里主要是调用注册Touch事件监听时重写的onTouch()方法。如果onTouch()方法方法返回true,就会让这4个条件全部成立,从而让dispatchTouchEvent()方法直接返回true,不会再继续往下执行。如果onTouch()方法返回false,就会再去执行onTouchEvent()方法。如果onTouchEvent()方法返回true,则表示View消费事件,dispatchTouchEvent()方法直接返回true,不会再继续往下执行,否则将告知父View将事件传递给其它兄弟View。基于上述分析,我们可以得到的一个结论,那就是onTouch肯定是优先于onClick执行的,而且onClick的执行肯定是在onTouchEvent()中的。那么,接下来我们就来重点分析下View的onTouchEvent()方法。
// View # 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();
final boolean clickable = ((viewFlags & CLICKABLE) == CLICKABLE
|| (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)
|| (viewFlags & CONTEXT_CLICKABLE) == CONTEXT_CLICKABLE;
if ((viewFlags & ENABLED_MASK) == DISABLED) {
if (action == MotionEvent.ACTION_UP && (mPrivateFlags & PFLAG_PRESSED) != 0) {
setPressed(false);
}
mPrivateFlags3 &= ~PFLAG3_FINGER_DOWN;
// A disabled view that is clickable still consumes the touch
// events, it just doesn't respond to them.
return clickable;
}
if (mTouchDelegate != null) {
if (mTouchDelegate.onTouchEvent(event)) {
return true;
}
}
if (clickable || (viewFlags & TOOLTIP) == TOOLTIP) {
switch (action) {
case MotionEvent.ACTION_UP:
mPrivateFlags3 &= ~PFLAG3_FINGER_DOWN;
if ((viewFlags & TOOLTIP) == TOOLTIP) {
handleTooltipUp();
}
if (!clickable) {
removeTapCallback();
removeLongPressCallback();
mInContextButtonPress = false;
mHasPerformedLongPress = false;
mIgnoreNextUpEvent = false;
break;
}
boolean prepressed = (mPrivateFlags & PFLAG_PREPRESSED) != 0;
if ((mPrivateFlags & PFLAG_PRESSED) != 0 || prepressed) {
// take focus if we don't have it already and we should in
// touch mode.
boolean focusTaken = false;
if (isFocusable() && isFocusableInTouchMode() && !isFocused()) {
focusTaken = requestFocus();
}
if (prepressed) {
// The button is being released before we actually
// showed it as pressed. Make it show the pressed
// state now (before scheduling the click) to ensure
// the user sees it.
setPressed(true, x, y);
}
if (!mHasPerformedLongPress && !mIgnoreNextUpEvent) {
// This is a tap, so remove the longpress check
removeLongPressCallback();
// Only perform take click actions if we were in the pressed state
if (!focusTaken) {
// Use a Runnable and post this rather than calling
// performClick directly. This lets other visual state
// of the view update before click actions start.
if (mPerformClick == null) {
mPerformClick = new PerformClick();
}
if (!post(mPerformClick)) {
performClick();
}
}
}
if (mUnsetPressedState == null) {
mUnsetPressedState = new UnsetPressedState();
}
if (prepressed) {
postDelayed(mUnsetPressedState,
ViewConfiguration.getPressedStateDuration());
} else if (!post(mUnsetPressedState)) {
// If the post failed, unpress right now
mUnsetPressedState.run();
}
removeTapCallback();
}
mIgnoreNextUpEvent = false;
break;
case MotionEvent.ACTION_DOWN:
if (event.getSource() == InputDevice.SOURCE_TOUCHSCREEN) {
mPrivateFlags3 |= PFLAG3_FINGER_DOWN;
}
mHasPerformedLongPress = false;
if (!clickable) {
checkForLongClick(0, x, y);
break;
}
if (performButtonActionOnTouchDown(event)) {
break;
}
// Walk up the hierarchy to determine if we're inside a scrolling container.
boolean isInScrollingContainer = isInScrollingContainer();
// For views inside a scrolling container, delay the pressed feedback for
// a short period in case this is a scroll.
if (isInScrollingContainer) {
mPrivateFlags |= PFLAG_PREPRESSED;
if (mPendingCheckForTap == null) {
mPendingCheckForTap = new CheckForTap();
}
mPendingCheckForTap.x = event.getX();
mPendingCheckForTap.y = event.getY();
postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout());
} else {
// Not inside a scrolling container, so show the feedback right away
setPressed(true, x, y);
checkForLongClick(0, x, y);
}
break;
case MotionEvent.ACTION_CANCEL:
if (clickable) {
setPressed(false);
}
removeTapCallback();
removeLongPressCallback();
mInContextButtonPress = false;
mHasPerformedLongPress = false;
mIgnoreNextUpEvent = false;
mPrivateFlags3 &= ~PFLAG3_FINGER_DOWN;
break;
case MotionEvent.ACTION_MOVE:
if (clickable) {
drawableHotspotChanged(x, y);
}
// Be lenient about moving outside of buttons
if (!pointInView(x, y, mTouchSlop)) {
// Outside button
// Remove any future long press/tap checks
removeTapCallback();
removeLongPressCallback();
if ((mPrivateFlags & PFLAG_PRESSED) != 0) {
setPressed(false);
}
mPrivateFlags3 &= ~PFLAG3_FINGER_DOWN;
}
break;
}
return true;
}
return false;
}
相较于View的dispatchTouchEvent()方法,View的onTouchEvent()方法看起来复杂了许多,不过没有关系我们把握住整体就行。首先我们看到,使用布尔变量clickable表示当前控件是否可以点击。如果当前控件处于DISABLED状态,但如果它是可点击的话,仍然会消费事件,因为此时onTouchEvent()方法的返回值就是clickable的值。紧接着,如果控件处于ENABLED状态,并且是可以点击的,就会进入到switch判断中,并且无论如何最终返回true,也就是说如果View处于enable的状态并且可点击,事件将被这个View消费。
如果是抬起手指,就会进入到MotionEvent.ACTION_UP这个case中,在经过一系列判断之后,会执行performClick()方法,看方法名应该就是处理点击事件的,我们看这个方法的具体实现。
public boolean performClick() {
final boolean result;
final ListenerInfo li = mListenerInfo;
if (li != null && li.mOnClickListener != null) {
playSoundEffect(SoundEffectConstants.CLICK);
li.mOnClickListener.onClick(this);
result = true;
} else {
result = false;
}
sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_CLICKED);
notifyEnterOrExitForAutoFillIfNeeded(true);
return result;
}
首先,我们看下if判断的第2个条件,判断ListenerInfo的成员变量mOnClickListener是否为空,看它是在哪边赋值的。
public void setOnClickListener(@Nullable OnClickListener l) {
if (!isClickable()) {
setClickable(true);
}
getListenerInfo().mOnClickListener = l;
}
这个方法我们在熟悉不过了,mOnClickListener是在setOnClickListener()方法中进行赋值的,也就是说只要我们给控件注册了Click事件的监听,mOnClickListener就不会为null。至于第1个判断条件,这个与之前的分析类似,只要注册了Click事件的监听,li就不会为null。那么,现在就很明显了,只要注册了Click事件的监听,就会回调我们注册监听时重写的onClick()方法,并且消费事件。
至此,整个事件分发流程差不多已经分析完毕了,具体还要靠实践来加深印象,毕竟实践出真知。