动手模拟实现一个自己的mini Vue

268 阅读5分钟

前置知识

需要了解Vue 的数据响应式、双向绑定、数据驱动

数据响应式 数据模型仅仅是普通的 JavaScript 对象,而当我们修改数据时,视图会进行更新,避免了繁 琐的 DOM 操作,提高开发效率

双向绑定

  • 数据 改变 视图也随之改变,反之亦然
  • 可以使用 v-model 在表单元素上创建双向数据绑定

数据驱动是Vue 最独特的特性之一

开发过程中仅需要关注数据本身,不需要关心数据是如何渲染到视图

发布订阅模式和观察者模式

发布订阅模式

举个例子: 小明的家长要知道自己小明在学校各科的学习情况, 这时候就需要去小明班主任那边去交代,让班主任将小明的的表现情况定期的反馈给家长。各个科任老师要将小明的的学习成绩汇报给班主任。等班主任汇总了了某次考试的所有科目成绩后,就通知小明家长

从以上的例子中,我们可以归纳出几个不同的角色

  • 订阅者 (小明家长)
  • 发布者 (科任老师)
  • 事件中心 (班主任)

兄弟组件通信过程

这个过程也可以看做是一个发布订阅者模式

// eventBus.js
// 事件中心
let eventHub = new Vue()
// ComponentA.vue
// 发布者
addTodo: function () {
 // 发布消息(事件)
 eventHub.$emit('add-todo', { text: this.newTodoText })
 this.newTodoText = ''
}
// ComponentB.vue
// 订阅者
created: function () {
 // 订阅消息(事件)
 eventHub.$on('add-todo', this.addTodo)
}

模拟vue 的自定义事件

class EventEmitter {
    constructor () {
      // 创建一个订阅者对象
      // 数据结构 {'click': [fn1,fn2], 'blur': [fn3]}
      this.subs = Object.create(null) 
    }
    // 注册事件
    $on(eventName, handler) {
      this.subs[eventName] = this.subs[eventName] || []
      this.subs[eventName].push(handler)
    }
    // 触发事件
    $emit(eventName) {
      const subs = this.subs[eventName] || []
      subs.forEach(handler => {
        handler()
      });
    }
  }

  // 测试
  let em = new EventEmitter()
  em.$on('click', () => {
    console.log('click1')
  })
  em.$on('click', () => {
    console.log('click2')
  })
  em.$on('blur', () => {
    console.log('blur')
  })
  em.$emit('click')
  em.$emit('blur')

观察者模式

  • 观察者(订阅者) --Watcher update() 当事件发生时具体要做的事情
  • 发布者(目标)-- Dep

subs 数组:存储所有的观察者

addSub(): 添加观察者

notify(): 当事件发生,调用所有观察者的 update() 方法

  • 没有事件中心

两者的总结

  • 观察者模式是由具体目标调度,比如当事件触发,Dep 就会去调用观察者的方法,所以观察者模 式的订阅者与发布者之间是存在依赖的

  • 发布/订阅模式由统一调度中心调用,因此发布者和订阅者不需要知道对方的存在

开始实现mini vue

创建Vue实例

类的功能:

  • 负责接收初始化的参数(选项)

  • 负责把 data 中的属性注入到 Vue 实例,转换成 getter/setter

  • 负责调用 observer 监听 data 中所有属性的变化

  • 负责调用 compiler 解析指令/插值表达式

class Vue {
 constructor (options) {
   // 1. 通过属性保存选项的数据
   this.$options = options || {}
   this.$data =  options.data || {}
   this.$el =  typeof options.el === 'string' ? document.querySelector("#app") : ''
   // 2. 数据劫持,将对象中的数据转化成getter 或 setter
   this._proxyData(this.$data)
 }

 _proxyData (data) {
   // 遍历 data 中的所有属性
   Object.keys(data).forEach(key => {
     Object.defineProperty(this, key, {
       // 此处的this 表示的是 vue 实例
       enumerable: true,
       configurable: true,
       get () {
         console.log('getter:'+ key)
         return data[key]
       },
       set (newVal) {
         console.log(`setter:`+ key)
         if (newVal === data[key]) {
           return 
         }
         data[key] = newVal
         
       }
     })
   })
 }
}

Observe

类的功能:

  • 负责把 data 选项中的属性转换成响应式数据

  • data 中的某个属性也是对象,把该属性转换成响应式数据

  • 数据变化发送通知

// 负责数据劫持
// 把$data中的属性转换成getter/setter
class Observer {
  constructor (data) {
    this.walk(data)
  }
  // 遍历data属性
  walk (data) {
    // 1. data 为空 或者 不是对象的情况
    if ( !data || typeof data !== 'object') {
      return
    }
    // 2. 遍历data 属性
    Object.keys(data).forEach(key => {
      this.defineReactive(data, key, data[key])
    })
  }
  // 定义响应式
  // 使用 val 的原因
  // 1. 避免发生死递归  Observer.js:26 Uncaught RangeError: Maximum call stack size exceeded
  // 2. 在 get 中产生 了闭包,扩展了val
  defineReactive (obj, key, val) {
    const that = this
    // 将data 中的属性是对象的转换成响应式
    this.walk(val)
    Object.defineProperty(obj, key, {
      enumerable: true,
      configurable: true,
      get () {
      	// 当前的属性有Watcher观察者对象时,Dep对其进行依赖收集
        Dep.target && dep.addSub(Dep.target)
        // 这种写法会与_proxyData 的get 方法发生死递归
        // return obj[key] 
        return val
      },
      set (newVal) {
        if (newVal === val) {
          return
        }
        val = newVal
        // 新设置的值是对象的进行响应式
        // this 指向 data
        that.walk(newVal)
      }
    })
  }
}

