实现一个简单的MVVM

此文是对 第二届EConf线上技术分享大会 上《还原vue中的MVVM》部分的再现。

部分用到的API

Object.defineProperty()
Array.from()
Document.createDocumentFragment()
Node.textContent
Node.childNodes
Node.nodeType

要实现的效果

我们要实现的效果是在HTML这样写:

    <div id="app">
      <h1>{{ name }}</h1>
      <div class="article">
        <h2>{{ title }}</h2>
        <span>创建时间:{{ time }}</span>
        <p>{{ content }}</p>
      </div>
    </div>

JS中这样写:

      const vm = new Vue({
        el: '#app',
        data: {
          name: '我的博客',
          title: '第一篇博客',
          time: '2018-12-10',
          content: '今天发布了我的第一篇博客,非常开心。'
        }
      })

得到渲染效果:

image.png

然而,很遗憾,我们并没有Vue,于是渲染效果是这样的:
image.png

下面我们就动手一步一步实现一个简单的Vue

实现模板编译

Vue的使用是通过new运算符来实例化一个对象,所以Vue是一个构造函数,接受一个对象options作为参数

function Vue(options = {}) {

}

在实例化vm之后,对参数optionsdata下的数据,我们可以用vm[key](在vm内部通过this[key],下文不再赘述此种方式)来访问,这是通过Vue代理对data的访问来实现的

function Vue(options = {}) {
    this.$options = options
    this._data = this.$options.data
    for (const key in this._data) {
        Object.defineProperty(this, key, {
            enumerable: true,
            get() {
                return this._data[key]
            },
            set(newVal) {
                this._data[key] = newVal
            }
        })
    }
    new Compile(this.$options.el, this)
}

在构造函数Vue内部,将参数options赋值给实例的$options属性,将options.data赋值给实例的私有属性 _data,然后遍历this._data(即options.data)。在for...in循环中,使用了Object.defineProperty(),其第一个参数是this,所以这个for...in循环实际上是在给实例this添加属性,这些新添加的属性取值时将返回this._data[key]的值,赋值时将改写this._data[key]的值。for...in循环结束,我们就可以通过vm[key]来访问和修改参数data中的数据了。比如可以通过vm.title来取值,通过vm.title=newVal来设值。
在函数的最后,调用了另一个构造函数Compile,并将参数中的el属性和实例this作为其参数,这个Compile构造函数将完成模板编译的工作,它长这个样子

function Compile(el, vm) {
    vm.$el = document.querySelector(el)
    const fragment = document.createDocumentFragment()
    let child = null
    while (child = vm.$el.firstChild) {
        fragment.append(child)
    }
    replace(fragment)
    vm.$el.append(fragment)
    function replace(fragment) {
        const pattern = /\{\{(.*)\}\}/
        Array.from(fragment.childNodes).forEach(node => {
            let text = node.textContent
            if (node.nodeType === 3 && pattern.test(text)) {
                const key = RegExp.$1.trim()
                node.textContent = text.replace(pattern, vm[key])
            }
            if (node.childNodes && node.childNodes.length) {
                replace(node)
            }
        })
    }
}

我们知道vm.$elVue实例的dom对象,它就是在这里被定义的。
使用document.createDocumentFragment()创建一个新的空白文档片段,声明一个空变量child,并用while循环将vm.$el下所有子元素(包括文本节点)都移到fragment中去(append一个已经存在于文档中的dom结构,相当于将它从原位置移动到新位置),while循环结束(只要vm.$el.firstChild不为空,循环就会进行下去),vm.$el就成了一个空元素,其所有子元素都被移动到了内存中的fragment下。
接着调用replace函数。replace函数内部声明一个正则,这个正则将匹配形如{{str}}的字符串,并捕获双大括号中的内容(此内容对应data的键名key)。
遍历fragment的子节点,获取子节点的文本内容text,当子节点为文本节点(nodeType3)且正则匹配成功时,将正则匹配到的内容用对应的vm[key]替换。当子节点不为文本节点时,递归调用replace。在replace函数执行完毕后,fragment中所有形如{{str}}的字符串都被对应的vm[key]替换了,然后将fragment插入vm.$el中,至此,模板编译完成,渲染结果已经是我们想要的了。然而,此时页面并不是响应式的,当渲染完毕,我们通过vm.title=newVal这样的方式来修改data的值时,页面不会更新,所以我们还需要更多的工作要做。

实现响应式

