# Vueuv **Repository Path**: mirrors_singod/Vueuv ## Basic Information - **Project Name**: Vueuv - **Description**: 参照Vue实现的一个JavaScript MVVM 框架,手把手教你从零开始Make Your Own Vue! - **Primary Language**: Unknown - **License**: MIT - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2020-09-26 - **Last Updated**: 2026-07-19 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # Vueuv **Vueuv**是一个轻量的前端MVVM框架,是在研究Vue双向绑定实现原理的时候参照着Vue捣鼓出来的轮子,Vue的绑定指令基本都实现了一遍。 MVVM原理实现非常巧妙,真心佩服作者的构思;编译部分没用源码的方式实现,自己捣鼓着实现的,过程真是既烧脑也获益良多: > 不造个轮子,你还真以为你会写代码了? ## Live Demo - [todoMVC](https://qieguo2016.github.io/Vueuv/examples/todoMVC/index.html) ## How to use 引入[Vueuv.js](https://github.com/qieguo2016/Vueuv/blob/master/dist/Vueuv.js)后,用法就跟Vue一毛一样了: ```html
{{ message }}
``` ```javascript var app = new Vue({ el: '#app', data: { message: 'Hello Vue!' } }) ``` 渲染后的HTML是这样的: ```html
Hello Vue!
``` 其他的指令也是一样的语法,也支持缩写啥的,更多指令请看Vue的文档http://cn.vuejs.org/v2/guide/,这里就不再赘述了。 现在Vueuv还没加Filter语法,但是可以使用computed方法来实现同样的效果,以后我会视心情而考虑补上这个filter的。 ***代码目前还是用es5写的,打包也是手动拼装的,这方面不打算折腾了,下面来点干货,分享下基本实现和编码过程的一些思考吧。*** ## 双向绑定核心 双向绑定的实现核心有两点:1、Object.defineProperty劫持对象的getter、setter,从而实现对数据的监控。2、发布/订阅者模式实现数据与视图的自动同步。 - Object.defineProperty顾名思义,就是用来定义对象属性的,这里我们主要在getter和setter函数里面插入一些处理方法,当对象被读写的时候处理方法就会被执行了。 关于这个方法的更具体解释,可以看MDN上的解释([戳我](https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Object/defineProperty)); - 发布/订阅者模式,其实就是我们addEventListener那套东西。自己手动实现一个也非常简单: ```javascript function EventHandle() { var events = {}; this.on = function (event, callback) { callback = callback || function () { }; if (typeof events[event] === 'undefined') { events[event] = [callback]; } else { events[event].push(callback); } }; this.emit = function (event, args) { events[event].forEach(function (fn) { fn(args); }); }; this.off = function (event) { delete events[event]; }; } ``` 视图的变化引发数据更新可以用监听input事件的方式直接修改数据来实现,而数据的变动驱动视图的更新则需要手动实现。 参照订阅发布者模式,我们可以将视图更新方法注册到事件列表中,而更新消息则由setter触发,更新消息会触发视图更新函数,这样就实现了数据到视图的更新。 ## 模块分析 为了更好分析整个系统,接下来分成三个大模块来展开。首先是订阅/发布者模式中的发布者,在Vue中发布者就是观察数据模型并发出更新消息的Observer。 ### Observer 我们都知道要在setter里面发布更新消息,但是一个变量会被多个表达式所依赖,怎么找出依赖的表达式并更新呢?如果是用Angular1.x中的脏检查来实现,那么遍历所有被监视的值,找出脏数据然后更新视图就可以了。 但是Vue的实现却是更为精细的依赖管理,找到依赖该变量的表达式列表,然后更新列表中表达式的值,再去更新视图。显然,关键的一步就是依赖列表的构建了。 想当然的我们肯定是在解析表达式的时候收集变量,然后用一个`依赖列表[变量a]`的数组/哈希来依次保存依赖该变量a的表达式。Vue的做法也是类似,但是实在是高明太多。直接看代码: ```javascript Observer.prototype.observe = function (data) { var self = this; // 设置开始和递归终止条件 if (!data || typeof data !== 'object') { return; } Object.keys(data).forEach(function (key) { self.defineReactive(data, key, data[key]); }); }; Observer.prototype.defineReactive = function (data, key, val) { var dep = new Dep(); var self = this; Object.defineProperty(data, key, { enumerable : true, // 枚举 configurable: false, // 不可再配置 get : function () { Dep.target && dep.addSub(Dep.target); return val; }, set : function (newVal) { if (val === newVal) { return; } val = newVal; // setter本身已经做了赋值,val作为一个闭包变量,保存最新值 if (Array.isArray(newVal)) { self.observeArray(newVal, dep); // 递归监视,数组的监视要分开 } else { self.observe(newVal); // 递归对象属性到基本类型为止 } dep.notify(); // 触发通知 }, }); if (Array.isArray(val)) { self.observeArray(val, dep); // 递归监视,数组的监视要分开 } else { self.observe(val); // 递归对象属性到基本类型为止 } }; ``` setter里面跟我们想的一样,更新数据的时候发出通知,这里我们可能会漏掉的是对newVal的监控,设置值之后当然也要监控新值了。 再看看getter,可以看到依赖列表是在getter里面添加的!并不是在解析的时候另调用一个方法来创建依赖列表! 而且依赖列表是作为一个闭包存在,每个变量单独一个列表!并不是像我想的那样用一个全局的结构来保存依赖列表! 而由于getter除了初次编译之外后面每次使用都会触发,所以还增加了一个标识来控制是否添加依赖列表,为了能从外部传入,标识挂在了Dep构造函数上! Dep上的属性是被所有Dep的实例共享的,但由于js是单线程的,所以在一个时刻只有一个Dep生效,在添加完监视后移掉target即可保证不会影响到其他变量! **这一做法堪称神来之笔,并没有很高深的东西,但我相信绝大部分人永远也想不到如此巧妙的实现。** 依赖Dep的构造就很简单了,跟我们上文的EventHandle是一样的,这里加了一点去重。 ```javascript function Dep() { this.subs = {}; }; Dep.prototype.addSub = function (target) { if (!this.subs[target.uid]) { //防止重复添加 this.subs[target.uid] = target; } }; Dep.prototype.notify = function () { for (var uid in this.subs) { this.subs[uid].update(); } }; ``` ### Watcher 看完了发布者,接下来看看订阅者Watcher。订阅者的功能比较简单,就是接收发布者的消息,然后调用相应的更新方法去更新视图。 每一个订阅者对应一个表达式,这里要注意的就是Dep.target的赋值与清除。这里最重要最有意思的是用来计算表达式的computeExpression这个方法,文末会结合编译器一起介绍。 ```javascript function Watcher(exp, scope, callback) { this.value = null; this.update(); //初始化时,触发添加到监听队列 } Watcher.prototype = { get : function () { Dep.target = this; var value = computeExpression(this.exp, this.scope); // 表达式求值的时候添加监听 Dep.target = null; return value; }, update: function () { var newVal = this.get(); // 这里有可能是对象/数组,所以不能直接比较,可以借助JSON来转换成字符串对比 if (!isEqual(this.value, newVal)) { this.callback && this.callback(newVal, this.value, options); this.value = fullCopy(newVal); } } } ``` ### Compiler 以上两步已经实现了一个订阅/发布者模式,接下来就是如何将模板与这两者关联起来了,这就轮到Compiler出场了。Compiler主要是提取模板中的指令,然后将数据与模板绑定起来。 > PS:这里参照的是Vue 1.x版的Compiler,2.x的实现已经用上了AST了,有时间你们就研究一下吧~~~ 为了提高效率,Vue首先将模板的dom结构复制到文档片段中,然后在文档片段中进行编译,最后将编译好的文档片段插入dom树中。主体代码如下: ```javascript function Compiler(options) { this.$el = options.el; this.vm = options.vm; if (this.$el) { this.$fragment = nodeToFragment(this.$el); this.compile(this.$fragment); this.$el.appendChild(this.$fragment); } } Compiler.prototype = { compile: function (node, scope) { var self = this; if (node.childNodes && node.childNodes.length) { [].slice.call(node.childNodes).forEach(function (child) { if (child.nodeType === 3) { self.compileTextNode(child, scope); } else if (child.nodeType === 1) { self.compileElementNode(child, scope); } }); } }, compileTextNode: function (node, scope) { var text = node.textContent.trim(); if (!text) { return; } var exp = parseTextExp(text); scope = scope || this.vm; this.textHandler(node, scope, exp); }, compileElementNode: function (node, scope) { // var attrs = node.attributes; var attrs = [].slice.call(node.attributes); var self = this; scope = scope || this.vm; // [].forEach.call(attrs, function (attr) { // attributes是动态的,会漏点某些属性 attrs.forEach(function (attr) { var attrName = attr.name; var exp = attr.value; var dir = checkDirective(attrName); if (dir.type) { var handler = self[dir.type + 'Handler'].bind(self); // 不要漏掉bind(this),否则其内部this指向会出错 handler && handler(node, scope, exp, dir.prop); node.removeAttribute(attrName); } }); }, } ``` Compiler主流程是对dom树的递归编译,分为文本节点和元素节点两种分支。 #### 文本节点编译的关键是提取`{{}}`内的表达式,也即是parseTextExp函数, 其作用是将'a {{b+"text"}} c {{d+f}}' 这样的字符串转换成 '"a " + b + "text" + " c" + d + f'这样的表达式。 ```javascript function parseTextExp(text) { var regText = /\{\{(.+?)\}\}/g; var pieces = text.split(regText); var matches = text.match(regText); var tokens = []; pieces.forEach(function (piece) { if (matches && matches.indexOf('{{' + piece + '}}') > -1) { // 注意排除无{{}}的情况 tokens.push(piece); } else if (piece) { tokens.push('`' + piece + '`'); } }); return tokens.join('+'); } ``` #### 元素节点就要提取各种`v-xxx`指令,然后做三件事:1) 根据指令类型设置节点的属性并将指令内的变量与vm绑定起来; 2) 将表达式加入到监控(订阅者)中 3) 指定相应的视图更新方法。 1) 将表达式加入监控就是实例化Watcher,将更新方法传到Watcher的回调函数中。 ```javascript Compiler.prototype = { // ... bindWatcher: function (node, scope, exp, dir, prop) { var updateFn = updater[dir]; var watcher = new Watcher(exp, scope, function (newVal) { updateFn && updateFn(node, newVal, prop); }); }, } ``` 2) 变量绑定非常简单,要注意的作用域要以参数的形式传进来,这样才能做各个层次的绑定。而不同的指令有不同的处理方式,下面简单介绍比较有意思的指令编译 **model双向绑定(v-model="expression")** 这里比较有意思的我既要使用监视器来更新input的value,又要用value去更新vm的数据,所以在输入的时候就形成了一个循环依赖了。 当然,更新函数会判断新旧值,只有新旧值不同才调用更新方法。然后,我们的中文输入法却因此而不能正常工作了: input事件的value取值会取拼音字母,然后更新函数直接将字母拿去反过来更新了value,所以根本就不能选词了。解决办法非常简单,在事件中加入一个标志就可以了,更新方法里面判断这个标志来判断是否要更新。 ```javascript Compiler.prototype = { // ... modelHandler: function (node, scope, exp, prop) { if (node.tagName.toLowerCase() === 'input') { this.bindWatcher(node, scope, exp, 'value'); node.addEventListener('input', function (e) { node.isInputting = true; // 由于上面绑定了自动更新,循环依赖了,中文输入法不能用。这里加入一个标志避开自动update var newValue = e.target.value; scope[exp] = newValue; }); } }, valueUpdater: function (node, newVal) { // 当有输入的时候循环依赖了,中文输入法不能用。这里加入一个标志避开自动update if (!node.isInputting) { node.value = newVal ? newVal : ''; } node.isInputting = false; // 记得要重置标志 }, } ``` **if/for指令的懒编译** 想象一下if为false的时候你先编译了父元素,然后,然后就没有了!!所以,要先编译子元素,然后编译父元素根据值来判断是否要保留Dom节点。 还有就是指令本身也要在编译完别的指令才编译,否则你节点都没有了,别的指令还怎么编译?当你if为true的时候,没编译的指令就有问题了,所以要最后编译if。 for也是同理,先编译好其他指令,最后只需要克隆一下节点就可以了,不需要反复编译相同的指令。 ```javascript Compiler.prototype = { // ... compileElementNode: function (node, scope) { var attrs = node.attributes; var lazyCompileDir = ''; var lazyCompileExp = ''; var self = this; scope = scope || this.vm; [].forEach.call(attrs, function (attr) { var dir = checkDirective(attrName); if (dir.type) { if (dir.type === 'for') { lazyCompileDir = dir.type; lazyCompileExp = exp; } else { var handler = self[dir.type + 'Handler'].bind(self); // 不要漏掉bind(this),否则其内部this指向会出错 handler && handler(node, scope, exp, dir.prop); } node.removeAttribute(attrName); } }); // if/for懒编译(编译完其他指令后才编译) if (lazyCompileExp) { this[lazyCompileDir + 'Handler'](node, scope, lazyCompileExp); } else { this.compile(node, scope); } }, } ``` **for指令的编译** **指令里面最有意思的莫过于这个for指令了!最有意思的地方就是,实现子元素的绑定取值。** 比如一个指令: ```html
  • Parent.name: {{name}}; item: {{item.id}}:
  • ``` name是li级的,而item.id则是li的子元素的,这个作用域要怎么构建呢?先看代码: ```javascript Compiler.prototype = { // ... forHandler: function (node, scope, exp, prop) { var self = this; var itemName = exp.split('in')[0].replace(/\s/g, '') var arrNames = exp.split('in')[1].replace(/\s/g, '').split('.'); var arr = scope[arrNames[0]]; if (arrNames.length === 2) { arr = arr[arrNames[1]]; } var parentNode = node.parentNode; arr.forEach(function (item) { var cloneNode = node.cloneNode(true); parentNode.insertBefore(cloneNode, node); var forScope = Object.create(scope); // 注意每次循环要生成一个新对象 forScope[itemName] = item; self.compile(cloneNode, forScope); }); parentNode.removeChild(node); // 去掉原始模板 }, } ``` 对的,就是用Object.create(scope)将forScope的原型链绑定到父级上,然后forScope.name就是scope.name了。 看起来,这里用forScope=scope也可以呀,但是这样的话,`forScope[itemName]`就是同一个对象了,没有列表的效果了。 再者,虽然可以深复制scope造出列表,但是与scope脱离了关系,没有绑定的关系了!**所以,这里还是要用原型链!** 3) Compiler里面还有一个比较重要的点就是更新视图方法。 这里说说if指令的更新方法,为了要在指定位置插入节点,我们可以先在该位置加一个占位的textNode,然后将这个textNode传给更新方法, 后续就根据这个占位的textNode进行dom的插删。 ```javascript var updater = { dom : function (node, newVal, nextNode) { if (newVal) { nextNode.parentNode.insertBefore(node, nextNode); } else { nextNode.parentNode.removeChild(node); } } } ``` ## 表达式的求值 ### 首先是双大括号文本表达式的解。 假如有`'{{b+"text"}} c {{d+f}}'`这样的一个绑定表达式,最后的求值结果就是`scope.b + "text" + " c " + scope.d + scope.f` 。 做法有两种,一种是构造一个函数,函数体就是要求值的表达式,返回值为表达式的结果,执行这个函数就可以得到求值结果,构造这样的函数可以使用`new Function`来构造。 上述还有一个作用域的限制,可以根据有无""来判断是否变量或者直接改造parseTextExp函数返回变量的数组,然后给每个变量加一个`scope.`。 ```javascript function computeExp(exp, scope) { exp = addScope(scope); // 得到"a " + scope.b + "text" + " c " + scope.d var fn = new Function('scope', 'return ' + exp); return fn(scope); } ``` 另外一种方法是使用with+eval的方式绑定作用域并执行表达式得到结果,这也是我现在使用的方式,听说Vue2.0用的也是with呢~~ ```javascript function computeExpression(exp, scope) { try { with (scope) { return eval(exp); } } catch (e) { console.error('ERROR', e); } } ``` ### class指令的求值。 class指令的对象语法是这样的:
    最后要根据isActive、hasError的值返回相应的class。而isActive还可以computed属性或者表达式,这里你会怎么实现呢? 我的做法是使用三元判断语句,构造出 (isActive)?"active":""这样一个个语句,连起来执行就可以得到期望的class了。 ```javascript function parseClassExp(exp) { if (!exp) { return; } var regObj = /\{(.+?)\}/g; var regArr = /\[(.+?)\]/g; var result = []; if (regObj.test(exp)) { var subExp = exp.replace(/[\s\{\}]/g, '').split(','); subExp.forEach(function (sub) { var key = '"' + sub.split(':')[0].replace(/['"`]/g, '') + ' "'; var value = sub.split(':')[1]; result.push('((' + value + ')?' + key + ':"")') }); } else if (regArr.test(exp)) { var subExp = exp.replace(/[\s\[\]]/g, '').split(','); } return result.join('+'); // 拼成 (a?"acls ":"")+(b?"bcls ":"")的形式 } ``` style指令的求值,与class做法一样,不过构造出来的表达式要稍微改改,不再赘述。 ## Vueuv的实现 Vueuv构造函数其实就是一个壳,主要是引入Observer和Compiler,将数据和模板关联起来。 在使用Vue时你会发现,在vue内部是可以直接用this来指定data、method、computed数据的。这是怎么实现的呢?引用吗? 其实前面已经实现了Observer,很容易就能想到,这也是一个Object.defineProperty的应用。(PS:method是引用) ```javascript function Vueuv(options) { this.$data = options.data || {}; this.$el = typeof options.el === 'string' ? document.querySelector(options.el) : options.el || document.body; this.$options = options; this.window = window; // 为了exp中全局对象(Math、location等)的计算取值 // 代理属性,直接用vm.props访问data、method、computed内数据/方法 this._proxy(options); this._proxyMethods(options.methods); // method不劫持getter/setter var ob = new Observer(this.$data); if (!ob) return; new Compiler({el: this.$el, vm: this}); } Vueuv.prototype = { // 代理属性,直接用vm.props访问data、computed内数据/方法 _proxy : function (data) { var self = this; var proxy = ['data', 'computed']; proxy.forEach(function (item) { Object.keys(data[item]).forEach(function (key) { Object.defineProperty(self, key, { configurable: false, enumerable : true, get : function () { // 注意不要返回与或表达式,会因类型转换导致出错 // return self.$data[key] || ((typeof self.$options.computed[key] !== 'undefined') && self.$options.computed[key].call(self)); if (typeof self.$data[key] !== 'undefined') { return self.$data[key]; } else if (typeof self.$options.computed[key] !== 'undefined') { return self.$options.computed[key].call(self); } else { return undefined; } }, set : function (newVal) { if (self.$data.hasOwnProperty(key)) { self.$data[key] = newVal; } else if (self.$options.computed.hasOwnProperty(key)) { self.$options.computed[key] = newVal; } } }); }) }) }, // method不劫持getter/setter,直接引用 _proxyMethods: function (methods) { var self = this; Object.keys(methods).forEach(function (key) { self[key] = self.$options.methods[key]; }) } } ``` ------- ## 【补充】数组监视 @2016.12.20 for指令还要监视数组的动态变化从而增减for绑定的视图项。回到Observer中,现在要区别对待数组和对象,在哪里做分支比较好呢? 想象一下我们的使用场景,有时候我们可能会对整个数组进行set操作,所以,数组本身的set也是要被监视的,因此可以想到是要在劫持了set之后进行分支,也就是遍历子元素的方式做区分。 当然,也不要忘了setter内部的递归监视新值,不然设置的新值就没有监视了。 ```javascript Observer.prototype = { // ... observeObject: function (data, key, val) { var dep = new Dep(); // 每个变量单独一个dependence列表 var self = this; Object.defineProperty(data, key, { // ... set : function (newVal) { if (val === newVal) { return; } val = newVal; // setter本身已经做了赋值,val作为一个闭包变量,保存最新值 if (Array.isArray(newVal)) { self.observeArray(newVal, dep); // 递归监视,数组的监视要分开 } else { self.observe(newVal); // 递归对象属性到基本类型为止 } dep.notify(); // 触发通知 }, }); if (Array.isArray(val)) { self.observeArray(val, dep); // 递归监视,数组的监视要分开 } else { self.observe(val); // 递归对象属性到基本类型为止 } }, }; ``` 接着看数组的监控,实现方法是通过监视数组的几个变异方法来实现的,也就是更改数组的原型链。 在调用那些会更改数组的方法时,发出变更通知,原理跟对象的监视也是一毛一样的,直接看代码吧。 ```javascript Observer.prototype = { // ... observeArray: function (arr, dep) { var self = this; arr.__proto__ = self.defineReactiveArray(dep); arr.forEach(function (item) { self.observe(item); }); }, defineReactiveArray: function (dep) { var arrayPrototype = Array.prototype; var arrayMethods = Object.create(arrayPrototype); var self = this; // 重写/定义数组变异方法 var methods = [ 'pop', 'push', 'sort', 'shift', 'splice', 'unshift', 'reverse' ]; methods.forEach(function (method) { // 得到单个方法的原型对象,不能直接修改整个Array原型,那是覆盖 var original = arrayPrototype[method]; // 给数组方法的原型添加监监视 Object.defineProperty(arrayMethods, method, { value : function () { // 获取函数参数 var args = []; for (var i = 0, l = arguments.length; i < l; i++) { args.push(arguments[i]); } // 数组方法的实现 var result = original.apply(this, args); // 数组插入项 var inserted switch (method) { case 'push': case 'unshift': inserted = args break case 'splice': inserted = args.slice(2) break } // 监视数组插入项,而不是重新监视整个数组 if (inserted && inserted.length) { self.observeArray(inserted, dep) } // 触发更新 dep.notify({method, args}); return result }, enumerable : true, writable : true, configurable: true }); }); return arrayMethods; } }; ``` ------- 补齐了数组监视,Vue MVVM双向绑定的简易实现就完整啦!(泪奔!。。。) Vue里面还有一个非常重要的点就是component的实现。这也是Vue能这么火的关键因素吧, component可以看做是上述实现的一个子集,为了实现组件间的通信而增加了prop和event。 vue中的prop是父到子的单向数据流,event则是组件间的订阅/发布者。实现的思路想了下,不过要做的东西不少,所以看心情吧,爽了的时候再补上~~ ### 或者,你来个pull requests? ## Change Log #### 更新 @2016.12.22 - 修复了深路径引用问题。 - 增加了todoMVC Demo。 #### 更新 @2016.12.21 - 增加了`v-html`指令的更新编译,更改`v-html`中的值时,也会解析新值内的指令。 - 修改了`v-on`指令的事件绑定实现,支持表达式、函数名、函数调用这三种语法:`@click="count=count+1"`,`@click="yourFn"`、`@click="addItem(item)"` #### 更新 @2016.12.20 - 增加了数组的监控,绑定指令总算是完整了!!实现原理也补充到下文了,因为跟对象监控原理差不多,就没详细展开写。手指好累,不多说了,我先去楼下的大保健按摩下。哟吼吼吼~~:( ---- Reference: 1. [开发vue(或类似的MVVM框架)的过程中,需要面对的主要问题有哪些?](https://www.zhihu.com/question/53176471) 2. [剖析vue实现原理,自己动手实现mvvm](https://github.com/DMQ/mvvm#_2) 3. [官网介绍](http://cn.vuejs.org/v2/guide/index.html)