环境

Cocos Creator 2.4
Chrome 88

概要

模块作用

事件监听机制应该是所有游戏都必不可少的内容。不管是按钮的点击还是物体的拖动,都少不了事件的监听与分发。
主要的功能还是通过节点的on/once函数,对系统事件(如触摸、点击)进行监听,随后触发对应的游戏逻辑。同时,也支持用户发射/监听自定义的事件,这方面可以看一下官方文档监听和发射事件。

涉及文件

其中,CCGame和CCInputManager都有涉及注册事件,但他们负责的是不同的部分。

源码解析

事件是怎么(从浏览器)到达引擎的?

想知道这个问题,必须要了解引擎和浏览器的交互是从何而起。
上代码。

CCGame.js

// 初始化事件系统
_initEvents: function () {
  var win = window, hiddenPropName;

  //_ register system events
  // 注册系统事件,这里调用了CCInputManager的方法
  if (this.config.registerSystemEvent)
    _cc.inputManager.registerSystemEvent(this.canvas);

  // document.hidden表示页面隐藏,后面的if用于处理浏览器兼容
  if (typeof document.hidden !== 'undefined') {
    hiddenPropName = "hidden";
  } else if (typeof document.mozHidden !== 'undefined') {
    hiddenPropName = "mozHidden";
  } else if (typeof document.msHidden !== 'undefined') {
    hiddenPropName = "msHidden";
  } else if (typeof document.webkitHidden !== 'undefined') {
    hiddenPropName = "webkitHidden";
  }

  // 当前页面是否隐藏
  var hidden = false;

  // 页面隐藏时的回调,并发射game.EVENT_HIDE事件
  function onHidden () {
    if (!hidden) {
      hidden = true;
      game.emit(game.EVENT_HIDE);
    }
  }
  //_ In order to adapt the most of platforms the onshow API.
  // 为了适配大部分平台的onshow API。应该是指传参的部分...
  // 页面可视时的回调,并发射game.EVENT_SHOW事件
  function onShown (arg0, arg1, arg2, arg3, arg4) {
    if (hidden) {
      hidden = false;
      game.emit(game.EVENT_SHOW, arg0, arg1, arg2, arg3, arg4);
    }
  }

  // 如果浏览器支持隐藏属性,则注册页面可视状态变更事件
  if (hiddenPropName) {
    var changeList = [
      "visibilitychange",
      "mozvisibilitychange",
      "msvisibilitychange",
      "webkitvisibilitychange",
      "qbrowserVisibilityChange"
    ];
    // 循环注册上面的列表里的事件,同样是是为了兼容
    // 隐藏状态变更后,根据可视状态调用onHidden/onShown回调函数
    for (var i = 0; i < changeList.length; i++) {
      document.addEventListener(changeList[i], function (event) {
        var visible = document[hiddenPropName];
        //_ QQ App
        visible = visible || event["hidden"];
        if (visible)
          onHidden();
        else
          onShown();
      });
    }
  }
  // 此处省略部分关于 页面可视状态改变 的兼容性代码

  // 注册隐藏和显示事件,暂停或重新开始游戏主逻辑。
  this.on(game.EVENT_HIDE, function () {
    game.pause();
  });
  this.on(game.EVENT_SHOW, function () {
    game.resume();
  });
}

其实核心代码只有一点点…为了保持对各个平台的兼容性,
重要的地方有两个:

  1. 调用CCInputManager的方法
  2. 注册页面可视状态改变事件,并派发game.EVENT_HIDE和game.EVENT_SHOW事件。

来看看CCInputManager。

CCInputManager.js

// 注册系统事件 element是canvas
registerSystemEvent (element) {
  if(this._isRegisterEvent) return;

  // 注册过了,直接return
  this._glView = cc.view;
  let selfPointer = this;
  let canvasBoundingRect = this._canvasBoundingRect;

  // 监听resize事件,修改this._canvasBoundingRect
  window.addEventListener('resize', this._updateCanvasBoundingRect.bind(this));

  let prohibition = sys.isMobile;
  let supportMouse = ('mouse' in sys.capabilities);
  // 是否支持触摸
  let supportTouches = ('touches' in sys.capabilities);
	
  // 省略了鼠标事件的注册代码
  
  //_register touch event
  // 注册触摸事件
  if (supportTouches) {
    // 事件map
    let _touchEventsMap = {
      "touchstart": function (touchesToHandle) {
        selfPointer.handleTouchesBegin(touchesToHandle);
        element.focus();
      },
      "touchmove": function (touchesToHandle) {
        selfPointer.handleTouchesMove(touchesToHandle);
      },
      "touchend": function (touchesToHandle) {
        selfPointer.handleTouchesEnd(touchesToHandle);
      },
      "touchcancel": function (touchesToHandle) {
        selfPointer.handleTouchesCancel(touchesToHandle);
      }
    };

    // 遍历map注册事件
    let registerTouchEvent = function (eventName) {
      let handler = _touchEventsMap[eventName];
      // 注册事件到canvas上
      element.addEventListener(eventName, (function(event) {
        if (!event.changedTouches) return;
        let body = document.body;

        // 计算偏移量
        canvasBoundingRect.adjustedLeft = canvasBoundingRect.left - (body.scrollLeft || window.scrollX || 0);
        canvasBoundingRect.adjustedTop = canvasBoundingRect.top - (body.scrollTop || window.scrollY || 0);
        // 从事件中获得触摸点,并调用回调函数
        handler(selfPointer.getTouchesByEvent(event, canvasBoundingRect));
        // 停止事件冒泡
        event.stopPropagation();
        event.preventDefault();
      }), false);
    };
    for (let eventName in _touchEventsMap) {
      registerTouchEvent(eventName);
    }
  }

  // 修改属性表示已完成事件注册
  this._isRegisterEvent = true;
}

