由浅到深的React合成事件

前言

📢 文章首发博客: 阿宽的博客

💕 温馨提示: 下边是对React合成事件的源码阅读,全文有点长,但是!如果你真的想知道这不为人知的背后内幕,那一定要耐心看下去!

最近在做一个功能,然后不小心踩到了 React 合成事件 的坑,好奇心的驱使,去看了 React 官网合成事件 的解释,这不看不知道,一看吓一跳…

SyntheticEvent是个什么鬼?咋冒出来了个事件池

我就一个简单的需求功能,为什么能扯出这些鬼玩意??

我们先简单的来看一看我的需求功能是个啥???

合成事件 - 图1

导火线

需要做一个弹窗打开/关闭 的功能,当点击 button 的时候打开,此时打开的情况下,点击弹窗 区域 外,就需要关闭。

这简单嘛,直接在 button 上注册一个点击事件,同时在 document.body 注册一个点击事件,然后在 弹窗container 里阻止冒泡,很难嘛?

  1. class FuckEvent extends React.PureComponent {
  2. state = {
  3. showBox: false
  4. }
  5. componentDidMount() {
  6. document.body.addEventListener('click', this.handleClickBody, false)
  7. }
  8. componentWillUnmount() {
  9. document.body.removeEventListener('click', this.handleClickBody, false)
  10. }
  11. handleClickBody = () => {
  12. this.setState({
  13. showBox: false
  14. })
  15. }
  16. handleClickButton = () => {
  17. this.setState({
  18. showBox: true
  19. })
  20. }
  21. render() {
  22. return (
  23. <div>
  24. <button onClick={this.handleClickButton}>点击我显示弹窗</button>
  25. {this.state.showBox && (
  26. <div onClick={e => e.stopPropagation()}>我是弹窗</div>
  27. )}
  28. </div>
  29. )
  30. }
  31. }
  32. 复制代码

很简单嘛,很开心的点击了弹窗区域….

于是…我没了…点击弹窗区域,弹窗也被关闭了。。。what the f**k ?????? 难道冒泡没有用 ?

带着这个问题,我走上了不归之路

合成事件 - 图2

事件委托

我们都知道,什么是事件委托,(不知道的出门左拐 👈) 在前端刀耕火种时期,事件委托可是爸爸

事件委托解决了庞大的数据列表时,无需为每个列表项绑定事件监听。同时可以动态挂载元素无需作额外的事件监听处理。

你看,事件委托那么牛 13,你觉得 React 会不用?呵,React 不仅用了,还用的非常溜 ~

怎么说呢,react 它接管了浏览器事件的优化策略,然后自身实现了一套自己的事件机制,而且特别贴心,就跟你男朋友一样,它把浏览器的不同差异,都帮你消除了 ~

合成事件 - 图3

React 实现了一个合成事件层,就是这个事件层,把 IE 和 W3C 标准之间的兼容问题给消除了。

📌 那么问题来了,什么是合成事件与原生事件????

  • 原生事件: 在 componentDidMount生命周期里边进行addEventListener绑定的事件
  • 合成事件: 通过 JSX 方式绑定的事件,比如 onClick={() => this.handle()}

还记得上边的那个例子吗?我们在弹窗的 DOM 元素上绑定了一个事件,进行阻止冒泡

  1. {
  2. this.state.showBox && <div onClick={e => e.stopPropagation()}>我是弹窗</div>
  3. }
  4. 复制代码

然后在componentDidMount生命周期里边对 body 进行了 click 的绑定

  1. componentDidMount() {
  2. document.body.addEventListener('click', this.handleClickBody, false)
  3. }
  4. componentWillUnmount() {
  5. document.body.removeEventListener('click', this.handleClickBody, false)
  6. }
  7. 复制代码

我们去分析一下,因为合成事件的触发是基于浏览器的事件机制来实现的,通过冒泡机制冒泡到最顶层元素,然后再由 dispatchEvent 统一去处理

回顾一下浏览器事件机制

合成事件 - 图4

Document 上边是 Window,这里截的是《JavaScript 高级程序设计》书籍里的图片

浏览器事件的执行需要经过三个阶段,捕获阶段-目标元素阶段-冒泡阶段。

🙋 Question: 此时对于合成事件进行阻止,原生事件会执行吗?答案是: 会!

