读Vue源码2---组件挂载$mount

378 阅读6分钟

在调用_init方法最后挂载组件vm.mount(vm.options.el);

 /**
  * 先调用扩展的$mount方法,生成render
  * 在调用原始的$mount     获得元素,在调用mountComponent方法
  */
 vm.$mount(vm.$options.el);

扩展的$mount

src/platforms/web/entry-runtime-with-compiler.js 文件,这个文件是完整版Vue(运行时+编译器)的入口文件。

// 扩展$mount方法,先保存原先的$mount方法,在对其重写
const mount = Vue.prototype.$mount
// 生成render函数,没有render函数 会把 el 或者 template 字符串转换成 render ⽅法
// 对于template是对其编译,对el是获取 outerHTML生成template
Vue.prototype.$mount = function (
  el?: string | Element,
  hydrating?: boolean
): Component {
  // 调用query方法
  /* query (el: string | Element): Element 传入el为string或Element,返回Element
    el是字符串,找到了该节点就返回,没找到就返回一个div
    el是节点就直接返回
  */
  el = el && query(el)

  /* istanbul ignore if */
  // 判断传入的节点,不能是body或 documentElement文档
  if (el === document.body || el === document.documentElement) {
    process.env.NODE_ENV !== 'production' && warn(
      `Do not mount Vue to <html> or <body> - mount to normal elements instead.`
    )
    return this
  }

  const options = this.$options
  // resolve template/el and convert to render function
  // 没有render函数 会把 el 或者 template 字符串转换成 render ⽅法
  // 先生成template,再将template编译成render函数
  if (!options.render) {
    let template = options.template
    // 有template
    if (template) {
      if (typeof template === 'string') {
        // template是字符串,获取模板字符串
        if (template.charAt(0) === '#') {
          template = idToTemplate(template)
          /* istanbul ignore if */
          if (process.env.NODE_ENV !== 'production' && !template) {
            warn(
              `Template element not found or is empty: ${options.template}`,
              this
            )
          }
        }
      } else if (template.nodeType) {
        // template是DOM节点,就获取内容作为模板
        template = template.innerHTML
      } else {
        if (process.env.NODE_ENV !== 'production') {
          warn('invalid template option:' + template, this)
        }
        return this
      }
    } else if (el) {
      // 没有template就生成一个,并转换成 render ⽅法
      template = getOuterHTML(el)
    }
     if (template) {
      // 如果是模板字符串,需要用编译器编译,返回一个render函数
      const { render, staticRenderFns } = compileToFunctions(template, {
        outputSourceRange: process.env.NODE_ENV !== 'production',
        shouldDecodeNewlines,
        shouldDecodeNewlinesForHref,
        delimiters: options.delimiters,
        comments: options.comments
      }, this)
      options.render = render
      options.staticRenderFns = staticRenderFns
    }
  }
  // 调用原始的mount方法
  return mount.call(this, el, hydrating)
}

原始的mount

src/platforms/web/runtime/index.js这里的$mount是一个public mount method。之所以这么说是因为Vue有很多构建版本,有些版本会依赖此方法进行有些功能定制

// public mount method
Vue.prototype.$mount = function (
  el?: string | Element,
  hydrating?: boolean
): Component {
// 判断el, 以及宿主环境, 然后通过工具函数query重写el。
  el = el && inBrowser ? query(el) : undefined
  // 执行真正的挂载并返回
  return mountComponent(this, el, hydrating)
}

mountComponent函数

  callHook(vm, "beforeMount");
// 先执行vm._render()返回vnode,作为参数传入 vm._update做DOM更新
 vm._update(vm._render(), hydrating);
 if (vm.$vnode == null) {
    vm._isMounted = true;
    callHook(vm, "mounted");
 }
 return vm;

vm._render

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

vm._update接受参数Vnode

if (!prevVnode) {
      // 首次渲染
      // initial render
      vm.$el = vm.__patch__(vm.$el, vnode, hydrating, false /* removeOnly */);
    } else {
      // 数据更新,diff 返回新的DOM
      // updates
      vm.$el = vm.__patch__(prevVnode, vnode);
    }

src/platforms/web/runtime/index.js