在代码中,主要完成的事情就是注册了touchstart等一系列的原生事件,在事件回调中,则分别调用了selfPointer(=this)中的函数进行处理。这里我们用touchstart事件作为例子,即handleTouchesBegin函数。

// 处理touchstart事件
handleTouchesBegin (touches) {
  let selTouch, index, curTouch, touchID,
      handleTouches = [], locTouchIntDict = this._touchesIntegerDict,
      now = sys.now();
  // 遍历触摸点
  for (let i = 0, len = touches.length; i < len; i ++) {
    // 当前触摸点
    selTouch = touches[i];
    // 触摸点id
    touchID = selTouch.getID();
    // 触摸点在触摸点列表(this._touches)中的位置
    index = locTouchIntDict[touchID];

    // 如果没有获得index,说明是个新的触摸点(刚按下去)
    if (index == null) {
      // 获得一个没有被使用的index
      let unusedIndex = this._getUnUsedIndex();
      // 取不到,抛出错误。可能是超出了支持的最大触摸点数量。
      if (unusedIndex === -1) {
        cc.logID(2300, unusedIndex);
        continue;
      }
      //_curTouch = this._touches[unusedIndex] = selTouch;
      // 存储触摸点
      curTouch = this._touches[unusedIndex] = new cc.Touch(selTouch._point.x, selTouch._point.y, selTouch.getID());
      curTouch._lastModified = now;
      curTouch._setPrevPoint(selTouch._prevPoint);
      locTouchIntDict[touchID] = unusedIndex;
      // 加到需要处理的触摸点列表中
      handleTouches.push(curTouch);
    }
  }
  // 如果有新触点,生成一个触摸事件,分发到eventManager
  if (handleTouches.length > 0) {
    // 这个方法会把触摸点的位置根据scale做处理
    this._glView._convertTouchesWithScale(handleTouches);
    let touchEvent = new cc.Event.EventTouch(handleTouches);
    touchEvent._eventCode = cc.Event.EventTouch.BEGAN;
    eventManager.dispatchEvent(touchEvent);
  }
},

函数中,一部分代码用于过滤是否有新的触摸点产生,另一部分用于处理并分发事件(如果需要的话)。
到这里,事件就完成了从浏览器到引擎的转化,事件已经到达eventManager里。那么引擎到节点之间又经历了什么?

事件是怎么从引擎到节点的?

传递事件到节点的工作主要都发生在CCEventManager类中。包括了存储事件监听器,分发事件等。先从_dispatchTouchEvent作为入口来看看。

CCEventManager.js

// 分发事件
_dispatchTouchEvent: function (event) {
  // 为触摸监听器排序
  // TOUCH_ONE_BY_ONE:触摸事件监听器类型,触点会一个一个地分开被派发
  // TOUCH_ALL_AT_ONCE:触点会被一次性全部派发
  this._sortEventListeners(ListenerID.TOUCH_ONE_BY_ONE);
  this._sortEventListeners(ListenerID.TOUCH_ALL_AT_ONCE);

  // 获得监听器列表
  var oneByOneListeners = this._getListeners(ListenerID.TOUCH_ONE_BY_ONE);
  var allAtOnceListeners = this._getListeners(ListenerID.TOUCH_ALL_AT_ONCE);

  //_ If there aren't any touch listeners, return directly.
  // 如果没有任何监听器,直接return。
  if (null === oneByOneListeners && null === allAtOnceListeners)
    return;

  // 存储一下变量
  var originalTouches = event.getTouches(), mutableTouches = cc.js.array.copy(originalTouches);
  var oneByOneArgsObj = {event: event, needsMutableSet: (oneByOneListeners && allAtOnceListeners), touches: mutableTouches, selTouch: null};

  //
  //_ process the target handlers 1st
  //  不会翻。感觉是首先处理单个触点的事件。
  if (oneByOneListeners) {
    // 遍历触点,依次分发
    for (var i = 0; i < originalTouches.length; i++) {
      event.currentTouch = originalTouches[i];
      event._propagationStopped = event._propagationImmediateStopped = false;
      this._dispatchEventToListeners(oneByOneListeners, this._onTouchEventCallback, oneByOneArgsObj);
    }
  }

  //
  //_ process standard handlers 2nd
  //  不会翻。感觉是其次处理多触点事件(一次性全部派发)
  if (allAtOnceListeners && mutableTouches.length > 0) {
    this._dispatchEventToListeners(allAtOnceListeners, this._onTouchesEventCallback, {event: event, touches: mutableTouches});
    if (event.isStopped())
      return;
  }
  // 更新触摸监听器列表,主要是移除和新增监听器
  this._updateTouchListeners(event);
},

