eventsMixin
on
监听当前实例上的自定义事件。事件可以由vm.
e
m
i
t
触
发
。
回
调
函
数
会
接
收
所
有
传
入
事
件
触
发
函
数
的
额
外
参
数
如
果
是
数
组
,
迭
代
调
用
emit触发。回调函数会接收所有传入事件触发函数的额外参数 如果是数组,迭代调用
emit触发。回调函数会接收所有传入事件触发函数的额外参数如果是数组,迭代调用on方法,在当前实例的events上添加事件监听
注意,事件如果由$emit触发,那么fn参数为父组件中对应的事件内容
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)
// optimize hook:event cost by using a boolean flag marked at registration
// instead of a hash lookup
if (hookRE.test(event)) {
vm._hasHookEvent = true
}
}
return vm
}
once
创建一个on函数,添加到当前实例
o
n
上
,
当
触
发
后
利
用
on上,当触发后利用
on上,当触发后利用off删除当前实例的函数监听,并执行一次这个函数
Vue.prototype.KaTeX parse error: Expected '}', got 'EOF' at end of input: … () { vm.off(event, on)
fn.apply(vm, arguments)
}
on.fn = fn
vm.$on(event, on)
return vm
}
off
如果没有提供参数,则移除所有的事件监听器;
如果只提供了事件,则移除该事件所有的监听器;
如果同时提供了事件与回调,则只移除这个回调的监听器。
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
}
emit
Vue.prototype.$emit = function (event: string): Component {
const vm: Component = this
if (process.env.NODE_ENV !== 'production') {
const lowerCaseEvent = event.toLowerCase()
if (lowerCaseEvent !== event && vm._events[lowerCaseEvent]) {
tip(
`Event "${lowerCaseEvent}" is emitted in component ` +
`${formatComponentName(vm)} but the handler is registered for "${event}". ` +
`Note that HTML attributes are case-insensitive and you cannot use ` +
`v-on to listen to camelCase events when using in-DOM templates. ` +
`You should probably use "${hyphenate(event)}" instead of "${event}".`
)
}
}
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
}
renderMixin
installRenderHelpers(Vue.prototype)
里面是一些渲染时候的帮助方法,全部挂载到Vue.prototype上,比如创建空节点、创建文本节点、toNumber、toString等等。
$nextTick
使用异步函数来执行
Vue.prototype.$nextTick = function (fn: Function) {
return nextTick(fn, this)
}
src\core\util\next-tick.js
把nextTick回调函数添加到callbacks中,然后利用异步微任务延迟执行回调函数,等待渲染完成之后再执行
使用异步方式优先级如下
1、promise
2、MutationObserver
3、setImmediate
4、setTimeOut
export function nextTick (cb?: Function, ctx?: Object) {
let _resolve
callbacks.push(() => {
if (cb) {
try {
cb.call(ctx)
} catch (e) {
handleError(e, ctx, 'nextTick')
}
} else if (_resolve) {
_resolve(ctx)
}
})
if (!pending) {
pending = true
timerFunc()
}
// $flow-disable-line
if (!cb && typeof Promise !== 'undefined') {
return new Promise(resolve => {
_resolve = resolve
})
}
}
_render
整段代码最重要的是调用render函数
render函数我们写的比较少,一般都是使用template
其实在mounted方法里面,我们写的template会被编译成render方法
vm._render 最终是通过执行 createElement 方法并返回的是 vnode,它是一个虚拟 Node。Vue 2.0 相比 Vue 1.0 最大的升级就是利用了 Virtual DOM。
生成Vnode方法render.call(vm._renderProxy,vm.$createElement)中,第一个参数vm._renderProxy,其实就是vm实例,定义在src\core\instance\init.js的_init方法中
为什么我们模板中如果写了多个根标签会报错?
因为通过template编译后变成的render函数,执行后会返回Vnode,此时如果返回的vnode是一个数组,那么说明我们的template是多根节点,就会提示报错
Vue.prototype._render = function (): VNode {
const vm: Component = this
const { render, _parentVnode } = vm.$options
if (_parentVnode) {
vm.$scopedSlots = normalizeScopedSlots(
_parentVnode.data.scopedSlots,
vm.$slots,
vm.$scopedSlots
)
}
// set parent vnode. this allows render functions to have access
// to the data on the placeholder node.
vm.$vnode = _parentVnode
// render self
let vnode
try {
// There's no need to maintain a stack because all render fns are called
// separately from one another. Nested component's render fns are called
// when parent component is patched.
currentRenderingInstance = vm
vnode = render.call(vm._renderProxy, vm.$createElement)
} catch (e) {
handleError(e, vm, `render`)
// return error render result,
// or previous vnode to prevent render error causing blank component
/* istanbul ignore else */
if (process.env.NODE_ENV !== 'production' && vm.$options.renderError) {
try {
vnode = vm.$options.renderError.call(vm._renderProxy, vm.$createElement, e)
} catch (e) {
handleError(e, vm, `renderError`)
vnode = vm._vnode
}
} else {
vnode = vm._vnode
}
} finally {
currentRenderingInstance = null
}
// if the returned array contains only a single node, allow it
if (Array.isArray(vnode) && vnode.length === 1) {
vnode = vnode[0]
}
// return empty vnode in case the render function errored out
if (!(vnode instanceof VNode)) {
if (process.env.NODE_ENV !== 'production' && Array.isArray(vnode)) {
warn(
'Multiple root nodes returned from render function. Render function ' +
'should return a single root node.',
vm
)
}
vnode = createEmptyVNode()
}
// set parent
vnode.parent = _parentVnode
return vnode
}
renderMixin里面,有一句代码
render.call(vm._renderProxy, vm.$createElement)
其中有两个重点,一个是render函数是怎么来的,另一个是$createElement是什么
render函数由来
从入口编译文件src\platforms\web\entry-runtime-with-compiler.js 看可以发现,在扩展$mount的源码中有一句:
const { render, staticRenderFns } = compileToFunctions(template, {
outputSourceRange: process.env.NODE_ENV !== 'production',
shouldDecodeNewlines,
shouldDecodeNewlinesForHref,
delimiters: options.delimiters,
comments: options.comments
}, this)
render函数生成的走向其实是一个函数柯里化过程,一层层的函数返回函数进行包裹嵌套,是俄罗斯套娃的实现形式
compileToFunctions是怎么生成的
createCompiler -》 createCompilerCreator -》 createCompiler -》 createCompileToFunctionFn -》compileToFunctions
compileToFunctions 其实是createCompileToFunctionFn返回的一个柯里化函数
compileToFunctions 作用就是添加vm缓存信息,调用compile函数进行编译然后变成render函数
compile函数的创建过程
createCompiler 其实是一个常量
createCompilerCreator 主要是提供一个通用的compile方法
createCompiler 主要是处理option的一些逻辑,然后调用createCompilerCreator 提供处理后的option作为参数,生成compile函数
compile函数
export function createCompilerCreator (baseCompile: Function): Function {
return function createCompiler (baseOptions: CompilerOptions) {
function compile (
template: string,
options?: CompilerOptions
): CompiledResult {
const finalOptions = Object.create(baseOptions)
const errors = []
const tips = []
let warn = (msg, range, tip) => {
(tip ? tips : errors).push(msg)
}
if (options) {
if (process.env.NODE_ENV !== 'production' && options.outputSourceRange) {
// $flow-disable-line
const leadingSpaceLength = template.match(/^\s*/)[0].length
warn = (msg, range, tip) => {
const data: WarningMessage = { msg }
if (range) {
if (range.start != null) {
data.start = range.start + leadingSpaceLength
}
if (range.end != null) {
data.end = range.end + leadingSpaceLength
}
}
(tip ? tips : errors).push(data)
}
}
// merge custom modules
if (options.modules) {
finalOptions.modules =
(baseOptions.modules || []).concat(options.modules)
}
// merge custom directives
if (options.directives) {
finalOptions.directives = extend(
Object.create(baseOptions.directives || null),
options.directives
)
}
// copy other options
for (const key in options) {
if (key !== 'modules' && key !== 'directives') {
finalOptions[key] = options[key]
}
}
}
finalOptions.warn = warn
const compiled = baseCompile(template.trim(), finalOptions)
if (process.env.NODE_ENV !== 'production') {
detectErrors(compiled.ast, warn)
}
compiled.errors = errors
compiled.tips = tips
return compiled
}
return {
compile,
compileToFunctions: createCompileToFunctionFn(compile)
}
}
}
baseCompile是怎么创建render函数的
export const createCompiler = createCompilerCreator(function baseCompile (
template: string,
options: CompilerOptions
): CompiledResult {
const ast = parse(template.trim(), options)
if (options.optimize !== false) {
optimize(ast, options)
}
const code = generate(ast, options)
return {
ast,
render: code.render,
staticRenderFns: code.staticRenderFns
}
})
ast:
检测静态子树
1。把它们变成常数,这样我们就不需要在每次重新渲染时为它们创建新的节点;
2。在打补丁的过程中完全跳过它们。
if (options.optimize !== false) {
optimize(ast, options)
}
最终我们找到src\compiler\codegen\index.js
render函数是通过ast抽象语法树配合renderMixin提到过的installRenderHelpers帮助渲染语法来返回出如下一段字符串,标注着模板中每个节点的信息
“_c(‘div’,{attrs:{“id”:“demo”}},[_c(‘welcome-button’,{on:{“welcome”:sayHi}}),_v(”\n “+_s(currentBranch)+”\n “)],1)”
export function generate (
ast: ASTElement | void,
options: CompilerOptions
): CodegenResult {
const state = new CodegenState(options)
const code = ast ? genElement(ast, state) : '_c("div")'
return {
render: `with(this){return ${code}}`,
staticRenderFns: state.staticRenderFns
}
}
$createElement
这个方法是在initRender里面创建的,它是一个函数,返回一个函数。
参数a,b,c,d的由来:
在调用_render渲染虚拟DOM的时候,我们执行了一句话
vnode = render.call(vm._renderProxy, vm.$createElement)
由上render函数生成所知,render函数出来的是这样的
const code = ast ? genElement(ast, state) : '_c("div")'
render: `with(this){return ${code}}`,
也就是说把Vue的实例this绑定到当前上下文,而在render函数的code中,内容是如下
"_c('div',{attrs:{"id":"demo"}},[_c('welcome-button',{on:{"welcome":sayHi}}),_v("\n "+_s(currentBranch)+"\n ")],1)"
所以执行到render.call(vm._renderProxy, vm.$createElement)这个方法时候,_c就会变成this._c,也就是vm._c
那么上面的内容会变成什么样呢?
其实就是
vm._c('div',{attrs:{"id":"demo"}},[_c('welcome-button',{on:{"welcome":sayHi}}),_v("\n "+_s(currentBranch)+"\n ")],1)
对应出来的a b c d 的参数就是这样来的
//将createElement fn绑定到这个实例
//这样我们就能在里面得到合适的渲染上下文。
// args order: tag, data, children, normalizationType, alwaysNormalize
//内部版本由模板编译的渲染函数使用
vm._c = (a, b, c, d) => createElement(vm, a, b, c, d, false)
// normalization is always applied for the public version, used in
// user-written render functions.
vm.$createElement = (a, b, c, d) => createElement(vm, a, b, c, d, true)
createElement
createElement 方法实际上是对 _createElement 方法的封装,它允许传入的参数更加灵活,在处理这些参数后,调用真正创建 VNode 的函数 _createElement
context 当前 vm 实例
tag 当前标签
data VNode的data
children 当前VNode的子节点
normalizationType
alwaysNormalize 当render函数是手写的时候,这个为true,当render函数是根据template编译生成的这个为false
const SIMPLE_NORMALIZE = 1
const ALWAYS_NORMALIZE = 2
// wrapper function for providing a more flexible interface
// without getting yelled at by flow
export function createElement (
context: Component,
tag: any,
data: any,
children: any,
normalizationType: any,
alwaysNormalize: boolean
): VNode | Array<VNode> {
if (Array.isArray(data) || isPrimitive(data)) {
normalizationType = children
children = data
data = undefined
}
if (isTrue(alwaysNormalize)) {
normalizationType = ALWAYS_NORMALIZE
}
return _createElement(context, tag, data, children, normalizationType)
}
export function _createElement (
context: Component,
tag?: string | Class<Component> | Function | Object,
data?: VNodeData,
children?: any,
normalizationType?: number
): VNode | Array<VNode> {
if (isDef(data) && isDef((data: any).__ob__)) {
process.env.NODE_ENV !== 'production' && warn(
`Avoid using observed data object as vnode data: ${JSON.stringify(data)}\n` +
'Always create fresh vnode data objects in each render!',
context
)
return createEmptyVNode()
}
// object syntax in v-bind
if (isDef(data) && isDef(data.is)) {
tag = data.is
}
if (!tag) {
// in case of component :is set to falsy value
return createEmptyVNode()
}
// warn against non-primitive key
if (process.env.NODE_ENV !== 'production' &&
isDef(data) && isDef(data.key) && !isPrimitive(data.key)
) {
if (!__WEEX__ || !('@binding' in data.key)) {
warn(
'Avoid using non-primitive value as key, ' +
'use string/number value instead.',
context
)
}
}
// support single function children as default scoped slot
if (Array.isArray(children) &&
typeof children[0] === 'function'
) {
data = data || {}
data.scopedSlots = { default: children[0] }
children.length = 0
}
if (normalizationType === ALWAYS_NORMALIZE) {
children = normalizeChildren(children)
} else if (normalizationType === SIMPLE_NORMALIZE) {
children = simpleNormalizeChildren(children)
}
let vnode, ns
if (typeof tag === 'string') {
let Ctor
ns = (context.$vnode && context.$vnode.ns) || config.getTagNamespace(tag)
if (config.isReservedTag(tag)) {
// platform built-in elements
if (process.env.NODE_ENV !== 'production' && isDef(data) && isDef(data.nativeOn)) {
warn(
`The .native modifier for v-on is only valid on components but it was used on <${tag}>.`,
context
)
}
vnode = new VNode(
config.parsePlatformTagName(tag), data, children,
undefined, undefined, context
)
} else if ((!data || !data.pre) && isDef(Ctor = resolveAsset(context.$options, 'components', tag))) {
// component
vnode = createComponent(Ctor, data, context, children, tag)
} else {
// unknown or unlisted namespaced elements
// check at runtime because it may get assigned a namespace when its
// parent normalizes children
vnode = new VNode(
tag, data, children,
undefined, undefined, context
)
}
} else {
// direct component options / constructor
vnode = createComponent(tag, data, context, children)
}
if (Array.isArray(vnode)) {
return vnode
} else if (isDef(vnode)) {
if (isDef(ns)) applyNS(vnode, ns)
if (isDef(data)) registerDeepBindings(data)
return vnode
} else {
return createEmptyVNode()
}
}
_createElement
1、如果不为null或undefined,且已添加响应式数据监听则报错
SIMPLE_NORMALIZE 普通html标签
ALWAYS_NORMALIZE Vue组件标签
children相关
如果是SIMPLE_NORMALIZE,则判断children是否还是嵌套数组,然后全部展平
simpleNormalizeChildren 方法调用场景是 render 函数是编译生成的。理论上编译生成的 children 都已经是 VNode 类型的,但这里有一个例外,就是 functional component 函数式组件返回的是一个数组而不是一个根节点,所以会通过 Array.prototype.concat 方法把整个 children 数组打平,让它的深度只有一层。
//模板编译器试图最小化对标准化的需求
//编译时静态分析模板。
//
//对于普通HTML标记,可以完全跳过标准化,因为
//生成的渲染函数保证返回数组。
//有两种需要额外归一化的情况:
// 1。当子组件包含组件时——因为是功能组件
//可能会返回一个数组,而不是单个根。在这种情况下,很简单
//需要归一化——如果任何一个子元素是一个数组,我们就把它整平
//关于数组的东西。它保证只有1级深
//因为功能组件已经将它们自己的子组件规范化了。
export function simpleNormalizeChildren (children: any) {
for (let i = 0; i < children.length; i++) {
if (Array.isArray(children[i])) {
return Array.prototype.concat.apply([], children)
}
}
return children
}
normalizeChildren 方法调用是因为手写render函数就会调用。我们手写有两种方法定义我们的children
第一种,直接写文本属性不内嵌标签
render(h) {
return h('div',{attrs:{id:'app'}},this.message)
}
第二种,数组形式,可以写入多个内容
render(h) {
return h('div',{attrs:{id:'app'}},[h('div',this.message)])
}
以上两种写法都可以渲染出来
normalizeChildren
由于有上面两种写法,所以先判断是否是基础类型即string,如果是则直接创建文本节点,如果不是,则判断是不是数组,如果是则调用normalizeArrayChildren 方法,如果不是那么就识别不了直接当做没有子节点处理。
normalizeArrayChildren 递归去找children其实最后也是返回一个一层的数组
// 2. When the children contains constructs that always generated nested Arrays,
// e.g. <template>, <slot>, v-for, or when the children is provided by user
// with hand-written render functions / JSX. In such cases a full normalization
// is needed to cater to all possible types of children values.
export function normalizeChildren (children: any): ?Array<VNode> {
return isPrimitive(children)
? [createTextVNode(children)]
: Array.isArray(children)
? normalizeArrayChildren(children)
: undefined
}
function isTextNode (node): boolean {
return isDef(node) && isDef(node.text) && isFalse(node.isComment)
}
function normalizeArrayChildren (children: any, nestedIndex?: string): Array<VNode> {
const res = []
let i, c, lastIndex, last
for (i = 0; i < children.length; i++) {
c = children[i]
if (isUndef(c) || typeof c === 'boolean') continue
lastIndex = res.length - 1
last = res[lastIndex]
// nested
if (Array.isArray(c)) {
if (c.length > 0) {
c = normalizeArrayChildren(c, `${nestedIndex || ''}_${i}`)
// merge adjacent text nodes
if (isTextNode(c[0]) && isTextNode(last)) {
res[lastIndex] = createTextVNode(last.text + (c[0]: any).text)
c.shift()
}
res.push.apply(res, c)
}
} else if (isPrimitive(c)) {
if (isTextNode(last)) {
// merge adjacent text nodes
// this is necessary for SSR hydration because text nodes are
// essentially merged when rendered to HTML strings
res[lastIndex] = createTextVNode(last.text + c)
} else if (c !== '') {
// convert primitive to vnode
res.push(createTextVNode(c))
}
} else {
if (isTextNode(c) && isTextNode(last)) {
// merge adjacent text nodes
res[lastIndex] = createTextVNode(last.text + c.text)
} else {
// default key for nested array children (likely generated by v-for)
if (isTrue(children._isVList) &&
isDef(c.tag) &&
isUndef(c.key) &&
isDef(nestedIndex)) {
c.key = `__vlist${nestedIndex}_${i}__`
}
res.push(c)
}
}
}
return res
}
以上处理完children之后开始处理tag
1、如果tag为字符串
①判断是否是平台保留字符串,如果是则创建平台相关标签
②判断是否在实例component属性上定义了的字符串,如果是则判定是组件
③老子也不知道是啥,照着他提供的tag来创建
2、不是字符串,当做组件创建