從觀察者模式到響應(yīng)式的設(shè)計原理

作者：阿寶哥 2021-01-25 05:38:04

響應(yīng)式對使用過 Vue 或 RxJS 的小伙伴來說，應(yīng)該都不會陌生。響應(yīng)式也是 Vue 的核心功能特性之一，因此如果要想掌握 Vue，我們就必須深刻理解響應(yīng)式。接下來阿寶哥將從觀察者模式說起，然后結(jié)合 observer-util 這個庫，帶大家一起深入學(xué)習(xí)響應(yīng)式的原理。

[[378005]]

一、觀察者模式

觀察者模式，它定義了一種一對多的關(guān)系，讓多個觀察者對象同時監(jiān)聽某一個主題對象，這個主題對象的狀態(tài)發(fā)生變化時就會通知所有的觀察者對象，使得它們能夠自動更新自己。在觀察者模式中有兩個主要角色：Subject(主題)和 Observer(觀察者)。

由于觀察者模式支持簡單的廣播通信，當(dāng)消息更新時，會自動通知所有的觀察者。下面我們來看一下如何使用 TypeScript 來實現(xiàn)觀察者模式：

1.1 定義 ConcreteObserver

interface Observer { 
  notify: Function; 
} 
 
class ConcreteObserver implements Observer{ 
  constructor(private name: string) {} 
  notify() { 
    console.log(`${this.name} has been notified.`); 
  } 
}

1.2 定義 Subject 類

class Subject {  
  private observers: Observer[] = []; 
 
  public addObserver(observer: Observer): void { 
    this.observers.push(observer); 
  } 
 
  public notifyObservers(): void { 
    console.log("notify all the observers"); 
    this.observers.forEach(observer => observer.notify()); 
  } 
}

1.3 使用示例

// ① 創(chuàng)建主題對象 
const subject: Subject = new Subject(); 
 
// ② 添加觀察者 
const observerA = new ConcreteObserver("ObserverA"); 
const observerC = new ConcreteObserver("ObserverC"); 
subject.addObserver(observerA);  
subject.addObserver(observerC); 
 
// ③ 通知所有觀察者 
subject.notifyObservers();

對于以上的示例來說，主要包含三個步驟：① 創(chuàng)建主題對象、② 添加觀察者、③ 通知觀察者。上述代碼成功運行后，控制臺會輸出以下結(jié)果：

notify all the observers 
ObserverA has been notified. 
ObserverC has been notified.

在前端大多數(shù)場景中，我們所觀察的目標(biāo)是數(shù)據(jù)，當(dāng)數(shù)據(jù)發(fā)生變化的時候，頁面能實現(xiàn)自動的更新，對應(yīng)的效果如下圖所示：

要實現(xiàn)自動更新，我們需要滿足兩個條件：一個是能實現(xiàn)精準(zhǔn)地更新，另一個是能檢測到數(shù)據(jù)的異動。要能實現(xiàn)精準(zhǔn)地更新就需要收集對該數(shù)據(jù)異動感興趣的更新函數(shù)(觀察者)，在完成收集之后，當(dāng)檢測到數(shù)據(jù)異動，就可以通知對應(yīng)的更新函數(shù)。

上面的描述看起來比較繞，其實要實現(xiàn)自動更新，我們就是要讓 ① 創(chuàng)建主題對象、② 添加觀察者、③ 通知觀察者這三個步驟實現(xiàn)自動化，這就是實現(xiàn)響應(yīng)式的核心思路。接下來，我們來舉一個具體的示例：

相信熟悉 Vue2 響應(yīng)式原理的小伙伴，對上圖中的代碼都不會陌生，其中第二步驟也被稱為收集依賴。通過使用 Object.defineProperty API，我們可以攔截對數(shù)據(jù)的讀取和修改操作。

若在函數(shù)體中對某個數(shù)據(jù)進(jìn)行讀取，則表示此函數(shù)對該數(shù)據(jù)的異動感興趣。當(dāng)進(jìn)行數(shù)據(jù)讀取時，就會觸發(fā)已定義的 getter 函數(shù)，這時就可以把數(shù)據(jù)的觀察者存儲起來。而當(dāng)數(shù)據(jù)發(fā)生異動的時候，我們就可以通知觀察者列表中的所有觀察者，從而執(zhí)行相應(yīng)的更新操作。