函数中,主要做的事情就是,排序、分发到注册的监听器列表、更新监听器列表。平平无奇。你可能会奇怪,怎么有一个突兀的排序?哎,这正是重中之重!关于排序的作用,可以看官方文档触摸事件的传递。正是这个排序,实现了不同层级/不同zIndex的节点之间的触点归属问题。排序会在后面提到,妙不可言。
分发事件是通过调用_dispatchEventToListeners函数实现的,接着就来看一下它的内部实现。

/**
* 分发事件到监听器列表
* @param {*} listeners     监听器列表
* @param {*} onEvent       事件回调
* @param {*} eventOrArgs   事件/参数
*/
_dispatchEventToListeners: function (listeners, onEvent, eventOrArgs) {
  // 是否需要停止继续分发
  var shouldStopPropagation = false;
  // 获得固定优先级的监听器(系统事件)
  var fixedPriorityListeners = listeners.getFixedPriorityListeners();
  // 获得场景图优先级别的监听器(我们添加的监听器正常都是在这里)
  var sceneGraphPriorityListeners = listeners.getSceneGraphPriorityListeners();

  /**
  * 监听器触发顺序:
  *      固定优先级中优先级 < 0
  *      场景图优先级别
  *      固定优先级中优先级 > 0
  */
  var i = 0, j, selListener;
  if (fixedPriorityListeners) {  //_ priority < 0
    if (fixedPriorityListeners.length !== 0) {
      // 遍历监听器分发事件
      for (; i < listeners.gt0Index; ++i) {
        selListener = fixedPriorityListeners[i];
        // 若 监听器激活状态 且 没有被暂停 且 已被注册到事件管理器
        // 最后一个onEvent是使用_onTouchEventCallback函数分发事件到监听器
        // onEvent会返回一个boolean,表示是否需要继续向后续的监听器分发事件,若true,停止继续分发
        if (selListener.isEnabled() && !selListener._isPaused() && selListener._isRegistered() && onEvent(selListener, eventOrArgs)) {
          shouldStopPropagation = true;
          break;
        }
      }
    }
  }
  // 省略另外两个优先级的触发代码
},

在函数中,通过遍历监听器列表,将事件依次分发出去,并根据onEvent的返回值判定是否需要继续派发。一般情况下,一个触摸事件被节点接收到后,就会停止派发。随后会从该节点进行冒泡派发等逻辑。这也是一个重点,即触摸事件仅有一个节点会进行响应,至于节点的优先级,就是上面提到的排序算法啦。
这里的onEvent其实是_onTouchEventCallback函数,来看看。

// 触摸事件回调。分发事件到监听器
_onTouchEventCallback: function (listener, argsObj) {
  //_ Skip if the listener was removed.
  // 若 监听器已被移除,跳过。
  if (!listener._isRegistered())
    return false;

  var event = argsObj.event, selTouch = event.currentTouch;
  event.currentTarget = listener._node;

  // isClaimed:监听器是否认领事件
  var isClaimed = false, removedIdx;
  var getCode = event.getEventCode(), EventTouch = cc.Event.EventTouch;
  // 若 事件为触摸开始事件
  if (getCode === EventTouch.BEGAN) {
    // 若 不支持多点触摸 且 当前已经有一个触点了
    if (!cc.macro.ENABLE_MULTI_TOUCH && eventManager._currentTouch) {
      // 若 该触点已被节点认领 且 该节点在节点树中是激活的,则不处理事件
      let node = eventManager._currentTouchListener._node;
      if (node && node.activeInHierarchy) {
        return false;
      }
    }

    // 若 监听器有对应事件
    if (listener.onTouchBegan) {
      // 尝试分发给监听器,会返回一个boolean,表示监听器是否认领该事件
      isClaimed = listener.onTouchBegan(selTouch, event);
      // 若 事件被认领 且 监听器是已被注册的,保存一些数据
      if (isClaimed && listener._registered) {
        listener._claimedTouches.push(selTouch);
        eventManager._currentTouchListener = listener;
        eventManager._currentTouch = selTouch;
      }
    }
  } 
  // 若 监听器已有认领的触点 且 当前触点正是被当前监听器认领
  else if (listener._claimedTouches.length > 0
           && ((removedIdx = listener._claimedTouches.indexOf(selTouch)) !== -1)) {
    // 直接领回家
    isClaimed = true;

    // 若 不支持多点触摸 且 已有触点 且 已有触点还不是当前触点,不处理事件
    if (!cc.macro.ENABLE_MULTI_TOUCH && eventManager._currentTouch && eventManager._currentTouch !== selTouch) {
      return false;
    }

    // 分发事件给监听器
    // ENDED或CANCELED的时候,需要清理监听器和事件管理器中的触点
    if (getCode === EventTouch.MOVED && listener.onTouchMoved) {
      listener.onTouchMoved(selTouch, event);
    } else if (getCode === EventTouch.ENDED) {
      if (listener.onTouchEnded)
        listener.onTouchEnded(selTouch, event);
      if (listener._registered)
        listener._claimedTouches.splice(removedIdx, 1);
      eventManager._clearCurTouch();
    } else if (getCode === EventTouch.CANCELED) {
      if (listener.onTouchCancelled)
        listener.onTouchCancelled(selTouch, event);
      if (listener._registered)
        listener._claimedTouches.splice(removedIdx, 1);
      eventManager._clearCurTouch();
    }
  }

  //_ If the event was stopped, return directly.
  // 若事件已经被停止传递,直接return(对事件调用stopPropagationImmediate()等情况)
  if (event.isStopped()) {
    eventManager._updateTouchListeners(event);
    return true;
  }

  // 若 事件被认领 且 监听器把事件吃掉了(x)(指不需要再继续传递,默认为false,但在Node的touch系列事件中为true)
  if (isClaimed && listener.swallowTouches) {
    if (argsObj.needsMutableSet)
      argsObj.touches.splice(selTouch, 1);
    return true;
  }
  return false;
},