📢 Answer: 因为原生事件先于合成事件执行 (个人理解: 注册的原生事件已经执行,而合成事件处于目标阶段,它阻止的冒泡只是阻止合成的事件冒泡,但是原生事件在捕获阶段就已经执行了)

合成事件 - 图5

合成事件特点

React 自己实现了这么一套事件机制,它在 DOM 事件体系基础上做了改进,减少了内存的消耗,并且最大程度上解决了 IE 等浏览器的不兼容问题

那它有什么特点?

  • React 上注册的事件最终会绑定在document这个 DOM 上,而不是 React 组件对应的 DOM(减少内存开销就是因为所有的事件都绑定在 document 上,其他节点没有绑定事件)
  • React 自身实现了一套事件冒泡机制,所以这也就是为什么我们 event.stopPropagation() 无效的原因。
  • React 通过队列的形式,从触发的组件向父组件回溯,然后调用他们 JSX 中定义的 callback
  • React 有一套自己的合成事件 SyntheticEvent,不是原生的,这个可以自己去看官网
  • React 通过对象池的形式管理合成事件对象的创建和销毁,减少了垃圾的生成和新对象内存的分配,提高了性能

React 事件系统

看到这里,应该对 React 合成事件有一个简单的了解了吧,我们接着去看一看源码 ~

👉 源码 ReactBrowserEventEmitter

我们在 ReactBrowserEventEmitter.js 文件中可以看到,React 合成系统框架图

  1. /**
  2. * React和事件系统概述:
  3. *
  4. * +------------+ .
  5. * | DOM | .
  6. * +------------+ .
  7. * | .
  8. * v .
  9. * +------------+ .
  10. * | ReactEvent | .
  11. * | Listener | .
  12. * +------------+ . +-----------+
  13. * | . +--------+|SimpleEvent|
  14. * | . | |Plugin |
  15. * +-----|------+ . v +-----------+
  16. * | | | . +--------------+ +------------+
  17. * | +-----------.--->|EventPluginHub| | Event |
  18. * | | . | | +-----------+ | Propagators|
  19. * | ReactEvent | . | | |TapEvent | |------------|
  20. * | Emitter | . | |<---+|Plugin | |other plugin|
  21. * | | . | | +-----------+ | utilities |
  22. * | +-----------.--->| | +------------+
  23. * | | | . +--------------+
  24. * +-----|------+ . ^ +-----------+
  25. * | . | |Enter/Leave|
  26. * + . +-------+|Plugin |
  27. * +-------------+ . +-----------+
  28. * | application | .
  29. * |-------------| .
  30. * | | .
  31. * | | .
  32. * +-------------+ .
  33. * .
  34. */
  35. 复制代码

源码里边的一大串英文解释,我帮你们 google 翻译了,简单来讲就是:

  • Top-level delegation 用于捕获最原始的浏览器事件,它主要由 ReactEventListener 负责,ReactEventListener 被注入后可以支持插件化的事件源,这一过程发生在主线程。
  • React 对事件进行规范化和重复数据删除,以解决浏览器的怪癖。这可以在工作线程中完成。
  • 将这些本地事件(具有关联的顶级类型用来捕获它)转发到EventPluginHub,后者将询问插件是否要提取任何合成事件。
  • 然后,EventPluginHub 将通过为每个事件添加“dispatches”(关心该事件的侦听器和 ID 的序列)来对其进行注释来进行处理。
  • 再接着,EventPluginHub 会调度分派事件.

❗ 建议直接去看英文注释,翻译可能不是很标准。

看会上边的框架图,我们得先知道一下这些都是个啥玩意,直接看名称,也能够知道 :

  • ReactEventListener:负责事件的注册。
  • ReactEventEmitter:负责事件的分发。
  • EventPluginHub:负责事件的存储及分发。
  • Plugin:根据不同的事件类型构造不同的合成事件。

👇 下面我们来一步一步的看它是怎么工作的

事件注册

React 中注册一个事件贼简单,就比如这样:

  1. class TaskEvent extends Reac.PureComponent {
  2. render() {
  3. return (
  4. <div
  5. onClick={() => {
  6. console.log('我是注册事件')
  7. }}
  8. >
  9. 呵呵呵
  10. </div>
  11. )
  12. }
  13. }
  14. 复制代码

