160行代碼仿Vue實現極簡雙向綁定[詳細註釋]

前言

現在的前端面試不管你用的什麼框架,總會問你這個框架的雙向綁定機制,有的甚至要求你現場實現一個雙向綁定出來,那對於沒有好好研究過這方面知識的同學來說,當然是很難的,接下來本文用160行代碼帶你實現一個極簡的雙向綁定機制。如果喜歡的話可以點波贊/關注,支持一下,希望大家看完本文可以有所收穫。

本文是在面試題:你能寫一個Vue的雙向數據綁定嗎?的基礎上仔細研究+改動,並添加了詳細註釋,而成的。

個人博客瞭解一下:obkoro1.com


效果GIF:

demo地址:

codepen:仿Vue極簡雙向綁定

Github:仿Vue極簡雙向綁定


瞭解Object.defineProperty():

這個API是實現雙向綁定的核心,最主要的作用是重寫數據的getset方法。

使用方式:

    let obj = {
      singer: "周杰倫"
    };
    let value = "青花瓷";
    Object.defineProperty(obj, "music", {
      // value: '七里香', // 設置屬性的值 下面設置了get set函數 所以這裏不能設置
      configurable: false, // 是否可以刪除屬性 默認不能刪除
      // writable: true,  // 是否可以修改對象 下面設置了get set函數 所以這裏不能設置
      enumerable: true, // music是否可以被枚舉 默認是不能被枚舉(遍歷)
      // ☆ get,set設置時不能設置writable和value,要一對一對設置,交叉設置/同時存在 就會報錯
      get() {
        // 獲取obj.music的時候就會調用get方法
        // let value = "強行設置get的返回值"; // 打開註釋 讀取屬性永遠都是‘強行設置get的返回值’
        return value;
      },
      set(val) {
        // 將修改的值重新賦給song
        value = val;
      }
    });
    console.log(obj.music); // 青花瓷
    delete obj.music; // configurable設爲false 刪除無效
    console.log(obj.music); // 青花瓷
    obj.music = "聽媽媽的話"; 
    console.log(obj.music); // 聽媽媽的話
    for (let key in obj) {
      // 默認情況下通過defineProperty定義的屬性是不能被枚舉(遍歷)的
      // 需要設置enumerable爲true纔可以 否則只能拿到singer 屬性
      console.log(key); // singer, music
    }

示例demo:

對,這裏有個demo

畫一下重點:

  • get,set設置時不能設置writable和value, 他們是一對情侶的存在,交叉設置或同時存在,會報錯
  • 通過defineProperty設置的屬性,默認不能刪除,不能遍歷,當然你可以通過設置更改他們。
  • get、set 是函數,可以做的事情很多

兼容性:IE 9,Firefox 4, Chorme 5,Opera 11.6,Safari 5.1

更詳細的可以看一下MDN


實現思路:

mvvm系列的雙向綁定,關鍵步驟:

  1. 實現數據監聽器Observer,用Object.defineProperty()重寫數據的get、set,值更新就在set中通知訂閱者更新數據
  2. 實現模板編譯Compile,深度遍歷dom樹,對每個元素節點的指令模板進行替換數據以及訂閱數據
  3. 實現Watch用於連接Observer和Compile,能夠訂閱並收到每個屬性變動的通知,執行指令綁定的相應回調函數,從而更新視圖
  4. mvvm入口函數,整合以上三者。

流程圖:

這部分講的很清楚,現在有點懵逼也沒關係,看完代碼,自己copy下來玩一玩之後,回頭再看實現思路,相信會有收穫的。


具體代碼實現:

html結構:

<div id="app">
    <input type="text" v-model="name">
    <h3 v-bind="name"></h3>
    <input type="text" v-model="testData1">
    <h3>{{ testData1 }}</h3>
    <input type="text" v-model="testData2">
    <h3>{{ testData2 }}</h3>
</div>

看到這個模板,相信用過Vue的同學都不會陌生。

調用方法:

採用類Vue方式來使用雙向綁定:

 window.onload = function () {
    var app = new myVue({
        el: '#app', // dom
        data: { // 數據
            testData1: '仿Vue',
            testData2: '極簡雙向綁定',
            name: 'OBKoro1'
        }
    })
}

創建myVue函數:

實際上這裏是我們實現思路中的第四步,用於整合數據監聽器this._observer()、指令解析器this._compile()以及連接Observer和Compile的_watcherTpl的watch池。

    function myVue(options = {}) {  // 防止沒傳,設一個默認值
        this.$options = options; // 配置掛載
        this.$el = document.querySelector(options.el); // 獲取dom
        this._data = options.data; // 數據掛載
        this._watcherTpl = {}; // watcher池
        this._observer(this._data); // 傳入數據,執行函數,重寫數據的get set
        this._compile(this.$el); // 傳入dom,執行函數,編譯模板 發佈訂閱
    };

Watcher函數:

這是實現思路中的第三步,因爲下方數據監聽器_observer()需要用到Watcher函數,所以這裏就先講了。

像實現思路中所說的,這裏起到了連接Observer和Compile的作用:

  1. 在模板編譯_compile()階段發佈訂閱
  2. 在賦值操作的時候,更新視圖

    // new Watcher() 爲this._compile()發佈訂閱+ 在this._observer()中set(賦值)的時候更新視圖
    function Watcher(el, vm, val, attr) {
        this.el = el; // 指令對應的DOM元素
        this.vm = vm; // myVue實例
        this.val = val; // 指令對應的值 
        this.attr = attr; // dom獲取值,如value獲取input的值 / innerHTML獲取dom的值
        this.update(); // 更新視圖
    }
    Watcher.prototype.update = function () { 
        this.el[this.attr] = this.vm._data[this.val]; // 獲取data的最新值 賦值給dom 更新視圖
    }
    