函数主要功能是分发事件,并对多触点进行兼容处理。重要的是返回值,当事件被监听器认领时,就会返回true,阻止事件的继续传递。
分发事件时,以触摸开始事件为例,会调用监听器的onTouchBegan方法。奇了怪了,不是分发给节点嘛?为什么是调用监听器?监听器是个什么东西?这就要研究一下,当我们对节点调用on函数注册事件的时候,事件注册到了哪里?

事件是注册到了哪里?

对节点调的on函数,那相关代码自然在CCNode里。直接来看看on函数都干了些啥。

/**
* 在节点上注册指定类型的回调函数
* @param {*} type          事件类型
* @param {*} callback      回调函数
* @param {*} target        目标(用于绑定this)
* @param {*} useCapture    注册在捕获阶段
*/
on (type, callback, target, useCapture) {
  // 是否是系统事件(鼠标、触摸)
  let forDispatch = this._checknSetupSysEvent(type);
  if (forDispatch) {
    // 注册事件
    return this._onDispatch(type, callback, target, useCapture);
  }
  // 省略掉非系统事件的部分,其中包括了位置改变、尺寸改变等。
},

官方注释老长一串,我给写个简化版。总之就是用来注册针对某事件的回调函数。
你可能想说,内容这么少???然而这里分了两个分支,一个是调用_checknSetupSysEvent函数,一个是_onDispatch函数,代码都在里面555。
注册相关的是_onDispatch函数,另一个一会讲。

// 注册分发事件
_onDispatch (type, callback, target, useCapture) {
  //_ Accept also patameters like: (type, callback, useCapture)
  // 也可以接收这样的参数:(type, callback, useCapture)
  // 参数兼容性处理
  if (typeof target === 'boolean') {
    useCapture = target;
    target = undefined;
  }
  else useCapture = !!useCapture;
  // 若 没有回调函数,报错,return。
  if (!callback) {
    cc.errorID(6800);
    return;
  }

  // 根据useCapture获得不同的监听器。
  var listeners = null;
  if (useCapture) {
    listeners = this._capturingListeners = this._capturingListeners || new EventTarget();
  }
  else {
    listeners = this._bubblingListeners = this._bubblingListeners || new EventTarget();
  }

  // 若 已注册了相同的回调事件,则不做处理
  if ( !listeners.hasEventListener(type, callback, target) ) {
    // 注册事件到监听器
    listeners.on(type, callback, target);

    // 保存this到target的__eventTargets数组里,用于从target中调用targetOff函数来清除监听器。
    if (target && target.__eventTargets) {
      target.__eventTargets.push(this);
    }
  }

  return callback;
},

节点会持有两个监听器,一个是_capturingListeners,一个是_bubblingListeners,区别是什么呢?前者是注册在捕获阶段的,后者是冒泡阶段,更具体的区别后面会讲。
listeners.on(type, callback, target);可以看出其实事件是注册在这两个监听器中的,而不在节点里。
那就看看里面是个啥玩意。

event-target.js(EventTarget)

//_注册事件目标的特定事件类型回调。这种类型的事件应该被 `emit` 触发。
proto.on = function (type, callback, target, once) {
    // 若 没有传递回调函数,报错,return
    if (!callback) {
        cc.errorID(6800);
        return;
    }

    // 若 已存在该回调,不处理
    if ( !this.hasEventListener(type, callback, target) ) {
        // 注册事件
        this.__on(type, callback, target, once);

        if (target && target.__eventTargets) {
            target.__eventTargets.push(this);
        }
    }
    return callback;
};

追到最后,又是一个on…由js.extend(EventTarget, CallbacksInvoker);可以看出,EventTarget继承了CallbacksInvoker,再扒一层!

callbacks-invoker.js(CallbacksInvoker)

//_ 事件添加管理
proto.on = function (key, callback, target, once) {
    // 获得事件对应的回调列表
    let list = this._callbackTable[key];
    // 若 不存在,到池子里取一个
    if (!list) {
        list = this._callbackTable[key] = callbackListPool.get();
    }
    // 把回调相关信息存起来
    let info = callbackInfoPool.get();
    info.set(callback, target, once);
    list.callbackInfos.push(info);
};

