剖析Vue原理&實現雙向綁定MVVM
本文能幫你做什麽?
1、了解vue的雙向數據綁定原理以及核心代碼模塊
2、緩解好奇心的同時了解如何實現雙向綁定
為了便於說明原理與實現,本文相關代碼主要摘自vue源碼, 並進行了簡化改造,相對較簡陋,並未考慮到數組的處理、數據的循環依賴等,也難免存在一些問題,歡迎大家指正。不過這些並不會影響大家的閱讀和理解,相信看完本文後對大家在閱讀vue源碼的時候會更有幫助<
本文所有相關代碼均在github上面可找到 https://github.com/DMQ/mvvm
相信大家對mvvm雙向綁定應該都不陌生了,一言不合上代碼,下面先看一個本文最終實現的效果吧,和vue一樣的語法,如果還不了解雙向綁定,猛戳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>
效果:
幾種實現雙向綁定的做法
目前幾種主流的mvc(vm)框架都實現了單向數據綁定,而我所理解的雙向數據綁定無非就是在單向綁定的基礎上給可輸入元素(input、textare等)添加了change(input)事件,來動態修改model和 view,並沒有多高深。所以無需太過介懷是實現的單向或雙向綁定。
實現數據綁定的做法有大致如下幾種:
發布者-訂閱者模式(backbone.js)
臟值檢查(angular.js)
數據劫持(vue.js)
發布者-訂閱者模式: 一般通過sub, pub的方式實現數據和視圖的綁定監聽,更新數據方式通常做法是 vm.set(‘property‘, value)
這種方式現在畢竟太low了,我們更希望通過 vm.property = value
這種方式更新數據,同時自動更新視圖,於是有了下面兩種方式
臟值檢查: angular.js 是通過臟值檢測的方式比對數據是否有變更,來決定是否更新視圖,最簡單的方式就是通過 setInterval()
定時輪詢檢測數據變動,當然Google不會這麽low,angular只有在指定的事件觸發時進入臟值檢測,大致如下:
-
DOM事件,譬如用戶輸入文本,點擊按鈕等。( ng-click )
-
XHR響應事件 ( $http )
-
瀏覽器Location變更事件 ( $location )
-
Timer事件( $timeout , $interval )
-
執行 $digest() 或 $apply()
數據劫持: vue.js 則是采用數據劫持結合發布者-訂閱者模式的方式,通過Object.defineProperty()
來劫持各個屬性的setter
,getter
,在數據變動時發布消息給訂閱者,觸發相應的監聽回調。
思路整理
已經了解到vue是通過數據劫持的方式來做數據綁定的,其中最核心的方法便是通過Object.defineProperty()
來實現對屬性的劫持,達到監聽數據變動的目的,無疑這個方法是本文中最重要、最基礎的內容之一,如果不熟悉defineProperty,猛戳這裏
整理了一下,要實現mvvm的雙向綁定,就必須要實現以下幾點:
1、實現一個數據監聽器Observer,能夠對數據對象的所有屬性進行監聽,如有變動可拿到最新值並通知訂閱者
2、實現一個指令解析器Compile,對每個元素節點的指令進行掃描和解析,根據指令模板替換數據,以及綁定相應的更新函數
3、實現一個Watcher,作為連接Observer和Compile的橋梁,能夠訂閱並收到每個屬性變動的通知,執行指令綁定的相應回調函數,從而更新視圖
4、mvvm入口函數,整合以上三者
上述流程如圖所示:
1、實現Observer
ok, 思路已經整理完畢,也已經比較明確相關邏輯和模塊功能了,let‘s do it
我們知道可以利用Obeject.defineProperty()
來監聽屬性變動
那麽將需要observe的數據對象進行遞歸遍歷,包括子屬性對象的屬性,都加上 setter
和getter
這樣的話,給這個對象的某個值賦值,就會觸發setter
,那麽就能監聽到了數據變化。。相關代碼可以是這樣:
var data = {name: ‘kindeng‘};
observe(data);
data.name = ‘dmq‘; // 哈哈哈,監聽到值變化了 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); // 監聽子屬性
Object.defineProperty(data, key, {
enumerable: true, // 可枚舉
configurable: false, // 不能再define
get: function() {
return val;
},
set: function(newVal) {
console.log(‘哈哈哈,監聽到值變化了 ‘, val, ‘ --> ‘, newVal);
val = newVal;
}
});
}
這樣我們已經可以監聽每個數據的變化了,那麽監聽到變化之後就是怎麽通知訂閱者了,所以接下來我們需要實現一個消息訂閱器,很簡單,維護一個數組,用來收集訂閱者,數據變動觸發notify,再調用訂閱者的update方法,代碼改善之後是這樣:
// ... 省略
function defineReactive(data, key, val) {
var dep = new Dep();
observe(val); // 監聽子屬性
Object.defineProperty(data, key, {
// ... 省略
set: function(newVal) {
if (val === newVal) return;
console.log(‘哈哈哈,監聽到值變化了 ‘, 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();
});
}
};
那麽問題來了,誰是訂閱者?怎麽往訂閱器添加訂閱者?
沒錯,上面的思路整理中我們已經明確訂閱者應該是Watcher, 而且var dep = new Dep();
是在 defineReactive
方法內部定義的,所以想通過dep
添加訂閱者,就必須要在閉包內操作,所以我們可以在 getter
裏面動手腳:
// Observer.js
// ...省略
Object.defineProperty(data, key, {
get: function() {
// 由於需要在閉包內添加watcher,所以通過Dep定義一個全局target屬性,暫存watcher, 添加完移除
Dep.target && dep.addDep(Dep.target);
return val;
}
// ... 省略
});
// Watcher.js
Watcher.prototype = {
get: function(key) {
Dep.target = this;
this.value = data[key]; // 這裏會觸發屬性的getter,從而添加訂閱者
Dep.target = null;
}
}
這裏已經實現了一個Observer了,已經具備了監聽數據和數據變化通知訂閱者的功能,完整代碼。那麽接下來就是實現Compile了
2、實現Compile
compile主要做的事情是解析模板指令,將模板中的變量替換成數據,然後初始化渲染頁面視圖,並將每個指令對應的節點綁定更新函數,添加監聽數據的訂閱者,一旦數據有變動,收到通知,更新視圖,如圖所示:
因為遍歷解析的過程有多次操作dom節點,為提高性能和效率,會先將跟節點el
轉換成文檔碎片fragment
進行解析編譯操作,解析完成,再將fragment
添加回原來的真實dom節點中
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;
// 將原生節點拷貝到fragment
while (child = el.firstChild) {
fragment.appendChild(child);
}
return fragment;
}
};
compileElement方法將遍歷所有節點及其子節點,進行掃描解析編譯,調用對應的指令渲染函數進行數據渲染,並調用對應的指令更新函數進行綁定,詳看代碼及註釋說明:
Compile.prototype = {
// ... 省略
compileElement: function(el) {
var childNodes = el.childNodes, me = this;
[].slice.call(childNodes).forEach(function(node) {
var text = node.textContent;
var reg = /\{\{(.*)\}\}/; // 表達式文本
// 按元素節點方式編譯
if (me.isElementNode(node)) {
me.compile(node);
} else if (me.isTextNode(node) && reg.test(text)) {
me.compileText(node, RegExp.$1);
}
// 遍歷編譯子節點
if (node.childNodes && node.childNodes.length) {
me.compileElement(node);
}
});
},
compile: function(node) {
var nodeAttrs = node.attributes, me = this;
[].slice.call(nodeAttrs).forEach(function(attr) {
// 規定:指令以 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]);
// 實例化訂閱者,此操作會在對應的屬性消息訂閱器中添加了該訂閱者watcher
new Watcher(vm, exp, function(value, oldValue) {
// 一旦屬性值有變化,會收到通知執行此更新函數,更新視圖
updaterFn && updaterFn(node, value, oldValue);
});
}
};
// 更新函數
var updater = {
textUpdater: function(node, value) {
node.textContent = typeof value == ‘undefined‘ ? ‘‘ : value;
}
// ...省略
};
這裏通過遞歸遍歷保證了每個節點及子節點都會解析編譯到,包括了{{}}表達式聲明的文本節點。指令的聲明規定是通過特定前綴的節點屬性來標記,如<span v-text="content" other-attr
中v-text
便是指令,而other-attr
不是指令,只是普通的屬性。
監聽數據、綁定更新函數的處理是在compileUtil.bind()
這個方法中,通過new Watcher()
添加回調來接收數據變化的通知
至此,一個簡單的Compile就完成了,完整代碼。接下來要看看Watcher這個訂閱者的具體實現了
3、實現Watcher
Watcher訂閱者作為Observer和Compile之間通信的橋梁,主要做的事情是:
1、在自身實例化時往屬性訂閱器(dep)裏面添加自己
2、自身必須有一個update()方法
3、待屬性變動dep.notice()通知時,能調用自身的update()方法,並觸發Compile中綁定的回調,則功成身退。
如果有點亂,可以回顧下前面的思路整理
function Watcher(vm, exp, cb) {
this.cb = cb;
this.vm = vm;
this.exp = exp;
// 此處為了觸發屬性的getter,從而在dep添加自己,結合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); // 執行Compile中綁定的回調,更新視圖
}
},
get: function() {
Dep.target = this; // 將當前訂閱者指向自己
var value = this.vm[exp]; // 觸發getter,添加自己到屬性訂閱器中
Dep.target = null; // 添加完畢,重置
return value;
}
};
// 這裏再次列出Observer和Dep,方便理解
Object.defineProperty(data, key, {
get: function() {
// 由於需要在閉包內添加watcher,所以可以在Dep定義一個全局target屬性,暫存watcher, 添加完移除
Dep.target && dep.addDep(Dep.target);
return val;
}
// ... 省略
});
Dep.prototype = {
notify: function() {
this.subs.forEach(function(sub) {
sub.update(); // 調用訂閱者的update方法,通知變化
});
}
};
實例化Watcher
的時候,調用get()
方法,通過Dep.target = watcherInstance
標記訂閱者是當前watcher實例,強行觸發屬性定義的getter
方法,getter
方法執行的時候,就會在屬性的訂閱器dep
添加當前watcher實例,從而在屬性值有變化的時候,watcherInstance就能收到更新通知。
ok, Watcher也已經實現了,完整代碼。
基本上vue中數據綁定相關比較核心的幾個模塊也是這幾個,猛戳這裏 , 在src
目錄可找到vue源碼。
最後來講講MVVM入口文件的相關邏輯和實現吧,相對就比較簡單了~
4、實現MVVM
MVVM作為數據綁定的入口,整合Observer、Compile和Watcher三者,通過Observer來監聽自己的model數據變化,通過Compile來解析編譯模板指令,最終利用Watcher搭起Observer和Compile之間的通信橋梁,達到數據變化 -> 視圖更新;視圖交互變化(input) -> 數據model變更的雙向綁定效果。
一個簡單的MVVM構造器是這樣子:
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)
}
但是這裏有個問題,從代碼中可看出監聽的數據對象是options.data,每次需要更新視圖,則必須通過var vm = new MVVM({data:{name: ‘kindeng‘}}); vm._data.name = ‘dmq‘;
這樣的方式來改變數據。
顯然不符合我們一開始的期望,我們所期望的調用方式應該是這樣的:var vm = new MVVM({data: {name: ‘kindeng‘}}); vm.name = ‘dmq‘;
所以這裏需要給MVVM實例添加一個屬性代理的方法,使訪問vm的屬性代理為訪問vm._data的屬性,改造後的代碼如下:
function MVVM(options) {
this.$options = options;
var data = this._data = this.$options.data, me = this;
// 屬性代理,實現 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()
這個方法來劫持了vm實例對象的屬性的讀寫權,使讀寫vm實例的屬性轉成讀寫了vm._data
的屬性值,達到魚目混珠的效果,哈哈
至此,全部模塊和功能已經完成了,如本文開頭所承諾的兩點。一個簡單的MVVM模塊已經實現,其思想和原理大部分來自經過簡化改造的vue源碼,猛戳這裏可以看到本文的所有相關代碼。
由於本文內容偏實踐,所以代碼量較多,且不宜列出大篇幅代碼,所以建議想深入了解的童鞋可以再次結合本文源代碼來進行閱讀,這樣會更加容易理解和掌握。
總結
本文主要圍繞“幾種實現雙向綁定的做法”、“實現Observer”、“實現Compile”、“實現Watcher”、“實現MVVM”這幾個模塊來闡述了雙向綁定的原理和實現。並根據思路流程漸進梳理講解了一些細節思路和比較關鍵的內容點,以及通過展示部分關鍵代碼講述了怎樣一步步實現一個雙向綁定MVVM。文中肯定會有一些不夠嚴謹的思考和錯誤,歡迎大家指正,有興趣歡迎一起探討和改進~
剖析Vue原理&實現雙向綁定MVVM