实现Observe
双向数据绑定
数据变动 ---> 视图更新
视图更新 ---> 数据变动
要想实现当数据变动时视图更新,首先要做的就是如何知道数据变动了,可以通过Object.defineProperty()函数监听data对象里的数据,当数据变动了就会触发set()方法。所以我们需要实现一个数据监听器Observe,来对数据对象中的所有属性进行监听,当某一属性数据发生变化时,拿到最新的数据通知绑定了该属性的订阅器,订阅器再执行相应的数据更新回调函数,从而实现视图的刷新。
function Observer(data) {
//在Observer实例上暂存data
this.data = data;
this.walk(data);
}
Observer.prototype = {
walk: function(data) {
var me = this;
//对data里所有的属性名进行遍历
Object.keys(data).forEach(function(key) {
me.convert(key, data[key]);
});
},
convert: function(key, val) {
//为每个属性增加响应式
this.defineReactive(this.data, key, val);
},
defineReactive: function(data, key, val) {
//为data中所有层次的属性都创建一个dep实例
var dep = new Dep();
//递归遍历data中所有层次的属性
var childObj = observe(val);
//为原有属性新增get和set方法(数据劫持)
Object.defineProperty(data, key, {
enumerable: true, // 可枚举
configurable: false, // 不能再define
get: function() {
//判断当前Dep.target的watcher是否存在
if (Dep.target) {//当模版初始化的时候会赋值watcher实例到target上
//调用dep的depend方法
dep.depend();
}
return val;
},
set: function(newVal) {
if (newVal === val) {
return;
}
val = newVal;
// 新的值是object的话,进行监听
childObj = observe(newVal);
// 通知订阅者
dep.notify();
}
});
}
};
function observe(value, vm) {
//判断value是否存在或者value的数据类型是否为object(递归的终止条件)
if (!value || typeof value !== 'object') {
return;
}
return new Observer(value);
};
var uid = 0;
function Dep() {
//每创建一个dep都会给这个dep增加一个独立的标识
this.id = uid++;
this.subs = []; //watcher
}
Dep.prototype = {
addSub: function(sub) {
this.subs.push(sub);
},
//调用watcher实例的addDep方法
depend: function() {
//Dep.target此时是watcher的实例
//this此时是当前dep的实例
Dep.target.addDep(this);
},
removeSub: function(sub) {
var index = this.subs.indexOf(sub);
if (index != -1) {
this.subs.splice(index, 1);
}
},
//通知所有的watcher
notify: function() {
// beforeUpdate
//遍历subs中所有的watcher的实例
this.subs.forEach(function(sub) {
// 每一个watcher的实例调用update方法
sub.update();
});
}
};
Dep.target = null;
实现Complie
compile主要做的事情是解析模板指令,将模板中的data属性替换成data属性对应的值(比如将{{name}}替换成data.name值),然后初始化渲染页面视图,并且为每个data属性添加一个监听数据的订阅者(new Watcher),一旦数据有变动,收到通知,更新视图。
遍历解析需要替换的根元素el下的HTML标签必然会涉及到多次的DOM节点操作,因此不可避免的会引发页面的重排或重绘,为了提高性能和效率,我们把根元素el下的所有节点转换为文档碎片fragment
进行解析编译操作,解析完成,再将fragment
添加回原来的真实dom节点中。
- 注:文档碎片本身也是一个节点,但是当将该节点append进页面时,该节点标签作为根节点不会显示html文档中,其里面的子节点则可以完全显示。
Compile解析模板,将模板内的子元素#text添加进文档碎片节点fragment。
function Compile(el, vm) {
this.$vm = vm; //this Compile的实例 $vm 是MVVM的实例 (vm)
// el == "#app" 判断当前用户传递的el属性是元素节点还是选择器,如果是元素节点则直接保存到$el中通,
//如果不是 则根据选择器 去查找对应的元素 然后保存
this.$el = this.isElementNode(el) ? el : document.querySelector(el);
//确定元素是否真正存在
if (this.$el) {//#app
this.$fragment = this.node2Fragment(this.$el);
this.$vm.$options.beforeMounted && this.$vm.$options.beforeMounted();
this.init();
this.$el.appendChild(this.$fragment);
this.$vm.$options.mounted && this.$vm.$options.mounted();
}
}
Compile.prototype = {
/**
* node to fragment 把节点转换成文档碎片
* @param el
* @returns {DocumentFragment}
*/
node2Fragment: function(el) {
var fragment = document.createDocumentFragment(),//文档碎片
child;
// 将原生节点拷贝到fragment
while (child = el.firstChild) {
fragment.appendChild(child);
}
return fragment;
},
/**
* 初始化
*/
init: function() {
//解析所有层次的元素节点
this.compileElement(this.$fragment);
},
/**
* 解析html元素
* @param el 元素
*/
compileElement: function(el) {
//初始化数据,保存所有子节点 保存this
var childNodes = el.childNodes,
me = this;
//对所有子节点进行递归遍历
[].slice.call(childNodes).forEach(function(node) {
//text节点的文本内容
var text = node.textContent;
//声明匹配大括号表达式的正则
var reg = /\{\{(.*)\}\}/; //{{name+{{age}}+phone}} //()非贪婪匹配 ->name+{{age}}+phone
// var reg = /(.*)/; //{{name}}
//判断当前节点是不是元素节点
if (me.isElementNode(node)) {
//解析指令
me.compile(node);
//判断当前元素是否为文本节点 并且 文本节点中是否拥有{{xxx}}
} else if (me.isTextNode(node) && reg.test(text)) {
//解析文本(大括号表达式)并且赋值
me.compileText(node, RegExp.$1); //name
}
//如果当前节点还有子节点 那么就需要递归查找所有的子节点是否符合以上条件
if (node.childNodes && node.childNodes.length) {
me.compileElement(node);
}
});
},
//解析指令
compile: function(node) {//button
//获取元素中的所有属性节点
var nodeAttrs = node.attributes,
me = this;
//遍历所有属性节点
[].slice.call(nodeAttrs).forEach(function(attr) {
var attrName = attr.name;//取出属性名
if (me.isDirective(attrName)) {//判断当前属性名是否为指令 (根据是否有v-)
var exp = attr.value;//show //获取指令值
var dir = attrName.substring(2);//on:click //去掉v- 取出指令名
// 判断当前指令是否为事件指令(是否有on)
if (me.isEventDirective(dir)) {
// node.addEventListener("dir",exp,false);
//为当前元素绑定事件
compileUtil.eventHandler(node, me.$vm, exp, dir);
// 普通指令
} else {
compileUtil[dir] && compileUtil[dir](node, me.$vm, exp);
}
//移除解析完成的指令
node.removeAttribute(attrName);
}
});
},
compileText: function(node, exp) {
compileUtil.text(node, this.$vm, exp);
},
isDirective: function(attr) {
return attr.indexOf('v-') == 0;
},
isEventDirective: function(dir) {
return dir.indexOf('on') === 0;
},
/**
* 判断当前的node是不是元节点节点
* @param node 节点
* @returns {boolean}
*/
isElementNode: function(node) {
// node = "#app"
//node.nodeType 1 element元素
return node.nodeType == 1;
},
/**
* 判断当前的node是不是文本节点
* @param node 节点
* @returns {boolean}
*/
isTextNode: function(node) {
return node.nodeType == 3;
}
};
// 指令处理集合
var compileUtil = {
//解析v-text指令
text: function(node, vm, exp) {
this.bind(node, vm, exp, 'text');
},
//解析v-html指令
html: function(node, vm, exp) {
this.bind(node, vm, exp, 'html');
},
//解析v-model指令
model: function(node, vm, exp) {
this.bind(node, vm, exp, 'model');
var me = this,
val = this._getVMVal(vm, exp);
node.addEventListener('input', function(e) {
var newValue = e.target.value;
if (val === newValue) {
return;
}
me._setVMVal(vm, exp, newValue);
val = newValue;
});
},
//解析v-class指令
class: function(node, vm, exp) {
this.bind(node, vm, exp, 'class');
},
//解析v-bind指令
bind: function(node, vm, exp, dir) {
//根据指令名称获取对应的更新函数
var updaterFn = updater[dir + 'Updater'];
//如果更新函数存在 则执行更新
// updaterFn && updaterFn(node, this._getVMVal(vm, exp));
if(updaterFn){
//node 当前的文本节点, 值 name
//updaterFn ==> node #text {{name}} _data.name
// updaterFn(node, this._data.name);
updaterFn(node, this._getVMVal(vm, exp));
}
//Watcher监听者 vm实例 exp表达式{{a}}/v-text="a"
new Watcher(vm, exp, function(value, oldValue) {
updaterFn && updaterFn(node, value, oldValue);
});
},
// 事件处理
eventHandler: function(node, vm, exp, dir) {//dir==>on:click exp==>"show"
//从指令名中取出事件名
//根据指令的值(表达式)从methods中得到对应的回调函数
var eventType = dir.split(':')[1],
fn = vm.$options.methods && vm.$options.methods[exp];
if (eventType && fn) {
//给当前元素节点绑定指定的事件名和回调函数(指定this指向为vm)
node.addEventListener(eventType, fn.bind(vm), false);
}
},
//获取vm中data里相对应的属性值
_getVMVal: function(vm, exp) {
//vm => $vm exp==>"name" "age.a1"
var val = vm._data;
// {
// name: "aa",
// age: {
// a1: 18
// }
// }
exp = exp.split('.'); //[age, a1]
exp.forEach(function(k) {//age
//val = {
// a1: 18
// }
val = val[k];
});
return val;
},
//设置vm中data里相对应的属性值
_setVMVal: function(vm, exp, value) {
var val = vm._data;
exp = exp.split('.');
exp.forEach(function(k, i) {
// 非最后一个key,更新val的值
if (i < exp.length - 1) {
val = val[k];
} else {
val[k] = value;
}
});
}
};
// a-> b ->c ->d 函数嵌套调用
// a-> a -> a -> 递归 ->特殊的函数嵌套
//更新器 操作原生DOM的方法
var updater = {
//更新节点的textContent属性
textUpdater: function(node, value) {
node.textContent = typeof value == 'undefined' ? '' : value;
},
//更新节点的innerHTML属性
htmlUpdater: function(node, value) {
node.innerHTML = typeof value == 'undefined' ? '' : value;
},
//更新节点的className属性
classUpdater: function(node, value, oldValue) {
var className = node.className; //className = > "bb"
node.className = className + (className?' ':'') + value; //bb aa
/* className = className.replace(oldValue, '').replace(/\s$/, '');
var space = className && String(value) ? ' ' : '';*/
// node.className = className + space + value; //bb aa
},
//更新节点的value属性
modelUpdater: function(node, value, oldValue) {
node.value = typeof value == 'undefined' ? '' : value;
}
};
实现Watcher
Observe()函数实现data对象的属性劫持,并在属性值改变时触发订阅器的notify()通知订阅者Watcher,订阅者就会调用自身的update方法实现视图更新。
Compile()函数负责解析模板,初始化页面,并且为每个data属性新增一个监听数据的订阅者(new Watcher)。
Watcher订阅者作为Observer和Compile之间通信的桥梁,所以我们可以大致知道Watcher的作用是什么。
主要做的事情是:
- 在自身实例化时往订阅器(dep)里面添加自己。
- 自身必须有一个update()方法 。
- 待属性变动dep.notice()通知时,能调用自身的update()方法,并触发Compile中绑定的回调。
function Watcher(vm, exp, cb) {
//在watcher的实例上保存回调函数
this.cb = cb; //用于更新界面的回调函数
this.vm = vm; //MVVM的实例vm
this.exp = exp; //对应的表达式
this.depIds = {}; //n个相关的dep的容器
this.value = this.get(); //初始化获取当前表达式对应的value
}
Watcher.prototype = {
update: function() {
this.run();
},
run: function() {
var value = this.get();
var oldVal = this.value;
if (value !== oldVal) {
this.value = value;
//调用构建watcher实例的时候传递过来的回调函数,并且确定他的this指向为vm
this.cb.call(this.vm, value, oldVal);
}
},
//添加dep到watcher实例的depIds里
addDep: function(dep) {
//判断当前depIds中是否已经拥有了dep
//当模版首次更新的时候都是没有的,需要添加,当页面数据发生改变的时候同时会调用此方法,但是depIds中已经拥有了当前的dep,所以就不用再添加了
if (!this.depIds.hasOwnProperty(dep.id)) {
//调用dep的addSub方法进行对watcher实例的添加
dep.addSub(this);//此时this是watcher的实例
//添加当前的dep到depIds中,并且把dep.id的值作为depIds的key
this.depIds[dep.id] = dep;
}
},
get: function() {
//在watcher初始化的时候保存实例到Dep的target上
Dep.target = this;
//调用get方法获取当前对应表达式的数据
var value = this.getVMVal();
//清空target
Dep.target = null;
return value;
},
getVMVal: function() {
var exp = this.exp.split('.');
var val = this.vm._data;
exp.forEach(function(k) {
//读取_data中表达式所对应的值 (此时会触发observer中的get方法)
val = val[k];
});
return val;
}
};
// 1. 每次调用run()的时候会触发相应属性的getter
// getter里面会触发dep.depend(),继而触发这里的addDep
// 2. 假如相应属性的dep.id已经在当前watcher的depIds里,说明不是一个新的属性,仅仅是改变了其值而已
// 则不需要将当前watcher添加到该属性的dep里
// 3. 假如相应属性是新的属性,则将当前watcher添加到新属性的dep里
// 如通过 vm.child = {name: 'a'} 改变了 child.name 的值,child.name 就是个新属性
// 则需要将当前watcher(child.name)加入到新的 child.name 的dep里
// 因为此时 child.name 是个新值,之前的 setter、dep 都已经失效,如果不把 watcher 加入到新的 child.name 的dep中
// 通过 child.name = xxx 赋值的时候,对应的 watcher 就收不到通知,等于失效了
// 4. 每个子属性的watcher在添加到子属性的dep的同时,也会添加到父属性的dep
// 监听子属性的同时监听父属性的变更,这样,父属性改变时,子属性的watcher也能收到通知进行update
// 这一步是在 this.get() --> this.getVMVal() 里面完成,forEach时会从父级开始取值,间接调用了它的getter
// 触发了addDep(), 在整个forEach过程,当前wacher都会加入到每个父级过程属性的dep
// 例如:当前watcher的是'child.child.name', 那么child, child.child, child.child.name这三个属性的dep都会加入当前watcher
我们知道在Observe()函数执行时,我们为每个属性都添加了一个订阅器dep,而这个dep被闭包在属性的get/set函数内。所以,我们可以在实例化Watcher时调用this.get()函数访问data.name属性,这会触发defineProperty()函数内的get函数,get
方法执行的时候,就会在属性的订阅器dep
添加当前watcher实例,从而在属性值有变化的时候,watcher实例就能收到更新通知。
实现VMVM
MVVM作为数据绑定的入口,整合Observer、Compile和Watcher三者,通过Observer来监听自己的model数据变化,通过Compile来解析编译模板指令,最终利用Watcher搭起Observer和Compile之间的通信桥梁,达到数据变化 -> 视图更新;视图交互变化(input) -> 数据model变更的双向绑定效果。
function MVVM(options) {
//给实例新增一个$options属性,.并且把传递过来的配置进行暂存
this.$options = options;
this.$options.beforeCreate && this.$options.beforeCreate();
//在实例上新增一个_data 保存传递过来的data数据
var data = this._data = this.$options.data;
//保存this 为了之后使用this的时候保证this指向的正确性
var me = this;
//通过Object.keys取出data中每一项数据的属性名,然后遍历调用_proxy方法
Object.keys(data).forEach(function(key) {
// 数据代理
me._proxy(key);
});
this.$options.created && this.$options.created();
//为data所有数据进行劫持 结合订阅发布模式
observe(data, this);
//增加模版解析
this.$compile = new Compile(options.el || document.body, this)
}
MVVM.prototype = {
$watch: function(key, cb, options) {
new Watcher(this, key, cb);
},
_proxy: function(key) {//实现数据代理
var me = this;//暂存this 保证this的指向正确 这里的this还是实例vm
//通过defineProperty方法在实例(vm)上新增所有与data中属性所对应属性,并且为该属性添加get和set方法
Object.defineProperty(me, key, {//vm.name
configurable: false,
enumerable: true,
get: function proxyGetter() {
//实现了vm代理data中数据的读操作
return me._data[key];
},
set: function proxySetter(newVal) {//vm.name = "bb"
//实现了vm代理data中数据的写操作
me._data[key] = newVal;
}
});
}
};