【手写 Vue2.x 源码】第二十八篇 - diff 算法-问题分析与 patch 优化

343 阅读10分钟

一,前言

首先,对 6 月的更文内容做一下简单回顾:

  • Vue2.x 源码环境的搭建
  • Vue2.x 初始化流程介绍
  • 对象的单层、深层劫持
  • 数组的单层、深层劫持
  • 数据代理的实现
  • 对象、数组数据变化的观测
  • Vue 数据渲染流程介绍
  • 模板生成 AST 语法树
  • AST 语法树生成 render 函数
  • render 函数生成 Vnode
  • 根据 Vnode 创建真实节点
  • 真实节点替换原始节点
  • Vue2.x 依赖收集的流程分析
  • 依赖收集和视图更新流程(dep 和 watcher 关联)
  • 异步更新流程说明
  • 数组的依赖收集
  • Vue 生命周期和 Mixin 的实现

本篇开始,继续 Vue2.x 源码的 diff 算法部分;


二,当前版本存在的问题

1,Vue 初始化流程回顾

vue 流程图.png

Vue流程图:

  • Vue的初始化流程,默认会创建一个Vue实例,执行初始化、挂载、模板编译操作,模板被编译成为render函数;
  • render函数初始化时会执行取值操作,从而进入getter方法对当前组件进行依赖收集,收集渲染Watcher
  • 当用户修改数据时,进入setter方法就会通知对应的渲染Watcher执行更新操作;

当前,视图更新操作的实现,是通过patch方法直接进行替换完成的,野蛮且暴力;

// src/lifeCycle.js

export function lifeCycleMixin(Vue){
  
  Vue.prototype._update = function (vnode) {
    const vm = this;
    // 生成新的真实节点,直接将老节点全部替换掉,可以做性能优化
    vm.$el = patch(vm.$el, vnode);
  }
}

2,初始化与更新流程分析

Vue的初始化流程,在挂载时会调用mountComponent方法:

  // src/init.js

  Vue.prototype.$mount = function (el) {
    const vm = this;
    const opts = vm.$options;
    el = document.querySelector(el); // 获取真实的元素
    vm.$el = el; // vm.$el 表示当前页面上的真实元素

    // 如果没有 render, 看 template
    if (!opts.render) {
      // 如果没有 template, 采用元素内容
      let template = opts.template;
      if (!template) {
        // 拿到整个元素标签,将模板编译为 render 函数
        template = el.outerHTML;
      }
      let render = compileToFunction(template);
      opts.render = render;
    }

    // 挂载
    mountComponent(vm);
  }

mountComponent方法中,会创建渲染watcher

// src/lifeCycle.js

export function mountComponent(vm) {

  let updateComponent = ()=>{
    vm._update(vm._render());  
  }
  // 当视图渲染前,调用钩子: beforeCreate
  callHook(vm, 'beforeCreate');

  // 渲染 watcher :每个组件都有一个 watcher
  new Watcher(vm, updateComponent, ()=>{
    // 视图更新后,调用钩子: created
    callHook(vm, 'created');
  },true)

   // 当视图挂载完成,调用钩子: mounted
   callHook(vm, 'mounted');
}

当数据更新时,会进入definePropertyset方法:

// src/observe/index.js

function defineReactive(obj, key, value) {

  // childOb 是数据组进行观测后返回的结果,内部 new Observe 只处理数组或对象类型
  let childOb = observe(value);// 递归实现深层观测
  let dep = new Dep();  // 为每个属性添加一个 dep
  
  Object.defineProperty(obj, key, {
    // get方法构成闭包:取obj属性时需返回原值value,
    // value会查找上层作用域的value,所以defineReactive函数不能被释放销毁
    get() {
      if(Dep.target){
        // 对象属性的依赖收集
        dep.depend();
        // 数组或对象本身的依赖收集
        if(childOb){  // 如果 childOb 有值,说明数据是数组或对象类型
          // observe 方法中,会通过 new Observe 为数组或对象本身添加 dep 属性
          childOb.dep.depend();    // 让数组和对象本身的 dep 记住当前 watcher
          if(Array.isArray(value)){// 如果当前数据是数组类型
            // 可能数组中继续嵌套数组,需递归处理
            dependArray(value)
          }  
        }
      }
      return value;
    },
    
    set(newValue) { // 确保新对象为响应式数据:如果新设置的值为对象,需要再次进行劫持
      console.log("修改了被观测属性 key = " + key + ", newValue = " + JSON.stringify(newValue))
      if (newValue === value) return
      observe(newValue);  // observe方法:如果是对象,会 new Observer 深层观测
      value = newValue;
      dep.notify(); // 通知当前 dep 中收集的所有 watcher 依次执行视图更新
    }
  })
}