终于到头啦!其中,callbackListPool和callbackInfoPool都是js.Pool对象,这是一个对象池。回调函数最终会存储在_callbackTable中。
了解完存储的位置,那事件又是怎么被触发的?

事件是怎么触发的?

了解触发之前,先来看看触发顺序。先看一段官方注释。

鼠标或触摸事件会被系统调用 dispatchEvent 方法触发,触发的过程包含三个阶段:    
* 1. 捕获阶段:派发事件给捕获目标(通过 _getCapturingTargets 获取),比如,节点树中注册了捕获阶段的父节点,从根节点开始派发直到目标节点。
* 2. 目标阶段:派发给目标节点的监听器。
* 3. 冒泡阶段:派发事件给冒泡目标(通过 _getBubblingTargets 获取),比如,节点树中注册了冒泡阶段的父节点,从目标节点开始派发直到根节点。

啥意思呢?on函数的第四个参数useCapture,若为true,则事件会被注册在捕获阶段,即可以最早被调用。
需要注意的是,捕获阶段的触发顺序是从父节点到子节点(从根节点开始)。随后会触发节点本身注册的事件。最后,进入冒泡阶段,将事件从父节点传递到根节点。
简单理解:捕获阶段从上到下,然后本身,最后冒泡阶段从下到上。
理论可能有点生硬,一会看代码就懂了!
还记得_checknSetupSysEvent函数嘛,前面的注释只是写了检查是否为系统事件,其实它做的事情可不止这么一点点。

// 检查是否是系统事件
_checknSetupSysEvent (type) {
  // 是否需要新增监听器
  let newAdded = false;
  // 是否需要分发(系统事件需要)
  let forDispatch = false;
  // 若 事件是触摸事件
  if (_touchEvents.indexOf(type) !== -1) {
    // 若 当前没有触摸事件监听器 新建一个
    if (!this._touchListener) {
      this._touchListener = cc.EventListener.create({
        event: cc.EventListener.TOUCH_ONE_BY_ONE,
        swallowTouches: true,
        owner: this,
        mask: _searchComponentsInParent(this, cc.Mask),
        onTouchBegan: _touchStartHandler,
        onTouchMoved: _touchMoveHandler,
        onTouchEnded: _touchEndHandler,
        onTouchCancelled: _touchCancelHandler
      });
      // 将监听器添加到eventManager
      eventManager.addListener(this._touchListener, this);
      newAdded = true;
    }
    forDispatch = true;
  }
  // 省略事件是鼠标事件的代码,和触摸事件差不多
  
  // 若 新增了监听器 且 当前节点不是活跃状态
  if (newAdded && !this._activeInHierarchy) {
    // 稍后一小会,若节点仍不是活跃状态,暂停节点的事件传递,
    cc.director.getScheduler().schedule(function () {
      if (!this._activeInHierarchy) {
        eventManager.pauseTarget(this);
      }
    }, this, 0, 0, 0, false);
  }
  return forDispatch;
},

重点在哪呢?在eventManager.addListener(this._touchListener, this);这行。可以看到,每个节点都会持有一个_touchListener,并将其添加到eventManager中。是不是有点眼熟?哎,这不就是刚刚eventManager分发事件时的玩意嘛!这不就连起来了嘛,虽然eventManager不持有节点,但是持有这些监听器啊!
新建监听器的时候,传了一大堆参数,还是拿熟悉的触摸开始事件,onTouchBegan: _touchStartHandler,这又是个啥玩意呢?

// 触摸开始事件处理器
var _touchStartHandler = function (touch, event) {
    var pos = touch.getLocation();
    var node = this.owner;

    // 若 触点在节点范围内,则触发事件,并返回true,表示这事件我领走啦!
    if (node._hitTest(pos, this)) {
        event.type = EventType.TOUCH_START;
        event.touch = touch;
        event.bubbles = true;
        // 分发到本节点内
        node.dispatchEvent(event);
        return true;
    }
    return false;
};

简简单单,获得触点,判断触点是否落在节点内,是则分发!

