Android事件分发机制完全解析(二) :View的事件分发机制

说明:
1.若未特别强调,本文中提到的view,不包括viewGroup。
2. View的事件分发机制不同的版本源码变化较大,并且基本上是"版本越高,源码越晦涩难懂"。但View的事件分发机制核心是一样的。为了降低大家的学习成本，本文若未特殊说明,源码分析片段采用API Level: 10。

在正式分析文章之前,关于View的事件分发,提几个问题:
(1) onTouch() 和的 onClick() 谁先执行?
(2) onTouch和onTouchEvent有什么区别，又该如何使用？
(3) view.setOnTouchListener 的返回值true和false 分别代表了什么意义? 返回什么时,点击事件不会执行了?

为了避免大家在学习源码过程中陷入细节不能自拔, 先给出结论性的东西,便于在分析过程中有一个主脉络(图片点击可放大)。

一. dispatchTouchEvent源码分析

dispatchTouchEvent是在ViewGroup中调用的。具体的调用时机，在此文Android事件分发机制完全解析(三) :ViewGroup的事件分发机制中有详细分析。不属于本文谈论范畴。

我们来看一下View中dispatchTouchEvent方法的源码:

代码片1
public boolean dispatchTouchEvent(MotionEvent event) {
    if (mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED &&
            mOnTouchListener.onTouch(this, event)) {
        return true;
    }
    return onTouchEvent(event);
}

上述代码很简单,我们可以看到，第3行代码if判断的3个条件同时为真, dispatchTouchEvent()才返回true；否则执行onTouchEvent()。至于onTouchEvent()的值为true还是false，在二中（onTouchEvent(event) 源码分析）会进行分析。

下面分别就

