CocosCreator系统事件产生及触发 详解CocosCreator系统事件是怎么产生及触发的

// 初始化事件系统
_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();
  });
}

// 注册系统事件 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事件
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);
  }
},

// 分发事件
_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);
},

/**
* 分发事件到监听器列表
* @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;
        }
      }
    }
  }
  // 省略另外两个优先级的触发代码
},

// 触摸事件回调。分发事件到监听器
_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;
},

/**
* 在节点上注册指定类型的回调函数
* @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);
  }
  // 省略掉非系统事件的部分，其中包括了位置改变、尺寸改变等。
},

// 注册分发事件
_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;
},

//_注册事件目标的特定事件类型回调。这种类型的事件应该被 `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;
};

//_ 事件添加管理
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);
};

// 检查是否是系统事件
_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;
},

// 触摸开始事件处理器
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;
  }
},

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();
            }
        }
    }
};

// 场景图级优先级监听器的排序算法
// 返回-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;
},