vue源码~render函数、 Virtual DOM、createElement学习

render

Vue 的 _render 方法是实例的一个私有方法,它用来把实例渲染成一个虚拟 Node。它的定义在 src/core/instance/render.js 文件中:

Vue.prototype._render = function (): VNode {

  const vm: Component = this

  const { render, _parentVnode } = vm.$options



  // reset _rendered flag on slots for duplicate slot check

  if (process.env.NODE_ENV !== 'production') {

    for (const key in vm.$slots) {

      // $flow-disable-line

      vm.$slots[key]._rendered = false

    }

  }



  if (_parentVnode) {

    vm.$scopedSlots = _parentVnode.data.scopedSlots || emptyObject

  }



  // 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 {

    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') {

      if (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

      }

    } else {

      vnode = vm._vnode

    }

  }

  // 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

}

这段代码最关键的是 render 方法的调用,我们在平时的开发工作中手写 render 方法的场景比较少,而写的比较多的是 template 模板,在之前的 mounted 方法的实现中,会把 template 编译成 render 方法,但这个编译过程是非常复杂的,我们不打算在这里展开讲,之后会专门花一个章节来分析 Vue 的编译过程。

在 Vue 的官方文档中介绍了 render 函数的第一个参数是 createElement,那么结合之前的例子:

  {{ message }}

相当于我们编写如下 render 函数:

render: function (createElement) {

  return createElement('div', {

     attrs: {

        id: 'app'

      },

  }, this.message)

}

再回到 _render 函数中的 render 方法的调用:

vnode = render.call(vm._renderProxy, vm.$createElement)

可以看到,render 函数中的 createElement 方法就是 vm.$createElement 方法:

export function initRender (vm: Component) {

  // ...

  // bind the createElement fn to this instance

  // so that we get proper render context inside it.

  // args order: tag, data, children, normalizationType, alwaysNormalize

  // internal version is used by render functions compiled from templates

  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)

}

实际上,vm.$createElement 方法定义是在执行 initRender 方法的时候,可以看到除了 vm.$createElement 方法,还有一个 vm._c 方法,它是被模板编译成的 render 函数使用,而 vm.$createElement 是用户手写 render 方法使用的, 这俩个方法支持的参数相同,并且内部都调用了 createElement 方法。

总结

vm._render 最终是通过执行 createElement 方法并返回的是 vnode,它是一个虚拟 Node。Vue 2.0 相比 Vue 1.0 最大的升级就是利用了 Virtual DOM。因此在分析 createElement 的实现前,我们先了解一下 Virtual DOM 的概念。

 

 

Virtual DOM

Virtual DOM 这个概念相信大部分人都不会陌生,它产生的前提是浏览器中的 DOM 是很“昂贵"的,为了更直观的感受,我们可以简单的把一个简单的 div 元素的属性都打印出来,如图所示:

可以看到,真正的 DOM 元素是非常庞大的,因为浏览器的标准就把 DOM 设计的非常复杂。当我们频繁的去做 DOM 更新,会产生一定的性能问题。

而 Virtual DOM 就是用一个原生的 JS 对象去描述一个 DOM 节点,所以它比创建一个 DOM 的代价要小很多。在 Vue.js 中,Virtual DOM 是用 VNode 这么一个 Class 去描述,它是定义在 src/core/vdom/vnode.js 中的。

export default class VNode {

  tag: string | void;

  data: VNodeData | void;

  children: ?Array;

  text: string | void;

  elm: Node | void;

  ns: string | void;

  context: Component | void; // rendered in this component's scope

  key: string | number | void;

  componentOptions: VNodeComponentOptions | void;

  componentInstance: Component | void; // component instance

  parent: VNode | void; // component placeholder node



  // strictly internal

  raw: boolean; // contains raw HTML? (server only)

  isStatic: boolean; // hoisted static node

  isRootInsert: boolean; // necessary for enter transition check

  isComment: boolean; // empty comment placeholder?

  isCloned: boolean; // is a cloned node?

  isOnce: boolean; // is a v-once node?

  asyncFactory: Function | void; // async component factory function

  asyncMeta: Object | void;

  isAsyncPlaceholder: boolean;

  ssrContext: Object | void;

  fnContext: Component | void; // real context vm for functional nodes

  fnOptions: ?ComponentOptions; // for SSR caching

  fnScopeId: ?string; // functional scope id support