此时,就会调用dep.notify(),通知对应watcher执行update方法更新视图:

// src/obseve/dep.js

class Dep {
  constructor(){
    this.id = id++;
    this.subs = [];
  }
  
  // 让 watcher 记住 dep(查重),再让 dep 记住 watcher
  depend(){
    Dep.target.addDep(this);  
  }
  
  // 让 dep 记住 watcher - 在 watcher 中被调用
  addSub(watcher){
    this.subs.push(watcher);
  }
  
  // dep 中收集的全部 watcher 依次执行更新方法 update
  notify(){
    this.subs.forEach(watcher => watcher.update())
  }
}

Watcher类的update方法中,调用了queueWatcher方法,对watcher进行了查重并缓存:

// src/observe/watcher.js

class Watcher {
  constructor(vm, fn, cb, options){
    this.vm = vm;
    this.fn = fn;
    this.cb = cb;
    this.options = options;

    this.id = id++;   // watcher 唯一标记
    this.depsId = new Set();  // 用于当前 watcher 保存 dep 实例的唯一id
    this.deps = []; // 用于当前 watcher 保存 dep 实例
    this.getter = fn; // fn 为页面渲染逻辑
    this.get();
  }
  
  addDep(dep){
    let did = dep.id;
    // dep 查重 
    if(!this.depsId.has(did)){
      // 让 watcher 记住 dep
      this.depsId.add(did);
      this.deps.push(dep);
      // 让 dep 也记住 watcher
      dep.addSub(this); 
    }
  }
  
  get(){
    Dep.target = this;  // 在触发视图渲染前,将 watcher 记录到 Dep.target 上
    this.getter();      // 调用页面渲染逻辑
    Dep.target = null;  // 渲染完成后,清除 Watcher 记录
  }
  
  update(){
    console.log("watcher-update", "查重并缓存需要更新的 watcher")
    queueWatcher(this);
  }
  
  run(){
    console.log("watcher-run", "真正执行视图更新")
    this.get();
  }
}

queueWatcher方法:

// src/observe/scheduler.js

/**
 * 将 watcher 进行查重并缓存,最后统一执行更新
 * @param {*} watcher 需更新的 watcher
 */
export function queueWatcher(watcher) {
  let id = watcher.id;
  if (has[id] == null) {
    has[id] = true;
    queue.push(watcher);  // 缓存住watcher,后续统一处理
    if (!pending) {       // 等效于防抖
      nextTick(flushschedulerQueue);
      pending = true;     // 首次进入被置为 true,使微任务执行完成后宏任务才执行
    }
  }
}

/**
 * 刷新队列:执行所有 watcher.run 并将队列清空;
 */
function flushschedulerQueue() {
  // 更新前,执行生命周期:beforeUpdate
  queue.forEach(watcher => watcher.run()) // 依次触发视图更新
  queue = [];       // reset
  has = {};         // reset
  pending = false;  // reset
  // 更新完成,执行生命周期:updated
}

flushschedulerQueue方法执行时,会调用watcherrun方法

run内部调用watcherget方法,get方法中记录当前watcher并调用getter

this.getter,即watcher初始化时传入的视图更新方法fn,即updateComponent视图渲染逻辑:

// src/lifeCycle.js