// 浏览器中? patch : noop
Vue.prototype.__patch__ = inBrowser ? patch : noop;

patch函数src/platforms/web/runtime/patch.js

// 扩展操作:将通用模块和浏览器特有模块合并
const modules = platformModules.concat(baseModules)
// nodeOps:对浏览器DOM操作
// platformModules:所有属性操作
//工厂函数:创建浏览器特有patch函数,主要解决跨平台问题
export const patch: Function = createPatchFunction({ nodeOps, modules })

createPatchFunction返回一个patch方法(进行数据更新的方法,diff)

patch函数:新的虚拟DOM -> diff 旧的虚拟DOM(真实DOM) -> 更新旧的虚拟DOM ->同步真的DOM

增:old VNode不存在就增

删:new VNode不存在就删

改:⽐较类型,类型不同直接替换、类型相同执⾏更新

  return function patch(oldVnode, vnode, hydrating, removeOnly) {

    // isUndef没定义
    // 新节点中不存在,删除oldVnode
    if (isUndef(vnode)) {
      if (isDef(oldVnode)) invokeDestroyHook(oldVnode)
      return
    }
    // oldVnode不存在,新增
    if (isUndef(oldVnode)) {
      createElm(vnode, insertedVnodeQueue)
    } else {
      // 改
      // oldVnode有nodeType则是真实DOM
      const isRealElement = isDef(oldVnode.nodeType)
      if (!isRealElement && sameVnode(oldVnode, vnode)) {
        // 自定义组件补丁操作
        patchVnode(oldVnode, vnode, insertedVnodeQueue, null, null, removeOnly)
      } else {
        // 传入的是dom
        if (isRealElement) {
          // 将该dom元素清空
          oldVnode = emptyNodeAt(oldVnode)
        }
        /*取代现有元素:*/
        // replacing existing element
        const oldElm = oldVnode.elm
        const parentElm = nodeOps.parentNode(oldElm)
        //创建⼀个新的dom
        // create new node
        createElm(
          vnode,
          insertedVnodeQueue,
          oldElm._leaveCb ? null : parentElm,
          nodeOps.nextSibling(oldElm)
        )
    }

    invokeInsertHook(vnode, insertedVnodeQueue, isInitialPatch)
    return vnode.elm
  }

patchVnode函数

如果符合sameVnode,就不会渲染vnode重新创建DOM节点,而是在原有的DOM节点上进行修补,尽可能复用原有的DOM节点。

// 组件更新 两个组件diff
// 两个VNode类型相同,就执⾏更新操作,包括三种类型操作:属性更新PROPS、⽂本更新TEXT、⼦节点更新REORDER
/**
 *0.如果两个节点相同则直接返回
 *1. 如果新旧VNode都是静态的,同时它们的key相同(代表同⼀节点),并且新的VNode是clone或者
 是标记了v-once,那么只需要替换elm以及componentInstance即可。
 2. 新⽼节点均有children⼦节点,则对⼦节点进⾏diff操作,调⽤updateChildren ,这个updateChildren也是diff的核⼼。
 3. 如果⽼节点没有⼦节点⽽新节点存在⼦节点,先清空⽼节点DOM的⽂本内容,然后为当前DOM节点加⼊⼦节点。
 4. 当新节点没有⼦节点⽽⽼节点有⼦节点的时候,则移除该DOM节点的所有⼦节点
 5. 当新⽼节点都⽆⼦节点的时候,只是⽂本的替换 
*
*/
function patchVnode(
    oldVnode,
    vnode,
    insertedVnodeQueue,
    ownerArray,
    index,
    removeOnly
  ) {
    /*两个VNode节点相同则直接返回*/
    if (oldVnode === vnode) {
      return
    }
    const elm = vnode.elm = oldVnode.elm
    // 异步组件特殊处理
    if (isTrue(oldVnode.isAsyncPlaceholder)) {
      if (isDef(vnode.asyncFactory.resolved)) {
        hydrate(oldVnode.elm, vnode, insertedVnodeQueue)
      } else {
        vnode.isAsyncPlaceholder = true
      }
      return
    }

    // 静态节点可复用 更新componentInstance跳过  <h1></h1>
    // 对应第一条
    /*
      如果新旧VNode都是静态的,同时它们的key相同(代表同⼀节点),
      并且新的VNode是clone或者是标记了once(标记v-once属性,只渲染⼀次),
      那么只需要替换elm以及componentInstance即可。
    */
    if (isTrue(vnode.isStatic) &&
      isTrue(oldVnode.isStatic) &&
      vnode.key === oldVnode.key &&
      (isTrue(vnode.isCloned) || isTrue(vnode.isOnce))
    ) {
      vnode.componentInstance = oldVnode.componentInstance
      return
    }

    /*如果存在data.hook.prepatch则要先执⾏*/
    let i
    const data = vnode.data
    if (isDef(data) && isDef(i = data.hook) && isDef(i = i.prepatch)) {
      i(oldVnode, vnode)
    }

    // 节点更新
    const oldCh = oldVnode.children
    const ch = vnode.children

    // 属性更新
    /*执⾏属性、事件、样式等等更新操作*/
    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)
    }

    // 没有定义text
    if (isUndef(vnode.text)) {
      // 新旧都有定义
      if (isDef(oldCh) && isDef(ch)) {
        /*新⽼节点均有children⼦节点,则对⼦节点进⾏diff操作,调⽤updateChildren*/
        if (oldCh !== ch) updateChildren(elm, oldCh, ch, insertedVnodeQueue, removeOnly)
      } else if (isDef(ch)) {
        /*如果⽼节点没有⼦节点⽽新节点存在⼦节点,先清空elm的⽂本内容,然后为当前节点加⼊⼦节点*/
        if (isDef(oldVnode.text)) nodeOps.setTextContent(elm, '')
        addVnodes(elm, null, ch, 0, ch.length - 1, insertedVnodeQueue)

      } else if (isDef(oldCh)) {
        /*当新节点没有⼦节点⽽⽼节点有⼦节点的时候,则移除所有ele的⼦节点*/
        removeVnodes(oldCh, 0, oldCh.length - 1)
      } else if (isDef(oldVnode.text)) {
        /*当新⽼节点都⽆⼦节点的时候,只是⽂本的替换,因为这个逻辑中新节点text不存在,所以
          清除ele⽂本*/
        nodeOps.setTextContent(elm, '')
      }
    } else if (oldVnode.text !== vnode.text) {
      // 新的有文本 <div>abc</div>,直接设置dom的文本
      // 当新⽼节点都⽆⼦节点的时候,只是⽂本的替换,对应第五条
      nodeOps.setTextContent(elm, vnode.text)
    }
    // 钩子函数 /*调⽤postpatch钩⼦*/
    if (isDef(data)) {
      if (isDef(i = data.hook) && isDef(i = i.postpatch)) i(oldVnode, vnode)
    }
  }

