携手创作,共同成长!这是我参与「掘金日新计划 · 8 月更文挑战」的第9天,点击查看活动详情
本文主要内容摘抄自黄轶老师的慕课网课程Vue.js 源码全方位深入解析 全面深入理解Vue实现原理,主要用于个人学习和复习,不用作其他用途。
我们平时开发工作中,处理组件间的通讯,原生的交互,都离不开事件。对于一个组件元素,我们不仅仅可以绑定原生的 DOM 事件,还可以绑定自定义事件,非常灵活和方便。我们从官网回顾下vue
中事件是如何使用的。
事件处理
基本使用
<div id="example-2">
<button v-on:click="greet">Greet</button>
</div>
var example2 = new Vue({
el: '#example-2',
data: {
name: 'Vue.js'
},
// 在 `methods` 对象中定义方法
methods: {
greet: function (event) {
// `this` 在方法里指向当前 Vue 实例
alert('Hello ' + this.name + '!')
// `event` 是原生 DOM 事件
if (event) {
alert(event.target.tagName)
}
}
}
})
复制代码
除了直接绑定到一个方法,也可以在内联 JavaScript 语句中调用方法:
<div id="example-3">
<button v-on:click="say('hi')">Say hi</button>
<button v-on:click="say('what')">Say what</button>
</div>
复制代码
有时也需要在内联语句处理器中访问原始的 DOM 事件。可以用特殊变量 $event
把它传入方法:
<button v-on:click="warn('Form cannot be submitted yet.', $event)">
Submit
</button>
methods: {
warn: function (message, event) {
// 现在我们可以访问原生事件对象
if (event) {
event.preventDefault()
}
alert(message)
}
}
复制代码
事件修饰符
在事件处理程序中调用 event.preventDefault()
或 event.stopPropagation()
是非常常见的需求。尽管我们可以在方法中轻松实现这点,但更好的方式是:方法只有纯粹的数据逻辑,而不是去处理 DOM 事件细节。
为了解决这个问题,Vue.js 为 v-on
提供了事件修饰符。之前提过,修饰符是由点开头的指令后缀来表示的。
<!-- 阻止单击事件继续传播 -->
<a v-on:click.stop="doThis"></a>
<!-- 提交事件不再重载页面 -->
<form v-on:submit.prevent="onSubmit"></form>
<!-- 只当在 event.target 是当前元素自身时触发处理函数 -->
<!-- 即事件不是从内部元素触发的 -->
<div v-on:click.self="doThat">...</div>
<!-- 点击事件将只会触发一次 -->
// 不像其它只能对原生的 DOM 事件起作用的修饰符,`.once` 修饰符还能被用到自定义的[组件事件]
<a v-on:click.once="doThis"></a>
复制代码
按键修饰符
在监听键盘事件时,我们经常需要检查详细的按键。Vue 允许为 v-on
在监听键盘事件时添加按键修饰符:
<!-- 只有在 `key` 是 `Enter` 时调用 `vm.submit()` -->
<input v-on:keyup.enter="submit">
复制代码
你可以直接将 KeyboardEvent.key
暴露的任意有效按键名转换为 kebab-case 来作为修饰符。
<input v-on:keyup.page-down="onPageDown">
复制代码
在上述示例中,处理函数只会在 $event.key
等于 PageDown
时被调用。
系统修饰键
可以用如下修饰符来实现仅在按下相应按键时才触发鼠标或键盘事件的监听器。
.ctrl
.alt
.shift
.meta
注意:在 Mac 系统键盘上,meta 对应 command 键 (⌘)。在 Windows 系统键盘 meta 对应 Windows 徽标键 (⊞)。
编译
上面介绍事件的基本用法,那么接下来我们从源码角度来看看它的实现原理。
为了更加直观,我们通过一个例子来分析它的实现:
let Child = {
template: '<button @click="clickHandler($event)">' +
'click me' +
'</button>',
methods: {
clickHandler(e) {
console.log('Button clicked!', e)
this.$emit('select')
}
}
}
let vm = new Vue({
el: '#app',
template: '<div>' +
'<child @select="selectHandler" @click.native.prevent="clickHandler"></child>' +
'</div>',
methods: {
clickHandler() {
console.log('Child clicked!')
},
selectHandler() {
console.log('Child select!')
}
},
components: {
Child
}
})
复制代码
先从编译阶段开始看起,在 parse
阶段,当遇到闭合标签的时候会执行closeElement
,这个函数又执行了processElement
,它又执行了processAttrs
function closeElement (element) {
if (!inVPre && !element.processed) {
element = processElement(element, options)
}
}
function processElement (
element: ASTElement,
options: CompilerOptions
) {
...
processRef(element)
processSlotContent(element)
processSlotOutlet(element)
processComponent(element)
...
processAttrs(element)
return element
}
复制代码
const dirRE = /^v-|^@|^:|^\.|^#/
const onRE = /^@|^v-on:/
function processAttrs (el) {
const list = el.attrsList
let i, l, name, rawName, value, modifiers, syncGen, isDynamic
for (i = 0, l = list.length; i < l; i++) {
name = rawName = list[i].name
value = list[i].value
if (dirRE.test(name)) {
// 如果是 v- : @ 开头的说明是绑定了响应式数据
el.hasBindings = true
// 是否有修饰符,比如@click.stop stop就是修饰符
modifiers = parseModifiers(name.replace(dirRE, ''))
...
// 主要是针对事件 @click v-on:click
if (onRE.test(name)) { // v-on
name = name.replace(onRE, '')
...
addHandler(el, name, value, modifiers, false, warn, list[i], isDynamic)
}
}
}
}
const modifierRE = /\.[^.\]]+(?=[^\]]*$)/g
function parseModifiers (name: string): Object | void {
const match = name.match(modifierRE)
if (match) {
const ret = {}
match.forEach(m => { ret[m.slice(1)] = true })
return ret
}
}
复制代码
在对标签属性的处理过程中,判断如果是指令,首先通过 parseModifiers
解析出修饰符,然后判断如果事件的指令,则执行 addHandler(el, name, value, modifiers, false, warn)
方法,它的定义在 src/compiler/helpers.js
中:
export function addHandler (
el: ASTElement,
name: string,
value: string,
modifiers: ?ASTModifiers,
important?: boolean,
warn?: ?Function,
range?: Range,
dynamic?: boolean
) {
modifiers = modifiers || emptyObject
// right middle这是针对鼠标的右键 和 中键的处理
// 可以看到如果修饰符是right,那么实际调用的事件是contextmenu
// 如果修饰符是middle,那么实际调用的事件是mouseup
if (modifiers.right) {
if (name === 'click') {
name = 'contextmenu'
delete modifiers.right
}
} else if (modifiers.middle) {
if (name === 'click') {
name = 'mouseup'
}
}
// 针对修饰符的一系列处理
if (modifiers.capture) {
delete modifiers.capture
name = prependModifierMarker('!', name, dynamic)
}
if (modifiers.once) {
delete modifiers.once
name = prependModifierMarker('~', name, dynamic)
}
if (modifiers.passive) {
delete modifiers.passive
name = prependModifierMarker('&', name, dynamic)
}
let events
// 如果修饰符有native,那么在el上挂载nativeEvents,否则挂载events
if (modifiers.native) {
delete modifiers.native
events = el.nativeEvents || (el.nativeEvents = {})
} else {
events = el.events || (el.events = {})
}
const newHandler: any = rangeSetItem({ value: value.trim(), dynamic }, range)
if (modifiers !== emptyObject) {
newHandler.modifiers = modifiers
}
const handlers = events[name]
// 给events赋值
// 因为对同一个事件可以赋值多个,所以是一个数组,比如用户可以写两个事件@click="handle1" @click="handle2"
if (Array.isArray(handlers)) {
important ? handlers.unshift(newHandler) : handlers.push(newHandler)
} else if (handlers) {
events[name] = important ? [newHandler, handlers] : [handlers, newHandler]
} else {
events[name] = newHandler
}
el.plain = false
}
复制代码
addHandler
函数看起来长,实际上就做了 3 件事情,首先根据 modifier
修饰符对事件名 name
做处理,接着根据 modifier.native
判断是一个纯原生事件还是普通事件,分别对应 el.nativeEvents
和 el.events
,最后按照 name
对事件做归类,并把回调函数的字符串保留到对应的事件中。
在我们的例子中,父组件的 child
节点生成的 el.events
和 el.nativeEvents
如下:
el.events = {
select: {
value: 'selectHandler'
}
}
el.nativeEvents = {
click: {
value: 'clickHandler',
modifiers: {
prevent: true
}
}
}
复制代码
子组件的 button
节点生成的 el.events
如下:
el.events = {
click: {
value: 'clickHandler($event)'
}
}
复制代码
然后在 codegen
的阶段,会在 genData
函数中根据 AST 元素节点上的 events
和 nativeEvents
生成 data
数据,它的定义在 src/compiler/codegen/index.js
中:
export function genData (el: ASTElement, state: CodegenState): string {
let data = '{'
// ...
if (el.events) {
data += `${genHandlers(el.events, false, state.warn)},`
}
if (el.nativeEvents) {
data += `${genHandlers(el.nativeEvents, true, state.warn)},`
}
// ...
return data
}
复制代码
对于这两个属性,会调用 genHandlers
函数,定义在 src/compiler/codegen/events.js
中:
export function genHandlers (
events: ASTElementHandlers,
isNative: boolean
): string {
const prefix = isNative ? 'nativeOn:' : 'on:'
let staticHandlers = ``
for (const name in events) {
const handlerCode = genHandler(events[name])
...
staticHandlers += `"${name}":${handlerCode},`
}
staticHandlers = `{${staticHandlers.slice(0, -1)}}`
}
复制代码
const modifierCode: { [key: string]: string } = {
stop: '$event.stopPropagation();',
prevent: '$event.preventDefault();',
self: genGuard(`$event.target !== $event.currentTarget`),
ctrl: genGuard(`!$event.ctrlKey`),
shift: genGuard(`!$event.shiftKey`),
alt: genGuard(`!$event.altKey`),
meta: genGuard(`!$event.metaKey`),
left: genGuard(`'button' in $event && $event.button !== 0`),
middle: genGuard(`'button' in $event && $event.button !== 1`),
right: genGuard(`'button' in $event && $event.button !== 2`)
}
function genHandler (handler: ASTElementHandler | Array<ASTElementHandler>): string {
if (!handler) {
return 'function(){}'
}
if (Array.isArray(handler)) {
return `[${handler.map(handler => genHandler(handler)).join(',')}]`
}
const isMethodPath = simplePathRE.test(handler.value)
const isFunctionExpression = fnExpRE.test(handler.value)
const isFunctionInvocation = simplePathRE.test(handler.value.replace(fnInvokeRE, ''))
if (!handler.modifiers) {
// 这种情况是@click="clickHandler"
if (isMethodPath || isFunctionExpression) {
return handler.value
}
// 这种情况是@click="clickHandler($event)"
return `function($event){${
isFunctionInvocation ? `return ${handler.value}` : handler.value
}}` // inline statement
} else {
let code = ''
let genModifierCode = ''
const keys = []
for (const key in handler.modifiers) {
if (modifierCode[key]) {
genModifierCode += modifierCode[key]
}
...
}
if (genModifierCode) {
code += genModifierCode
}
const handlerCode = isMethodPath
? `return ${handler.value}.apply(null, arguments)`
: isFunctionExpression
? `return (${handler.value}).apply(null, arguments)`
: isFunctionInvocation
? `return ${handler.value}`
: handler.value
return `function($event){${code}${handlerCode}}`
}
}
复制代码
genHandlers
方法遍历事件对象 events
,对同一个事件名称的事件调用 genHandler(name, events[name])
方法,它的内容看起来多,但实际上逻辑很简单,首先先判断如果 handler
是一个数组,就遍历它然后递归调用 genHandler
方法并拼接结果,然后判断 hanlder.value
是一个函数的调用路径还是一个函数表达式, 接着对 modifiers
做判断,对于没有 modifiers
的情况,就根据 handler.value
不同情况处理,要么直接返回,要么返回一个函数包裹的表达式;对于有 modifiers
的情况,则对各种不同的 modifer
情况做不同处理,添加相应的代码串。
那么对于我们的例子而言,父组件生成的 data
串为:
{
on: {"select": selectHandler},
nativeOn: {"click": function($event) {
$event.preventDefault();
return clickHandler($event)
}
}
}
复制代码
子组件生成的 data
串为:
{
on: {"click": function($event) {
clickHandler($event)
}
}
}
复制代码
那么到这里,编译部分完了,接下来我们来看一下运行时部分是如何实现的。其实 Vue 的事件有 2 种,一种是原生 DOM 事件,一种是用户自定义事件,我们分别来看。
DOM 事件
还记得我们之前在 patch
的时候执行各种 module
的钩子函数吗,当时这部分是略过的,我们之前只分析了 DOM 是如何渲染的,而 DOM 元素相关的属性、样式、事件等都是通过这些 module
的钩子函数完成设置的。
所有和 web 相关的 module
都定义在 src/platforms/web/runtime/modules
目录下,
在patch.js
中:
import * as nodeOps from 'web/runtime/node-ops'
import { createPatchFunction } from 'core/vdom/patch'
import baseModules from 'core/vdom/modules/index'
import platformModules from 'web/runtime/modules/index'
const modules = platformModules.concat(baseModules)
export const patch: Function = createPatchFunction({ nodeOps, modules })
复制代码
baseModules
是在core/vdom/modules/index
中,它包含ref
和directives
:
import directives from './directives'
import ref from './ref'
export default [
ref,
directives
]
复制代码
在执行patch
的时候,首先会收集这些modules:
const hooks = ['create', 'activate', 'update', 'remove', 'destroy']
export function createPatchFunction (backend) {
let i, j
const cbs = {}
const { modules, nodeOps } = backend
for (i = 0; i < hooks.length; ++i) {
cbs[hooks[i]] = []
for (j = 0; j < modules.length; ++j) {
if (isDef(modules[j][hooks[i]])) {
cbs[hooks[i]].push(modules[j][hooks[i]])
}
}
}
...
}
复制代码
那什么时候执行这些hooks
呢?我们来看下createElm
的执行逻辑,首先创建DOM的真实节点,创建完成后,如果vnode.data
存在,那么就执行invokeCreateHooks
function createElm () {
...
if (createComponent(vnode, insertedVnodeQueue, parentElm, refElm)) {
return
}
...
const data = vnode.data
const children = vnode.children
const tag = vnode.tag
if (isDef(tag)) {
vnode.elm = vnode.ns
? nodeOps.createElementNS(vnode.ns, tag)
: nodeOps.createElement(tag, vnode)
setScope(vnode)
...
createChildren(vnode, children, insertedVnodeQueue)
// 如果存在data,即属性,那么就执行invokeCreateHooks
if (isDef(data)) {
invokeCreateHooks(vnode, insertedVnodeQueue)
}
insert(parentElm, vnode.elm, refElm)
...
} else if (isTrue(vnode.isComment)) {
vnode.elm = nodeOps.createComment(vnode.text)
insert(parentElm, vnode.elm, refElm)
} else {
vnode.elm = nodeOps.createTextNode(vnode.text)
insert(parentElm, vnode.elm, refElm)
}
}
复制代码
还有一个地方也执行了invokeCreateHooks
,就是在创建组件的过程中当创建完组件内部的真实DOM后,执行initComponent
,它又执行了invokeCreateHooks
function createComponent (vnode, insertedVnodeQueue, parentElm, refElm) {
let i = vnode.data
if (isDef(i)) {
const isReactivated = isDef(vnode.componentInstance) && i.keepAlive
if (isDef(i = i.hook) && isDef(i = i.init)) {
i(vnode, false /* hydrating */)
}
if (isDef(vnode.componentInstance)) {
initComponent(vnode, insertedVnodeQueue)
insert(parentElm, vnode.elm, refElm)
if (isTrue(isReactivated)) {
reactivateComponent(vnode, insertedVnodeQueue, parentElm, refElm)
}
return true
}
}
}
function initComponent (vnode, insertedVnodeQueue) {
...
vnode.elm = vnode.componentInstance.$el
if (isPatchable(vnode)) {
// 此时vnode为组件的占位符节点
invokeCreateHooks(vnode, insertedVnodeQueue)
setScope(vnode)
} else {
...
insertedVnodeQueue.push(vnode)
}
}
复制代码
下面我们来看看invokeCreateHooks
里面的逻辑:
function invokeCreateHooks (vnode, insertedVnodeQueue) {
for (let i = 0; i < cbs.create.length; ++i) {
cbs.create[i](emptyNode, vnode)
}
...
}
复制代码
除了在create
阶段调用这些hooks
,在update
阶段也调用了
function patchVode() {
...
if (isDef(data) && isPatchable(vnode)) {
for (i = 0; i < cbs.update.length; ++i) cbs.update[i](oldVnode, vnode)
if (isDef(i = data.hook) && isDef(i = i.update)) i(oldVnode, vnode)
}
...
}
复制代码
搞清楚了什么时候执行hooks
,那么现在就来看看这些hookds
的逻辑,这里只关注目录下的 events.js
即可:
// event.js
let target: any
function updateDOMListeners (oldVnode: VNodeWithData, vnode: VNodeWithData) {
if (isUndef(oldVnode.data.on) && isUndef(vnode.data.on)) {
return
}
const on = vnode.data.on || {}
const oldOn = oldVnode.data.on || {}
target = vnode.elm || oldVnode.elm
normalizeEvents(on)
updateListeners(on, oldOn, add, remove, createOnceHandler, vnode.context)
target = undefined
}
export default {
create: updateDOMListeners,
update: updateDOMListeners,
destroy: (vnode: VNodeWithData) => updateDOMListeners(vnode, emptyNode)
}
复制代码
首先获取 vnode.data.on
,这就是我们之前的生成的 data
中对应的事件对象,target
是当前 vnode
对应的 真实 DOM 对象,normalizeEvents
主要是对 v-model
相关的处理,我们之后分析 v-model
的时候会介绍,接着调用 updateListeners(on, oldOn, add, remove, vnode.context)
方法,它的定义在 src/core/vdom/helpers/update-listeners.js
中:
export function updateListeners (
on: Object,
oldOn: Object,
add: Function,
remove: Function,
createOnceHandler: Function,
vm: Component
) {
let name, def, cur, old, event
for (name in on) {
def = cur = on[name]
old = oldOn[name]
event = normalizeEvent(name)
...
if (isUndef(cur)) {
process.env.NODE_ENV !== 'production' && warn(
`Invalid handler for event "${event.name}": got ` + String(cur),
vm
)
} else if (isUndef(old)) {
if (isUndef(cur.fns)) {
cur = on[name] = createFnInvoker(cur, vm)
}
if (isTrue(event.once)) {
cur = on[name] = createOnceHandler(event.name, cur, event.capture)
}
add(event.name, cur, event.capture, event.passive, event.params)
} else if (cur !== old) {
old.fns = cur
on[name] = old
}
}
for (name in oldOn) {
if (isUndef(on[name])) {
event = normalizeEvent(name)
remove(event.name, oldOn[name], event.capture)
}
}
}
复制代码
updateListeners
的逻辑很简单,遍历 on
去添加事件监听,遍历 oldOn
去移除事件监听,关于监听和移除事件的方法都是外部传入的,因为它既处理原生 DOM 事件的添加删除,也处理自定义事件的添加删除。
对于第一次,满足 isUndef(old)
并且 isUndef(cur.fns)
,会执行 cur = on[name] = createFnInvoker(cur)
方法去创建一个回调函数,然后在执行 add(event.name, cur, event.once, event.capture, event.passive, event.params)
完成一次事件绑定。我们先看一下 createFnInvoker
的实现:
export function createFnInvoker (fns: Function | Array<Function>): Function {
function invoker () {
const fns = invoker.fns
if (Array.isArray(fns)) {
const cloned = fns.slice()
for (let i = 0; i < cloned.length; i++) {
cloned[i].apply(null, arguments)
}
} else {
return fns.apply(null, arguments)
}
}
invoker.fns = fns
return invoker
}
复制代码
这里定义了 invoker
方法并返回,由于一个事件可能会对应多个回调函数,所以这里做了数组的判断,多个回调函数就依次调用。注意最后的赋值逻辑, invoker.fns = fns
,每一次执行 invoker
函数都是从 invoker.fns
里取执行的回调函数,回到 updateListeners
,当我们第二次执行该函数的时候,判断如果 cur !== old
,那么只需要更改 old.fns = cur
把之前绑定的 involer.fns
赋值为新的回调函数即可,并且 通过 on[name] = old
保留引用关系,这样就保证了事件回调只添加一次,之后仅仅去修改它的回调函数的引用。
之所以这么巧妙,是因为下面的这段代码:
cur = on[name] = createOnceHandler(event.name, cur, event.capture)
复制代码
当createOnceHandler
返回invoker
函数后,赋值给了on[name]
,当下次更新的时候,old = oldOn[name]
,old
就是invoker
函数,所以我们只需要old.fns = cur
即可。
updateListeners
函数的最后遍历 oldOn
拿到事件名称,判断如果满足 isUndef(on[name])
,则执行 remove(event.name, oldOn[name], event.capture)
去移除事件回调。
了解了 updateListeners
的实现后,我们来看一下在原生 DOM 事件中真正添加回调和移除回调函数的实现,它们的定义都在 src/platforms/web/runtime/modules/event.js
中:
function add (
name: string,
handler: Function,
capture: boolean,
passive: boolean
) {
...
target.addEventListener(
name,
handler,
supportsPassive
? { capture, passive }
: capture
)
}
function remove (
name: string,
handler: Function,
capture: boolean,
_target?: HTMLElement
) {
(_target || target).removeEventListener(
name,
handler._wrapper || handler,
capture
)
}
复制代码
add
和 remove
的逻辑很简单,就是实际上调用原生 addEventListener
和 removeEventListener
,并根据参数传递一些配置。
下面来看看只执行一次的事件是如何完成的?它其实是对事件做了一层包裹,执行完事件后执行一次remove
把事件绑定移除,这样就完成了只执行一次。
function createOnceHandler (event, handler, capture) {
const _target = target // save current target element in closure
return function onceHandler () {
const res = handler.apply(null, arguments)
if (res !== null) {
remove(event, onceHandler, capture, _target)
}
}
}
复制代码
以下面的例子来单步调试下原生事件是如何绑定的,这里只考虑原生事件,不考虑自定义事件。
const Child = {
template: '<button @click="clickHandler($event)">' + 'click me' + '</button>',
methods: {
clickHandler(e) {
console.log('Button clicked!', e)
this.$emit('select')
}
}
}
new Vue({
el: '#app',
template:
'<div>' +
'<child @select="selectHandler" @click.native.prevent="clickHandler"></child>' +
'</div>',
components: {
Child
},
methods: {
clickHandler() {
console.log('Child clicked!')
},
selectHandler() {
console.log('Child select!')
}
}
})
复制代码
通过编译后父组件生成的 data
串为:
{
on: {"select": selectHandler},
nativeOn: {"click": function($event) {
$event.preventDefault();
return clickHandler($event)
}
}
}
复制代码
子组件生成的 data
串为:
{
on: {"click": function($event) {
clickHandler($event)
}
}
}
复制代码
根据上面的分析,等所有的真实DOM节点生成完成以后,开始执行invokeCreateHooks
,所以事件的绑定也是先子后父的顺序,所以先对组件的button
进行事件绑定,当组件内的事件绑定结束后,进行组件占位符vnode的事件绑定,此时target$1
仍然是组件内的button
节点,所以button
绑定了两个click
事件,顺序是组件内的事件优先执行,占位符节点的事件后执行。
在绑定原生事件的时候,我们都是从vnode.data.on
上获取的,但是组件的原生事件是在nativeon
上,这是怎么回事呢?
function updateDOMListeners() {
...
const on = vnode.data.on || {}
const oldOn = oldVnode.data.on || {}
...
}
复制代码
在我们生成组件的占位符节点的时候有这么一段逻辑data.on = data.nativeOn;
export function createComponent() {
...
const baseCtor = context.$options._base;
...
if (isObject(Ctor)) {
Ctor = baseCtor.extend(Ctor);
}
...
data = data || {};
// 把自定义事件赋值给listeners
const listeners = data.on;
// 把nativeOn指给on
data.on = data.nativeOn;
...
const name = Ctor.options.name || tag;
const vnode = new VNode(
`vue-component-${Ctor.cid}${name ? `-${name}` : ""}`,
data,
undefined,
undefined,
undefined,
context,
// 把自定义事件放在这里
{ Ctor, propsData, listeners, tag, children },
asyncFactory
);
return vnode;
}
复制代码
自定义事件
除了原生 DOM 事件,Vue 还支持了自定义事件,并且自定义事件只能作用在组件上,如果在组件上使用原生事件,需要加 .native
修饰符,普通元素上使用 .native
修饰符无效,接下来我们就来分析它的实现。
在 render
阶段,如果是一个组件节点,则通过 createComponent
创建一个组件 vnode
,我们再来回顾这个方法,定义在 src/core/vdom/create-component.js
中:
export function createComponent (
Ctor: Class<Component> | Function | Object | void,
data: ?VNodeData,
context: Component,
children: ?Array<VNode>,
tag?: string
): VNode | Array<VNode> | void {
// ...
const listeners = data.on
data.on = data.nativeOn
// ...
const name = Ctor.options.name || tag
const vnode = new VNode(
`vue-component-${Ctor.cid}${name ? `-${name}` : ''}`,
data, undefined, undefined, undefined, context,
{ Ctor, propsData, listeners, tag, children },
asyncFactory
)
return vnode
}
复制代码
我们只关注事件相关的逻辑,可以看到,它把 data.on
赋值给了 listeners
,把 data.nativeOn
赋值给了 data.on
,这样所有的原生 DOM 事件处理跟我们刚才介绍的一样,它是在当前组件环境中处理的。而对于自定义事件,我们把 listeners
作为 vnode
的 componentOptions
传入,它是在子组件初始化阶段中处理的,所以它的处理环境是子组件。
怎么理解呢?
子组件child
,我们处理原生事件绑定的时候是在子组件内部处理的。当在组件child
上也绑定一个@click.native
原生事件的时候,此时是在app.vue
组件内处理的,在这个组件内child
就是对应的占位符节点,所以上面那段话的意思就是原生事件在各自的组件内处理。自定义事件是绑定在child
身上,此时的组件环境是app.vue
,在这个组件环境下不会处理,只有在child
环境下才会处理自定义事件。(比较绕)
然后在子组件的初始化的时候,会执行 initInternalComponent
方法,它的定义在 src/core/instance/init.js
中:
export function initInternalComponent (vm: Component, options: InternalComponentOptions) {
const opts = vm.$options = Object.create(vm.constructor.options)
// ....
const vnodeComponentOptions = parentVnode.componentOptions
opts._parentListeners = vnodeComponentOptions.listeners
// ...
}
复制代码
这里拿到了父组件传入的 listeners
,然后在执行 initEvents
的过程中,会处理这个 listeners
,定义在 src/core/instance/events.js
中:
export function initEvents (vm: Component) {
vm._events = Object.create(null)
vm._hasHookEvent = false
// init parent attached events
const listeners = vm.$options._parentListeners
if (listeners) {
updateComponentListeners(vm, listeners)
}
}
复制代码
拿到 listeners
后,执行 updateComponentListeners(vm, listeners)
方法:
let target: any
export function updateComponentListeners (
vm: Component,
listeners: Object,
oldListeners: ?Object
) {
target = vm
updateListeners(listeners, oldListeners || {}, add, remove, vm)
target = undefined
}
复制代码
updateListeners
我们之前介绍过,所以对于自定义事件和原生 DOM 事件处理的差异就在事件添加和删除的实现上,来看一下自定义事件 add
和 remove
的实现:
function add(event, fn) {
target.$on(event, fn);
}
function remove(event, fn) {
target.$off(event, fn);
}
复制代码
实际上是利用 Vue 定义的事件中心,简单分析一下它的实现:
export function eventsMixin(Vue: Class<Component>) {
const hookRE = /^hook:/;
Vue.prototype.$on = function (
event: string | Array<string>,
fn: Function
): Component {
const vm: Component = this;
if (Array.isArray(event)) {
for (let i = 0, l = event.length; i < l; i++) {
vm.$on(event[i], fn);
}
} else {
(vm._events[event] || (vm._events[event] = [])).push(fn);
...
}
return vm;
};
Vue.prototype.$once = function (event: string, fn: Function): Component {
const vm: Component = this;
function on() {
vm.$off(event, on);
fn.apply(vm, arguments);
}
on.fn = fn;
vm.$on(event, on);
return vm;
};
Vue.prototype.$off = function (
event?: string | Array<string>,
fn?: Function
): Component {
const vm: Component = this;
// all
if (!arguments.length) {
vm._events = Object.create(null);
return vm;
}
// array of events
if (Array.isArray(event)) {
for (let i = 0, l = event.length; i < l; i++) {
vm.$off(event[i], fn);
}
return vm;
}
// specific event
const cbs = vm._events[event];
if (!cbs) {
return vm;
}
if (!fn) {
vm._events[event] = null;
return vm;
}
// specific handler
let cb;
let i = cbs.length;
while (i--) {
cb = cbs[i];
if (cb === fn || cb.fn === fn) {
cbs.splice(i, 1);
break;
}
}
return vm;
};
Vue.prototype.$emit = function (event: string): Component {
const vm: Component = this;
if (process.env.NODE_ENV !== "production") {
const lowerCaseEvent = event.toLowerCase();
...
}
let cbs = vm._events[event];
if (cbs) {
cbs = cbs.length > 1 ? toArray(cbs) : cbs;
const args = toArray(arguments, 1);
const info = `event handler for "${event}"`;
for (let i = 0, l = cbs.length; i < l; i++) {
invokeWithErrorHandling(cbs[i], vm, args, vm, info);
}
}
return vm;
};
}
复制代码
非常经典的事件中心的实现,把所有的事件用 vm._events
存储起来,当执行 vm.$on(event,fn)
的时候,按事件的名称 event
把回调函数 fn
存储起来 vm._events[event].push(fn)
。
当执行 vm.$emit(event)
的时候,根据事件名 event
找到所有的回调函数 let cbs = vm._events[event]
,然后遍历执行所有的回调函数。
当执行 vm.$off(event,fn)
的时候会移除指定事件名 event
和指定的 fn
当执行 vm.$once(event,fn)
的时候,内部就是执行 vm.$on
,并且当回调函数执行一次后再通过 vm.$off
移除事件的回调,这样就确保了回调函数只执行一次。
所以对于用户自定义的事件添加和删除就是利用了这几个事件中心的 API。需要注意的事一点,vm.$emit
是给当前的 vm
上派发的事件,之所以我们常用它做父子组件通讯,是因为它的回调函数的定义是在父组件中,在构建组件构造函数的时候把回调放到了componentOptions
中,这样就传递到子组件的$options
。对于我们这个例子而言,当子组件的 button
被点击了,它通过 this.$emit('select')
派发事件,那么子组件的实例就监听到了这个 select
事件,并执行它的回调函数——定义在父组件中的 selectHandler
方法,这样就相当于完成了一次父子组件的通讯。
总结
那么至此我们对 Vue 的事件实现有了进一步的了解,Vue 支持 2 种事件类型,原生 DOM 事件和自定义事件,它们主要的区别在于添加和删除事件的方式不一样,并且自定义事件的派发是往当前实例上派发,但是可以利用在父组件环境定义回调函数来实现父子组件的通讯。
另外要注意一点,只有组件节点才可以添加自定义事件,并且添加原生 DOM 事件需要使用 native
修饰符;而普通元素使用 .native
修饰符是没有作用的,也只能添加原生 DOM 事件。