ok,洋洋洒洒的写下这段代码,它是如何被注册到 React 事件系统中的?

合成事件 - 图6

enqueuePutListener()

组件在创建 mountComponent 和更新 updateComponent 的时候,都会调用 _updateDOMProperties() 方法

📢 温馨提示,这快的源码是 react 15.6.1 的源码,但是我在 github 上找对应的版本进去,居然是 Pages Not Found … 这里就用我翻阅资料的文章中对这个注册事件的源码解释了

  1. mountComponent: function(transaction, hostParent, hostContainerInfo, context) {
  2. // ...
  3. var props = this._currentElement.props;
  4. // ...
  5. this._updateDOMProperties(null, props, transaction);
  6. // ...
  7. }
  8. 复制代码
  9. _updateDOMProperties: function (lastProps, nextProps, transaction) {
  10. // ...
  11. for (propKey in nextProps) {
  12. var nextProp = nextProps[propKey];
  13. var lastProp = propKey === STYLE ? this._previousStyleCopy : lastProps != null ? lastProps[propKey] : undefined;
  14. if (!nextProps.hasOwnProperty(propKey) || nextProp === lastProp || nextProp == null && lastProp == null) {
  15. continue;
  16. }
  17. if (propKey === STYLE) {
  18. // ...
  19. } else if (registrationNameModules.hasOwnProperty(propKey)) {
  20. // 如果是props这个对象直接声明的属性,而不是从原型链中继承而来的,则处理它
  21. // 对于mountComponent,lastProp为null。updateComponent二者都不为null。unmountComponent则nextProp为null
  22. if (nextProp) {
  23. // mountComponent和updateComponent中,enqueuePutListener注册事件
  24. enqueuePutListener(this, propKey, nextProp, transaction);
  25. } else if (lastProp) {
  26. // unmountComponent中,删除注册的listener,防止内存泄漏
  27. deleteListener(this, propKey);
  28. }
  29. }
  30. }
  31. }
  32. 复制代码

上边的代码很清楚告诉你,通过 enqueuePutListener() 方法进行注册事件,我们接着去看看这是个啥玩意

  1. function enqueuePutListener(inst, registrationName, listener, transaction) {
  2. if (transaction instanceof ReactServerRenderingTransaction) {
  3. return
  4. }
  5. var containerInfo = inst._hostContainerInfo
  6. var isDocumentFragment =
  7. containerInfo._node && containerInfo._node.nodeType === DOC_FRAGMENT_TYPE
  8. // 找到document
  9. var doc = isDocumentFragment
  10. ? containerInfo._node
  11. : containerInfo._ownerDocument
  12. // 注册事件,将事件注册到document上
  13. listenTo(registrationName, doc)
  14. // 存储事件,放入事务队列中
  15. transaction.getReactMountReady().enqueue(putListener, {
  16. inst: inst,
  17. registrationName: registrationName,
  18. listener: listener
  19. })
  20. }
  21. 复制代码

💢 看到没,这个 enqueuePutListener() 就只干了两个事情 :

  • 通过调用 listenTo 把事件注册到 document 上 (这就是前边说的 React 上注册的事件最终会绑定在document这个 DOM 上)
  • 事务方式调用 putListener 存储事件 (就是把 React 组件内的所有事件统一的存放到一个对象里,缓存起来,为了在触发事件的时候可以查找到对应的方法去执行)

合成事件 - 图7

listenTo()

虽然说不要贴代码,但是!直接看源码真的是简单明了啊,👉 listenTo 源码

📢 注意,react 版本是目前 github master 分支代码

我们来看一下代码

  1. export function listenTo(
  2. registrationName: string,
  3. mountAt: Document | Element | Node
  4. ): void {
  5. const listeningSet = getListeningSetForElement(mountAt)
  6. const dependencies = registrationNameDependencies[registrationName]
  7. for (let i = 0; i < dependencies.length; i++) {
  8. const dependency = dependencies[i]
  9. // 调用该方法进行注册
  10. listenToTopLevel(dependency, mountAt, listeningSet)
  11. }
  12. }
  13. 复制代码

