浅谈React Event实现原理

React 元素的事件处理和 DOM元素的很相似。但是有一点语法上的不同:

  1. React事件绑定属性的命名采用驼峰式写法,而不是小写。
  2. 如果采用 JSX 的语法你需要传入一个函数作为事件处理函数,而不是一个字符串(DOM元素的写法)

并且 React 自己内部实现了一个合成事件,使用 React 的时候通常你不需要使用 addEventListener 为一个已创建的 DOM 元素添加监听器。你仅仅需要在这个元素初始渲染的时候提供一个监听器。

我们看一下这是怎么实现的

React 事件机制分为 事件注册,和事件分发,两个部分

事件注册

return (

Click me

);

上述代码中, onClick 作为一个 props 传入了一个 handleClick,在组件更新和挂载的时候,会对props处理, 事件绑定流程如下:

核心代码

在 ReactDOMComponent.js 进行组件加载 (mountComponent)、更新 (updateComponent) 的时候,调用 _updateDOMProperties 方法对 props 进行处理:

ReactDOMComponent.js

注册事件 enqueuePutListener(this,propKey,nextProp,transaction); } else if (lastProp) { deleteListener(this,propKey); } } ... }

// 注册事件
function enqueuePutListener(inst,registrationName,listener,transaction) {
var containerInfo = inst._nativeContainerInfo;
var doc = containerInfo._ownerDocument;
...
// 去doc上注册
listenTo(registrationName,doc);
// 事务结束之后 putListener
transaction.getReactMountReady().enqueue(putListener,{
inst: inst,registrationName: registrationName,listener: listener,});
}

看下绑定方法

ReactBrowserEventEmitter.js

listento