//_ 分发事件到事件流中。
dispatchEvent (event) {
  _doDispatchEvent(this, event);
  _cachedArray.length = 0;
},
// 分发事件
function _doDispatchEvent (owner, event) {
    var target, i;
    event.target = owner;

    //_ Event.CAPTURING_PHASE
    // 捕获阶段
    _cachedArray.length = 0;
    // 获得捕获阶段的节点,储存在_cachedArray
    owner._getCapturingTargets(event.type, _cachedArray);
    //_ capturing
    event.eventPhase = 1;
    // 从尾到头遍历(即从根节点到目标节点的父节点)
    for (i = _cachedArray.length - 1; i >= 0; --i) {
        target = _cachedArray[i];
        // 若 目标节点注册了捕获阶段的监听器
        if (target._capturingListeners) {
            event.currentTarget = target;
            //_ fire event
            // 在目标节点上处理事件
            target._capturingListeners.emit(event.type, event, _cachedArray);
            //_ check if propagation stopped
            // 若 事件已经停止传递了,return
            if (event._propagationStopped) {
                _cachedArray.length = 0;
                return;
            }
        }
    }
    // 清空_cachedArray
    _cachedArray.length = 0;

    //_ Event.AT_TARGET
    //_ checks if destroyed in capturing callbacks
    // 目标节点本身阶段
    event.eventPhase = 2;
    event.currentTarget = owner;
    // 若 自身注册了捕获阶段的监听器,则处理事件
    if (owner._capturingListeners) {
        owner._capturingListeners.emit(event.type, event);
    }
    // 若 事件没有被停止 且 自身注册了冒泡阶段的监听器,则处理事件
    if (!event._propagationImmediateStopped && owner._bubblingListeners) {
        owner._bubblingListeners.emit(event.type, event);
    }

    // 若 事件没有被停止 且 事件需要冒泡处理(默认true)
    if (!event._propagationStopped && event.bubbles) {
        //_ Event.BUBBLING_PHASE
        // 冒泡阶段
        // 获得冒泡阶段的节点
        owner._getBubblingTargets(event.type, _cachedArray);
        //_ propagate
        event.eventPhase = 3;
        // 从头到尾遍历(实现从父节点到根节点),触发逻辑和捕获阶段一致
        for (i = 0; i < _cachedArray.length; ++i) {
            target = _cachedArray[i];
            if (target._bubblingListeners) {
                event.currentTarget = target;
                //_ fire event
                target._bubblingListeners.emit(event.type, event);
                //_ check if propagation stopped
                if (event._propagationStopped) {
                    _cachedArray.length = 0;
                    return;
                }
            }
        }
    }
    // 清空_cachedArray
    _cachedArray.length = 0;
}

不知道看完有没有对事件的触发顺序有更进一步的了解呢?
其中对于捕获阶段的节点和冒泡阶段的节点,是通过别的函数来获得的,用捕获阶段的代码来做示例,两者是类似的。

_getCapturingTargets (type, array) {
  // 从父节点开始
  var parent = this.parent;
  // 若 父节点不为空(根节点的父节点为空)
  while (parent) {
    // 若 节点有捕获阶段的监听器 且 有对应类型的监听事件,则把节点加到array数组中
    if (parent._capturingListeners && parent._capturingListeners.hasEventListener(type)) {
      array.push(parent);
    }
    // 设置节点为其父节点
    parent = parent.parent;
  }
},

一个自底向上的遍历,将沿途符合条件的节点加到数组中,就得到了所有需要处理的节点!
好像有点偏题… 回到刚刚的事件分发,同样,因为不管是捕获阶段的监听器,还是冒泡阶段的监听器,都是一个EventTarget,这边拿自身的触发来做示例。
owner._bubblingListeners.emit(event.type, event);
上面这行代码将事件分发到自身节点的冒泡监听器里,所以直接看看emit里是什么。
emit其实是CallbacksInvoker里的方法。

callbacks-invoker.js

proto.emit = function (key, arg1, arg2, arg3, arg4, arg5) {
    // 获得事件列表
    const list = this._callbackTable[key];
    // 若 事件列表存在
    if (list) {
        // list.isInvoking 事件是否正在触发
        const rootInvoker = !list.isInvoking;
        list.isInvoking = true;

        // 获得回调列表,遍历
        const infos = list.callbackInfos;
        for (let i = 0, len = infos.length; i < len; ++i) {
            const info = infos[i];
            if (info) {
                let target = info.target;
                let callback = info.callback;
                // 若 回调函数是用once注册的,那先把这个函数取消掉
                if (info.once) {
                    this.off(key, callback, target);
                }

                // 若 传递了target,则使用call保证this的指向是正确的
                if (target) {
                    callback.call(target, arg1, arg2, arg3, arg4, arg5);
                }
                else {
                    callback(arg1, arg2, arg3, arg4, arg5);
                }
            }
        }
        // 若 当前事件没有在被触发
        if (rootInvoker) {
            list.isInvoking = false;
            // 若 含有被取消的回调,则调用purgeCanceled函数,过滤已被移除的回调并压缩数组
            if (list.containCanceled) {
                list.purgeCanceled();
            }
        }
    }
};

核心是,根据事件获得回调函数列表,遍历调用,最后根据需要做一个回收。到此为止啦!

结尾

加点有意思的监听器排序算法

前面的内容中,有提到_sortEventListeners函数,用于将监听器按照触发优先级排序,这个算法我觉得蛮有趣的,与君共赏。
先理论。节点树顾名思义肯定是个树结构。那如果树中随机取两个节点A、B,有以下几种种特殊情况:

  1. A和B属于同一个父节点
  2. A和B不属于同一个父节点
  3. A是B的某个父节点(反过来也一样)