Vue3 使用了 Proxy API 來實現(xiàn)響應(yīng)式，Proxy API 相比 Object.defineProperty API 有哪些優(yōu)點呢?這里阿寶哥不打算展開介紹了，后面打算寫一篇專門的文章來介紹 Proxy API。下面阿寶哥將開始介紹本文的主角 —— observer-util：

Transparent reactivity with 100% language coverage. Made with ❤️ and ES6 Proxies.
https://github.com/nx-js/observer-util

該庫內(nèi)部也是利用了 ES6 的 Proxy API 來實現(xiàn)響應(yīng)式，在介紹它的工作原理前，我們先來看一下如何使用它。

二、observer-util 簡介

observer-util 這個庫使用起來也很簡單，利用該庫提供的 observable 和 observe 函數(shù)，我們就可以方便地實現(xiàn)數(shù)據(jù)的響應(yīng)式。下面我們先來舉個簡單的例子：

2.1 已知屬性

import { observable, observe } from '@nx-js/observer-util'; 
 
const counter = observable({ num: 0 }); 
const countLogger = observe(() => console.log(counter.num)); // 輸出 0 
 
counter.num++; // 輸出 1

在以上代碼中，我們從 @nx-js/observer-util 模塊中分別導(dǎo)入 observable 和 observe 函數(shù)。其中 observable 函數(shù)用于創(chuàng)建可觀察的對象，而 observe 函數(shù)用于注冊觀察者函數(shù)。以上的代碼成功執(zhí)行后，控制臺會依次輸出 0 和 1。除了已知屬性外，observer-util 也支持動態(tài)屬性。

2.2 動態(tài)屬性

import { observable, observe } from '@nx-js/observer-util'; 
 
const profile = observable(); 
observe(() => console.log(profile.name)); 
 
profile.name = 'abao'; // 輸出 'abao'

以上的代碼成功執(zhí)行后，控制臺會依次輸出 undefined 和 abao。observer-util 除了支持普通對象之外，它還支持?jǐn)?shù)組和 ES6 中的集合，比如 Map、Set 等。這里我們以常用的數(shù)組為例，來看一下如何讓數(shù)組對象變成響應(yīng)式對象。

2.3 數(shù)組

import { observable, observe } from '@nx-js/observer-util'; 
 
const users = observable([]); 
 
observe(() => console.log(users.join(', '))); 
 
users.push('abao'); // 輸出 'abao' 
 
users.push('kakuqo'); // 輸出 'abao, kakuqo' 
 
users.pop(); // 輸出 'abao,'

這里阿寶哥只介紹了幾個簡單的示例，對 observer-util 其他使用示例感興趣的小伙伴，可以閱讀該項目的 README.md 文檔。接下來，阿寶哥將以最簡單的例子為例，來分析一下 observer-util 這個庫響應(yīng)式的實現(xiàn)原理。

如果你想在本地運行以上示例的話，可以先修改 debug/index.js 目錄下的 index.js文件，然后在根目錄下執(zhí)行 npm run debug 命令。

三、observer-util 原理解

析首先，我們再來回顧一下最早的那個例子：

import { observable, observe } from '@nx-js/observer-util'; 
 
const counter = observable({ num: 0 }); // A 
const countLogger = observe(() => console.log(counter.num)); // B 
 
counter.num++; // C

在第 A 行中，我們通過 observable 函數(shù)創(chuàng)建了可觀察的 counter 對象，該對象的內(nèi)部結(jié)構(gòu)如下：

通過觀察上圖可知，counter 變量所指向的是一個 Proxy 對象，該對象含有 3 個 Internal slots。那么 observable 函數(shù)是如何將我們的 { num: 0 } 對象轉(zhuǎn)換成 Proxy 對象呢?在項目的 src/observable.js 文件中，我們找到了該函數(shù)的定義：

