目录
前言
自定义view中,经常会对view的onTouch、onTouchEvent、onClick等等方法进行重写,他们之间的先后顺序?是否会影响彼此正常调用?…等等知识较为模糊,看了一下郭霖大神的博客 Android事件分发机制完全解析,又在Android Studio上跟了会源码,在此做个笔记。
SDK:android 34
一、button的onTouch和onClick
以Button为例
button.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
Log.d(TAG, "------onclick-----");
}
});
button.setOnTouchListener(new View.OnTouchListener() {
@Override
public boolean onTouch(View v, MotionEvent event) {
Log.d(TAG, "-----onTouch------"+event.getAction());
return false;
}
});
onTouch方法里能做的事情很多,比如判断手指按下、抬起、移动等事件。如果和onClick两个事件都注册了,哪一个会先执行呢?运行程序点击按钮,打印结果如下:
onTouch是优先于onClick执行的,并且onTouch执行了很多次,ACTION_DOWN,ACTION_UP和ACTION_MOVE的执行,按下、拖动、拿起分别对应了0 2 1三个action,因此事件传递的顺序是先经过onTouch,再传递到onClick。
可以注意到,onTouch方法是有返回值的,这里返回的是false,如果是true呢,运行一次,结果如下:
button.setOnTouchListener(new View.OnTouchListener() {
@Override
public boolean onTouch(View v, MotionEvent event) {
Log.d(TAG, "-----onTouch------"+event.getAction());
return true;
}
});
)
只有onTouch,onClick方法不再执行了!onTouch方法返回true把事件消费掉了,因而不会再继续向下传递。
只要触摸到了任何一个控件,就一定会调用该控件的dispatchTouchEvent方法。当点击按钮的时候,会调用Button类(本类没有去找父类)里的dispatchTouchEvent方法。
结论
:onTouch方法影响onClick能否执行。
二、dispatchTouchEvent()
跟到了View的dispatchTouchEvent方法
public boolean dispatchTouchEvent(MotionEvent event) {
// 如果事件应该首先由辅助功能焦点处理
if (event.isTargetAccessibilityFocus()) {
// 如果没有焦点或没有虚拟子视图拥有焦点,则不处理事件
if (!isAccessibilityFocusedViewOrHost()) {
return false;
}
// 如果有焦点并获取了事件,则使用正常事件分发
event.setTargetAccessibilityFocus(false);
}
boolean result = false;
if (mInputEventConsistencyVerifier != null) {
// 验证输入事件的一致性
mInputEventConsistencyVerifier.onTouchEvent(event, 0);
}
// 获取事件的动作类型
final int actionMasked = event.getActionMasked();
if (actionMasked == MotionEvent.ACTION_DOWN) {
// 新手势时的清理工作
stopNestedScroll();
}
if (onFilterTouchEventForSecurity(event)) {
if ((mViewFlags & ENABLED_MASK) == ENABLED && handleScrollBarDragging(event)) {
result = true;
}
// 检查是否有触摸监听器,并处理触摸事件
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;
}
}
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;
}
最后,方法返回 result,该变量表示是否处理了事件,如果 result 为 true,则表示事件已被处理,否则表示事件未被处理。整个方法主要是处理触摸事件的分发和处理过程,根据事件类型和条件来决定是否处理事件,并最终返回处理结果。
方法或属性 | 描述 |
---|---|
event.isTargetAccessibilityFocus() | 检查事件是否应该由辅助功能焦点优先处理。如果事件是针对辅助功能焦点的,则返回 true。 |
isAccessibilityFocusedViewOrHost() | 检查当前视图或它的虚拟子视图是否拥有辅助功能焦点。如果有,返回 true;否则返回 false。 |
event.setTargetAccessibilityFocus(false) | 将事件的辅助功能焦点设置为 false,表示事件将使用正常的事件分发机制处理。 |
mInputEventConsistencyVerifier | 用于验证输入事件的一致性的对象,可以用来检查事件的正确性。 |
event.getActionMasked() | 获取事件的动作类型,返回的是一个整型值,代表事件的类型。 |
MotionEvent.ACTION_DOWN | 表示手指按下的事件类型。 |
stopNestedScroll() | 停止嵌套滚动,用于清理新手势。 |
onFilterTouchEventForSecurity(event) | 用于安全过滤触摸事件,返回一个布尔值,表示是否允许继续处理事件。 |
mViewFlags & ENABLED_MASK: | 检查 View 是否启用的标志位。 |
handleScrollBarDragging(event) | 处理滚动条拖动事件,返回一个布尔值,表示是否处理了事件。 |
ListenerInfo li = mListenerInfo | 获取 View 的 ListenerInfo 对象,用于存储监听器。 |
li.mOnTouchListener | 获取 View 的触摸监听器,用于处理触摸事件。 |
li.mOnTouchListener.onTouch(this, event) | 调用触摸监听器的 onTouch() 方法来处理触摸事件,返回一个布尔值,表示是否处理了事件。 |
onTouchEvent(event) | 处理触摸事件的方法,返回一个布尔值,表示是否处理了事件。 |
mInputEventConsistencyVerifier.onUnhandledEvent(event, 0) | 在事件未处理时,用于验证输入事件的一致性。 |
MotionEvent.ACTION_UP | 表示手指抬起的事件类型。 |
MotionEvent.ACTION_CANCEL | 表示事件被取消的事件类型。 |
stopNestedScroll() | 停止嵌套滚动,用于清理手势。 |
核心代码在这里
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;
}
ListenerInfo 是个啥,从它能够.mOnTouchListener 便可以知道最新的sdk中,控件的监听器被封装在了一个ListenerInfo类中,包括了所有的控件监听器:OnClickListener、OnLongClickListener、OnTouchListener、OnKeyListener等等。
其他的便和之前没什么两样,ListenerInfo不为空,mOnTouchListener 不为空。
条件(mViewFlags & ENABLED_MASK) == ENABLED是判断当前点击的控件是否是enable的,按钮默认都是enable的,因此这个条件恒定为true。
mOnTouchListener.onTouch(this, event),其实也就是去回调控件注册touch事件时的onTouch方法。也就是说如果在onTouch方法里返回true,就会让这三个条件全部成立,从而整个方法直接返回true。
如果在onTouch方法里返回false,result为false,此时还会再去执行onTouchEvent(event)方法判断result结果,但如果为true,在逻辑运算符 && 中,如果第一个条件为 false,则不会执行第二个条件。因此,如果 result 已经为 true,!result 使得第一个条件成为false,则不会执行 onTouchEvent(event) 方法。
onclick仍然执行在onTouchEvent方法中。
public boolean onTouchEvent(MotionEvent event) {
......
if (clickable || (viewFlags & TOOLTIP) == TOOLTIP) {
switch (action) {
case MotionEvent.ACTION_UP:
......
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)) {
performClickInternal();
}
}
}
......
case MotionEvent.ACTION_DOWN:
......
private boolean performClickInternal() {
// Must notify autofill manager before performing the click actions to avoid scenarios where
// the app has a click listener that changes the state of views the autofill service might
// be interested on.
notifyAutofillManagerOnClick();
return performClick();
}
public boolean performClick() {
......
final ListenerInfo li = mListenerInfo;
if (li != null && li.mOnClickListener != null) {
playSoundEffect(SoundEffectConstants.CLICK);
li.mOnClickListener.onClick(this);
result = true;
} else {
result = false;
}
......
return result;
}
结论
:onTouch事件优先于onTouchEvent执行,且返回值影响onTouchEvent能否执行。onClick是在onTouchEvent中执行的。
三、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 (clickable || (viewFlags & TOOLTIP) == TOOLTIP) {
switch (action) {
case MotionEvent.ACTION_UP:
break;
......
case MotionEvent.ACTION_DOWN:
......
break;
case MotionEvent.ACTION_CANCEL:
......
break;
case MotionEvent.ACTION_MOVE:
......
break;
}
return true;
}
return false;
}
在onTouchEvent事件中,只要检测到动作action,并且控件是可以点击的,一般都会进入 switch (action) { 的流程中,且返回值为true。只有前一个action返回true,才会触发后一个action。
替换Button为Imageview,同样注册一个touch事件,返回false
button.setOnTouchListener(new View.OnTouchListener() {
@Override
public boolean onTouch(View v, MotionEvent event) {
Log.d(TAG, "-----onTouch------"+event.getAction());
return false;
}
});
观察log,只有onTouch的 action 0,按下操作,why?因为Imageview默认是不可点击的。
在onTouchEvent判断时无法进入到if的内部,直接返回了false,也就导致后面其它的action都无法执行了
现在给他设置点击事件,再次观察log
button.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
// mtv.setRotationY(45);
Log.d(TAG, "------onclick-----");
}
});
所有log都打出来了,原因就是因为在设置点击事件的时候设置了可以点击。
结论
:onTouchEvent的正常执行依赖于控件是否可以点击,只有前一个action返回true,才会触发后一个action。
四、onTouch和onTouchEvent
两个方法都是在View的dispatchTouchEvent中调用的,onTouch优先于onTouchEvent执行。如果在onTouch方法中通过返回true将事件消费掉,onTouchEvent将不会再执行。
onTouchEvent 是 View 类的方法,用于处理具体的触摸事件逻辑;而 onTouch 是接口方法,通过设置 OnTouchListener 可以监听触摸事件并自定义处理逻辑。
五、VewGroup的事件分发
5.1 示例引申
上面都是针对单独的控件进行事件分发阐述的,实际中的布局都是多层嵌套,整体view之间的事件分发关系又是怎样的?
以下笔记还是参考链接:Android事件分发机制完全解析。
新建一个MyLayout 继承自LinearLayout,为什么要用继承自LinearLayout?因为LinearLayout简单方便,最重要的是继承自ViewGroup,而ViewGroup又继承自View,绝大多数的布局都继承自ViewGroup。
public class MyLayout extends LinearLayout {
public MyLayout(Context context) {
super(context);
}
}
activity布局
使用自定义的MyLayout嵌套两个Button
<com.henry.custom_view.MyLayout xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:tools="http://schemas.android.com/tools"
android:id="@+id/my_layout"
android:layout_width="match_parent"
android:layout_height="match_parent"
android:orientation="vertical">
<Button
android:id="@+id/button1"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:text="Button1" />
<Button
android:id="@+id/button2"
android:layout_width="match_parent"
android:layout_height="wrap_content"
android:text="Button2" />
</com.henry.custom_view.MyLayout>
ViewGroupActivity
public class ViewGroupActivity extends AppCompatActivity {
MyLayout myLayout;
Button button1;
Button button2;
String TAG = "henry";
@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_view_group_test);
myLayout = findViewById(R.id.my_layout);
button1 = findViewById(R.id.button1);
button2 = findViewById(R.id.button2);
myLayout.setOnTouchListener(new View.OnTouchListener() {
@Override
public boolean onTouch(View v, MotionEvent event) {
Log.d(TAG, "myLayout on touch---------");
return false;
}
});
button1.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
Log.d(TAG, "You clicked button1---------");
}
});
button2.setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View v) {
Log.d(TAG, "You clicked button2----------");
}
});
}
}
分别点击一下Button1、Button2和空白区域,打印结果如下所示:
当点击按钮的时候,MyLayout注册的onTouch方法并不会执行,只有点击空白区域的时候才会执行该方法。可以理解成Button的onClick方法将事件消费掉了,因此事件不会再继续向下传递。
事件先是传到子view,再传递到上面的ViewGroup吗?
ViewGroup中有一个onInterceptTouchEvent方法,方法的源码如下:
public boolean onInterceptTouchEvent(MotionEvent ev) {
if (ev.isFromSource(InputDevice.SOURCE_MOUSE)
&& ev.getAction() == MotionEvent.ACTION_DOWN
&& ev.isButtonPressed(MotionEvent.BUTTON_PRIMARY)
&& isOnScrollbarThumb(ev.getXDispatchLocation(0), ev.getYDispatchLocation(0))) {
return true;
}
return false;
}
ev.isFromSource(InputDevice.SOURCE_MOUSE):判断触摸事件是否来自鼠标输入设备,如果是鼠标事件,则继续进行下一步判断。
ev.getAction() == MotionEvent.ACTION_DOWN:判断触摸事件是否是按下动作。
ev.isButtonPressed(MotionEvent.BUTTON_PRIMARY):判断是否按下了主要的按钮。
isOnScrollbarThumb(ev.getXDispatchLocation(0), ev.getYDispatchLocation(0)):调用自定义方法 isOnScrollbarThumb,判断触摸点是否在滚动条的滑块上。
如果以上条件都满足,则返回 true,表示拦截该触摸事件;否则返回 false,表示不拦截该触摸事件。
这段代码的作用是在触摸事件传递到子 View 之前,先在父 View 中判断是否需要拦截该事件。如果判断条件为真,那么父 View 将拦截该事件,不再传递给子 View 处理。这样可以实现在特定条件下拦截触摸事件,避免不必要的事件传递和处理。
现在我们在MyLayout中,重写该方法,返回true,然后再实验一遍:
@Override
public boolean onInterceptTouchEvent(MotionEvent ev) {
return true;
}
这时发现不管点击哪里,永远都只会触发MyLayout的touch事件了,按钮的点击事件完全被屏蔽掉了!
没错,Android中touch事件的传递如下:
- ViewGrop中和事件传递有关的函数
事件分发:dispatchTouchEvent
事件拦截:onInterceptTouchEvent
事件处理:onTouchEvent- View中和事件传递有关的函数
事件分发:dispatchTouchEvent
事件处理:onTouchEvent
从上面可以看出,ViewGrop中多了事件拦截onInterceptTouchEvent函数,是为了询问自己是否拦截事件(在事件分发中询问),如果没有拦截就传递事件给直接子view,如果拦截就将事件交给自己的事件处理函数处理。View中没有事件拦截函数,因为view是在view树中的叶节点,已经没有子view。
当点击了某个控件,首先会去调用该控件所在布局的dispatchTouchEvent方法,然后在布局的dispatchTouchEvent方法中找到被点击的相应控件,再去调用该控件的dispatchTouchEvent方法。如果我们点击了MyLayout中的按钮,会先去调用MyLayout的dispatchTouchEvent方法,最终在ViewGroup中看到了这个方法,按钮的dispatchTouchEvent方法就是在这里调用的。
5.2 VewGroup的dispatchTouchEvent
@Override
public boolean dispatchTouchEvent(MotionEvent ev) {
if (mInputEventConsistencyVerifier != null) {
mInputEventConsistencyVerifier.onTouchEvent(ev, 1);
}
if (ev.isTargetAccessibilityFocus() && isAccessibilityFocusedViewOrHost()) {
ev.setTargetAccessibilityFocus(false);
}
boolean handled = false;
if (onFilterTouchEventForSecurity(ev)) {
final int action = ev.getAction();
final int actionMasked = action & MotionEvent.ACTION_MASK;
if (actionMasked == MotionEvent.ACTION_DOWN) {
cancelAndClearTouchTargets(ev);
resetTouchState();
}
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 {
intercepted = true;
}
if (intercepted || mFirstTouchTarget != null) {
ev.setTargetAccessibilityFocus(false);
}
final boolean canceled = resetCancelNextUpFlag(this)
|| actionMasked == MotionEvent.ACTION_CANCEL;
final boolean isMouseEvent = ev.getSource() == InputDevice.SOURCE_MOUSE;
final boolean split = (mGroupFlags & FLAG_SPLIT_MOTION_EVENTS) != 0
&& !isMouseEvent;
TouchTarget newTouchTarget = null;
boolean alreadyDispatchedToNewTouchTarget = false;
if (!canceled && !intercepted) {
View childWithAccessibilityFocus = ev.isTargetAccessibilityFocus()
? findChildWithAccessibilityFocus() : null;
if (actionMasked == MotionEvent.ACTION_DOWN
|| (split && actionMasked == MotionEvent.ACTION_POINTER_DOWN)
|| actionMasked == MotionEvent.ACTION_HOVER_MOVE) {
final int actionIndex = ev.getActionIndex(); // always 0 for down
final int idBitsToAssign = split ? 1 << ev.getPointerId(actionIndex)
: TouchTarget.ALL_POINTER_IDS;
removePointersFromTouchTargets(idBitsToAssign);
final int childrenCount = mChildrenCount;
if (newTouchTarget == null && childrenCount != 0) {
final float x = ev.getXDispatchLocation(actionIndex);
final float y = ev.getYDispatchLocation(actionIndex);
final ArrayList<View> preorderedList = buildTouchDispatchChildList();
final boolean customOrder = preorderedList == null
&& isChildrenDrawingOrderEnabled();
final View[] children = mChildren;
for (int i = childrenCount - 1; i >= 0; i--) {
final int childIndex = getAndVerifyPreorderedIndex(
childrenCount, i, customOrder);
final View child = getAndVerifyPreorderedView(
preorderedList, children, childIndex);
if (childWithAccessibilityFocus != null) {
if (childWithAccessibilityFocus != child) {
continue;
}
childWithAccessibilityFocus = null;
i = childrenCount;
}
if (!child.canReceivePointerEvents()
|| !isTransformedTouchPointInView(x, y, child, null)) {
ev.setTargetAccessibilityFocus(false);
continue;
}
newTouchTarget = getTouchTarget(child);
if (newTouchTarget != null) {
// Child is already receiving touch within its bounds.
// Give it the new pointer in addition to the ones it is handling.
newTouchTarget.pointerIdBits |= idBitsToAssign;
break;
}
resetCancelNextUpFlag(child);
if (dispatchTransformedTouchEvent(ev, false, child, idBitsToAssign)) {
// Child wants to receive touch within its bounds.
mLastTouchDownTime = ev.getDownTime();
if (preorderedList != null) {
// childIndex points into presorted list, find original index
for (int j = 0; j < childrenCount; j++) {
if (children[childIndex] == mChildren[j]) {
mLastTouchDownIndex = j;
break;
}
}
} else {
mLastTouchDownIndex = childIndex;
}
mLastTouchDownX = x;
mLastTouchDownY = y;
newTouchTarget = addTouchTarget(child, idBitsToAssign);
alreadyDispatchedToNewTouchTarget = true;
break;
}
ev.setTargetAccessibilityFocus(false);
}
if (preorderedList != null) preorderedList.clear();
}
if (newTouchTarget == null && mFirstTouchTarget != null) {
newTouchTarget = mFirstTouchTarget;
while (newTouchTarget.next != null) {
newTouchTarget = newTouchTarget.next;
}
newTouchTarget.pointerIdBits |= idBitsToAssign;
}
}
}
if (mFirstTouchTarget == null) {
handled = dispatchTransformedTouchEvent(ev, canceled, null,
TouchTarget.ALL_POINTER_IDS);
} else {
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;
}
}
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;
}
代码非常长,其实整段代码是围绕canceled
和intercepted
这两个值进行的,先是在上面对这两个值进行获取,然后对这两个值进行判断 if (!canceled && !intercepted) { ,然后进入一大段逻辑当中。intercepted
的赋值是在disallowIntercept
为false的情况下获取onInterceptTouchEvent()
的返回值。
而disallowIntercept
是指是否禁用掉事件拦截的功能,默认是false,也可以通过调用requestDisallowInterceptTouchEvent方法对这个值进行修改。
刚才的示例onInterceptTouchEvent
返回了true,那么在后面if (!canceled && !intercepted) {的判断中,绝对是进不去里面的逻辑的。也正因如此,Button的onclick事件也就无法传递,那么Button的onclick事件便极有可能就在这个判断当中进行传递的。
在if(){判断中遍历了子view,调用了dispatchTransformedTouchEvent进一步在内部调用了子view的dispatchTouchEvent
方法
View child, int desiredPointerIdBits) {
final boolean handled;
// Canceling motions is a special case. We don't need to perform any transformations
// or filtering. The important part is the action, not the contents.
final int oldAction = event.getAction();
if (cancel || oldAction == MotionEvent.ACTION_CANCEL) {
event.setAction(MotionEvent.ACTION_CANCEL);
if (child == null) {
handled = super.dispatchTouchEvent(event);
} else {
handled = child.dispatchTouchEvent(event);
}
event.setAction(oldAction);
return handled;
}
......
如果子view为null,就会调用父布局的super.dispatchTouchEvent方法,反之则会调用child.dispatchTouchEvent,这里的super和child正好对应示例中的MyLayout和Button。
源码较多,多个版本迭代更新后内部的逻辑仍然是不变的。
六、总结
整个ViewGroup的事件分发流程的分析大致如此,简单梳理一下。
- Android事件分发是先传递到ViewGroup,再由ViewGroup传递到View的。
- 在ViewGroup中可以通过
onInterceptTouchEvent
方法对事件传递进行拦截,onInterceptTouchEvent方法返回true代表不允许事件继续向子View传递,返回false代表不对事件进行拦截,默认返回false。 - 子View中如果将传递的事件消费掉,ViewGroup中将无法接收到任何事件。