要实现响应式,还需要三个东东

  1. 观察者Observer,能够对数据对象的所有属性进行监听,如有变动可拿到最新值并通知订阅者
  2. 订阅者Watcher,能够订阅并收到每个属性变动的通知并执行相应回调函数,从而更新视图
  3. Dep,充当eventHub的角色
    这三者的关系是:Observer负责观察数据,当数据发生变化时,通过Dep通知WatcherWatcher收到数据变动的通知时,能够拿到数据的最新值并执行相应回调更新视图。
    下面实现这三个构造函数
  • Dep
function Dep() {
    this.subs = []
}
Dep.prototype.addSub = function(sub) {
    this.subs.push(sub)
}
Dep.prototype.notify = function() {
    this.subs.forEach(sub => sub.update())
}

Dep构造函数实例化的对象具有subs属性,addSubnotify方法。addSub方法将sub添加到subs数组,notify方法遍历subs数组并调用每个子元素subupdate方法(此方法将更新视图)。后文我们将知道,subs数组中的每一个sub,其实就是Watcher的实例。

  • Watcher
function Compile(el, vm) {
    //部分代码略
            if (node.nodeType === 3 && pattern.test(text)) {
                const key = RegExp.$1.trim()
                //实例化一个订阅者
                new Watcher(vm, key, (newVal) => {
                    node.textContent = text.replace(pattern, newVal)
                })
                node.textContent = text.replace(pattern, vm[key])
            }
    //部分代码略
}

function Watcher(vm, key, fn) {
    this.vm = vm
    this.key = key
    this.fn = fn
    Dep.target = this
}

Watcher.prototype.update = function() {
    this.fn(this.vm[this.key])
}

Compile函数中当子节点为文本节点且正则匹配成功时,除了替换文本内容外,还必须调用Watcher,传递三个参数,vm, keyfnvm为当前Vue实例,key为此节点中正则匹配到的keyfn为更新此节点文本内容的回调(需传参)。Watcher函数的最后,将实例this赋值给Dep.target,这个实例将被添加到Dep实例的subs数组中,这一步是在Observer中进行的。

  • Observer
function Vue(options = {}) {
    this.$options = options
    this._data = this.$options.data
    //观测数据
    new Observer(this._data)
    //部分代码省略
}

function Observer(data) {
    const dep = new Dep()
    for (const key in data) {
        let val = data[key]
        Object.defineProperty(data, key, {
            enumerable: true,
            get() {
                Dep.target && dep.addSub(Dep.target)
                Dep.target = null
                return val
            },
            set(newVal) {
                if (newVal === val) {
                    return
                }
                val = newVal
                dep.notify()
            }
        })
    }
}

要实现响应式,就需要Observer观察数据。在Vue中实例化一个观察者对象观测this._data,遍历this._data进行数据劫持,在取值时将Dep.target添加到dep.subs中(Dep.targetCompile中调用Watcher生成的实例对象);在设值成功时(值相同会直接返回),会调用depnotify方法,notify方法会遍历subs数组并调用其中每个Watcher实例的update方法(update方法定义在Watcher原型上,并通过this.vm[this.key]拿到最新的数据以更新视图)。至此,这个简单的MVVM框架就完成了。(Observer中省去了对参数data做判断,data必须为对象)
效果预览
完整代码

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,607评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,047评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,496评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,405评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,400评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,479评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,883评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,535评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,743评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,544评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,612评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,309评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,881评论 3 306
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,891评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,136评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,783评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,316评论 2 342

推荐阅读更多精彩内容

  • 本文是lhyt本人原创,希望用通俗易懂的方法来理解一些细节和难点。转载时请注明出处。文章最早出现于本人github...
    lhyt阅读 2,193评论 0 4
  • vue理解浅谈 一 理解vue的核心理念 使用vue会让人感到身心愉悦,它同时具备angular和react的优点...
    ambeer阅读 24,100评论 2 18
  • 「声动派」,专注互联网价值传播,为你分享大连接时代的一切! 本文大约11000字阅读需要12分钟 第一部分 写在前...
    声动派阅读 570评论 0 1
  • 今天已经是2018年4月10号了,离2018年6月10号这个日子只剩两个月,6月10号这一天将举行小升初考试。按说...
    我写我快乐阅读 362评论 0 0
  • 公司:扬州市方圆建筑工程有限公司 2018.3.23 哈尔滨363期 努力一组 【日精进打卡第92天】 【知-学习...
    jszhufeng阅读 130评论 0 0