// src/observable.js 
export function observable (obj = {}) { 
  // 如果obj已經(jīng)是一個observable對象或者不應(yīng)該被包裝，則直接返回它 
  if (proxyToRaw.has(obj) || !builtIns.shouldInstrument(obj)) { 
    return obj 
  } 
 
  // 如果obj已經(jīng)有一個對應(yīng)的observable對象，則將其返回。否則創(chuàng)建一個新的observable對象 
  return rawToProxy.get(obj) || createObservable(obj) 
}

在以上代碼中出現(xiàn)了 proxyToRaw 和 rawToProxy 兩個對象，它們被定義在 src/internals.js 文件中：

// src/internals.js 
export const proxyToRaw = new WeakMap() 
export const rawToProxy = new WeakMap()

這兩個對象分別存儲了 proxy => raw 和 raw => proxy 之間的映射關(guān)系，其中 raw 表示原始對象，proxy 表示包裝后的 Proxy 對象。很明顯首次執(zhí)行時，proxyToRaw.has(obj) 和 rawToProxy.get(obj) 分別會返回 false 和 undefined，所以會執(zhí)行 || 運算符右側(cè)的邏輯。

下面我們來分析一下 shouldInstrument 函數(shù)，該函數(shù)的定義如下：

// src/builtIns/index.js 
export function shouldInstrument ({ constructor }) { 
  const isBuiltIn = 
    typeof constructor === 'function' && 
    constructor.name in globalObj && 
    globalObj[constructor.name] === constructor 
  return !isBuiltIn || handlers.has(constructor) 
}

在 shouldInstrument 函數(shù)內(nèi)部，會使用參數(shù) obj 的構(gòu)造函數(shù)判斷其是否為內(nèi)置對象，對于 { num: 0 } 對象來說，它的構(gòu)造函數(shù)是 ƒ Object() { [native code] }，因此 isBuiltIn 的值為 true，所以會繼續(xù)執(zhí)行 || 運算符右側(cè)的邏輯。其中 handlers 對象是一個 Map 對象：

// src/builtIns/index.js 
const handlers = new Map([ 
  [Map, collectionHandlers], 
  [Set, collectionHandlers], 
  [WeakMap, collectionHandlers], 
  [WeakSet, collectionHandlers], 
  [Object, false], 
  [Array, false], 
  [Int8Array, false], 
  [Uint8Array, false], 
  // 省略部分代碼 
  [Float64Array, false] 
])

看完 handlers 的結(jié)構(gòu)，很明顯 !builtIns.shouldInstrument(obj) 表達(dá)式的結(jié)果為 false。所以接下來，我們的焦點就是 createObservable 函數(shù)：

function createObservable (obj) { 
  const handlers = builtIns.getHandlers(obj) || baseHandlers 
  const observable = new Proxy(obj, handlers) 
  // 保存raw => proxy，proxy => raw 之間的映射關(guān)系 
  rawToProxy.set(obj, observable) 
  proxyToRaw.set(observable, obj) 
  storeObservable(obj) 
  return observable 
}

通過觀察以上代碼，我們就知道了為什么調(diào)用 observable({ num: 0 }) 函數(shù)之后，返回的是一個 Proxy 對象。對于 Proxy 的構(gòu)造函數(shù)來說，它支持兩個參數(shù)：

const p = new Proxy(target, handler)

target：要使用 Proxy 包裝的目標(biāo)對象(可以是任何類型的對象，包括原生數(shù)組，函數(shù)，甚至另一個代理);
handler：一個通常以函數(shù)作為屬性的對象，各屬性中的函數(shù)分別定義了在執(zhí)行各種操作時代理 p 的行為。

示例中的 target 指向的就是 { num: 0 } 對象，而 handlers 的值會根據(jù) obj 的類型而返回不同的 handlers：

// src/builtIns/index.js 
export function getHandlers (obj) { 
  return handlers.get(obj.constructor) // [Object, false], 
}

而 baseHandlers 是一個包含了 get、has 和 set 等 “陷阱“ 的對象：

