實現雙向綁定Proxy比defineproperty優劣如何?

前言

雙向綁定其實已經是一個老掉牙的問題了,只要涉及到MVVM框架就不得不談的知識點,但它畢竟是Vue的三要素之一.

Vue三要素

  • 響應式: 例如如何監聽數據變化,其中的實現方法就是我們提到的雙向綁定
  • 模板引擎: 如何解析模板
  • 渲染: Vue如何將監聽到的數據變化和解析後的HTML進行渲染

可以實現雙向綁定的方法有很多,KnockoutJS基於觀察者模式的雙向綁定,Ember基於數據模型的雙向綁定,Angular基於髒檢查的雙向綁定,本篇文章我們重點講面試中常見的基於數據劫持的雙向綁定。

常見的基於數據劫持的雙向綁定有兩種實現,一個是目前Vue在用的Object.defineProperty,另一個是ES2015中新增的Proxy,而Vue的作者宣稱將在Vue3.0版本後加入Proxy從而代替Object.defineProperty,通過本文你也可以知道爲什麼Vue未來會選擇Proxy

嚴格來講Proxy應該被稱爲『代理』而非『劫持』,不過由於作用有很多相似之處,我們在下文中就不再做區分,統一叫『劫持』。

我們可以通過下圖清楚看到以上兩種方法在雙向綁定體系中的關係.

基於數據劫持的當然還有已經涼透的Object.observe方法,已被廢棄。

提前聲明: 我們沒有對傳入的參數進行及時判斷而規避錯誤,僅僅對核心方法進行了實現.


文章目錄

  1. 基於數據劫持實現的雙向綁定的特點
  2. 基於Object.defineProperty雙向綁定的特點
  3. 基於Proxy雙向綁定的特點

1.基於數據劫持實現的雙向綁定的特點

1.1 什麼是數據劫持

數據劫持比較好理解,通常我們利用Object.defineProperty劫持對象的訪問器,在屬性值發生變化時我們可以獲取變化,從而進行進一步操作。

// 這是將要被劫持的對象
const data = {
  name: '',
};

function say(name) {
  if (name === '古天樂') {
    console.log('給大家推薦一款超好玩的遊戲');
  } else if (name === '渣渣輝') {
    console.log('戲我演過很多,可遊戲我只玩貪玩懶月');
  } else {
    console.log('來做我的兄弟');
  }
}

// 遍歷對象,對其屬性值進行劫持
Object.keys(data).forEach(function(key) {
  Object.defineProperty(data, key, {
    enumerable: true,
    configurable: true,
    get: function() {
      console.log('get');
    },
    set: function(newVal) {
      // 當屬性值發生變化時我們可以進行額外操作
      console.log(`大家好,我係${newVal}`);
      say(newVal);
    },
  });
});

data.name = '渣渣輝';
//大家好,我係渣渣輝
//戲我演過很多,可遊戲我只玩貪玩懶月

1.2 數據劫持的優勢

目前業界分爲兩個大的流派,一個是以React爲首的單向數據綁定,另一個是以Angular、Vue爲主的雙向數據綁定。

其實三大框架都是既可以雙向綁定也可以單向綁定,比如React可以手動綁定onChange和value實現雙向綁定,也可以調用一些雙向綁定庫,Vue也加入了props這種單向流的api,不過都並非主流賣點。

單向或者雙向的優劣不在我們的討論範圍,我們需要討論一下對比其他雙向綁定的實現方法,數據劫持的優勢所在。

  1. 無需顯示調用: 例如Vue運用數據劫持+發佈訂閱,直接可以通知變化並驅動視圖,上面的例子也是比較簡單的實現data.name = '渣渣輝'後直接觸發變更,而比如Angular的髒檢測則需要顯示調用markForCheck(可以用zone.js避免顯示調用,不展開),react需要顯示調用setState
  2. 可精確得知變化數據:還是上面的小例子,我們劫持了屬性的setter,當屬性值改變,我們可以精確獲知變化的內容newVal,因此在這部分不需要額外的diff操作,否則我們只知道數據發生了變化而不知道具體哪些數據變化了,這個時候需要大量diff來找出變化值,這是額外性能損耗。

1.3 基於數據劫持雙向綁定的實現思路

數據劫持是雙向綁定各種方案中比較流行的一種,最著名的實現就是Vue。

