前言
先上個成果圖來吸引各位:javascript
代碼: 效果圖:html
是否是看起來跟vue的使用方式差很少?接下來就來從原理到實現,從簡到難一步一步來實現這個SelfVue。vue
本文主要介紹兩大內容:java
1. vue數據雙向綁定的原理。node
2. 實現簡單版vue的過程,主要實現{{}}、v-model和事件指令的功能。git
相關代碼地址:https://github.com/canfoo/self-vuegithub
vue數據雙向綁定原理
vue數據雙向綁定是經過數據劫持結合發佈者-訂閱者模式的方式來實現的,咱們能夠先來看一下經過控制檯輸出一個定義在vue初始化數據上的對象是個什麼東西。緩存
代碼:app
var vm = new Vue({ data: { obj: { a: 1 } }, created: function () { console.log(this.obj); } });
結果:dom
咱們能夠看到屬性a有兩個相對應的get和set方法,爲何會多出這兩個方法呢?由於vue是經過Object.defineProperty()來實現數據劫持的。
Object.defineProperty( )是用來作什麼的?它能夠來控制一個對象屬性的一些特有操做,好比讀寫權、是否能夠枚舉,這裏咱們主要先來研究下它對應的兩個描述屬性get和set,若是還不熟悉其用法,請點擊這裏閱讀更多用法。
在日常,咱們很容易就能夠打印出一個對象的屬性數據:
var Book = { name: 'vue權威指南' }; console.log(Book.name); // vue權威指南
若是想要在執行console.log(book.name)的同時,直接給書名加個書名號,那要怎麼處理呢?或者說要經過什麼監聽對象 Book 的屬性值。這時候Object.defineProperty( )就派上用場了,代碼以下:
var Book = {} var name = ''; Object.defineProperty(Book, 'name', { set: function (value) { name = value; console.log('你取了一個書名叫作' + value); }, get: function () { return '《' + name + '》' } }) Book.name = 'vue權威指南'; // 你取了一個書名叫作vue權威指南 console.log(Book.name); // 《vue權威指南》
咱們經過Object.defineProperty( )設置了對象Book的name屬性,對其get和set進行重寫操做,顧名思義,get就是在讀取name屬性這個值觸發的函數,set就是在設置name屬性這個值觸發的函數,因此當執行 Book.name = 'vue權威指南' 這個語句時,控制檯會打印出 "你取了一個書名叫作vue權威指南",緊接着,當讀取這個屬性時,就會輸出 "《vue權威指南》",由於咱們在get函數裏面對該值作了加工了。若是這個時候咱們執行下下面的語句,控制檯會輸出什麼?
console.log(Book);
結果:
乍一看,是否是跟咱們在上面打印vue數據長得有點相似,說明vue確實是經過這種方法來進行數據劫持的。接下來咱們經過其原理來實現一個簡單版的mvvm雙向綁定代碼。
思路分析
實現mvvm主要包含兩個方面,數據變化更新視圖,視圖變化更新數據:
關鍵點在於data如何更新view,由於view更新data其實能夠經過事件監聽便可,好比input標籤監聽 'input' 事件就能夠實現了。因此咱們着重來分析下,當數據改變,如何更新視圖的。
數據更新視圖的重點是如何知道數據變了,只要知道數據變了,那麼接下去的事都好處理。如何知道數據變了,其實上文咱們已經給出答案了,就是經過Object.defineProperty( )對屬性設置一個set函數,當數據改變了就會來觸發這個函數,因此咱們只要將一些須要更新的方法放在這裏面就能夠實現data更新view了。
思路有了,接下去就是實現過程了。
實現過程
咱們已經知道實現數據的雙向綁定,首先要對數據進行劫持監聽,因此咱們須要設置一個監聽器Observer,用來監聽全部屬性。若是屬性發上變化了,就須要告訴訂閱者Watcher看是否須要更新。由於訂閱者是有不少個,因此咱們須要有一個消息訂閱器Dep來專門收集這些訂閱者,而後在監聽器Observer和訂閱者Watcher之間進行統一管理的。接着,咱們還須要有一個指令解析器Compile,對每一個節點元素進行掃描和解析,將相關指令對應初始化成一個訂閱者Watcher,並替換模板數據或者綁定相應的函數,此時當訂閱者Watcher接收到相應屬性的變化,就會執行對應的更新函數,從而更新視圖。所以接下去咱們執行如下3個步驟,實現數據的雙向綁定:
1.實現一個監聽器Observer,用來劫持並監聽全部屬性,若是有變更的,就通知訂閱者。
2.實現一個訂閱者Watcher,能夠收到屬性的變化通知並執行相應的函數,從而更新視圖。
3.實現一個解析器Compile,能夠掃描和解析每一個節點的相關指令,並根據初始化模板數據以及初始化相應的訂閱器。
流程圖以下:
1.實現一個Observer
Observer是一個數據監聽器,其實現核心方法就是前文所說的Object.defineProperty( )。若是要對全部屬性都進行監聽的話,那麼能夠經過遞歸方法遍歷全部屬性值,並對其進行Object.defineProperty( )處理。以下代碼,實現了一個Observer。
// 實現observer function defineReactive(data,key,val){ // 遞歸遍歷全部子屬性 observer(val); // 實例化一個dep實例 var dep = new Dep(); Object.defineProperty(data,key,{ enumerable:true, configurable:true, get:function() { if(是否須要添加訂閱者){ dep.addSub(watcher); // 添加一個訂閱者 } return val; }, set:function(newVal) { if(val === newVal){ return } val = newVal; console.log('屬性' + key + '已經被監聽了,如今值爲:「' + newVal.toString() + '」'); dep.notify(); // 若是數據變化,通知全部訂閱者 } }) } function observer(data){ if(!data || typeof data !== 'object'){ return } Object.keys(data).forEach(function(key){ defineReactive(data,key,data[key]); }); } // 實現消息訂閱器 function Dep(){ this.subs = []; } // 在消息訂閱器原型上添加方法 Dep.prototype = { // 添加訂閱者 addSub:function(sub){ this.subs.push(sub); }, // 訂閱者執行相應函數 notify:function(){ this.subs.forEach(function(sub){ sub.update(); }); } } <script>
從代碼上看,咱們將訂閱器Dep添加一個訂閱者設計在getter裏面,這是爲了讓Watcher初始化進行觸發,所以須要判斷是否要添加訂閱者,至於具體設計方案,下文會詳細說明的。在setter函數裏面,若是數據變化,就會去通知全部訂閱者,訂閱者們就會去執行對應的更新的函數。到此爲止,一個比較完整Observer已經實現了,接下來咱們開始設計Watcher。
2.實現Watcher
訂閱者Watcher在初始化的時候須要將本身添加進訂閱器Dep中,那該如何添加呢?咱們已經知道監聽器Observer是在get函數執行了添加訂閱者Wather的操做的,因此咱們只要在訂閱者Watcher初始化的時候觸發對應的get函數去執行添加訂閱者操做便可,那要如何觸發get的函數,再簡單不過了,只要獲取對應的屬性值就能夠觸發了,核心緣由就是由於咱們使用了Object.defineProperty( )進行數據監聽。這裏還有一個細節點須要處理,咱們只要在訂閱者Watcher初始化的時候才須要添加訂閱者,因此須要作一個判斷操做,所以能夠在訂閱器上作一下手腳:在Dep.target上緩存下訂閱者,添加成功後再將其去掉就能夠了。訂閱者Watcher的實現以下:
// 實現watcher function Watcher(vm,exp,cb){ this.vm = vm; this.exp = exp; this.cb = cb; this.value = this.get(); // 將本身添加進訂閱器 } Watcher.prototype = { update() { this.run(); }, run() { var value = this.vm.data[this.exp]; var oldVal = this.value; if(value !== oldVal){ this.value = value; this.cb.call(this.vm,value,oldVal); } }, get() { Dep.target = this; // 緩存本身 var value = this.vm.data[this.exp] // 強制執行監聽器裏的get函數 Dep.target = null; // 釋放本身 return value; } }
這時候,咱們須要對監聽器Observer也作個稍微調整,主要是對應Watcher類原型上的get函數。須要調整地方在於defineReactive函數:
// 實現observer function defineReactive(data,key,val){ // 遞歸遍歷全部子屬性 observer(val); // 實例化一個dep實例 var dep = new Dep(); Object.defineProperty(data,key,{ enumerable:true, configurable:true, get:function() { // 判斷是否須要一個訂閱者 if(Dep.target){ dep.addSub(Dep.target); // 添加一個訂閱者 } return val; }, set:function(newVal) { if(val === newVal){ return } val = newVal; console.log('屬性' + key + '已經被監聽了,如今值爲:「' + newVal.toString() + '」'); dep.notify(); // 若是數據變化,通知全部訂閱者 } }) } Dep.target = null;
到此爲止,簡單版的Watcher設計完畢,這時候咱們只要將Observer和Watcher關聯起來,就能夠實現一個簡單的雙向綁定數據了。由於這裏沒有尚未設計解析器Compile,因此對於模板數據咱們都進行寫死處理,假設模板上又一個節點,且id號爲'name',而且雙向綁定的綁定的變量也爲'name',且是經過兩個大雙括號包起來(這裏只是爲了演示,暫時沒什麼用處),模板以下:
<body> <h1 id="name">{{name}}</h1> </body>
這時候咱們須要將Observer和Watcher關聯起來:
// 將watcher和observer關聯起來 function SelfVue (data, el, exp) { this.data = data; observe(data); el.innerHTML = this.data[exp]; // 初始化模板數據的值 new Watcher(this, exp, function (value) { el.innerHTML = value; }); return this; }
而後在頁面上new如下SelfVue類,就能夠實現數據的雙向綁定了:
<body> <h1 id="name">{{name}}</h1> </body> <script src="js/observer.js"></script> <script src="js/watcher.js"></script> <script src="js/index.js"></script> <script type="text/javascript"> var ele = document.querySelector('#name'); var selfVue = new SelfVue({ name: 'hello world' }, ele, 'name'); window.setTimeout(function () { console.log('name值改變了'); selfVue.data.name = 'canfoo'; }, 2000); </script>
這時候打開頁面,能夠看到頁面剛開始顯示了是'hello world',過了2s後就變成'canfoo'了。到這裏,總算大功告成一半了,可是還有一個細節問題,咱們在賦值的時候是這樣的形式 ' selfVue.data.name = 'canfoo' ' 而咱們理想的形式是' selfVue.name = 'canfoo' '爲了實現這樣的形式,咱們須要在new SelfVue的時候作一個代理處理,讓訪問selfVue的屬性代理爲訪問selfVue.data的屬性,實現原理仍是使用Object.defineProperty( )對屬性值再包一層:
複製代碼 function SelfVue (data, el, exp) { var self = this; this.data = data; Object.keys(data).forEach(function(key) { self.proxyKeys(key); // 綁定代理屬性 }); observe(data); el.innerHTML = this.data[exp]; // 初始化模板數據的值 new Watcher(this, exp, function (value) { el.innerHTML = value; }); return this; } SelfVue.prototype = { proxyKeys: function (key) { var self = this; Object.defineProperty(this, key, { enumerable: false, configurable: true, get: function proxyGetter() { return self.data[key]; }, set: function proxySetter(newVal) { self.data[key] = newVal; } }); } }
這下咱們就能夠直接經過' selfVue.name = 'canfoo' '的形式來進行改變模板數據了。若是想要迫切看到現象的童鞋趕快來獲取代碼!
3.實現Compile
雖然上面已經實現了一個雙向數據綁定的例子,可是整個過程都沒有去解析dom節點,而是直接固定某個節點進行替換數據的,因此接下來須要實現一個解析器Compile來作解析和綁定工做。解析器Compile實現步驟:
1.解析模板指令,並替換模板數據,初始化視圖
2.將模板指令對應的節點綁定對應的更新函數,初始化相應的訂閱器
爲了解析模板,首先須要獲取到dom元素,而後對含有dom元素上含有指令的節點進行處理,所以這個環節須要對dom操做比較頻繁,全部能夠先建一個fragment片斷,將須要解析的dom節點存入fragment片斷裏再進行處理:
function nodeToFragment (el) { var fragment = document.createDocumentFragment(); var child = el.firstChild; while (child) { // 將Dom元素移入fragment中 fragment.appendChild(child); child = el.firstChild } return fragment; }
接下來須要遍歷各個節點,對含有相關指定的節點進行特殊處理,這裏我們先處理最簡單的狀況,只對帶有 '{{變量}}' 這種形式的指令進行處理,先簡道難嘛,後面再考慮更多指令狀況:
function compileElement (el) { var childNodes = el.childNodes; var self = this; [].slice.call(childNodes).forEach(function(node) { var reg = /\{\{(.*)\}\}/; var text = node.textContent; if (self.isTextNode(node) && reg.test(text)) { // 判斷是不是符合這種形式{{}}的指令 self.compileText(node, reg.exec(text)[1]); } if (node.childNodes && node.childNodes.length) { self.compileElement(node); // 繼續遞歸遍歷子節點 } }); }, function compileText (node, exp) { var self = this; var initText = this.vm[exp]; updateText(node, initText); // 將初始化的數據初始化到視圖中 new Watcher(this.vm, exp, function (value) { // 生成訂閱器並綁定更新函數 self.updateText(node, value); }); }, function updateText (node, value) { node.textContent = typeof value == 'undefined' ? '' : value; }
獲取到最外層節點後,調用compileElement函數,對全部子節點進行判斷,若是節點是文本節點且匹配{{}}這種形式指令的節點就開始進行編譯處理,編譯處理首先須要初始化視圖數據,對應上面所說的步驟1,接下去須要生成一個並綁定更新函數的訂閱器,對應上面所說的步驟2。這樣就完成指令的解析、初始化、編譯三個過程,一個解析器Compile也就能夠正常的工做了。爲了將解析器Compile與監聽器Observer和訂閱者Watcher關聯起來,咱們須要再修改一下類SelfVue函數:
function SelfVue (options) { var self = this; this.vm = this; this.data = options; Object.keys(this.data).forEach(function(key) { self.proxyKeys(key); }); observe(this.data); new Compile(options, this.vm); return this; }
<body> <div id="app"> <h2>{{title}}</h2> <h1>{{name}}</h1> </div> </body> <script src="js/observer.js"></script> <script src="js/watcher.js"></script> <script src="js/compile.js"></script> <script src="js/index.js"></script> <script type="text/javascript"> var selfVue = new SelfVue({ el: '#app', data: { title: 'hello world', name: '' } }); window.setTimeout(function () { selfVue.title = '你好'; }, 2000); window.setTimeout(function () { selfVue.name = 'canfoo'; }, 2500); </script>
如上代碼,在頁面上可觀察到,剛開始titile和name分別被初始化爲 'hello world' 和空,2s後title被替換成 '你好' 3s後name被替換成 'canfoo' 了。廢話很少說,再給大家來一個這個版本的代碼(v2),獲取代碼!
到這裏,一個數據雙向綁定功能已經基本完成了,接下去就是須要完善更多指令的解析編譯,在哪裏進行更多指令的處理呢?答案很明顯,只要在上文說的compileElement函數加上對其餘指令節點進行判斷,而後遍歷其全部屬性,看是否有匹配的指令的屬性,若是有的話,就對其進行解析編譯。這裏咱們再添加一個v-model指令和事件指令的解析編譯,對於這些節點咱們使用函數compile進行解析處理:
function compile (node) { var nodeAttrs = node.attributes; var self = this; Array.prototype.forEach.call(nodeAttrs, function(attr) { var attrName = attr.name;
// 判斷是不是指令屬性 if (self.isDirective(attrName)) { var exp = attr.value; var dir = attrName.substring(2); if (self.isEventDirective(dir)) { // 事件指令 self.compileEvent(node, self.vm, exp, dir); } else { // v-model 指令 self.compileModel(node, self.vm, exp, dir); } node.removeAttribute(attrName); } }); }
上面的compile函數是掛載Compile原型上的,它首先遍歷全部節點屬性,而後再判斷屬性是不是指令屬性,若是是的話再區分是哪一種指令,再進行相應的處理,處理方法相對來講比較簡單,這裏就再也不列出來,想要立刻看閱讀代碼的同窗能夠立刻點擊這裏獲取。
最後咱們在稍微改造下類SelfVue,使它更像vue的用法:
function SelfVue (options) {
var self = this;
this.data = options.data;
this.methods = options.methods;
Object.keys(this.data).forEach(function(key) {
self.proxyKeys(key);
});
observe(this.data);
new Compile(options.el, this);
options.mounted.call(this); // 全部事情處理好後執行mounted函數
}
這時候咱們能夠來真正測試了,在頁面上設置以下東西:
<body> <div id="app"> <h2>{{title}}</h2> <input v-model="name"> <h1>{{name}}</h1> <button v-on:click="clickMe">click me!</button> </div> </body> <script src="js/observer.js"></script> <script src="js/watcher.js"></script> <script src="js/compile.js"></script> <script src="js/index.js"></script> <script type="text/javascript"> new SelfVue({ el: '#app', data: { title: 'hello world', name: 'canfoo' }, methods: { clickMe: function () { this.title = 'hello world'; } }, mounted: function () { window.setTimeout(() => { this.title = '你好'; }, 1000); } }); </script>
是否是看起來跟vue的使用方法同樣,哈,真正的大功告成!想要代碼,直接點擊這裏獲取!現象還沒描述?直接上圖!!!請觀賞
其實這個效果圖,就是本文開頭貼出來的效果圖了,前文說着要帶着你們實現,因此就在這裏把圖再貼一次了,這叫首尾呼應嘛。