export default { get, has, ownKeys, set, deleteProperty }

在創(chuàng)建完 observable 對象之后，會保存 raw => proxy，proxy => raw 之間的映射關(guān)系，然后再調(diào)用 storeObservable 函數(shù)執(zhí)行存儲操作，storeObservable 函數(shù)被定義在 src/store.js 文件中：

// src/store.js 
const connectionStore = new WeakMap() 
 
export function storeObservable (obj) { 
  // 用于后續(xù)保存obj.key -> reaction之間映射關(guān)系 
  connectionStore.set(obj, new Map()) 
}

介紹了那么多，阿寶哥用一張圖來總結(jié)一下前面的內(nèi)容：

至于 proxyToRaw 和 rawToProxy 對象有什么用呢?相信看完以下代碼，你就會知道答案。

// src/observable.js 
export function observable (obj = {}) { 
  // 如果obj已經(jīng)是一個observable對象或者不應(yīng)該被包裝，則直接返回它 
  if (proxyToRaw.has(obj) || !builtIns.shouldInstrument(obj)) { 
    return obj 
  } 
 
  // 如果obj已經(jīng)有一個對應(yīng)的observable對象，則將其返回。否則創(chuàng)建一個新的observable對象 
  return rawToProxy.get(obj) || createObservable(obj) 
}

下面我們來開始分析第 B 行：

const countLogger = observe(() => console.log(counter.num)); // B

observe 函數(shù)被定義在 src/observer.js 文件中，其具體定義如下：

// src/observer.js 
export function observe (fn, options = {}) { 
  // const IS_REACTION = Symbol('is reaction') 
  const reaction = fn[IS_REACTION] 
    ? fn 
    : function reaction () { 
      return runAsReaction(reaction, fn, this, arguments) 
    } 
  // 省略部分代碼 
  reaction[IS_REACTION] = true 
  // 如果非lazy，則直接運行 
  if (!options.lazy) { 
    reaction() 
  } 
  return reaction 
}

在上面代碼中，會先判斷傳入的 fn 是不是 reaction 函數(shù)，如果是的話，直接使用它。如果不是的話，會把傳入的 fn 包裝成 reaction 函數(shù)，然后再調(diào)用該函數(shù)。在 reaction 函數(shù)內(nèi)部，會調(diào)用另一個函數(shù) —— runAsReaction，顧名思義該函數(shù)用于運行 reaction 函數(shù)。

runAsReaction 函數(shù)被定義在 src/reactionRunner.js 文件中：

// src/reactionRunner.js 
const reactionStack = [] 
 
export function runAsReaction (reaction, fn, context, args) { 
  // 省略部分代碼 
  if (reactionStack.indexOf(reaction) === -1) { 
    // 釋放(obj -> key -> reactions) 鏈接并復(fù)位清理器鏈接 
    releaseReaction(reaction) 
 
    try { 
      // 壓入到reactionStack堆棧中，以便于在get陷阱中能建立(observable.prop -> reaction)之間的聯(lián)系 
      reactionStack.push(reaction) 
      return Reflect.apply(fn, context, args) 
    } finally { 
      // 從reactionStack堆棧中，移除已執(zhí)行的reaction函數(shù) 
      reactionStack.pop() 
    } 
  } 
}

在 runAsReaction 函數(shù)體中，會把當(dāng)前正在執(zhí)行的 reaction 函數(shù)壓入 reactionStack棧中，然后使用 Reflect.apply API 調(diào)用傳入的 fn 函數(shù)。當(dāng) fn 函數(shù)執(zhí)行時，就是執(zhí)行 console.log(counter.num) 語句，在該語句內(nèi)，會訪問 counter 對象的 num 屬性。counter 對象是一個 Proxy 對象，當(dāng)訪問該對象的屬性時，會觸發(fā) baseHandlers 中 get 陷阱：

// src/handlers.js 
function get (target, key, receiver) { 
  const result = Reflect.get(target, key, receiver) 
  // 注冊并保存(observable.prop -> runningReaction) 
  registerRunningReactionForOperation({ target, key, receiver, type: 'get' }) 
  const observableResult = rawToProxy.get(result) 
  if (hasRunningReaction() && typeof result === 'object' && result !== null) { 
    // 省略部分代碼 
  } 
  return observableResult || result 
}