基於數據劫持的雙向綁定離不開ProxyObject.defineProperty等方法對對象/對象屬性的"劫持",我們要實現一個完整的雙向綁定需要以下幾個要點。

  1. 利用ProxyObject.defineProperty生成的Observer針對對象/對象的屬性進行"劫持",在屬性發生變化後通知訂閱者
  2. 解析器Compile解析模板中的Directive(指令),收集指令所依賴的方法和數據,等待數據變化然後進行渲染
  3. Watcher屬於Observer和Compile橋樑,它將接收到的Observer產生的數據變化,並根據Compile提供的指令進行視圖渲染,使得數據變化促使視圖變化

我們看到,雖然Vue運用了數據劫持,但是依然離不開發佈訂閱的模式,之所以在系列2做了Event Bus的實現,就是因爲我們不管在學習一些框架的原理還是一些流行庫(例如Redux、Vuex),基本上都離不開發佈訂閱模式,而Event模塊則是此模式的經典實現,所以如果不熟悉發佈訂閱模式,建議讀一下系列2的文章。

2.基於Object.defineProperty雙向綁定的特點

關於Object.defineProperty的文章在網絡上已經汗牛充棟,我們不想花過多時間在Object.defineProperty上面,本節我們主要講解Object.defineProperty的特點,方便接下來與Proxy進行對比。

Object.defineProperty還不瞭解的請閱讀文檔

兩年前就有人寫過基於Object.defineProperty實現的文章,想深入理解Object.defineProperty實現的推薦閱讀,本文也做了相關參考。

上面我們推薦的文章爲比較完整的實現(400行代碼),我們在本節只提供一個極簡版(20行)和一個簡化版(150行)的實現,讀者可以循序漸進地閱讀。

2.1 極簡版的雙向綁定

我們都知道,Object.defineProperty的作用就是劫持一個對象的屬性,通常我們對屬性的gettersetter方法進行劫持,在對象的屬性發生變化時進行特定的操作。

我們就對對象objtext屬性進行劫持,在獲取此屬性的值時打印'get val',在更改屬性值的時候對DOM進行操作,這就是一個極簡的雙向綁定。

const obj = {};
Object.defineProperty(obj, 'text', {
  get: function() {
    console.log('get val'); 
  },
  set: function(newVal) {
    console.log('set val:' + newVal);
    document.getElementById('input').value = newVal;
    document.getElementById('span').innerHTML = newVal;
  }
});

const input = document.getElementById('input');
input.addEventListener('keyup', function(e){
  obj.text = e.target.value;
})

<p data-height="300" data-theme-id="33015" data-slug-hash="gzmEab" data-default-tab="js,result" data-user="xiaomuzhu" data-embed-version="2" data-pen-title="gzmEab" class="codepen">在線示例 極簡版雙向綁定 by Iwobi (@xiaomuzhu) on CodePen.</p>
<script async src="https://static.codepen.io/ass...;></script>

2.2 升級改造

我們很快會發現,這個所謂的雙向綁定貌似並沒有什麼亂用。。。

原因如下:

  1. 我們只監聽了一個屬性,一個對象不可能只有一個屬性,我們需要對對象每個屬性進行監聽。
  2. 違反開放封閉原則,我們如果瞭解開放封閉原則的話,上述代碼是明顯違反此原則,我們每次修改都需要進入方法內部,這是需要堅決杜絕的。
  3. 代碼耦合嚴重,我們的數據、方法和DOM都是耦合在一起的,就是傳說中的麪條代碼。

那麼如何解決上述問題?

Vue的操作就是加入了發佈訂閱模式,結合Object.defineProperty的劫持能力,實現了可用性很高的雙向綁定。

首先,我們以發佈訂閱的角度看我們第一部分寫的那一坨代碼,會發現它的監聽發佈訂閱都是寫在一起的,我們首先要做的就是解耦。