获取当前document上已经绑定的事件 var isListening = getListeningForDocument(mountAt); ... if (...) { //冒泡处理 ReactBrowserEventEmitter.ReactEventListener.trapBubbledEvent(...); } else if (...) { //捕捉处理 ReactBrowserEventEmitter.ReactEventListener.trapCapturedEvent(...); } ... },

走到最后其实就是 doc.addEventLister(event,callback,false);

可以看出所有事件绑定在document上

所以事件触发的都是ReactEventListener的dispatchEvent方法

回调事件储存

listenerBank

react 维护了一个 listenerBank 的变量保存了所有的绑定事件的回调。

回到之前注册事件的方法

当绑定完成以后会执行putListener。

名称 //listner为我们写的回调函数,也就是列子中的this.autoFocus putListener: function (inst,listener) { ... var key = getDictionaryKey(inst); var bankForRegistrationName = listenerBank[registrationName] || (listenerBank[registrationName] = {}); bankForRegistrationName[key] = listener; ... } }

EventPluginHub在每个React中只实例化一次。也就是说,项目组所有事件的回调都会储存在唯一的listenerBank中。

事件触发

注册事件流程图所示,所有的事件都是绑定在Document上。回调统一是ReactEventListener的dispatch方法。 由于冒泡机制,无论我们点击哪个DOM,最后都是由document响应(因为其他DOM根本没有事件监听)。也即是说都会触发 ReactEventListener.js 里的 dispatch方法

我们先看一下事件触发的流程图:

function handleTopLevelImpl(bookKeeping) {
var nativeEventTarget = getEventTarget(bookKeeping.nativeEvent);
// 获取当前事件的虚拟dom元素
var targetInst = ReactDOMComponentTree.getClosestInstanceFromNode(nativeEventTarget);

var ancestor = targetInst;
do {
bookKeeping.ancestors.push(ancestor);
ancestor = ancestor && findParent(ancestor);
} while (ancestor);

for (var i = 0; i < bookKeeping.ancestors.length; i++) {
targetInst = bookKeeping.ancestors[i];
// 这里的_handleTopLevel 对应的就是ReactEventEmitterMixin.js里的handleTopLevel
ReactEventListener._handleTopLevel(bookKeeping.topLevelType,targetInst,bookKeeping.nativeEvent,getEventTarget(bookKeeping.nativeEvent));
}
}

// 这里的findParent曾经给我带来误导,我以为去找当前元素所有的父节点,但其实不是的,
// 我们知道一般情况下,我们的组件最后会被包裹在

标签
// 一般是没有组件再去嵌套它的,所以通常返回null
/**

  • Find the deepest React component completely containing the root of the
  • passed-in instance (for use when entire React trees are nested within each
  • other). If React trees are not nested,returns null.
    */
    function findParent(inst) {
    while (inst._hostParent) {
    inst = inst._hostParent;
    }
    var rootNode = ReactDOMComponentTree.getNodeFromInstance(inst);
    var container = rootNode.parentNode;
    return ReactDOMComponentTree.getClosestInstanceFromNode(container);
    }

我们看一下核心方法 _handleTopLevel

ReactEventEmitterMixin.js

调用事件插件方法,返回合成事件,并执行队列里的dispatchListener var events = EventPluginHub.extractEvents(topLevelType,nativeEventTarget); //执行合成事件 runEventQueueInBatch(events); }
合成事件如何生成,请看上方事件触发的流程图

runEventQueuelnBatch(events)做了两件事

  1. 把 dispatchListener里面的事件排队push进 eventQueue
  2. 执行 EventPluginHub.processEventQueue(false);

执行的细节如下:

EventPluginHub.js

调用 var executeDispatchesAndReleaseTopLevel = function (e) { return executeDispatchesAndRelease(e,false); }; /* 从event._dispatchListener 取出 dispatchlistener,然后dispatch事件,
  • 循环_dispatchListeners,调用executeDispatch
    */
    var executeDispatchesAndRelease = function (event,simulated) {
    if (event) {
    // 在这里dispatch事件
    EventPluginUtils.executeDispatchesInOrder(event,simulated);
    // 释放事件
    if (!event.isPersistent()) {
    event.constructor.release(event);
    }
    }
    };
  • enqueueEvents: function (events) {
    if (events) {
    eventQueue = accumulateInto(eventQueue,events);
    }
    },/**

    • Dispatches all synthetic events on the event queue.
    • @internal
      */
      processEventQueue: function (simulated) {
      // Set eventQueue to null before processing it so that we can tell if more
      // events get enqueued while processing.
      var processingEventQueue = eventQueue;
      eventQueue = null;
      if (simulated) {
      forEachAccumulated(processingEventQueue,executeDispatchesAndReleaseSimulated);
      } else {
      forEachAccumulated(processingEventQueue,executeDispatchesAndReleaseTopLevel);
      }
      // This would be a good time to rethrow if any of the event fexers threw.
      ReactErrorUtils.rethrowCaughtError();
      },/**
    • Standard/simple iteration through an event's collected dispatches.
      */
      function executeDispatchesInOrder(event,simulated) {
      var dispatchListeners = event._dispatchListeners;
      var dispatchInstances = event._dispatchInstances;

    if (Array.isArray(dispatchListeners)) {
    for (var i = 0; i < dispatchListeners.length; i++) {
    // 由这里可以看出,合成事件的stopPropagation只能阻止react合成事件的冒泡,
    // 因为event._dispatchListeners 只记录了由jsx绑定的绑定的事件,对于原生绑定的是没有记录的
    if (event.isPropagationStopped()) {
    break;
    }
    // Listeners and Instances are two parallel arrays that are always in sync.
    executeDispatch(event,simulated,dispatchListeners[i],dispatchInstances[i]);
    }
    } else if (dispatchListeners) {
    executeDispatch(event,dispatchListeners,dispatchInstances);
    }
    event._dispatchListeners = null;
    event._dispatchInstances = null;
    }
    function executeDispatch(event,inst) {
    var type = event.type || 'unknown-event';
    // 注意这里将事件对应的dom元素绑定到了currentTarget上
    event.currentTarget = EventPluginUtils.getNodeFromInstance(inst);
    if (simulated) {
    ReactErrorUtils.invokeGuardedCallbackWithCatch(type,event);
    } else {
    // 一般都是非模拟的情况,执行invokeGuardedCallback
    ReactErrorUtils.invokeGuardedCallback(type,event);
    }
    event.currentTarget = null;
    }

    由上面的函数可知,dispatch 合成事件分为两个步骤:

    1. 通过_dispatchListeners里得到所有绑定的回调函数,在通过_dispatchInstances的绑定回调函数的虚拟dom元素
    2. 循环执行_dispatchListeners里所有的回调函数,这里有一个特殊情况,也是react阻止冒泡的原理

    其实在 EventPluginHub.js 里主要做了两件事情.

    1.从event._dispatchListener 取出 dispatchlistener,然后dispatch事件, 循环_dispatchListeners,调用executeDispatch,然后走到ReactErrorUtils.invokeGuardedCallback; 2.释放 event

    上面这个函数最重要的功能就是将事件对应的dom元素绑定到了currentTarget上,

    这样我们通过e.currentTarget就可以找到绑定事件的原生dom元素。

    下面就是整个执行过程的尾声了:

    ReactErrorUtils.js

    由invokeGuardedCallback可知,最后react调用了faked元素的dispatchEvent方法来触发事件,并且触发完毕之后立即移除监听事件。

    总的来说,整个click事件被分发的过程就是:

    1、用EventPluginHub生成合成事件,这里注意同一事件类型只会生成一个合成事件,里面的_dispatchListeners里储存了同一事件类型的所有回调函数

    2、按顺序去执行它

    以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持编程之家。

    相关文章

    事件冒泡和事件捕获 起因:今天在封装一个bind函数的时候,发现el.addEventListener函数支持第三个参数...
    js小数运算会出现精度问题 js number类型 JS 数字类型只有number类型,number类型相当于其他强类型语言...
    什么是跨域 跨域 : 广义的跨域包含一下内容 : 1.资源跳转(链接跳转,重定向跳转,表单提交) 2.资源...
    @ &quot;TOC&quot; 常见对base64的认知(不完全正确) 首先对base64常见的认知,也是须知的必须有...
    搞懂:MVVM模式和Vue中的MVVM模式 MVVM MVVM : 的缩写,说都能直接说出来 :模型, :视图, :视图模...
    首先我们需要一个html代码的框架如下: 我们的目的是实现ul中的内容进行横向的一点一点滚动。ul中的内容...