在以上的函數(shù)中，registerRunningReactionForOperation 函數(shù)用于保存 observable.prop -> runningReaction 之間的映射關(guān)系。其實就是為對象的指定屬性，添加對應(yīng)的觀察者，這是很關(guān)鍵的一步。所以我們來重點分析 registerRunningReactionForOperation 函數(shù)：

// src/reactionRunner.js 
export function registerRunningReactionForOperation (operation) { 
  // 從棧頂獲取當(dāng)前正在執(zhí)行的reaction 
  const runningReaction = reactionStack[reactionStack.length - 1] 
  if (runningReaction) { 
    debugOperation(runningReaction, operation) 
    registerReactionForOperation(runningReaction, operation) 
  } 
}

在 registerRunningReactionForOperation 函數(shù)中，首先會從 reactionStack 堆棧中獲取正在運行的 reaction 函數(shù)，然后再次調(diào)用 registerReactionForOperation 函數(shù)為當(dāng)前的操作注冊 reaction 函數(shù)，具體的處理邏輯如下所示：

// src/store.js 
export function registerReactionForOperation (reaction, { target, key, type }) { 
  // 省略部分代碼 
  const reactionsForObj = connectionStore.get(target) // A 
  let reactionsForKey = reactionsForObj.get(key) // B 
  if (!reactionsForKey) { // C 
    reactionsForKey = new Set() 
    reactionsForObj.set(key, reactionsForKey) 
  } 
  if (!reactionsForKey.has(reaction)) { // D 
    reactionsForKey.add(reaction) 
    reaction.cleaners.push(reactionsForKey) 
  } 
}

在調(diào)用 observable(obj) 函數(shù)創(chuàng)建可觀察對象時，會為以 obj 對象為 key，保存在 connectionStore (connectionStore.set(obj, new Map()) )對象中。

阿寶哥把 registerReactionForOperation 函數(shù)內(nèi)部的處理邏輯分為 4 個部分：

(A)：從 connectionStore (WeakMap)對象中獲取 target 對應(yīng)的值，會返回一個 reactionsForObj(Map)對象;
(B)：從 reactionsForKey (Map)對象中獲取 key(對象屬性)對應(yīng)的值，如果不存在的話，會返回 undefined;
(C)：如果 reactionsForKey 為 undefined，則會創(chuàng)建一個 Set 對象，并把該對象作為 value，保存在 reactionsForObj(Map)對象中;
(D)：判斷 reactionsForKey(Set)集合中是否含有當(dāng)前的 reaction 函數(shù)，如果不存在的話，把當(dāng)前的 reaction 函數(shù)添加到 reactionsForKey(Set)集合中。

為了讓大家能夠更好地理解該部分的內(nèi)容，阿寶哥繼續(xù)通過畫圖來總結(jié)上述的內(nèi)容：

因為對象中的每個屬性都可以關(guān)聯(lián)多個 reaction 函數(shù)，為了避免出現(xiàn)重復(fù)，我們使用 Set 對象來存儲每個屬性所關(guān)聯(lián)的 reaction 函數(shù)。而一個對象又可以包含多個屬性，所以 observer-util 內(nèi)部使用了 Map 對象來存儲每個屬性與 reaction 函數(shù)之間的關(guān)聯(lián)關(guān)系。

此外，為了支持能把多個對象變成 observable 對象并在原始對象被銷毀時能及時地回收內(nèi)存， observer-util 定義了 WeakMap 類型的 connectionStore 對象來存儲對象的鏈接關(guān)系。對于當(dāng)前的示例，connectionStore 對象的內(nèi)部結(jié)構(gòu)如下所示：

最后，我們來分析 counter.num++; 這行代碼。簡單起見，阿寶哥只分析核心的處理邏輯，對完整代碼感興趣的小伙伴，可以閱讀該項目的源碼。當(dāng)執(zhí)行 counter.num++; 這行代碼時，會觸發(fā)已設(shè)置的 set 陷阱：