创建Compiler

功能:

  • 负责编译模板,解析指令/插值表达式
  • 负责页面的首次渲染
  • 当数据变化后重新渲染视图 类图: 具体代码:
/**
 * 负责编译模板,解析指令/插值表达式
 * 负责页面的首次渲染
 * 当数据变化后重新渲染视图
 */
class Compiler {
  constructor (vm) {
    this.vm  = vm
    this.el = vm.$el
    this.compiler(this.el)
  }
  // 编译模板,负责解析文本节点和元素节点
  compiler (el) {
    // 获取根元素下的子节点
    const children = el.childNodes
    //遍历子节点
    Array.from(children).forEach(node => {
      // 文本节点
      if (this.isTextNode(node)) {
        this.compilerText(node)
      }
      // 元素节点
      if ( this.isElementNode(node) ) {
        this.compilerElement (node)
      }
      
      if (node.childNodes && node.childNodes.length) {
        // 如果当前节点中还有子节点,递归编译
        this.compiler(node)
      }
    })

  }

  // 解析文本节点
  compilerText (node) {
    const reg = /\{\{(.+)\}\}/    
    let text = node.textContent
    //正则表达式匹配文本中是否包含 差值表达式
    if (reg.test(text)) {
      // 插值表达式中的值就是我们要的属性名称
      const key = RegExp.$1.trim()
      // 从vm 实例中找到对应的值,替换掉文本内容
      node.textContent = this.vm[key]
      // 实例化Watcher,当当前属性的数据发生变化时,通过回调函数更新视图
      new Watcher(this.vm, key, value => {
        node.textContent = value
      })
    }

  }

  // 负责编译元素的指令
  // 处理v-text , v-model
  compilerElement (node) {
    Array.from(node.attributes).forEach(attr => {
      // 获取属性名称
      let attrName = attr.name
      if (this.isDirective(attrName)) {
        const key = attr.value
        const dir = attrName.substr(2)
        this.update(node, dir, key)
      }

    })
  }
  
  update (node, dir, key) {
    const updaterFn = this[dir + 'Updater']
    updaterFn && updaterFn.call(this,node,key)
  }

  // v-text 指令编译
  textUpdater (node, key) {
    node.textContent =  this.vm[key]
    new Watcher (this.vm, key, value => {
      node.textContent = value
    } )
    // node.textContent = this.vm[key]
    
  }
  // v-model指令编译
  modelUpdater (node, key) {
    node.value = this.vm[key]
    new Watcher (this.vm, key, value => {
      node.value = value
    } )
    // 文本框添加input 监听事件,进行双向绑定
    node.addEventListener('input', () => {
      this.vm[key] = node.value
    })
    
  }
  // 判断是否是指令
  isDirective (attrName) {
    return attrName.startsWith('v-')
  }
  
  // 判断是否是文本节点
  isTextNode (node) {
    return node.nodeType === 3
  }

  // 判断是否是元素节点
  isElementNode (node) {
    return node.nodeType === 1
  }

}

创建Dep 功能:

  • 负责依赖收集
  • 通知Watcher进行视图的更新

类图:

具体代码:

/**
 * 负责依赖收集
 * 和通知Watcher 更新
 */
class Dep {
  constructor () {
    // 收集存放Watcher
    this.subs = []
    // 
  }

  // 添加Watcher
  addSub (sub) {
    if (sub && sub.update) {
      this.subs.push(sub)
    }
  }

  // 通知更新
  notify () {
    this.subs.forEach( sub => {
      sub.update()
    })
  }
}

创建Watcher

Watcher 和 Dep 的关系图:

功能:

  • 当数据变化触发依赖, dep 通知所有的 Watcher 实例更新视图
  • 自身实例化的时候往 dep 对象中添加自己

类结构:

具体代码:

/**
 * 当数据变化触发依赖, dep 通知所有的 Watcher 实例更新视图
 * 自身实例化的时候往 dep 对象中添加自己
 */
class Watcher {
  constructor (vm, key, cb) {
    this.vm = vm
    // data 中的属性名称
    this.key = key
    // Dep 对象的静态属性,在getter时把Watcher添加到subs 中
    Dep.target = this
    // 触发一次getter,让dep为当前的key记录Watcher
    this.oldValue = this.vm[key]
    this.cb = cb
    // 清空 
    Dep.target = null
  }
  update () {
    const newValue = this.vm[this.key]
    if (this.oldValue === newValue) {
      return
    }
    // 调用回调函数,更新视图
    this.cb(newValue)
  }
}

总结

整体流程图:

Vue

  • 记录传入的选项,设置 data/data/el
  • 把 data 的成员注入到 Vue 实例
  • 负责调用 Observer 实现数据响应式处理(数据劫持)
  • 负责调用 Compiler 编译指令/插值表达式等

Observer

  • 数据劫持
    • 负责把 data 中的成员转换成 getter/setter

    • 负责把多层属性转换成 getter/setter

    • 如果给属性赋值为新对象,把新对象的成员设置为 getter/setter

  • 负责添加Dep 和 Watcher 之间的关系
  • 数据变化通知

Compiler

  • 负责编译模板,解析指令/插值表达式
  • 负责页面的首次渲染过程
  • 当数据变化后重新渲染

Dep

  • 收集依赖,添加订阅者(watcher)
  • 通知所有订阅者

Watcher

  • 自身实例化的时候往dep对象中添加自己
  • 当数据变化dep通知所有的 Watcher 实例更新视图