registrationName 就是传过来的 onClick,而变量 registrationNameDependencies 是一个存储了 React 事件名与浏览器原生事件名对应的一个 Map,可以通过这个 map 拿到相应的浏览器原生事件名

  1. export function listenToTopLevel(
  2. topLevelType: DOMTopLevelEventType,
  3. mountAt: Document | Element | Node,
  4. listeningSet: Set<DOMTopLevelEventType | string>
  5. ): void {
  6. if (!listeningSet.has(topLevelType)) {
  7. switch (topLevelType) {
  8. //...
  9. case TOP_CANCEL:
  10. case TOP_CLOSE:
  11. if (isEventSupported(getRawEventName(topLevelType))) {
  12. trapCapturedEvent(topLevelType, mountAt) // 捕获阶段
  13. }
  14. break
  15. default:
  16. const isMediaEvent = mediaEventTypes.indexOf(topLevelType) !== -1
  17. if (!isMediaEvent) {
  18. trapBubbledEvent(topLevelType, mountAt) // 冒泡阶段
  19. }
  20. break
  21. }
  22. listeningSet.add(topLevelType)
  23. }
  24. }
  25. 复制代码

上边忽略部分源码,我们看到,注册事件的入口是 listenTo 方法, 通过对dependencies循环调用listenToTopLevel()方法,在该方法中调用 trapCapturedEventtrapBubbledEvent 来注册捕获和冒泡事件。

合成事件 - 图8

trapCapturedEvent 与 trapBubbledEvent

下边仅对 trapCapturedEvent 进行分析,👉 trapCapturedEvent 源码地址trapBubbledEvent 源码地址

  1. // 捕获阶段
  2. export function trapCapturedEvent(
  3. topLevelType: DOMTopLevelEventType,
  4. element: Document | Element | Node
  5. ): void {
  6. trapEventForPluginEventSystem(element, topLevelType, true)
  7. }
  8. // 冒泡阶段
  9. export function trapBubbledEvent(
  10. topLevelType: DOMTopLevelEventType,
  11. element: Document | Element | Node
  12. ): void {
  13. trapEventForPluginEventSystem(element, topLevelType, false)
  14. }
  15. 复制代码
  16. function trapEventForPluginEventSystem(
  17. element: Document | Element | Node,
  18. topLevelType: DOMTopLevelEventType,
  19. capture: boolean // 决定捕获还是冒泡阶段
  20. ): void {
  21. let listener
  22. switch (getEventPriority(topLevelType)) {
  23. }
  24. const rawEventName = getRawEventName(topLevelType)
  25. if (capture) {
  26. addEventCaptureListener(element, rawEventName, listener)
  27. } else {
  28. addEventBubbleListener(element, rawEventName, listener)
  29. }
  30. }
  31. 复制代码

😝 这里我们就能知道,捕获事件通过addEventCaptureListener(),而冒泡事件通过addEventBubbleListener()

  1. // 捕获
  2. export function addEventCaptureListener(
  3. element: Document | Element | Node,
  4. eventType: string,
  5. listener: Function
  6. ): void {
  7. element.addEventListener(eventType, listener, true)
  8. }
  9. // 冒泡
  10. export function addEventBubbleListener(
  11. element: Document | Element | Node,
  12. eventType: string,
  13. listener: Function
  14. ): void {
  15. element.addEventListener(eventType, listener, false)
  16. }
  17. 复制代码

合成事件 - 图9

事件存储

还记得上边的 enqueuePutListener() 中,我们将事件放入到事务队列嘛?

  1. function enqueuePutListener(inst, registrationName, listener, transaction) {
  2. //...
  3. // 注册事件,将事件注册到document上
  4. listenTo(registrationName, doc)
  5. // 存储事件,放入事务队列中
  6. transaction.getReactMountReady().enqueue(putListener, {
  7. inst: inst,
  8. registrationName: registrationName,
  9. listener: listener
  10. })
  11. }
  12. 复制代码