1. mOnTouchListener != null
2. (mViewFlags & ENABLED_MASK) == ENABLED
3. mOnTouchListener.onTouch(this, event)`

这3个条件进行分析。

1. mOnTouchListener != null

mOnTouchListener变量在View.setOnTouchListener（）方法里赋值

代码片2
/**
     * Register a callback to be invoked when a touch event is sent to this view.
     * @param l the touch listener to attach to this view
  */
 public void setOnTouchListener(OnTouchListener l) { 
    mOnTouchListener = l;  
} 

也就是说: 只要我们给控件注册了Touch事件，mOnTouchListener就一定被赋值（不为空）

2.mViewFlags & ENABLED_MASK) == ENABLED

这个条件是判断当前点击的控件是否是enable的，按钮默认都是enable的，因此这个条件恒定为true。

3. mOnTouchListener.onTouch(this, event)

mOnTouchListener是OnTouchListener的一个变量,而OnTouchListener 是一个接口,代码如下:

代码片3
   /**
     * Interface definition for a callback to be invoked when a touch event is
     * dispatched to this view. The callback will be invoked before the touch
     * event is given to the view.
     */
    public interface OnTouchListener {
        /**
         * Called when a touch event is dispatched to a view. This allows listeners to
         * get a chance to respond before the target view.
         *
         * @param v The view the touch event has been dispatched to.
         * @param event The MotionEvent object containing full information about
         *        the event.
         * @return True if the listener has consumed the event, false otherwise.
         */
        boolean onTouch(View v, MotionEvent event);
    }

即 回调控件注册Touch事件时的onTouch（）；需手动复写设置，具体如下（以按钮Button为例）

代码片4
button.setOnTouchListener(new OnTouchListener() {  
        @Override  
        public boolean onTouch(View v, MotionEvent event) { 
            return false;  
        }  
    });

第5行代码如果返回false,则 mOnTouchListener.onTouch(this, event) 为false;反之为true.

小结以下:
如果三个条件同时为true, 使得View.dispatchTouchEvent（）直接返回true，事件分发结束 。
如果至少有1个条件为false, View.dispatchTouchEvent（）中跳出if，执行onTouchEvent(event) 。

二.onTouchEvent(event) 源码分析

代码片5
/**
     * Implement this method to handle touch screen motion events.
     *
     * @param event The motion event.
     * @return True if the event was handled, false otherwise.
*/
public boolean onTouchEvent(MotionEvent event) {
    final int viewFlags = mViewFlags;
    if ((viewFlags & ENABLED_MASK) == DISABLED) {
        // A disabled view that is clickable still consumes the touch
        // events, it just doesn't respond to them.
        return (((viewFlags & CLICKABLE) == CLICKABLE ||
                (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE));
    }
    if (mTouchDelegate != null) {
        if (mTouchDelegate.onTouchEvent(event)) {
            return true;
        }
    }

    // 若该控件可点击，则进入switch判断中
    if (((viewFlags & CLICKABLE) == CLICKABLE ||
            (viewFlags & LONG_CLICKABLE) == LONG_CLICKABLE)) {
        switch (event.getAction()) {
           // a. 若当前的事件 = 抬起View（主要分析）
            case MotionEvent.ACTION_UP:
                boolean prepressed = (mPrivateFlags & PREPRESSED) != 0;
                .....
                //仅贴出核心代码
                ....
                //经过层层判断,会执行以下方法:
                // 执行performClick() ->>代码片6会分析此方法
                 performClick();  
                break;
                
             // b. 若当前的事件 = 按下View
            case MotionEvent.ACTION_DOWN:
                if (mPendingCheckForTap == null) {
                    mPendingCheckForTap = new CheckForTap();
                }
                mPrivateFlags |= PREPRESSED;
                mHasPerformedLongPress = false;
                postDelayed(mPendingCheckForTap, ViewConfiguration.getTapTimeout());
                break;
                
            // c. 若当前的事件 = 结束事件（非人为原因）
            case MotionEvent.ACTION_CANCEL:
                mPrivateFlags &= ~PRESSED;
                refreshDrawableState();
                removeTapCallback();
                break;
                
           // d. 若当前的事件 = 滑动View
            case MotionEvent.ACTION_MOVE:
                final int x = (int) event.getX();
                final int y = (int) event.getY();
                // Be lenient about moving outside of buttons
                int slop = mTouchSlop;
                if ((x < 0 - slop) || (x >= getWidth() + slop) ||
                        (y < 0 - slop) || (y >= getHeight() + slop)) {
                    // Outside button
                    removeTapCallback();
                    if ((mPrivateFlags & PRESSED) != 0) {
                        // Remove any future long press/tap checks
                        removeLongPressCallback();
                        // Need to switch from pressed to not pressed
                        mPrivateFlags &= ~PRESSED;
                        refreshDrawableState();
                    }
                }
                break;
        }
        // 若该控件可点击，就一定返回true
        return true;
    }
    
    // 若该控件不可点击，就一定返回false
    return false;
}

在代码片5中第33行代码,提到performClick()方法.现在分析一下:

代码片6
    /**
     * Call this view's OnClickListener, if it is defined.
     *
     * @return True there was an assigned OnClickListener that was called, false
     *         otherwise is returned.
     * (如果这个view已定义，则调用此视图的OnClickListener。 
     * @return True: 有一个已分配的OnClickListener被调用，否则返回false)
     */
     
public boolean performClick() {
    sendAccessibilityEvent(AccessibilityEvent.TYPE_VIEW_CLICKED);
    if (mOnClickListener != null) {
        playSoundEffect(SoundEffectConstants.CLICK);
        mOnClickListener.onClick(this);
        return true;
    }
    return false;
}

可以看到，只要mOnClickListener不是null，就会去调用它的onClick方法，那mOnClickListener又是在哪里赋值的呢？经过寻找后找到如下方法：

代码片7
public void setOnClickListener(OnClickListener l) {
    if (!isClickable()) {
        setClickable(true);
    }
    mOnClickListener = l;
}

一切都是那么清楚了！当我们通过调用setOnClickListener方法来给控件注册一个点击事件时，就会给mOnClickListener赋值。然后每当控件被点击时，都会在performClick()方法里回调被点击控件的onClick方法。

这样View的整个事件分发的流程就让我们搞清楚了！不过别高兴的太早，现在还没结束，还有一个很重要的知识点需要说明，就是touch事件的层级传递。我们都知道如果给一个控件注册了touch事件，每次点击它的时候都会触发一系列的ACTION_DOWN，ACTION_MOVE，ACTION_UP等事件。这里需要注意，如果你在执行ACTION_DOWN的时候返回了false，后面一系列其它的action就不会再得到执行了。简单的说，就是当dispatchTouchEvent在进行事件分发的时候，只有前一个action返回true，才会触发后一个action。

说到这里，很多的朋友肯定要有巨大的疑问了。这不是在自相矛盾吗？前面的例子中，明明在onTouch事件里面返回了false，ACTION_DOWN和ACTION_UP不是都得到执行了吗？其实你只是被假象所迷惑了，让我们仔细分析一下，在前面的例子当中，我们到底返回的是什么。

参考我们前面分析的源码(代码片1)，首先在onTouch事件里返回了false，就一定会进入到onTouchEvent方法中，然后我们来看一下onTouchEvent方法的细节。由于我们点击了按钮，就会进入到代码片5的第14行这个if判断的内部，然后你会发现，不管当前的action是什么，最终都一定会走到第75行，返回一个true。

是不是有一种被欺骗的感觉？明明在onTouch事件里返回了false，系统还是在onTouchEvent方法中帮你返回了true。就因为这个原因，才使得前面的例子中ACTION_UP可以得到执行。

那我们可以换一个控件，将按钮替换成ImageView，然后给它也注册一个touch事件，并返回false。如下所示：

代码片8
 imageView.setOnTouchListener(new OnTouchListener() {
    	@Override
    	public boolean onTouch(View v, MotionEvent event) {
    		Log.d("TAG", "onTouch execute, action " + event.getAction());
    		return false;
    	}
    });

运行一下程序，点击ImageView，你会发现结果如下：

在ACTION_DOWN执行完后，后面的一系列action都不会得到执行了。这又是为什么呢？因为ImageView和按钮不同，它是默认不可点击的，因此在onTouchEvent的第14行判断时无法进入到if的内部，直接跳到第91行返回了false，也就导致后面其它的action都无法执行了。

好了，关于View的事件分发，我想每个人都会有更深一层的理解。

现在我们就文章开始提出的3个问题进行回答:

问题一: onTouch() 和的 onClick() 谁先执行?

答: 由代码片1第4行可知,执行onTouch()后,如果第4行的if判断为true,进入到代码片5中. 如果若该控件可点击，则进入switch判断中(代码片5第22行)。
再由代码片5第34行 及 代码片6第15行 可知,
onTouch()比 onClick() 先执行。

问题二: onTouch和onTouchEvent有什么区别，又该如何使用？

答: 从代码片1可以看出，这两个方法都是在View的dispatchTouchEvent中调用的，onTouch优先于onTouchEvent执行。如果在onTouch方法中通过返回true将事件消费掉，onTouchEvent将不会再执行（代码片1第5行）。

另外需要注意的是，onTouch能够得到执行需要两个前提条件，第一mOnTouchListener的值不能为空，第二当前点击的控件必须是enable的。因此如果你有一个控件是非enable的，那么给它注册onTouch事件将永远得不到执行。对于这一类控件，如果我们想要监听它的touch事件，就必须通过在该控件中重写onTouchEvent方法来实现。

问题三: view.setOnTouchListener 的返回值true和false 分别代表了什么意义? 返回什么时,点击事件不会执行了?

答: view.setOnTouchListener 的返回值直接影响到dispatchTouchEvent的返回值(有代码片1-4分析可以)。这里再此贴出代码片1和4的代码：

代码片1
public boolean dispatchTouchEvent(MotionEvent event) {
    if (mOnTouchListener != null && (mViewFlags & ENABLED_MASK) == ENABLED &&
            mOnTouchListener.onTouch(this, event)) {
        return true;
    }
    return onTouchEvent(event);
}

代码片4
button.setOnTouchListener(new OnTouchListener() {  
        @Override  
        public boolean onTouch(View v, MotionEvent event) { 
            return false;  
        }  
    });

如果view.setOnTouchListener返回true,则进入到代码片1的第5行代码,即dispatchTouchEvent返回true。也就是事件被拦截了。不会执行onTouchEvent（）方法了。而点击事件又是在onTouchEvent（）方法中，也就是点击事件不会执行。

如果view.setOnTouchListener返回false，则代码片1的第3行最后一个条件为false，也就是执行第7行代码。
在onTouchEvent(event) 源码分析中可知，只要view可被点击，进入到代码片5的第34行代码（详情在代码片6中）
，也就是会执行点击事件。

当然，这里要额外说一句，只要进入到了代码片5中switch中，一定会执行代码片5第75行代码，即拦截事件。不继续往下传递。

下面通过一个流程图进行总结:

View的事件分发机制到此全部讲解完毕,相信大家现在对Android事件分发机制又有了进一步的认识，如果想了解ViewGroup的事件分发，请看下文：
Android事件分发机制完全解析(三) :ViewGroup的事件分发机制