天天看點

剖析Vue原理&實作雙向綁定MVVM

本文能幫你做什麼?

1、了解vue的雙向資料綁定原理以及核心代碼子產品

2、緩解好奇心的同時了解如何實作雙向綁定

為了便于說明原理與實作,本文相關代碼主要摘自

vue源碼

, 并進行了簡化改造,相對較簡陋,并未考慮到數組的處理、資料的循環依賴等,也難免存在一些問題,歡迎大家指正。不過這些并不會影響大家的閱讀和了解,相信看完本文後對大家在閱讀vue源碼的時候會更有幫助<

本文所有相關代碼均在github上面可找到

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>
           

效果:

剖析Vue原理&amp;實作雙向綁定MVVM

幾種實作雙向綁定的做法

目前幾種主流的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入口函數,整合以上三者

上述流程如圖所示:

剖析Vue原理&amp;實作雙向綁定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主要做的事情是解析模闆指令,将模闆中的變量替換成資料,然後初始化渲染頁面視圖,并将每個指令對應的節點綁定更新函數,添加監聽資料的訂閱者,一旦資料有變動,收到通知,更新視圖,如圖所示:

剖析Vue原理&amp;實作雙向綁定MVVM

因為周遊解析的過程有多次操作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。文中肯定會有一些不夠嚴謹的思考和錯誤,歡迎大家指正,有興趣歡迎一起探讨和改進~

最後,感謝您的閱讀!

原文釋出時間為:2018年06月24日

原文作者:zhaiyy

本文來源: 

掘金 

如需轉載請聯系原作者

繼續閱讀