我們先實現一個訂閱發佈中心,即消息管理員(Dep),它負責儲存訂閱者和消息的分發,不管是訂閱者還是發佈者都需要依賴於它。

  let uid = 0;
  // 用於儲存訂閱者併發布消息
  class Dep {
    constructor() {
      // 設置id,用於區分新Watcher和只改變屬性值後新產生的Watcher
      this.id = uid++;
      // 儲存訂閱者的數組
      this.subs = [];
    }
    // 觸發target上的Watcher中的addDep方法,參數爲dep的實例本身
    depend() {
      Dep.target.addDep(this);
    }
    // 添加訂閱者
    addSub(sub) {
      this.subs.push(sub);
    }
    notify() {
      // 通知所有的訂閱者(Watcher),觸發訂閱者的相應邏輯處理
      this.subs.forEach(sub => sub.update());
    }
  }
  // 爲Dep類設置一個靜態屬性,默認爲null,工作時指向當前的Watcher
  Dep.target = null;

現在我們需要實現監聽者(Observer),用於監聽屬性值的變化。

// 監聽者,監聽對象屬性值的變化
  class Observer {
    constructor(value) {
      this.value = value;
      this.walk(value);
    }
    // 遍歷屬性值並監聽
    walk(value) {
      Object.keys(value).forEach(key => this.convert(key, value[key]));
    }
    // 執行監聽的具體方法
    convert(key, val) {
      defineReactive(this.value, key, val);
    }
  }

  function defineReactive(obj, key, val) {
    const dep = new Dep();
    // 給當前屬性的值添加監聽
    let chlidOb = observe(val);
    Object.defineProperty(obj, key, {
      enumerable: true,
      configurable: true,
      get: () => {
        // 如果Dep類存在target屬性,將其添加到dep實例的subs數組中
        // target指向一個Watcher實例,每個Watcher都是一個訂閱者
        // Watcher實例在實例化過程中,會讀取data中的某個屬性,從而觸發當前get方法
        if (Dep.target) {
          dep.depend();
        }
        return val;
      },
      set: newVal => {
        if (val === newVal) return;
        val = newVal;
        // 對新值進行監聽
        chlidOb = observe(newVal);
        // 通知所有訂閱者,數值被改變了
        dep.notify();
      },
    });
  }

  function observe(value) {
    // 當值不存在,或者不是複雜數據類型時,不再需要繼續深入監聽
    if (!value || typeof value !== 'object') {
      return;
    }
    return new Observer(value);
  }

那麼接下來就簡單了,我們需要實現一個訂閱者(Watcher)。

  class Watcher {
    constructor(vm, expOrFn, cb) {
      this.depIds = {}; // hash儲存訂閱者的id,避免重複的訂閱者
      this.vm = vm; // 被訂閱的數據一定來自於當前Vue實例
      this.cb = cb; // 當數據更新時想要做的事情
      this.expOrFn = expOrFn; // 被訂閱的數據
      this.val = this.get(); // 維護更新之前的數據
    }
    // 對外暴露的接口,用於在訂閱的數據被更新時,由訂閱者管理員(Dep)調用
    update() {
      this.run();
    }
    addDep(dep) {
      // 如果在depIds的hash中沒有當前的id,可以判斷是新Watcher,因此可以添加到dep的數組中儲存
      // 此判斷是避免同id的Watcher被多次儲存
      if (!this.depIds.hasOwnProperty(dep.id)) {
        dep.addSub(this);
        this.depIds[dep.id] = dep;
      }
    }
    run() {
      const val = this.get();
      console.log(val);
      if (val !== this.val) {
        this.val = val;
        this.cb.call(this.vm, val);
      }
    }
    get() {
      // 當前訂閱者(Watcher)讀取被訂閱數據的最新更新後的值時,通知訂閱者管理員收集當前訂閱者
      Dep.target = this;
      const val = this.vm._data[this.expOrFn];
      // 置空,用於下一個Watcher使用
      Dep.target = null;
      return val;
    }
  }

那麼我們最後完成Vue,將上述方法掛載在Vue上。

  class Vue {
    constructor(options = {}) {
      // 簡化了$options的處理
      this.$options = options;
      // 簡化了對data的處理
      let data = (this._data = this.$options.data);
      // 將所有data最外層屬性代理到Vue實例上
      Object.keys(data).forEach(key => this._proxy(key));
      // 監聽數據
      observe(data);
    }
    // 對外暴露調用訂閱者的接口,內部主要在指令中使用訂閱者
    $watch(expOrFn, cb) {
      new Watcher(this, expOrFn, cb);
    }
    _proxy(key) {
      Object.defineProperty(this, key, {
        configurable: true,
        enumerable: true,
        get: () => this._data[key],
        set: val => {
          this._data[key] = val;
        },
      });
    }
  }