export function mountComponent(vm) {

  let updateComponent = ()=>{
    vm._update(vm._render());  
  }
  
  // 当视图渲染前,调用钩子: beforeCreate
  callHook(vm, 'beforeCreate');

  // 渲染 watcher :每个组件都有一个 watcher
  new Watcher(vm, updateComponent, ()=>{
    // 视图更新后,调用钩子: created
    callHook(vm, 'created');
  },true)

   // 当视图挂载完成,调用钩子: mounted
   callHook(vm, 'mounted');
}

这样,就会再次执行updateComponent,相当于执行vm._render渲染操作,

会根据当前的最新数据,重新生成虚拟节点,并且再次调用update

// src/lifeCycle.js

export function lifeCycleMixin(Vue){
  Vue.prototype._update = function (vnode) {
    const vm = this;
    // 传入当前真实元素vm.$el,虚拟节点vnode,返回新的真实元素
    vm.$el = patch(vm.$el, vnode);
  }
}

3,问题分析与优化思路

update方法会使用新的虚拟节点重新生成真实dom,并替换掉原来的dom

Vue的实现中,会做一次diff算法优化:尽可能复用原有节点,以提升渲染性能

所以,patch方法即为重点优化对象:

当前的 patch 方法,仅考虑了初始化的情况,还需要处理更新操作,
patch 方法需要对新老虚拟节点进行一次比对,尽可能复用原有节点,以提升渲染性能;
  • 首次渲染,根据虚拟节点生成真实节点,替换掉原来的节点;
  • 更新渲染,生成新的虚拟节点,并与老的虚拟节点进行对比,再渲染;

三,模拟新老虚拟节点比对

模拟两个虚拟节点的比对:

  • 生成虚拟节点 1
  • 生成虚拟节点 2
  • 调用patch方法,进行新老虚拟节点的比对

1,生成第一个虚拟节点

首次,生成虚拟节点后,直接进行挂载

// src/index.js

// 1,生成第一个虚拟节点
// new Vue会对数据进行劫持
let vm1 = new Vue({
    data(){
        return {name:'Brave'}
    }
})

// 将模板 render1 生成为 render 函数
// 调用 compileToFunction,将模板生成 render 函数,会解析模板,最终包成一个 function
let render1 = compileToFunction('<div>{{name}}</div>');

// 第一个虚拟节点:调用 render 函数,产生虚拟节点
let oldVnode = render1.call(vm1) 

// 将虚拟节点生成真实节点
let el1 = createElm(oldVnode);

// 将真实节点渲染到页面上
document.body.appendChild(el1);

以上步骤,也就是Vue的初始化过程;

接下来,创建第二个虚拟节点,模拟更新渲染过程;

2,生成第二个虚拟节点

// src/index.js

// 2,生成第二个虚拟节点
let vm2 = new Vue({
    data(){
        return {name:'BraveWang'}
    }
})
let render2 = compileToFunction('<div>{{name}}</div>');
let newVnode = render2.call(vm2);

// 延迟效果:初始化完成显示 el1,1 秒后移除 el1 显示 el2
setTimeout(()=>{
    let el2 = createElm(newVnode);
    document.body.removeChild(el1);
    document.body.appendChild(el2);
}, 1000);

export default Vue;

创建了第二个虚拟节点,使用定时器模拟更新渲染:生成新的真实节点并替换掉老的真实节点;

思考:两次的模板一样,render函数就一样,如果节点可以被复用,就可以提高性能;

3,patch 方法比对新老虚拟节点

patch方法:将新老虚拟节点进行一次比对,尽可能复用原有节点,以提升渲染性能;

节点复用逻辑:标签名和key相同,即判定可复用;

// 如果标签名一样就复用
// 3,调用 patch 方法进行比对
setTimeout(()=>{
    // 比对新老虚拟节点的差异,尽可能复用原有节点,以提升渲染性能
    patch(oldVnode, newVnode); 
}, 1000);

4,查看新老节点

let vm = new Vue({
    data(){
        return {name:'Brave'}
    }
})

