剖析Vue實(shí)現(xiàn)原理 - 如何實(shí)現(xiàn)雙向綁定mvvm
本文能幫你做什么优炬?
1颁井、了解vue的雙向數(shù)據(jù)綁定原理以及核心代碼模塊
2、緩解好奇心的同時(shí)了解如何實(shí)現(xiàn)雙向綁定
為了便于說(shuō)明原理與實(shí)現(xiàn)蠢护,本文相關(guān)代碼主要摘自vue源碼, 并進(jìn)行了簡(jiǎn)化改造雅宾,相對(duì)較簡(jiǎn)陋,并未考慮到數(shù)組的處理葵硕、數(shù)據(jù)的循環(huán)依賴等眉抬,也難免存在一些問題,歡迎大家指正懈凹。不過(guò)這些并不會(huì)影響大家的閱讀和理解吐辙,相信看完本文后對(duì)大家在閱讀vue源碼的時(shí)候會(huì)更有幫助
本文所有相關(guān)代碼均在github上面可找到 https://github.com/DMQ/mvvm
相信大家對(duì)mvvm雙向綁定應(yīng)該都不陌生了,一言不合上代碼蘸劈,下面先看一個(gè)本文最終實(shí)現(xiàn)的效果吧昏苏,和vue一樣的語(yǔ)法,如果還不了解雙向綁定,猛戳Google
<div id="mvvm-app">
<input type="text" v-model="word">
<p>{{word}}</p>
<button v-on:click="sayHi">change model</button>
</div>
<script src="./js/observer.js"></script>
<script src="./js/watcher.js"></script>
<script src="./js/compile.js"></script>
<script src="./js/mvvm.js"></script>
<script>
var vm = new MVVM({
el: '#mvvm-app',
data: {
word: 'Hello World!'
},
methods: {
sayHi: function() {
this.word = 'Hi, everybody!';
}
}
});
</script>
效果: [圖片上傳失敗...(image-3e08dd-1555646134388)]
幾種實(shí)現(xiàn)雙向綁定的做法
目前幾種主流的mvc(vm)框架都實(shí)現(xiàn)了單向數(shù)據(jù)綁定贤惯,而我所理解的雙向數(shù)據(jù)綁定無(wú)非就是在單向綁定的基礎(chǔ)上給可輸入元素(input洼专、textare等)添加了change(input)事件,來(lái)動(dòng)態(tài)修改model和 view孵构,并沒有多高深屁商。所以無(wú)需太過(guò)介懷是實(shí)現(xiàn)的單向或雙向綁定。
實(shí)現(xiàn)數(shù)據(jù)綁定的做法有大致如下幾種:
發(fā)布者-訂閱者模式(backbone.js)
臟值檢查(angular.js)
數(shù)據(jù)劫持(vue.js)
發(fā)布者-訂閱者模式: 一般通過(guò)sub, pub的方式實(shí)現(xiàn)數(shù)據(jù)和視圖的綁定監(jiān)聽颈墅,更新數(shù)據(jù)方式通常做法是 vm.set('property', value)
蜡镶,這里有篇文章講的比較詳細(xì),有興趣可點(diǎn)這里
這種方式現(xiàn)在畢竟太low了恤筛,我們更希望通過(guò) vm.property = value
這種方式更新數(shù)據(jù)官还,同時(shí)自動(dòng)更新視圖,于是有了下面兩種方式
臟值檢查: angular.js 是通過(guò)臟值檢測(cè)的方式比對(duì)數(shù)據(jù)是否有變更毒坛,來(lái)決定是否更新視圖望伦,最簡(jiǎn)單的方式就是通過(guò) setInterval()
定時(shí)輪詢檢測(cè)數(shù)據(jù)變動(dòng),當(dāng)然Google不會(huì)這么low煎殷,angular只有在指定的事件觸發(fā)時(shí)進(jìn)入臟值檢測(cè)屯伞,大致如下:
- DOM事件,譬如用戶輸入文本豪直,點(diǎn)擊按鈕等劣摇。( ng-click )
- XHR響應(yīng)事件 ( $http )
- 瀏覽器Location變更事件 ( $location )
- Timer事件( interval )
- 執(zhí)行 apply()
數(shù)據(jù)劫持: vue.js 則是采用數(shù)據(jù)劫持結(jié)合發(fā)布者-訂閱者模式的方式,通過(guò)Object.defineProperty()
來(lái)劫持各個(gè)屬性的setter
弓乙,getter
末融,在數(shù)據(jù)變動(dòng)時(shí)發(fā)布消息給訂閱者,觸發(fā)相應(yīng)的監(jiān)聽回調(diào)唆貌。
思路整理
已經(jīng)了解到vue是通過(guò)數(shù)據(jù)劫持的方式來(lái)做數(shù)據(jù)綁定的,其中最核心的方法便是通過(guò)Object.defineProperty()
來(lái)實(shí)現(xiàn)對(duì)屬性的劫持垢乙,達(dá)到監(jiān)聽數(shù)據(jù)變動(dòng)的目的锨咙,無(wú)疑這個(gè)方法是本文中最重要、最基礎(chǔ)的內(nèi)容之一追逮,如果不熟悉defineProperty酪刀,猛戳這里 整理了一下,要實(shí)現(xiàn)mvvm的雙向綁定钮孵,就必須要實(shí)現(xiàn)以下幾點(diǎn): 1骂倘、實(shí)現(xiàn)一個(gè)數(shù)據(jù)監(jiān)聽器Observer,能夠?qū)?shù)據(jù)對(duì)象的所有屬性進(jìn)行監(jiān)聽巴席,如有變動(dòng)可拿到最新值并通知訂閱者 2历涝、實(shí)現(xiàn)一個(gè)指令解析器Compile,對(duì)每個(gè)元素節(jié)點(diǎn)的指令進(jìn)行掃描和解析,根據(jù)指令模板替換數(shù)據(jù)荧库,以及綁定相應(yīng)的更新函數(shù) 3堰塌、實(shí)現(xiàn)一個(gè)Watcher,作為連接Observer和Compile的橋梁分衫,能夠訂閱并收到每個(gè)屬性變動(dòng)的通知场刑,執(zhí)行指令綁定的相應(yīng)回調(diào)函數(shù),從而更新視圖 4蚪战、mvvm入口函數(shù)牵现,整合以上三者
上述流程如圖所示: [圖片上傳失敗...(image-acda53-1555646134388)]
1、實(shí)現(xiàn)Observer
ok, 思路已經(jīng)整理完畢邀桑,也已經(jīng)比較明確相關(guān)邏輯和模塊功能了瞎疼,let's do it 我們知道可以利用Obeject.defineProperty()
來(lái)監(jiān)聽屬性變動(dòng) 那么將需要observe的數(shù)據(jù)對(duì)象進(jìn)行遞歸遍歷,包括子屬性對(duì)象的屬性概漱,都加上 setter
和getter
這樣的話丑慎,給這個(gè)對(duì)象的某個(gè)值賦值,就會(huì)觸發(fā)setter
瓤摧,那么就能監(jiān)聽到了數(shù)據(jù)變化竿裂。。相關(guān)代碼可以是這樣:
var data = {name: 'kindeng'};
observe(data);
data.name = 'dmq'; // 哈哈哈照弥,監(jiān)聽到值變化了 kindeng --> dmq
function observe(data) {
if (!data || typeof data !== 'object') {
return;
}
// 取出所有屬性遍歷
Object.keys(data).forEach(function(key) {
defineReactive(data, key, data[key]);
});
};
function defineReactive(data, key, val) {
observe(val); // 監(jiān)聽子屬性
Object.defineProperty(data, key, {
enumerable: true, // 可枚舉
configurable: false, // 不能再define
get: function() {
return val;
},
set: function(newVal) {
console.log('哈哈哈腻异,監(jiān)聽到值變化了 ', val, ' --> ', newVal);
val = newVal;
}
});
}
這樣我們已經(jīng)可以監(jiān)聽每個(gè)數(shù)據(jù)的變化了,那么監(jiān)聽到變化之后就是怎么通知訂閱者了这揣,所以接下來(lái)我們需要實(shí)現(xiàn)一個(gè)消息訂閱器悔常,很簡(jiǎn)單,維護(hù)一個(gè)數(shù)組给赞,用來(lái)收集訂閱者机打,數(shù)據(jù)變動(dòng)觸發(fā)notify,再調(diào)用訂閱者的update方法片迅,代碼改善之后是這樣:
// ... 省略
function defineReactive(data, key, val) {
var dep = new Dep();
observe(val); // 監(jiān)聽子屬性
Object.defineProperty(data, key, {
// ... 省略
set: function(newVal) {
if (val === newVal) return;
console.log('哈哈哈残邀,監(jiān)聽到值變化了 ', val, ' --> ', newVal);
val = newVal;
dep.notify(); // 通知所有訂閱者
}
});
}
function Dep() {
this.subs = [];
}
Dep.prototype = {
addSub: function(sub) {
this.subs.push(sub);
},
notify: function() {
this.subs.forEach(function(sub) {
sub.update();
});
}
};
那么問題來(lái)了,誰(shuí)是訂閱者柑蛇?怎么往訂閱器添加訂閱者芥挣? 沒錯(cuò),上面的思路整理中我們已經(jīng)明確訂閱者應(yīng)該是Watcher, 而且var dep = new Dep();
是在 defineReactive
方法內(nèi)部定義的耻台,所以想通過(guò)dep
添加訂閱者空免,就必須要在閉包內(nèi)操作,所以我們可以在 getter
里面動(dòng)手腳:
// Observer.js
// ...省略
Object.defineProperty(data, key, {
get: function() {
// 由于需要在閉包內(nèi)添加watcher盆耽,所以通過(guò)Dep定義一個(gè)全局target屬性蹋砚,暫存watcher, 添加完移除
Dep.target && dep.addDep(Dep.target);
return val;
}
// ... 省略
});
// Watcher.js
Watcher.prototype = {
get: function(key) {
Dep.target = this;
this.value = data[key]; // 這里會(huì)觸發(fā)屬性的getter扼菠,從而添加訂閱者
Dep.target = null;
}
}
這里已經(jīng)實(shí)現(xiàn)了一個(gè)Observer了,已經(jīng)具備了監(jiān)聽數(shù)據(jù)和數(shù)據(jù)變化通知訂閱者的功能都弹,完整代碼娇豫。那么接下來(lái)就是實(shí)現(xiàn)Compile了
2、實(shí)現(xiàn)Compile
compile主要做的事情是解析模板指令畅厢,將模板中的變量替換成數(shù)據(jù)冯痢,然后初始化渲染頁(yè)面視圖,并將每個(gè)指令對(duì)應(yīng)的節(jié)點(diǎn)綁定更新函數(shù)框杜,添加監(jiān)聽數(shù)據(jù)的訂閱者浦楣,一旦數(shù)據(jù)有變動(dòng),收到通知咪辱,更新視圖振劳,如圖所示: [圖片上傳失敗...(image-76f81-1555646134387)]
因?yàn)楸闅v解析的過(guò)程有多次操作dom節(jié)點(diǎn),為提高性能和效率油狂,會(huì)先將vue實(shí)例根節(jié)點(diǎn)的el
轉(zhuǎn)換成文檔碎片fragment
進(jìn)行解析編譯操作历恐,解析完成,再將fragment
添加回原來(lái)的真實(shí)dom節(jié)點(diǎn)中
function Compile(el) {
this.$el = this.isElementNode(el) ? el : document.querySelector(el);
if (this.$el) {
this.$fragment = this.node2Fragment(this.$el);
this.init();
this.$el.appendChild(this.$fragment);
}
}
Compile.prototype = {
init: function() { this.compileElement(this.$fragment); },
node2Fragment: function(el) {
var fragment = document.createDocumentFragment(), child;
// 將原生節(jié)點(diǎn)拷貝到fragment
while (child = el.firstChild) {
fragment.appendChild(child);
}
return fragment;
}
};
compileElement方法將遍歷所有節(jié)點(diǎn)及其子節(jié)點(diǎn)专筷,進(jìn)行掃描解析編譯弱贼,調(diào)用對(duì)應(yīng)的指令渲染函數(shù)進(jìn)行數(shù)據(jù)渲染,并調(diào)用對(duì)應(yīng)的指令更新函數(shù)進(jìn)行綁定磷蛹,詳看代碼及注釋說(shuō)明:
Compile.prototype = {
// ... 省略
compileElement: function(el) {
var childNodes = el.childNodes, me = this;
[].slice.call(childNodes).forEach(function(node) {
var text = node.textContent;
var reg = /\{\{(.*)\}\}/; // 表達(dá)式文本
// 按元素節(jié)點(diǎn)方式編譯
if (me.isElementNode(node)) {
me.compile(node);
} else if (me.isTextNode(node) && reg.test(text)) {
me.compileText(node, RegExp.$1);
}
// 遍歷編譯子節(jié)點(diǎn)
if (node.childNodes && node.childNodes.length) {
me.compileElement(node);
}
});
},
compile: function(node) {
var nodeAttrs = node.attributes, me = this;
[].slice.call(nodeAttrs).forEach(function(attr) {
// 規(guī)定:指令以 v-xxx 命名
// 如 <span v-text="content"></span> 中指令為 v-text
var attrName = attr.name; // v-text
if (me.isDirective(attrName)) {
var exp = attr.value; // content
var dir = attrName.substring(2); // text
if (me.isEventDirective(dir)) {
// 事件指令, 如 v-on:click
compileUtil.eventHandler(node, me.$vm, exp, dir);
} else {
// 普通指令
compileUtil[dir] && compileUtil[dir](node, me.$vm, exp);
}
}
});
}
};
// 指令處理集合
var compileUtil = {
text: function(node, vm, exp) {
this.bind(node, vm, exp, 'text');
},
// ...省略
bind: function(node, vm, exp, dir) {
var updaterFn = updater[dir + 'Updater'];
// 第一次初始化視圖
updaterFn && updaterFn(node, vm[exp]);
// 實(shí)例化訂閱者吮旅,此操作會(huì)在對(duì)應(yīng)的屬性消息訂閱器中添加了該訂閱者watcher
new Watcher(vm, exp, function(value, oldValue) {
// 一旦屬性值有變化,會(huì)收到通知執(zhí)行此更新函數(shù)味咳,更新視圖
updaterFn && updaterFn(node, value, oldValue);
});
}
};
// 更新函數(shù)
var updater = {
textUpdater: function(node, value) {
node.textContent = typeof value == 'undefined' ? '' : value;
}
// ...省略
};
這里通過(guò)遞歸遍歷保證了每個(gè)節(jié)點(diǎn)及子節(jié)點(diǎn)都會(huì)解析編譯到庇勃,包括了{(lán){}}表達(dá)式聲明的文本節(jié)點(diǎn)。指令的聲明規(guī)定是通過(guò)特定前綴的節(jié)點(diǎn)屬性來(lái)標(biāo)記槽驶,如<span v-text="content" other-attr
中v-text
便是指令责嚷,而other-attr
不是指令,只是普通的屬性掂铐。 監(jiān)聽數(shù)據(jù)罕拂、綁定更新函數(shù)的處理是在compileUtil.bind()
這個(gè)方法中,通過(guò)new Watcher()
添加回調(diào)來(lái)接收數(shù)據(jù)變化的通知
至此堡纬,一個(gè)簡(jiǎn)單的Compile就完成了聂受,完整代碼蒿秦。接下來(lái)要看看Watcher這個(gè)訂閱者的具體實(shí)現(xiàn)了
3烤镐、實(shí)現(xiàn)Watcher
Watcher訂閱者作為Observer和Compile之間通信的橋梁,主要做的事情是: 1棍鳖、在自身實(shí)例化時(shí)往屬性訂閱器(dep)里面添加自己 2炮叶、自身必須有一個(gè)update()方法 3碗旅、待屬性變動(dòng)dep.notice()通知時(shí),能調(diào)用自身的update()方法镜悉,并觸發(fā)Compile中綁定的回調(diào)祟辟,則功成身退。 如果有點(diǎn)亂侣肄,可以回顧下前面的思路整理
function Watcher(vm, exp, cb) {
this.cb = cb;
this.vm = vm;
this.exp = exp;
// 此處為了觸發(fā)屬性的getter旧困,從而在dep添加自己,結(jié)合Observer更易理解
this.value = this.get();
}
Watcher.prototype = {
update: function() {
this.run(); // 屬性值變化收到通知
},
run: function() {
var value = this.get(); // 取到最新值
var oldVal = this.value;
if (value !== oldVal) {
this.value = value;
this.cb.call(this.vm, value, oldVal); // 執(zhí)行Compile中綁定的回調(diào)稼锅,更新視圖
}
},
get: function() {
Dep.target = this; // 將當(dāng)前訂閱者指向自己
var value = this.vm[exp]; // 觸發(fā)getter吼具,添加自己到屬性訂閱器中
Dep.target = null; // 添加完畢,重置
return value;
}
};
// 這里再次列出Observer和Dep矩距,方便理解
Object.defineProperty(data, key, {
get: function() {
// 由于需要在閉包內(nèi)添加watcher拗盒,所以可以在Dep定義一個(gè)全局target屬性,暫存watcher, 添加完移除
Dep.target && dep.addDep(Dep.target);
return val;
}
// ... 省略
});
Dep.prototype = {
notify: function() {
this.subs.forEach(function(sub) {
sub.update(); // 調(diào)用訂閱者的update方法锥债,通知變化
});
}
};
實(shí)例化Watcher
的時(shí)候陡蝇,調(diào)用get()
方法,通過(guò)Dep.target = watcherInstance
標(biāo)記訂閱者是當(dāng)前watcher實(shí)例哮肚,強(qiáng)行觸發(fā)屬性定義的getter
方法登夫,getter
方法執(zhí)行的時(shí)候,就會(huì)在屬性的訂閱器dep
添加當(dāng)前watcher實(shí)例绽左,從而在屬性值有變化的時(shí)候悼嫉,watcherInstance就能收到更新通知。
ok, Watcher也已經(jīng)實(shí)現(xiàn)了拼窥,完整代碼戏蔑。 基本上vue中數(shù)據(jù)綁定相關(guān)比較核心的幾個(gè)模塊也是這幾個(gè),猛戳這里 , 在src
目錄可找到vue源碼鲁纠。
最后來(lái)講講MVVM入口文件的相關(guān)邏輯和實(shí)現(xiàn)吧总棵,相對(duì)就比較簡(jiǎn)單了~
4、實(shí)現(xiàn)MVVM
MVVM作為數(shù)據(jù)綁定的入口改含,整合Observer情龄、Compile和Watcher三者,通過(guò)Observer來(lái)監(jiān)聽自己的model數(shù)據(jù)變化捍壤,通過(guò)Compile來(lái)解析編譯模板指令骤视,最終利用Watcher搭起Observer和Compile之間的通信橋梁,達(dá)到數(shù)據(jù)變化 -> 視圖更新鹃觉;視圖交互變化(input) -> 數(shù)據(jù)model變更的雙向綁定效果专酗。
一個(gè)簡(jiǎn)單的MVVM構(gòu)造器是這樣子:
function MVVM(options) {
this.$options = options;
var data = this._data = this.$options.data;
observe(data, this);
this.$compile = new Compile(options.el || document.body, this)
}
但是這里有個(gè)問題,從代碼中可看出監(jiān)聽的數(shù)據(jù)對(duì)象是options.data盗扇,每次需要更新視圖祷肯,則必須通過(guò)var vm = new MVVM({data:{name: 'kindeng'}}); vm._data.name = 'dmq';
這樣的方式來(lái)改變數(shù)據(jù)沉填。
顯然不符合我們一開始的期望,我們所期望的調(diào)用方式應(yīng)該是這樣的: var vm = new MVVM({data: {name: 'kindeng'}}); vm.name = 'dmq';
所以這里需要給MVVM實(shí)例添加一個(gè)屬性代理的方法佑笋,使訪問vm的屬性代理為訪問vm._data的屬性翼闹,改造后的代碼如下:
function MVVM(options) {
this.$options = options;
var data = this._data = this.$options.data, me = this;
// 屬性代理,實(shí)現(xiàn) vm.xxx -> vm._data.xxx
Object.keys(data).forEach(function(key) {
me._proxy(key);
});
observe(data, this);
this.$compile = new Compile(options.el || document.body, this)
}
MVVM.prototype = {
_proxy: function(key) {
var me = this;
Object.defineProperty(me, key, {
configurable: false,
enumerable: true,
get: function proxyGetter() {
return me._data[key];
},
set: function proxySetter(newVal) {
me._data[key] = newVal;
}
});
}
};
這里主要還是利用了Object.defineProperty()
這個(gè)方法來(lái)劫持了vm實(shí)例對(duì)象的屬性的讀寫權(quán)蒋纬,使讀寫vm實(shí)例的屬性轉(zhuǎn)成讀寫了vm._data
的屬性值猎荠,達(dá)到魚目混珠的效果,哈哈
至此蜀备,全部模塊和功能已經(jīng)完成了法牲,如本文開頭所承諾的兩點(diǎn)。一個(gè)簡(jiǎn)單的MVVM模塊已經(jīng)實(shí)現(xiàn)琼掠,其思想和原理大部分來(lái)自經(jīng)過(guò)簡(jiǎn)化改造的vue源碼拒垃,猛戳這里可以看到本文的所有相關(guān)代碼。 由于本文內(nèi)容偏實(shí)踐瓷蛙,所以代碼量較多悼瓮,且不宜列出大篇幅代碼,所以建議想深入了解的童鞋可以再次結(jié)合本文源代碼來(lái)進(jìn)行閱讀艰猬,這樣會(huì)更加容易理解和掌握横堡。
總結(jié)
本文主要圍繞“幾種實(shí)現(xiàn)雙向綁定的做法”、“實(shí)現(xiàn)Observer”冠桃、“實(shí)現(xiàn)Compile”命贴、“實(shí)現(xiàn)Watcher”、“實(shí)現(xiàn)MVVM”這幾個(gè)模塊來(lái)闡述了雙向綁定的原理和實(shí)現(xiàn)食听。并根據(jù)思路流程漸進(jìn)梳理講解了一些細(xì)節(jié)思路和比較關(guān)鍵的內(nèi)容點(diǎn)胸蛛,以及通過(guò)展示部分關(guān)鍵代碼講述了怎樣一步步實(shí)現(xiàn)一個(gè)雙向綁定MVVM。