如果要排优先级的话,应该怎么排呢?令p1 p2分别等于A B。往上走:A = A.parent

  1. 最简单的,直接比较_localZOrder
  2. A和B往上朔源,早晚会有一个共同的父节点,这时如果比较_localZOrder,可能有点不公平,因为可能有一个节点走了很远的路(层级更高),应该优先触发。此时又分情况:A和B层级一样。那p1 p2往上走,走到相同父节点,比较_localZOrder即可,A层级大于B。当p走到根节点时,将p交换到另一个起点。举例:p2会先到达根节点,此时,把p2放到A位置,继续。早晚他们会走过相同的距离,此时父节点相同。根据p1 p2的_localZOrder排序并取反即可。因为层级大的已经被交换到另一边了。这段要捋捋,妙不可言。
  3. 同样往上朔源,但不一样的是,因为有父子关系,在交换走过相同距离后,p1 p2最终会在A或B节点相遇!所以此时只要判断,是在A还是在B,若A,则A层级比较低,反之一样。所以相遇的节点优先级更低。

洋洋洒洒一大堆,上代码,简洁有力!

// 场景图级优先级监听器的排序算法
// 返回-1(负数)表示l1优先于l2,返回正数则相反,0表示相等
_sortEventListenersOfSceneGraphPriorityDes: function (l1, l2) {
  // 获得监听器所在的节点
  let node1 = l1._getSceneGraphPriority(),
      node2 = l2._getSceneGraphPriority();

  // 若 监听器2为空 或 节点2为空 或 节点2不是活跃状态 或 节点2是根节点 则l1优先
  if (!l2 || !node2 || !node2._activeInHierarchy || node2._parent === null)
    return -1;
  // 和上面的一样
  else if (!l1 || !node1 || !node1._activeInHierarchy || node1._parent === null)
    return 1;

  // 使用p1 p2暂存节点1 节点2
  // ex:我推测是 是否发生交换的意思(exchange)
  let p1 = node1, p2 = node2, ex = false;
  // 若 p1 p2的父节不相等 则向上朔源
  while (p1._parent._id !== p2._parent._id) {
    // 若 p1的爷爷节点是空(p1的父节点是根节点) 则ex置为true,p1指向节点2。否则p1指向其父节点
    p1 = p1._parent._parent === null ? (ex = true) && node2 : p1._parent;
    p2 = p2._parent._parent === null ? (ex = true) && node1 : p2._parent;
  }

  // 若 p1和p2指向同一个节点,即节点1、2存在某种父子关系,即情况3
  if (p1._id === p2._id) {
    // 若 p1指向节点2 则l1优先。反之l2优先
    if (p1._id === node2._id) 
      return -1;
    if (p1._id === node1._id)
      return 1;
  }

  // 注:此时p1 p2的父节点相同
  // 若ex为true 则节点1、2没有父子关系,即情况2
  // 若ex为false 则节点1、2父节点相同,即情况1
  return ex ? p1._localZOrder - p2._localZOrder : p2._localZOrder - p1._localZOrder;
},

总结

游戏由CCGame而起,调用CCInputManager、CCEventManager注册事件。随后的交互里,由引擎的回调调用CCEventManager中的监听器们,再到CCNode中对于事件的处理。若命中,进而传递到EventTarget中存储的事件列表,便走完了这一路。
模块其实没有到很复杂的地步,但是涉及若干文件,加上各种兼容性、安全性处理,显得多了起来。

以上就是详解CocosCreator系统事件是怎么产生及触发的的详细内容,更多关于CocosCreator系统事件产生及触发的资料请关注程序员的世界其它相关文章!