没错,就是 putListener 这个玩意,我们可以看一下代码

  1. putListener: function (inst, registrationName, listener) {
  2. // 用来标识注册了事件,比如onClick的React对象。key的格式为'.nodeId', 只用知道它可以标示哪个React对象就可以了
  3. // step1: 得到组件唯一标识
  4. var key = getDictionaryKey(inst);
  5. // step2: 得到listenerBank对象中指定事件类型的对象
  6. var bankForRegistrationName = listenerBank[registrationName] || (listenerBank[registrationName] = {});
  7. // step3: 将listener事件回调方法存入listenerBank[registrationName][key]中,比如listenerBank['onclick'][nodeId]
  8. // 所有React组件对象定义的所有React事件都会存储在listenerBank中
  9. bankForRegistrationName[key] = listener;
  10. // ...
  11. }
  12. // 拿到组件唯一标识
  13. var getDictionaryKey = function (inst) {
  14. return '.' + inst._rootNodeID;
  15. };
  16. 复制代码

事件分发

既然事件已经委托注册到 document 上了,那么事件触发的时候,肯定需要一个事件分发的过程,流程也很简单,既然事件存储在 listenrBank 中,那么我只需要找到对应的事件类型,然后执行事件回调就 ok 了

📢 注意: 由于元素本身并没有注册任何事件,而是委托到了 document 上,所以这个将被触发的事件是 React 自带的合成事件,而非浏览器原生事件

首先找到事件触发的DOMReact Component,找真实的 DOM 还是很好找的,在getEventTarget 源码中可以看到:

  1. // 源码看这里: https://github.com/facebook/react/blob/master/packages/react-dom/src/events/ReactDOMEventListener.js#L419
  2. const nativeEventTarget = getEventTarget(nativeEvent)
  3. let targetInst = getClosestInstanceFromNode(nativeEventTarget)
  4. 复制代码
  5. function getEventTarget(nativeEvent) {
  6. let target = nativeEvent.target || nativeEvent.srcElement || window
  7. if (target.correspondingUseElement) {
  8. target = target.correspondingUseElement
  9. }
  10. return target.nodeType === TEXT_NODE ? target.parentNode : target
  11. }
  12. 复制代码

这个 nativeEventTarget 对象上挂在了一个以 __reactInternalInstance 开头的属性,这个属性就是 internalInstanceKey ,其值就是当前 React 实例对应的 React Component

继续看源码: dispatchEventForPluginEventSystem()

  1. function dispatchEventForPluginEventSystem(
  2. topLevelType: DOMTopLevelEventType,
  3. eventSystemFlags: EventSystemFlags,
  4. nativeEvent: AnyNativeEvent,
  5. targetInst: null | Fiber
  6. ): void {
  7. const bookKeeping = getTopLevelCallbackBookKeeping(
  8. topLevelType,
  9. nativeEvent,
  10. targetInst,
  11. eventSystemFlags
  12. )
  13. try {
  14. // Event queue being processed in the same cycle allows
  15. // `preventDefault`.
  16. batchedEventUpdates(handleTopLevel, bookKeeping)
  17. } finally {
  18. releaseTopLevelCallbackBookKeeping(bookKeeping)
  19. }
  20. }
  21. 复制代码

看到了嘛,batchedEventUpdates()批量更新,它的工作是把当前触发的事件放到了批处理队列中。handleTopLevel 是事件分发的核心所在

👉 源码在这里: handleTopLevel

  1. function handleTopLevel(bookKeeping: BookKeepingInstance) {
  2. let targetInst = bookKeeping.targetInst
  3. // Loop through the hierarchy, in case there's any nested components.
  4. // It's important that we build the array of ancestors before calling any
  5. // event handlers, because event handlers can modify the DOM, leading to
  6. // inconsistencies with ReactMount's node cache. See #1105.
  7. let ancestor = targetInst
  8. do {
  9. if (!ancestor) {
  10. const ancestors = bookKeeping.ancestors
  11. ;((ancestors: any): Array<Fiber | null>).push(ancestor)
  12. break
  13. }
  14. const root = findRootContainerNode(ancestor)
  15. if (!root) {
  16. break
  17. }
  18. const tag = ancestor.tag
  19. if (tag === HostComponent || tag === HostText) {
  20. bookKeeping.ancestors.push(ancestor)
  21. }
  22. ancestor = getClosestInstanceFromNode(root)
  23. } while (ancestor)
  24. }
  25. 复制代码

这里直接看上边的英文注释,讲的很清楚,主要就是事件回调可能会改变 DOM 结构,所以要先遍历层次结构,以防存在任何嵌套的组件,然后缓存起来