看下效果:

<p data-height="300" data-theme-id="33015" data-slug-hash="jxBRgj" data-default-tab="js,result" data-user="xiaomuzhu" data-embed-version="2" data-pen-title="雙向綁定實現---無漏洞" class="codepen">在線示例 雙向綁定實現---無漏洞版 by Iwobi (@xiaomuzhu) on CodePen.</p>
<script async src="https://static.codepen.io/ass...;></script>

至此,一個簡單的雙向綁定算是被我們實現了。

2.3 Object.defineProperty的缺陷

其實我們升級版的雙向綁定依然存在漏洞,比如我們將屬性值改爲數組。

let demo = new Vue({
  data: {
    list: [1],
  },
});

const list = document.getElementById('list');
const btn = document.getElementById('btn');

btn.addEventListener('click', function() {
  demo.list.push(1);
});


const render = arr => {
  const fragment = document.createDocumentFragment();
  for (let i = 0; i < arr.length; i++) {
    const li = document.createElement('li');
    li.textContent = arr[i];
    fragment.appendChild(li);
  }
  list.appendChild(fragment);
};

// 監聽數組,每次數組變化則觸發渲染函數,然而...無法監聽
demo.$watch('list', list => render(list));

setTimeout(
  function() {
    alert(demo.list);
  },
  5000,
);

<p data-height="300" data-theme-id="33015" data-slug-hash="NMjKxV" data-default-tab="js,result" data-user="xiaomuzhu" data-embed-version="2" data-pen-title="雙向綁定-數組漏洞" class="codepen">在線示例 雙向綁定-數組漏洞 by Iwobi (@xiaomuzhu) on CodePen.</p>
<script async src="https://static.codepen.io/ass...;></script>

是的,Object.defineProperty的第一個缺陷,無法監聽數組變化。
然而Vue的文檔提到了Vue是可以檢測到數組變化的,但是隻有以下八種方法,vm.items[indexOfItem] = newValue這種是無法檢測的。

push()
pop()
shift()
unshift()
splice()
sort()
reverse()

其實作者在這裏用了一些奇技淫巧,把無法監聽數組的情況hack掉了,以下是方法示例。

const aryMethods = ['push', 'pop', 'shift', 'unshift', 'splice', 'sort', 'reverse'];
const arrayAugmentations = [];

aryMethods.forEach((method)=> {

    // 這裏是原生Array的原型方法
    let original = Array.prototype[method];

   // 將push, pop等封裝好的方法定義在對象arrayAugmentations的屬性上
   // 注意:是屬性而非原型屬性
    arrayAugmentations[method] = function () {
        console.log('我被改變啦!');

        // 調用對應的原生方法並返回結果
        return original.apply(this, arguments);
    };

});

let list = ['a', 'b', 'c'];
// 將我們要監聽的數組的原型指針指向上面定義的空數組對象
// 別忘了這個空數組的屬性上定義了我們封裝好的push等方法
list.__proto__ = arrayAugmentations;
list.push('d');  // 我被改變啦! 4

// 這裏的list2沒有被重新定義原型指針,所以就正常輸出
let list2 = ['a', 'b', 'c'];
list2.push('d');  // 4

由於只針對了八種方法進行了hack,所以其他數組的屬性也是檢測不到的,其中的坑很多,可以閱讀上面提到的文檔。

我們應該注意到在上文中的實現裏,我們多次用遍歷方法遍歷對象的屬性,這就引出了Object.defineProperty的第二個缺陷,只能劫持對象的屬性,因此我們需要對每個對象的每個屬性進行遍歷,如果屬性值也是對象那麼需要深度遍歷,顯然能劫持一個完整的對象是更好的選擇。

Object.keys(value).forEach(key => this.convert(key, value[key]));

_

3.Proxy實現的雙向綁定的特點

Proxy在ES2015規範中被正式發佈,它在目標對象之前架設一層“攔截”,外界對該對象的訪問,都必須先通過這層攔截,因此提供了一種機制,可以對外界的訪問進行過濾和改寫,我們可以這樣認爲,Proxy是Object.defineProperty的全方位加強版,具體的文檔可以查看此處;