详解CocosCreator系统事件是怎么产生及触发的的更多相关文章

  1. JavaScript对象与其复制清除方法简析

    var obj{属性1:属性值1, // 属性名=>key 不能重复属性2:属性值2, // 属性值=>value 是该属性的唯一值 (键值对数据 键=>key 值=>value 有键必有值)}var obj{a:1,b:2,c:3,}console.log(obj.a)......

  2. 微信小程序自定义scroll-view的实例代码

    小程序自定义 scroll-view 滚动条话不多说, 直接上效果图效果图wxml代码<scroll-view scroll-x class="scroll-view" bindscroll="bindScroll"><block wx:fo......

  3. 详解JavaScript中哪一种循环最快呢

    了解哪一种 for 循环或迭代器适合我们的需求,防止我们犯下一些影响应用性能的低级错误。JavaScript 是 Web 开发领域的“常青树”。无论是 JavaScript 框架(如 Node.js、React、Angular、Vue 等),还是原生 JavaScript,都拥有非常庞大的粉丝基础。......

  4. JavaScript实现颜色查看器

    本文实例为大家分享了JavaScript实现颜色查看器的具体代码,供大家参考,具体内容如下实现效果方框中初始为白色输入框中输入颜色代码,点击查看颜色,在上方即可出现对应颜色点击复原,复原到初始的白色,同时清空输入框的内容实现代码<!DOCTYPE html><html lang=&......

  5. JavaScript——深入了解this

    前言我曾以为func()其实就是window.func()function func(){console.log('this : ' + this);}func();//this : [object Window]window.func();//this : [object Window] 直到'u......

  6. 【机制】js的闭包、执行上下文、作用域链

    1.从闭包说起什么是闭包一个函数和对其周围状态(词法环境)的引用捆绑在一起,这样的组合就是闭包。也就是说,闭包让你可以在一个内层函数中访问到其外层函数的作用域。在 JavaScript 中,每当创建一个函数,闭包就会在函数创建的同时被创建出来。上面是MDN对闭包的解释,这几句话可能不太好懂,没关系,......

  7. 前端 javascript 实现文件下载的示例

    在 html5 中,a 标签新增了 download 属性,包含该属性的链接被点击时,浏览器会以下载文件方式下载 href 属性上的链接。示例:下载1. 前端 js 下载实现与示例通过 javascript 动态创建一个包含 download 属性的 a 元素,再触发点击事件,即可实现前端下载。代码......

  8. JS removeAttribute()方法实现删除元素的某个属性

    在 JavaScript 中,使用元素的 removeAttribute() 方法可以删除指定的属性。用法如下:removeAttribute(name)参数 name 表示元素的属性名。示例1下面示例演示了如何动态设置表格的边框。window.onload = function () { //绑定......

  9. 细数JS中实用且强大的操作符&运算符

    1,前言博主收录了一些在实际开发过程中,很实用且方便的JS操作符,熟练掌握的话,不仅代码看上去高大上(实为装逼),而且简洁大方。2,代码+应用2.1,短路运算符 ||从左往右1,只要有一个条件为true时,结果就为true。2,当两个条件都为false时,结果才为false。3,当一个条件为true......

  10. 深入理解Js中的this

    深入理解Js中的thisJavaScript作用域为静态作用域static scope,但是在Js中的this却是一个例外,this的指向问题就类似于动态作用域,其并不关心函数和作用域是如何声明以及在何处声明的,只关心它们从何处调用,this的指向在函数定义的时候是确定不了的,只有函数执行的时候才能......

随机推荐

  1. 使用bandit对目标python代码进行安全函数扫描

    本文介绍了python安全危险函数扫描工具bandit的数种使用方法与技巧,同时也分析了bandit在实际项目中的性能表现,给予了读者是否在python开发项目中引入bandit的启发思考。技术背景在一些对python开源库代码的安全扫描中,我们有可能需要分析库中所使用到的函数是否会对代码的执行环境......

  2. 【python接口自动化】- 正则用例参数化

    我们在做接口自动化的时候,处理接口依赖的相关数据时,通常会使用正则表达式来进行提取相关的数据。正则表达式,又称正规表示式、正规表示法、正规表达式、规则表达式、常规表示法(Regular Expression,在代码中常简写为regex、regexp或RE) 。它是一个特殊的字符序列,它能帮助你方便的......

  3. R语言 数据表匹配和拼接 merge函数的使用

    R中的merge函数类似于Excel中的Vlookup,可以实现对两个数据表进行匹配和拼接的功能。merge(x, y, by = intersect(names(x), names(y)), by.x = by, by.y = by, all = FALSE, all.x = all, all.y......

  4. vue 页面跳转的实现方式

    一、this.$router.push()1、vue点击跳转4 2、script//跳转前页面传参数:goTo(item) {//storageData中数据用于跳转到下一个页面之后,进行返回时能够返回到跳转之前的页面let storageData = {searchWords: this.keyW......

  5. asp取整数mod 有小数的就自动加1

    有一位同学问我一个问题:asp程序,有一个不确定的数除以10,结果需要用asp程序处理取整数,如果有小数点就自动加1这个问题有两个解决思路,如果用在分页上,rs的属性pagecount就可以轻松实现,另外一种方法是数学判断方法。现在做分别介绍。除法分页方法rs.pagesize = 10这个代表每页......

  6. ASP删除img标签的style属性只保留src的正则函数

    ASP去除img标签style属性只保留src'功能:将IMG代码格式化为<img src="XXX" />格式,只保留SRC属性,去掉IMG标签的其他属性。Function FixImg(sString) Dim sReallyDo......

  7. js获取IP地址的4种方法

    1,js取得IP地址的方法一< src="http://pv.sohu.com/cityjson?ie=utf-8"></> < type="text/java"> document.write(returnCi......

  8. mysql:如何解决数据修改冲突(事务+行级锁的实际运用)

    摘要:最近做一个接诊需求遇到一个问题,假设一个订单咨询超过3次就不能再接诊,但如果两个医生同时对该订单进行咨询,查数据库的时候都能查到满足条件的该订单,那两个医生都能接诊,所谓接诊可以理解为更新了接诊次数,此时就出现了bug(接诊超过3次)。其实这个问题看似很明朗,但想要完全解决需要理解事务和锁的概......

  9. c#添加Newtonsoft.Json包的操作

    C#使用json点击工具 - NuGet包管理器 - 程序包管理控制台,输入下面命令:Install-Package Newtonsoft.Json即可使用Newtonsoft.Json 包进行json操作PM> Install-Package Newtonsoft.Json正在尝试收集与目标......

  10. 这么优雅的Java ORM没见过吧

    Java的ORM框架有很多,但由于Java语言的限制大部分都不够优雅也不够简单,所以作者只能另辟蹊径造轮子了。照旧先看示例代码了解个大概,然后再解释实现原理。一、ORM示例1. Insertpublic CompletableFuture insert() {var obj = new sys.en......