  constructor (

    tag?: string,

    data?: VNodeData,

    children?: ?Array,

    text?: string,

    elm?: Node,

    context?: Component,

    componentOptions?: VNodeComponentOptions,

    asyncFactory?: Function

  ) {

    this.tag = tag

    this.data = data

    this.children = children

    this.text = text

    this.elm = elm

    this.ns = undefined

    this.context = context

    this.fnContext = undefined

    this.fnOptions = undefined

    this.fnScopeId = undefined

    this.key = data && data.key

    this.componentOptions = componentOptions

    this.componentInstance = undefined

    this.parent = undefined

    this.raw = false

    this.isStatic = false

    this.isRootInsert = true

    this.isComment = false

    this.isCloned = false

    this.isOnce = false

    this.asyncFactory = asyncFactory

    this.asyncMeta = undefined

    this.isAsyncPlaceholder = false

  }



  // DEPRECATED: alias for componentInstance for backwards compat.

  /* istanbul ignore next */

  get child (): Component | void {

    return this.componentInstance

  }

}

可以看到 Vue.js 中的 Virtual DOM 的定义还是略微复杂一些的,因为它这里包含了很多 Vue.js 的特性。这里千万不要被这些茫茫多的属性吓到,实际上 Vue.js 中 Virtual DOM 是借鉴了一个开源库 snabbdom 的实现,然后加入了一些 Vue.js 特色的东西。我建议大家如果想深入了解 Vue.js 的 Virtual DOM 前不妨先阅读这个库的源码,因为它更加简单和纯粹。

总结

其实 VNode 是对真实 DOM 的一种抽象描述,它的核心定义无非就几个关键属性,标签名、数据、子节点、键值等,其它属性都是都是用来扩展 VNode 的灵活性以及实现一些特殊 feature 的。由于 VNode 只是用来映射到真实 DOM 的渲染,不需要包含操作 DOM 的方法,因此它是非常轻量和简单的。

Virtual DOM 除了它的数据结构的定义,映射到真实的 DOM 实际上要经历 VNode 的 create、diff、patch 等过程。那么在 Vue.js 中,VNode 的 create 是通过之前提到的 createElement 方法创建的,我们接下来分析这部分的实现。

 

createElement

Vue.js 利用 createElement 方法创建 VNode,它定义在 src/core/vdom/create-elemenet.js 中:

// 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 {

  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)

}

createElement 方法实际上是对 _createElement 方法的封装,它允许传入的参数更加灵活,在处理这些参数后,调用真正创建 VNode 的函数 _createElement:

export function _createElement (

  context: Component,

  tag?: string | Class | Function | Object,

  data?: VNodeData,

  children?: any,

  normalizationType?: number

): VNode | Array {

  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

      vnode = new VNode(

        config.parsePlatformTagName(tag), data, children,

        undefined, undefined, context

      )

    } else if (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 方法有 5 个参数,context 表示 VNode 的上下文环境,它是 Component 类型;tag 表示标签,它可以是一个字符串,也可以是一个 Componentdata 表示 VNode 的数据,它是一个 VNodeData 类型,可以在 flow/vnode.js 中找到它的定义,这里先不展开说;children 表示当前 VNode 的子节点,它是任意类型的,它接下来需要被规范为标准的 VNode 数组;normalizationType 表示子节点规范的类型,类型不同规范的方法也就不一样,它主要是参考 render 函数是编译生成的还是用户手写的。

createElement 函数的流程略微有点多,我们接下来主要分析 2 个重点的流程 —— children 的规范化以及 VNode 的创建。

children 的规范化

由于 Virtual DOM 实际上是一个树状结构,每一个 VNode 可能会有若干个子节点,这些子节点应该也是 VNode 的类型。_createElement 接收的第 4 个参数 children 是任意类型的,因此我们需要把它们规范成 VNode 类型。

这里根据 normalizationType 的不同,调用了 normalizeChildren(children) 和 simpleNormalizeChildren(children) 方法,它们的定义都在 src/core/vdom/helpers/normalzie-children.js 中:

// The template compiler attempts to minimize the need for normalization by

// statically analyzing the template at compile time.

//

// For plain HTML markup, normalization can be completely skipped because the

// generated render function is guaranteed to return Array. There are

// two cases where extra normalization is needed:



// 1. When the children contains components - because a functional component

// may return an Array instead of a single root. In this case, just a simple

// normalization is needed - if any child is an Array, we flatten the whole

// thing with Array.prototype.concat. It is guaranteed to be only 1-level deep

// because functional components already normalize their own children.

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

}



// 2. When the children contains constructs that always generated nested Arrays,

// e.g.