沒有看錯,代碼量就這麼多,可能需要把整個代碼連接起來,多看幾遍才能夠理解。

實現數據監聽器_observer():

實現思路中的第一步,用Object.defineProperty()遍歷data重寫所有屬性的get set。

然後在給對象的某個屬性賦值的時候,就會觸發set。

在set中我們可以監聽到數據的變化,然後就可以觸發watch更新視圖

 myVue.prototype._observer = function (obj) {
        var _this = this;
        Object.keys(obj).forEach(key => { // 遍歷數據
            _this._watcherTpl[key] = { // 每個數據的訂閱池()
                _directives: []
            };
            var value = obj[key]; // 獲取屬性值
            var watcherTpl = _this._watcherTpl[key]; // 數據的訂閱池
            Object.defineProperty(_this._data, key, { // 雙向綁定最重要的部分 重寫數據的set get
                configurable: true,  // 可以刪除
                enumerable: true, // 可以遍歷
                get() {
                    console.log(`${key}獲取值:${value}`);
                    return value; // 獲取值的時候 直接返回
                },
                set(newVal) { // 改變值的時候 觸發set
                    console.log(`${key}更新:${newVal}`);
                    if (value !== newVal) {
                        value = newVal;
                        watcherTpl._directives.forEach((item) => { // 遍歷訂閱池 
                            item.update();
                            // 遍歷所有訂閱的地方(v-model+v-bind+{{}}) 觸發this._compile()中發佈的訂閱Watcher 更新視圖  
                        });
                    }
                }
            })
        });
    }

實現Compile 模板編譯

這裏是實現思路中的第三步,讓我們來總結一下這裏做了哪些事情:

  • 首先是深度遍歷dom樹,遍歷每個節點以及子節點。
  • 將模板中的變量替換成數據,初始化渲染頁面視圖。
  • 把指令綁定的屬性添加到對應的訂閱池中
  • 一旦數據有變動,收到通知,更新視圖。

    myVue.prototype._compile = function (el) {
        var _this = this, nodes = el.children; // 獲取app的dom
        for (var i = 0, len = nodes.length; i < len; i++) { // 遍歷dom節點
            var node = nodes[i];
            if (node.children.length) {
                _this._compile(node);  // 遞歸深度遍歷 dom樹
            }
            // 如果有v-model屬性,並且元素是INPUT或者TEXTAREA,我們監聽它的input事件    
            if (node.hasAttribute('v-model') && (node.tagName = 'INPUT' || node.tagName == 'TEXTAREA')) {
                node.addEventListener('input', (function (key) {
                    var attVal = node.getAttribute('v-model'); // 獲取v-model綁定的值
                    _this._watcherTpl[attVal]._directives.push(new Watcher( // 將dom替換成屬性的數據併發布訂閱 在set的時候更新數據
                        node,
                        _this,
                        attVal,
                        'value'
                    ));
                    return function () {
                        _this._data[attVal] = nodes[key].value;  // input值改變的時候 將新值賦給數據 觸發set=>set觸發watch 更新視圖
                    }
                })(i));
            }
            if (node.hasAttribute('v-bind')) { // v-bind指令 
                var attrVal = node.getAttribute('v-bind'); // 綁定的data
                _this._watcherTpl[attrVal]._directives.push(new Watcher( // 將dom替換成屬性的數據併發布訂閱 在set的時候更新數據
                    node,
                    _this,
                    attrVal,
                    'innerHTML'
                ))
            }
            var reg = /\{\{\s*([^}]+\S)\s*\}\}/g, txt = node.textContent;   // 正則匹配{{}}
            if (reg.test(txt)) {
                node.textContent = txt.replace(reg, (matched, placeholder) => {
                    // matched匹配的文本節點包括{{}}, placeholder 是{{}}中間的屬性名
                    var getName = _this._watcherTpl; // 所有綁定watch的數據
                    getName = getName[placeholder];  // 獲取對應watch 數據的值
                    if (!getName._directives) { // 沒有事件池 創建事件池
                        getName._directives = [];
                    }
                    getName._directives.push(new Watcher( // 將dom替換成屬性的數據併發布訂閱 在set的時候更新數據
                        node,
                        _this,
                        placeholder,
                        'innerHTML'
                    ));
                    return placeholder.split('.').reduce((val, key) => {
                        return _this._data[key]; // 獲取數據的值 觸發get 返回當前值 
                    }, _this.$el);
                });
            }
        }
    }
    

完整代碼&demo地址

GitHub完整代碼

codepen:仿Vue極簡雙向綁定

Github:仿Vue極簡雙向綁定

如果覺得還不錯的話,就給個Star⭐️鼓勵一下我吧~


結語

本文只是一個簡單的實現雙向綁定的方法,主要目的是幫助各位同學理解mvvm框架的雙向綁定機制,也並沒有很完善,這裏還是有很多缺陷,比如:沒有實現數據的深度對數據進行getset等。希望看完本文,大家能有所收穫。

希望看完的朋友可以點個喜歡/關注,您的支持是對我最大的鼓勵。

個人blog and 掘金個人主頁,如需轉載,請放上原文鏈接並署名。碼字不易,感謝支持!本人寫文章本着交流記錄的心態,寫的不好之處,不撕逼,但是歡迎指點。

如果喜歡本文的話,歡迎關注我的訂閱號,漫漫技術路,期待未來共同學習成長。

以上2018.6.24

參考資料:

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

面試題:你能寫一個Vue的雙向數據綁定嗎?

不好意思!耽誤你的十分鐘,讓MVVM原理還給你

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章