let render = compileToFunction('<div>{{name}}</div>');

let oldVnode = render.call(vm)
let el = createElm(oldVnode);
document.body.appendChild(el);

// 数据更新后,再次调用 render 函数
vm.name = 'BraveWang';
let newVnode = render.call(vm);

setTimeout(()=>{
    patch(oldVnode, newVnode); 
}, 1000);

查看生成的两个真实节点:

image.png

接下来,开始改造patch方法,以实现新老虚拟节点的对比和复用;


四,patch 方法优化

1,当前的 patch 方法

当前的patch方法仅考虑到初始化的情况,所以每次都会直接替换掉老节点

export function patch(el, vnode) {
  // 1,根据虚拟节点创建真实节点
  const elm = createElm(vnode);
  // 2,使用真实节点替换掉老节点
  // 找到元素的父亲节点
  const parentNode = el.parentNode;
  // 找到老节点的下一个兄弟节点(nextSibling 若不存在将返回 null)
  const nextSibling = el.nextSibling;
  // 将新节点elm插入到老节点el的下一个兄弟节点nextSibling的前面
  // 备注:若nextSibling为 null,insertBefore 等价与 appendChild
  parentNode.insertBefore(elm, nextSibling); 
  // 删除老节点 el
  parentNode.removeChild(el);

  return elm;
}

2,改造 patch 方法

  • 改造前:

当前,patch方法的两个入参分别是:元素和虚拟节点;

将虚拟节点创建为真实节点,直接进行元素替换,完成数据更新;

当前的patch方法仅考虑到初始化的情况;还需要支持数据更新的情况;

  • 改造目标:

现在,需要将新老虚拟节点进行比对,尽可能复用原有节点,提高渲染性能;

  • 改造方法:

所以,需要将patch方法的入参,改造为新老虚拟节点:oldVnodevnode

// src/vdom/patch.js

export function patch(oldVnode, vnode) {
  const elm = createElm(vnode);
  const parentNode = oldVnode.parentNode;
  parentNode.insertBefore(elm, oldVnode.nextSibling); 
  parentNode.removeChild(oldVnode);
  
  return elm;
}

问题:如何知道当前要走“初渲染”还是“更新渲染”呢?

通过判断oldVnode.nodeType节点类型,是否为真实节点;

  • oldVnode为真实节点(即为真实dom),执行初渲染逻辑;
  • oldVnode非真实节点,执行更新渲染逻辑,需要进行新老虚拟节点比对;

改造完成后的patch方法:

// src/vdom/patch.js

export function patch(oldVnode, vnode) {

  const isRealElement = oldVnode.nodeType;
  if(isRealElement){// 真实节点,执行出渲染逻辑
    const elm = createElm(vnode);
    const parentNode = oldVnode.parentNode;;
    parentNode.insertBefore(elm, oldVnode.nextSibling); 
    parentNode.removeChild(oldVnode);
    return elm;
  }else{// 虚拟节点:做 diff 算法,新老节点比对
    console.log(oldVnode, vnode)
  }
}

后续,开始针对更新渲染的情况,进行新老虚拟节点的比对,即diff算法逻辑;


五,结尾

本篇,diff 算法问题分析与 patch 方法改造,主要涉及以下几点:

  • 初始化与更新流程分析;
  • 问题分析与优化思路;
  • 新老虚拟节点比对模拟;
  • patch 方法改造;

下篇,diff 算法-节点比对

todo:这一篇实际并没有开始介绍 diff 算法,仅仅做了 diff 之前的问题分析,可以简化后与 diff 部分合并;


维护日志

  • 20210802:添加“四,patch 方法优化”;添加 Vue 执行流程图;更新文章标题和摘要;
  • 20210806:调整布局与格式,修改部分错别字和歧义语句;
  • 20230213:调整部分描述,添加内容中的代码高亮,更新文章摘要,添加 todo;
  • 20230217:对部分代码逻辑和实现思路添加简单描述,修改了部分不准确和有可能存在歧义的描述,更正了一处错误;