推薦閱讀:
MVVM 是 Web 前端一種非常流行的開發模式,利用 MVVM 可以讓我們的程式碼更專注於處理業務邏輯而不是去關心 DOM 作業。目前著名的 MVVM 框架有 vue, avalon , react 等,這些框架各有千秋,但是實現的想法大致上是相同的:資料綁定 + 視圖刷新。出於好奇和一顆願意折騰的心,我自己也沿著這個方向寫了一個最簡單的MVVM 庫( mvvm.js ),總共2000 多行程式碼,指令的命名和用法與vue 相似,在這裡分享一下實現的原理以及我的程式碼組織思路。
思路整理
MVVM 在概念上是真正將視圖與資料邏輯分離的模式,ViewModel 是整個模式的重點。要實作 ViewModel 就需要將資料模型(Model)和視圖(View)關聯起來,整個實作思維可以簡單的總結成 5 點:
實作一個 Compiler 對元素的每個節點進行指令的掃描與擷取;
實作一個Parser 去解析元素上的指令,能夠把指令的意圖透過某個刷新函數更新到dom 上(中間可能需要一個專門負責視圖刷新的模組)例如解析節點
時先取得Model 中isShow 的值,再根據isShow 更改node.style.display 從而控制元素的顯示與隱藏;實作一個 Watcher 能將 Parser 中每個指令的刷新函數和對應 Model 的欄位連結起來;
實作一個 Observer 使得能夠對物件的所有欄位進行值的變化監測,一旦發生變化時可以拿到最新的值並觸發通知回呼;
利用Observer 在Watcher 中建立一個對Model 的監聽,當Model 中的一個值改變時,監聽被觸發,Watcher 拿到新值後調用在步驟2 中關聯的那個刷新函數,就可以實現數據變化的同時刷新視圖的目的。
效果範例
首先粗看下最終的使用範例,與其他 MVVM 框架的實例化大同小異:
<div id="mobile-list"> <h1 v-text="title"></h1> <ul> <li v-for="item in brands"> <b v-text="item.name"></b> <span v-show="showRank">Rank: {{item.rank}}</span> </li> </ul> </div> var element = document.querySelector('#mobile-list'); var vm = new MVVM(element, { 'title' : 'Mobile List', 'showRank': true, 'brands' : [ {'name': 'Apple', 'rank': 1}, {'name': 'Galaxy', 'rank': 2}, {'name': 'OPPO', 'rank': 3} ] }); vm.set('title', 'Top 3 Mobile Rank List'); // => <h1>Top 3 Mobile Rank List</h1>
模組劃分
我把 MVVM 分成了五個模組去實作: 編譯模組 Compiler 、解析模組 Parser 、視圖刷新模組 Updater 、資料訂閱模組 Watcher 和 資料監聽模組 Observer 。流程可以簡述為:Compiler 編譯好指令後將指令資訊交給解析器Parser 解析,Parser 更新初始值並向Watcher 訂閱資料的變化,Observer 監測到資料的變化然後回饋給Watcher ,Watcher 再將變更結果通知Updater 找到對應的刷新函數進行視圖的刷新。
上述流程如圖所示:
下文就介紹下這五個模組實現的基本原理(程式碼只貼重點部分,完整的實作請到我的 Github 翻閱)
1. 編譯模組 Compiler
Compiler 的職責主要是對元素的每個節點進行指令的掃描和提取。因為編譯和解析的過程會多次遍歷整個節點樹,所以為了提高編譯效率在MVVM 構造函數內部先將element 轉成一個文檔碎片形式的副本fragment 編譯對像是這個文檔碎片而不應該是目標元素,待全部節點編譯完成後再將文件碎片加入到原來的真實節點。
vm.complieElement 實作了對元素所有節點的掃描和指令擷取:
vm.complieElement = function(fragment, root) { var node, childNodes = fragment.childNodes; // 扫描子节点 for (var i = 0; i < childNodes.length; i++) { node = childNodes[i]; if (this.hasDirective(node)) { this.$unCompileNodes.push(node); } // 递归扫描子节点的子节点 if (node.childNodes.length) { this.complieElement(node, false); } } // 扫描完成,编译所有含有指令的节点 if (root) { this.compileAllNodes(); } }
vm.compileAllNodes 方法將會對this.$unCompileNodes 中的每個節點進行編譯(將指令資訊交給Parser ),編譯完一個節點後就從快取佇列中移除它,同時檢查this.$unCompileNodes .length 當length === 0 時說明全部編譯完成,可以將文件碎片追加到真實節點上了。
2. 指令解析模組 Parser
當編譯器 Compiler 把每個節點的指令提取出來後就可以給到解析器解析了。每個指令都有不同的解析方法,所有指令的解析方法只要做好兩件事:一是將資料值更新到視圖上(初始狀態),二是將刷新函數訂閱到 Model 的變化監測中。這裡以解析 v-text 為例描述一個指令的大致解析方法:
parser.parseVText = function(node, model) { // 取得 Model 中定义的初始值 var text = this.$model[model]; // 更新节点的文本 node.textContent = text; // 对应的刷新函数: // updater.updateNodeTextContent(node, text); // 在 watcher 中订阅 model 的变化 watcher.watch(model, function(last, old) { node.textContent = last; // updater.updateNodeTextContent(node, text); }); }
3. 数据订阅模块 Watcher
上个例子,Watcher 提供了一个 watch 方法来对数据变化进行订阅,一个参数是模型字段 model 另一个是回调函数,回调函数是要通过 Observer 来触发的,参数传入新值 last 和 旧值 old , Watcher 拿到新值后就可以找到 model 对应的回调(刷新函数)进行更新视图了。model 和 刷新函数是一对多的关系,即一个 model 可以有任意多个处理它的回调函数(刷新函数),比如: v-text="title" 和 v-html="title" 两个指令共用一个数据模型字段。
添加数据订阅 watcher.watch 实现方式为:
watcher.watch = function(field, callback, context) { var callbacks = this.$watchCallbacks; if (!Object.hasOwnProperty.call(this.$model, field)) { console.warn('The field: ' + field + ' does not exist in model!'); return; } // 建立缓存回调函数的数组 if (!callbacks[field]) { callbacks[field] = []; } // 缓存回调函数 callbacks[field].push([callback, context]); }
当数据模型的 field 字段发生改变时,Watcher 就会触发缓存数组中订阅了 field 的所有回调。
4. 数据监听模块 Observer
Observer 是整个 mvvm 实现的核心基础,看过有一篇文章说 O.o (Object.observe) 将会引爆数据绑定革命,给前端带来巨大影响力,不过很可惜,ES7 草案已经将 O.o 给废弃了!目前也没有浏览器支持!所幸的是还有 Object.defineProperty 通过拦截对象属性的存取描述符(get 和 set) 可以模拟一个简单的 Observer :
// 拦截 object 的 prop 属性的 get 和 set 方法 Object.defineProperty(object, prop, { get: function() { return this.getValue(object, prop); }, set: function(newValue) { var oldValue = this.getValue(object, prop); if (newValue !== oldValue) { this.setValue(object, newValue, prop); // 触发变化回调 this.triggerChange(prop, newValue, oldValue); } } });
然后还有个问题就是数组操作 ( push, shift 等) 该如何监测?所有的 MVVM 框架都是通过重写该数组的原型来实现的:
observer.rewriteArrayMethods = function(array) { var self = this; var arrayProto = Array.prototype; var arrayMethods = Object.create(arrayProto); var methods = 'push|pop|shift|unshift|splice|sort|reverse'.split('|'); methods.forEach(function(method) { Object.defineProperty(arrayMethods, method, function() { var i = arguments.length; var original = arrayProto[method]; var args = new Array(i); while (i--) { args[i] = arguments[i]; } var result = original.apply(this, args); // 触发回调 self.triggerChange(this, method); return result; }); }); array.__proto__ = arrayMethods; }
这个实现方式是从 vue 中参考来的,觉得用的很妙,不过数组的 length 属性是不能够被监听到的,所以在 MVVM 中应避免操作 array.length
5. 视图刷新模块 Updater
Updater 在五个模块中是最简单的,只需要负责每个指令对应的刷新函数即可。其他四个模块经过一系列的折腾,把最后的成果交给到 Updater 进行视图或者事件的更新,比如 v-text 的刷新函数为:
updater.updateNodeTextContent = function(node, text) { node.textContent = text; }
v-bind:style 的刷新函数:
updater.updateNodeStyle = function(node, propperty, value) { node.style[propperty] = value; }
双向数据绑定的实现
表单元素的双向数据绑定是 MVVM 的一个最大特点之一:
其实这个神奇的功能实现原理也很简单,要做的只有两件事:一是数据变化的时候更新表单值,二是反过来表单值变化的时候更新数据,这样数据的值就和表单的值绑在了一起。
数据变化更新表单值利用前面说的 Watcher 模块很容易就可以做到:
watcher.watch(model, function(last, old) { input.value = last; });'
表单变化更新数据只需要实时监听表单的值得变化事件并更新数据模型对应字段即可:
var model = this.$model; input.addEventListenr('change', function() { model[field] = this.value; });‘
其他表单 radio, checkbox 和 select 都是一样的原理。
以上,整个流程以及每个模块的基本实现思路都讲完了,第一次在社区发文章,语言表达能力不太好,如有说的不对写的不好的地方,希望大家能够批评指正!
结语
折腾这个简单的 mvvm.js 是因为原来自己的框架项目中用的是 vue.js 但是只是用到了它的指令系统,一大堆功能只用到四分之一左右,就想着只是实现 data-binding 和 view-refresh 就够了,结果没找这样的 javascript 库,所以我自己就造了这么一个轮子。
虽说功能和稳定性远不如 vue 等流行 MVVM 框架,代码实现可能也比较粗糙,但是通过造这个轮子还是增长了很多知识的 ~ 进步在于折腾嘛!
目前我的 mvvm.js 只是实现了最本的功能,以后我会继续完善、健壮它,如有兴趣欢迎一起探讨和改进~