Vue3偵聽器的實現原理詳情

Posted on by

前言：

本篇內容基於Vue3計算屬性是如何實現的實現。

偵聽響應式對象

前面我們聊到計算屬性，它可以自動計算並緩存響應式數據的值。而如果我們僅需要在響應式數據變化時，執行一些預設的操作，就可以使用watch偵聽器。我們還是先來實現一個最簡單的例子，然後來一點一點擴充它。

const data = {foo: 1}
const obj = reactive(data)
watch(obj, () => {
  console.log('obj已改變')
})

在這個例子中，我們使用瞭watch偵聽器，當obj的屬性被改變時，控制臺應該會打印出obj已改變。基於前面我們對計算屬性的實現，這裡我們已經有瞭一個大概的思路。把watch視為響應式對象的副作用函數，當響應式對象改變時，觸發執行該副作用函數。

想要觸發副作用函數，必須先收集它，還記得副作用函數是如何收集的嗎？對，當響應式數據被get時，收集副作用函數。所以首先，我們需要讓watch被響應式對象收集到。     

function watch(getter, cb) {
  effect(
    () => getter.foo
  )
}

接著，我們還需要讓我們預設的方法被執行。當響應式數據被set時，觸發副作用函數。這裡我們想觸發的是cb這個傳入的回調函數，這裡我們就又能用到實現計算屬性時的調度器瞭，當調度器存在時，set觸發的trigger會先執行調度器中的函數。

function watch(getter, cb) {
  effect(
    () => getter.foo,
    {
      scheduler() {
        cb()
      }
    }
  )
}

一個簡單的偵聽器已經完成瞭！這裡我們為瞭簡單，把功能寫死瞭，僅支持對obj.foo的偵聽。接下來，我們就要想想，如何實現對響應式對象的任意屬性進行偵聽？

按照前面的思路，想要實現對響應式對象的任意屬性的偵聽，就需要我們get到該對象的每一個屬性，這就需要我們對響應式對象進行一次遞歸遍歷。

function traverse(value, seen = new Set()) { // (1)
  if(typeof value !== 'object' || value === null || seen.has(value)) return
  seen.add(value)
  for(const key in value) {
    traverse(value[key], seen)
  }
  return value
}

為瞭避免遞歸遍歷對象時，循環引用造成的死循環，我們在(1)處創建瞭Set，當重復出現相同的對象時，直接返回。

偵聽屬性值

在Vue3中，我們不能直接偵聽響應式對象的屬性值。如果需要偵聽響應式對象的屬性值，就需要一個getter函數，讓偵聽器能被響應式對象收集到。

const data = {
  foo: 1
}
const obj = reactive(data)
watch(
  () => obj.foo, 
  () => {
  console.log('obj.foo已改變')
})

指定瞭屬性就意味著，當前的偵聽器僅會被指定的屬性觸發，就無需遞歸遍歷整個響應式對象瞭。

function watch(getter, cb) {
  if(typeof getter !== 'function') getter = traverse(getter) // (2)
  effect(
    () => getter(),
    {
      scheduler() {
        cb()
      }
    }
  )
}

在(2)處，我們增加瞭一個判斷，如果傳入的已經是getter函數，我們直接使用，如果不是getter函數，則認為是一個響應式對象，就需要進行遞歸遍歷。

偵聽獲取新值和舊值

在Vue中我們還需要能夠在回調函數cb()中拿到響應式數據更新前後的新值與舊值。

const data = {
  foo: 1
}
const obj = reactive(data)
watch(
  () => obj.foo, 
  (newValue, oldValue) => {
  console.log(newValue, oldValue)
})

接下來的問題是，如何獲取newValue與oldValue。newValue好解決，執行完回調函數cb()得到的就是newValue，但這裡如何獲取oldValue的值呢？要從watch中拿到舊值，那就不能讓副作用函數被立即執行。這裡想到瞭什麼？對，在實現計算屬性的時候，我們用到過的lazy，它可以禁止副作用函數自動執行。

function watch(getter, cb) {
  if(typeof getter !== 'function') getter = traverse(getter)
  let oldValue
  const effectFn = effect(
    () => getter(),
    {
      lazy: true, // (3)
      scheduler() {
          cb(oldValue)
      }
    }
  )
  oldValue = effectFn() // (4)
}

在(3)處我們設置瞭lazy開關，設置瞭lazy後，副作用函數的執行權就交到瞭我們自己手上。在(4)處，我們手動執行瞭副作用函數。這裡可以需要我們向前回顧一下，前面我們傳入的getter是一個函數() => obj.foo，而effect函數的第一個參數就是真正被執行的副作用函數，所以我們手動執行的，其實就是函數() => obj.foo，這樣我們就拿到瞭舊值。

如何獲取新值呢？在響應式數據的值更新後，副作用函數effect會被觸發執行，當調度器屬性存在時，執行調度器。在調度器中，我們可以再次執行副作用函數，通過() => obj.foo拿到改變後的新值。

function watch(getter, cb) {
  if(typeof getter !== 'function') getter = traverse(getter)
  let oldValue, newValue
  const effectFn = effect(
    () => getter(),
    {
      lazy: true,
      scheduler() {
        newValue = effectFn()
        cb(newValue, oldValue)
        oldValue = newValue // (5)
      }
    }
  )
  oldValue = effectFn()
}

在(5)處，執行完回調函數cb()，我們進行瞭一下善後工作，更新瞭oldValue的值，為下一次回調做準備。

有時，我們還希望偵聽器可以在創建時就立即執行回調函數。

const data = {
  foo: 1
}
const obj = reactive(data)
watch(
  () => obj.foo, 
  (newValue, oldValue) => {
      console.log('newValue:', newValue,', oldValue:', oldValue)
  },
  { immediate: true }
)

當immediate的值為true時，需要立即執行。明確瞭需求，我們來完善watch偵聽器。

function watch(getter, cb, options = {}) {
  if(typeof getter !== 'function') getter = traverse(getter)
  let oldValue, newValue
  function job() { // (6)
    newValue = effectFn()
    cb(newValue, oldValue)
    oldValue = newValue
  }

  const effectFn = effect(
    () => getter(),
    {
      lazy: true,
      scheduler: job,
    }
  )

  if(options.immediate) {  // (7)
    job()
  } else {
    oldValue = effectFn()
  } 
}

在(6)處，我們抽離瞭回調函數的執行邏輯，當options.immediate存在時，直接觸發執行。

實現效果

到此這篇關於Vue3偵聽器是如何實現的的文章就介紹到這瞭,更多相關Vue3偵聽器內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：