// src/handlers.js 
function set (target, key, value, receiver) { 
  // 省略部分代碼 
  const hadKey = hasOwnProperty.call(target, key) 
  const oldValue = target[key] 
  const result = Reflect.set(target, key, value, receiver) 
  if (!hadKey) { 
    queueReactionsForOperation({ target, key, value, receiver, type: 'add' }) 
  } else if (value !== oldValue) { 
    queueReactionsForOperation({ 
      target, 
      key, 
      value, 
      oldValue, 
      receiver, 
      type: 'set' 
    }) 
  } 
  return result 
}

對于我們的示例，將會調(diào)用 queueReactionsForOperation 函數(shù)：

// src/reactionRunner.js 
export function queueReactionsForOperation (operation) { 
  // iterate and queue every reaction, which is triggered by obj.key mutation 
  getReactionsForOperation(operation).forEach(queueReaction, operation) 
}

在 queueReactionsForOperation 函數(shù)內(nèi)部會繼續(xù)調(diào)用 getReactionsForOperation 函數(shù)獲取當(dāng)前 key 對應(yīng)的 reactions：

// src/store.js 
export function getReactionsForOperation ({ target, key, type }) { 
  const reactionsForTarget = connectionStore.get(target) 
  const reactionsForKey = new Set() 
 
  if (type === 'clear') { 
    reactionsForTarget.forEach((_, key) => { 
      addReactionsForKey(reactionsForKey, reactionsForTarget, key) 
    }) 
  } else { 
    addReactionsForKey(reactionsForKey, reactionsForTarget, key) 
  } 
 // 省略部分代碼 
  return reactionsForKey 
}

在成功獲取當(dāng)前 key 對應(yīng)的 reactions 對象之后，會遍歷該對象執(zhí)行每個 reaction，具體的處理邏輯被定義在 queueReaction 函數(shù)中：

// src/reactionRunner.js 
function queueReaction (reaction) { 
  debugOperation(reaction, this) 
  // queue the reaction for later execution or run it immediately 
  if (typeof reaction.scheduler === 'function') { 
    reaction.scheduler(reaction) 
  } else if (typeof reaction.scheduler === 'object') { 
    reaction.scheduler.add(reaction) 
  } else { 
    reaction() 
  } 
}

因為我們的示例并沒有配置 scheduler 參數(shù)，所以就會直接執(zhí)行 else 分支的代碼，即執(zhí)行 reaction() 該語句。

好的，observer-util 這個庫內(nèi)部如何把普通對象轉(zhuǎn)換為可觀察對象的核心邏輯已經(jīng)分析完了。對于普通對象來說，observer-util 內(nèi)部通過 Proxy API 提供 get 和 set 陷阱，實現(xiàn)自動添加觀察者(添加 reaction 函數(shù))和通知觀察者(執(zhí)行 reaction 函數(shù))的處理邏輯。

如果你看完本文所介紹的內(nèi)容，應(yīng)該就可以理解 Vue3 中 reactivity 模塊內(nèi) targetMap 的相關(guān)定義：

// vue-next/packages/reactivity/src/effect.ts 
type Dep = Set<ReactiveEffect> 
type KeyToDepMap = Map<any, Dep> 
const targetMap = new WeakMap<any, KeyToDepMap>()

除了普通對象和數(shù)組之外，observer-util 還支持 ES6 中的集合，比如 Map、Set 和 WeakMap 等。當(dāng)處理這些對象時，在創(chuàng)建 Proxy 對象時，會使用 collectionHandlers對象，而不是 baseHandlers 對象。這部分內(nèi)容，阿寶哥就不再展開介紹，感興趣的小伙伴可以自行閱讀相關(guān)代碼。如果想了解 WeakMap 的相關(guān)知識，可以閱讀你不知道的 WeakMap 這篇文章。

四、參考資源

what-is-an-internal-slot-of-an-object-in-javascript
MDN-Proxy
MDN-Reflect

責(zé)任編輯：姜華來源：全棧修仙之路