然后继续这个方法

  1. for (let i = 0; i < bookKeeping.ancestors.length; i++) {
  2. targetInst = bookKeeping.ancestors[i]
  3. // getEventTarget上边有讲到
  4. const eventTarget = getEventTarget(bookKeeping.nativeEvent)
  5. const topLevelType = ((bookKeeping.topLevelType: any): DOMTopLevelEventType)
  6. const nativeEvent = ((bookKeeping.nativeEvent: any): AnyNativeEvent)
  7. runExtractedPluginEventsInBatch(
  8. topLevelType,
  9. targetInst,
  10. nativeEvent,
  11. eventTarget,
  12. bookKeeping.eventSystemFlags
  13. )
  14. }
  15. 复制代码

这里就是一个 for 循环来遍历这个 React Component 及其所有的父组件,然后执行runExtractedPluginEventsInBatch()方法

从上面的事件分发中可见,React 自身实现了一套冒泡机制。从触发事件的对象开始,向父元素回溯,依次调用它们注册的事件 callback。

合成事件 - 图10

事件执行

上边讲到的 runExtractedPluginEventsInBatch()方法就是事件执行的入口了,通过源码,我们可以知道,它干了两件事

👉 runExtractedPluginEventsInBatch 源码

  • 构造合成事件
  • 批处理构造出的合成事件
  1. export function runExtractedPluginEventsInBatch(
  2. topLevelType: TopLevelType,
  3. targetInst: null | Fiber,
  4. nativeEvent: AnyNativeEvent,
  5. nativeEventTarget: EventTarget,
  6. eventSystemFlags: EventSystemFlags
  7. ) {
  8. // step1 : 构造合成事件
  9. const events = extractPluginEvents(
  10. topLevelType,
  11. targetInst,
  12. nativeEvent,
  13. nativeEventTarget,
  14. eventSystemFlags
  15. )
  16. // step2 : 批处理
  17. runEventsInBatch(events)
  18. }
  19. 复制代码

构造合成事件

我们来看看相关的代码 extractPluginEvents()runEventsInBatch()

  1. function extractPluginEvents(
  2. topLevelType: TopLevelType,
  3. targetInst: null | Fiber,
  4. nativeEvent: AnyNativeEvent,
  5. nativeEventTarget: EventTarget,
  6. eventSystemFlags: EventSystemFlags
  7. ): Array<ReactSyntheticEvent> | ReactSyntheticEvent | null {
  8. let events = null
  9. for (let i = 0; i < plugins.length; i++) {
  10. // Not every plugin in the ordering may be loaded at runtime.
  11. const possiblePlugin: PluginModule<AnyNativeEvent> = plugins[i]
  12. if (possiblePlugin) {
  13. const extractedEvents = possiblePlugin.extractEvents(
  14. topLevelType,
  15. targetInst,
  16. nativeEvent,
  17. nativeEventTarget,
  18. eventSystemFlags
  19. )
  20. if (extractedEvents) {
  21. events = accumulateInto(events, extractedEvents)
  22. }
  23. }
  24. }
  25. return events
  26. }
  27. 复制代码

首先会去遍历 plugins,相关代码在: plugins 源码,这个 plugins 就是所有事件合成 plugins 的集合数组,这些 plugins 是在 EventPluginHub 初始化时候注入的

  1. // 📢 源码地址 : https://github.com/facebook/react/blob/master/packages/legacy-events/EventPluginHub.js#L80
  2. export const injection = {
  3. injectEventPluginOrder,
  4. injectEventPluginsByName
  5. }
  6. 复制代码
  7. // 📢 源码地址 : https://github.com/facebook/react/blob/master/packages/react-dom/src/client/ReactDOMClientInjection.js#L26
  8. EventPluginHubInjection.injectEventPluginOrder(DOMEventPluginOrder)
  9. EventPluginHubInjection.injectEventPluginsByName({
  10. SimpleEventPlugin: SimpleEventPlugin,
  11. EnterLeaveEventPlugin: EnterLeaveEventPlugin,
  12. ChangeEventPlugin: ChangeEventPlugin,
  13. SelectEventPlugin: SelectEventPlugin,
  14. BeforeInputEventPlugin: BeforeInputEventPlugin
  15. })
  16. 复制代码