3.1 Proxy可以直接監聽對象而非屬性

我們還是以上文中用Object.defineProperty實現的極簡版雙向綁定爲例,用Proxy進行改寫。

const input = document.getElementById('input');
const p = document.getElementById('p');
const obj = {};

const newObj = new Proxy(obj, {
  get: function(target, key, receiver) {
    console.log(`getting ${key}!`);
    return Reflect.get(target, key, receiver);
  },
  set: function(target, key, value, receiver) {
    console.log(target, key, value, receiver);
    if (key === 'text') {
      input.value = value;
      p.innerHTML = value;
    }
    return Reflect.set(target, key, value, receiver);
  },
});

input.addEventListener('keyup', function(e) {
  newObj.text = e.target.value;
});

<p data-height="300" data-theme-id="33015" data-slug-hash="KRmwRE" data-default-tab="js,result" data-user="xiaomuzhu" data-embed-version="2" data-pen-title="KRmwRE" class="codepen">在線示例 Proxy版 by Iwobi (@xiaomuzhu) on CodePen.</p>
<script async src="https://static.codepen.io/ass...;></script>

我們可以看到,Proxy直接可以劫持整個對象,並返回一個新對象,不管是操作便利程度還是底層功能上都遠強於Object.defineProperty

3.2 Proxy可以直接監聽數組的變化

當我們對數組進行操作(push、shift、splice等)時,會觸發對應的方法名稱和length的變化,我們可以藉此進行操作,以上文中Object.defineProperty無法生效的列表渲染爲例。

const list = document.getElementById('list');
const btn = document.getElementById('btn');

// 渲染列表
const Render = {
  // 初始化
  init: function(arr) {
    const fragment = document.createDocumentFragment();
    for (let i = 0; i < arr.length; i++) {
      const li = document.createElement('li');
      li.textContent = arr[i];
      fragment.appendChild(li);
    }
    list.appendChild(fragment);
  },
  // 我們只考慮了增加的情況,僅作爲示例
  change: function(val) {
    const li = document.createElement('li');
    li.textContent = val;
    list.appendChild(li);
  },
};

// 初始數組
const arr = [1, 2, 3, 4];

// 監聽數組
const newArr = new Proxy(arr, {
  get: function(target, key, receiver) {
    console.log(key);
    return Reflect.get(target, key, receiver);
  },
  set: function(target, key, value, receiver) {
    console.log(target, key, value, receiver);
    if (key !== 'length') {
      Render.change(value);
    }
    return Reflect.set(target, key, value, receiver);
  },
});

// 初始化
window.onload = function() {
    Render.init(arr);
}

// push數字
btn.addEventListener('click', function() {
  newArr.push(6);
});

<p data-height="300" data-theme-id="33015" data-slug-hash="zjwGoN" data-default-tab="js,result" data-user="xiaomuzhu" data-embed-version="2" data-pen-title="zjwGoN" class="codepen">在線示例 Proxy列表渲染 by Iwobi (@xiaomuzhu) on CodePen.</p>
<script async src="https://static.codepen.io/ass...;></script>

很顯然,Proxy不需要那麼多hack(即使hack也無法完美實現監聽)就可以無壓力監聽數組的變化,我們都知道,標準永遠優先於hack。

3.3 Proxy的其他優勢

Proxy有多達13種攔截方法,不限於apply、ownKeys、deleteProperty、has等等是Object.defineProperty不具備的。

Proxy返回的是一個新對象,我們可以只操作新的對象達到目的,而Object.defineProperty只能遍歷對象屬性直接修改。

Proxy作爲新標準將受到瀏覽器廠商重點持續的性能優化,也就是傳說中的新標準的性能紅利。

當然,Proxy的劣勢就是兼容性問題,而且無法用polyfill磨平,因此Vue的作者才聲明需要等到下個大版本(3.0)才能用Proxy重寫。


公衆號

想要實時關注筆者最新的文章和最新的文檔更新請關注公衆號程序員面試官,後續的文章會優先在公衆號更新.

簡歷模板: 關注公衆號回覆「模板」獲取

《前端面試手冊》: 配套於本指南的突擊手冊,關注公衆號回覆「fed」獲取

2019-08-12-03-18-41

本文由博客一文多發平臺 OpenWrite 發佈!
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章