updateChildren函数

/**
 * 双循环
 *updateChildren
 */
  function updateChildren(parentElm, oldCh, newCh, insertedVnodeQueue, removeOnly) {
    let oldStartIdx = 0
    let newStartIdx = 0
    let oldEndIdx = oldCh.length - 1
    let oldStartVnode = oldCh[0]
    let oldEndVnode = oldCh[oldEndIdx]
    let newEndIdx = newCh.length - 1
    let newStartVnode = newCh[0]
    let newEndVnode = newCh[newEndIdx]
    let oldKeyToIdx, idxInOld, vnodeToMove, refElm

    // 确保移除元素在过度动画过程中待在正确的相对位置,仅⽤于<transition-group>
    const canMove = !removeOnly

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

    // 循环条件:任意起始索引超过结束索引就结束
    while (oldStartIdx <= oldEndIdx && newStartIdx <= newEndIdx) {
      if (isUndef(oldStartVnode)) {
        oldStartVnode = oldCh[++oldStartIdx] // Vnode has been moved left
      } else if (isUndef(oldEndVnode)) {
        oldEndVnode = oldCh[--oldEndIdx]
      } else if (sameVnode(oldStartVnode, newStartVnode)) {
        /*分别⽐较oldCh以及newCh的两头节点4种情况,判定为同⼀个VNode,则直接patchVnode即可*/
        patchVnode(oldStartVnode, newStartVnode, insertedVnodeQueue, newCh, newStartIdx)
        oldStartVnode = oldCh[++oldStartIdx]
        newStartVnode = newCh[++newStartIdx]
      } else if (sameVnode(oldEndVnode, newEndVnode)) {
        patchVnode(oldEndVnode, newEndVnode, insertedVnodeQueue, newCh, newEndIdx)
        oldEndVnode = oldCh[--oldEndIdx]
        newEndVnode = newCh[--newEndIdx]
      } else if (sameVnode(oldStartVnode, newEndVnode)) { // Vnode moved right
        patchVnode(oldStartVnode, newEndVnode, insertedVnodeQueue, newCh, newEndIdx)
        canMove && nodeOps.insertBefore(parentElm, oldStartVnode.elm, nodeOps.nextSibling(oldEndVnode.elm))
        oldStartVnode = oldCh[++oldStartIdx]
        newEndVnode = newCh[--newEndIdx]
      } else if (sameVnode(oldEndVnode, newStartVnode)) { // Vnode moved left
        patchVnode(oldEndVnode, newStartVnode, insertedVnodeQueue, newCh, newStartIdx)
        canMove && nodeOps.insertBefore(parentElm, oldEndVnode.elm, oldStartVnode.elm)
        oldEndVnode = oldCh[--oldEndIdx]
        newStartVnode = newCh[++newStartIdx]
      } else {
        /*
          ⽣成⼀个哈希表,key是旧VNode的key,值是该VNode在旧VNode中索引
        */
        if (isUndef(oldKeyToIdx)) oldKeyToIdx = createKeyToOldIdx(oldCh, oldStartIdx, oldEndIdx)
        /*如果newStartVnode存在key并且这个key在oldVnode中能找到则返回这个节点的索引*/
        idxInOld = isDef(newStartVnode.key)
          ? oldKeyToIdx[newStartVnode.key]
          : findIdxInOld(newStartVnode, oldCh, oldStartIdx, oldEndIdx)
        if (isUndef(idxInOld)) { // New element
          /*没有key或者是该key没有在⽼节点中找到则创建⼀个新的节点*/
          createElm(newStartVnode, insertedVnodeQueue, parentElm, oldStartVnode.elm, false, newCh, newStartIdx)
        } else {
          /*获取同key的⽼节点*/
          vnodeToMove = oldCh[idxInOld]
          if (sameVnode(vnodeToMove, newStartVnode)) {
            /*如果新VNode与得到的有相同key的节点是同⼀个VNode则进⾏patchVnode*/
            patchVnode(vnodeToMove, newStartVnode, insertedVnodeQueue, newCh, newStartIdx)
            /*因为已经patchVnode进去了,所以将这个⽼节点赋值undefined,之后如果还有新节
              点与该节点key相同可以检测出来提示已有重复的key
            */
            oldCh[idxInOld] = undefined
            /*当有标识位canMove实可以直接插⼊oldStartVnode对应的真实DOM节点前⾯*/
            canMove && nodeOps.insertBefore(parentElm, vnodeToMove.elm, oldStartVnode.elm)
          } else {
            // same key but different element. treat as new element
            /*当新的VNode与找到的同样key的VNode不是sameVNode的时候(⽐如说tag不⼀样或者是有不⼀样type的input标签),
              创建⼀个新的节点
            */
            createElm(newStartVnode, insertedVnodeQueue, parentElm, oldStartVnode.elm, false, newCh, newStartIdx)
          }
        }
        newStartVnode = newCh[++newStartIdx]
      }
    }
    //循环结束了,新的孩子数组和老的孩子数组有一个可能还有未处理的
    if (oldStartIdx > oldEndIdx) {
      // 新的有没处理的,直接新增
      refElm = isUndef(newCh[newEndIdx + 1]) ? null : newCh[newEndIdx + 1].elm
      addVnodes(parentElm, refElm, newCh, newStartIdx, newEndIdx, insertedVnodeQueue)
    } else if (newStartIdx > newEndIdx) {
      // 老的有没处理的,批量删除
      removeVnodes(oldCh, oldStartIdx, oldEndIdx)
    }
  }