打住,这里不展开分析,我们继续看extractEvents的逻辑代码

  1. const extractedEvents = possiblePlugin.extractEvents(
  2. topLevelType,
  3. targetInst,
  4. nativeEvent,
  5. nativeEventTarget,
  6. eventSystemFlags
  7. )
  8. if (extractedEvents) {
  9. events = accumulateInto(events, extractedEvents)
  10. }
  11. 复制代码

因为 const possiblePlugin: PluginModule = plugins[i], 类型是 PluginModule,我们可以去 👉SimpleEventPlugin 源码去看一下 extractEvents 到底干了啥

  1. extractEvents: function() {
  2. const dispatchConfig = topLevelEventsToDispatchConfig[topLevelType]
  3. if (!dispatchConfig) {
  4. return null
  5. }
  6. //...
  7. }
  8. 复制代码

首先,看下 topLevelEventsToDispatchConfig 这个对象中有没有 topLevelType 这个属性,只要有,那么说明当前事件可以使用 SimpleEventPlugin 构造合成事件

函数里边定义了 EventConstructor,然后通过 switch...case 语句进行赋值

  1. extractEvents: function() {
  2. //...
  3. let EventConstructor
  4. switch (topLevelType) {
  5. // ...
  6. case DOMTopLevelEventTypes.TOP_POINTER_UP:
  7. EventConstructor = SyntheticPointerEvent
  8. break
  9. default:
  10. EventConstructor = SyntheticEvent
  11. break
  12. }
  13. }
  14. 复制代码

总之就是赋值给 EventConstructor,如果你想更加了解SyntheticEvent请点击这里

设置好了EventConstructor之后,这个方法继续执行

  1. extractEvents: function() {
  2. //...
  3. const event = EventConstructor.getPooled(
  4. dispatchConfig,
  5. targetInst,
  6. nativeEvent,
  7. nativeEventTarget
  8. )
  9. accumulateTwoPhaseDispatches(event)
  10. return event
  11. }
  12. 复制代码

这一段代码的意思就是,从 event 对象池中取出合成事件,这里的 getPooled() 方法其实在在 SyntheticEvent 初始化的时候就被设置好了,我们来看一下代码

  1. function addEventPoolingTo(EventConstructor) {
  2. EventConstructor.eventPool = []
  3. // 就是这里设置了getPooled
  4. EventConstructor.getPooled = getPooledEvent
  5. EventConstructor.release = releasePooledEvent
  6. }
  7. SyntheticEvent.extend = function(Interface) {
  8. //...
  9. addEventPoolingTo(Class)
  10. return Class
  11. }
  12. addEventPoolingTo(SyntheticEvent)
  13. 复制代码

看到这里,我们知道,getPooled 就是 getPooledEvent,那我们去看看getPooledEvent做了啥玩意

  1. function getPooledEvent(dispatchConfig, targetInst, nativeEvent, nativeInst) {
  2. const EventConstructor = this
  3. if (EventConstructor.eventPool.length) {
  4. const instance = EventConstructor.eventPool.pop()
  5. EventConstructor.call(
  6. instance,
  7. dispatchConfig,
  8. targetInst,
  9. nativeEvent,
  10. nativeInst
  11. )
  12. return instance
  13. }
  14. return new EventConstructor(
  15. dispatchConfig,
  16. targetInst,
  17. nativeEvent,
  18. nativeInst
  19. )
  20. }
  21. 复制代码

首先呢,会先去对象池中,看一下 length 是否为 0,如果是第一次事件触发,那不好意思,你需要 new EventConstructor 了,如果后续再次触发事件的时候,直接从对象池中取,也就是直接 instance = EventConstructor.eventPool.pop() 出来的完事了

合成事件 - 图11

ok,我们暂时就讲到这,我们继续说一说事件执行的另一个重要操作: 批处理 runEventsInBatch(events)

批处理

批处理主要是通过 runEventQueueInBatch(events) 进行操作,我们来看看源码: 👉 runEventQueueInBatch 源码

  1. export function runEventsInBatch(
  2. events: Array<ReactSyntheticEvent> | ReactSyntheticEvent | null
  3. ) {
  4. if (events !== null) {
  5. eventQueue = accumulateInto(eventQueue, events)
  6. }
  7. // Set `eventQueue` to null before processing it so that we can tell if more
  8. // events get enqueued while processing.
  9. const processingEventQueue = eventQueue
  10. eventQueue = null
  11. if (!processingEventQueue) {
  12. return
  13. }
  14. forEachAccumulated(processingEventQueue, executeDispatchesAndReleaseTopLevel)
  15. invariant(
  16. !eventQueue,
  17. 'processEventQueue(): Additional events were enqueued while processing ' +
  18. 'an event queue. Support for this has not yet been implemented.'
  19. )
  20. // This would be a good time to rethrow if any of the event handlers threw.
  21. rethrowCaughtError()
  22. }
  23. 复制代码

这个方法首先会将当前需要处理的 events 事件,与之前没有处理完毕的队列调用 accumulateInto 方法按照顺序进行合并,组合成一个新的队列

如果processingEventQueue这个为空,gg,没有处理的事件,退出,否则调用 forEachAccumulated(),源码看这里: forEachAccumulated 源码

  1. function forEachAccumulated<T>(
  2. arr: ?(Array<T> | T),
  3. cb: (elem: T) => void,
  4. scope: ?any
  5. ) {
  6. if (Array.isArray(arr)) {
  7. arr.forEach(cb, scope)
  8. } else if (arr) {
  9. cb.call(scope, arr)
  10. }
  11. }
  12. 复制代码

这个方法就是先看下事件队列 processingEventQueue 是不是个数组,如果是数组,说明队列中不止一个事件,则遍历队列,调用 executeDispatchesAndReleaseTopLevel,否则说明队列中只有一个事件,则无需遍历直接调用即可

📢 executeDispatchesAndReleaseTopLevel 源码

  1. const executeDispatchesAndRelease = function(event: ReactSyntheticEvent) {
  2. if (event) {
  3. executeDispatchesInOrder(event)
  4. if (!event.isPersistent()) {
  5. event.constructor.release(event)
  6. }
  7. }
  8. }
  9. const executeDispatchesAndReleaseTopLevel = function(e) {
  10. return executeDispatchesAndRelease(e)
  11. }
  12. 复制代码
  13. export function executeDispatchesInOrder(event) {
  14. const dispatchListeners = event._dispatchListeners
  15. const dispatchInstances = event._dispatchInstances
  16. if (__DEV__) {
  17. validateEventDispatches(event)
  18. }
  19. if (Array.isArray(dispatchListeners)) {
  20. for (let i = 0; i < dispatchListeners.length; i++) {
  21. if (event.isPropagationStopped()) {
  22. break
  23. }
  24. // Listeners and Instances are two parallel arrays that are always in sync.
  25. executeDispatch(event, dispatchListeners[i], dispatchInstances[i])
  26. }
  27. } else if (dispatchListeners) {
  28. executeDispatch(event, dispatchListeners, dispatchInstances)
  29. }
  30. event._dispatchListeners = null
  31. event._dispatchInstances = null
  32. }
  33. 复制代码

首先对拿到的事件上挂载的 dispatchListeners,就是所有注册事件回调函数的集合,遍历这个集合,如果event.isPropagationStopped() = ture,ok,break 就好了,因为说明在此之前触发的事件已经调用 event.stopPropagation(),isPropagationStopped 的值被置为 true,当前事件以及后面的事件作为父级事件就不应该再被执行了

这里当 event.isPropagationStopped()为 true 时,中断合成事件的向上遍历执行,也就起到了和原生事件调用 stopPropagation 相同的效果 如果循环没有被中断,则继续执行 executeDispatch 方法,至于这个方法,源码地址献上: executeDispatch 源码地址

还有…

后续

合成事件 - 图12

没有后续了,写不动了,接下来大家自行去看源码吧,从中午看踩坑,然后通过 event.nativeEvent.stopImmediatePropagation 解决问题之后,就开始翻阅相关博客文章,去看源码,我炸了,中午 2 点到晚上 10 点,都在看这玩意,我已经吐了,OMG

tips: 绑定的onClick触发的时候 是合成事件触发,而合成事件是会晚原生事件,于是乎,当你点击的时候,实际上,已经冒泡到原生事件了,也就是document上绑定的事件触发了再触发合成事件,此时在合成事件里边去组织,已经晚了。

故而将 document.body.addEventListener 改成 window.addEventListener 就可以了