Vue3中watch監聽對象的屬性值(監聽源必須是一個getter函數)

Posted on by

Vue3 中使用 watch 偵聽對象中的具體屬性

1.前言

<script lang="ts" setup>
	// 接受父組件傳遞的數據
    const props = defineProps({
        test: {
            type: String,
            default: ''
        }
    })
    
    // 使用 watch 偵聽 props 中的 test 屬性
    watch(
        // 這種寫法不會偵聽到 props 中 test 的變化
    	props.test,
        () => {
            console.log("偵聽成功")
        }
    )
    
    watch(
    	// 這種寫法會偵聽到 props 中 test 的變化
        () => props.test,
        () => {
            console.log("偵聽成功")
        }
    )
</script>

watch 的基本用法

watch() 默認是懶偵聽的，即僅在偵聽源發生變化時才執行回調函數

第一個參數：偵聽源，偵聽源可以是一下幾種

一個函數，返回一個值一個 ref一個響應式對象（reactive）或是由以上類型的值組成的數組

第二個參數：偵聽源發生變化時要觸發的回調函數。

​ (newValue, oldValue) => { /* code */}

​ 當偵聽多個來源時，回調函數接受兩個數組，分別對應源數組中的新值和舊值

​ ( [ newValue1, newValue2 ] , [ oldValue1 , oldValue2 ]) => {/* code */}

第三個參數：可選對象，可以支持一下這些選項

immediate：偵聽器創建時立即觸發回調deep：如果源是一個對象，會強制深度遍歷，以便在深層級發生變化時觸發回調函數flush：調整回調函數的刷新時機onTrack / onTrigger：調試偵聽器的依賴

2. 原因

因為watch的偵聽源隻能是上面的4中情況

const obj = reactive({ count: 0 })

// 錯誤，因為 watch() 中的偵聽源是一個 number，最終 source 返回的 getter 函數是一個空，所以就得不到偵聽的數據
watch(obj.count, (count) => {
  console.log(`count is: ${count}`)
})

// 正確，主要思想是，將偵聽源轉化為以上4種類型（轉化為getter函數是最簡單方便的）
watch(
  () => obj.count,
  (count) => {
    console.log(`count is: ${count}`)
  }
)

3.watch源碼分析

export function watch<T = any, Immediate extends Readonly<boolean> = false>(
  source: T | WatchSource<T>,
  cb: any,
  options?: WatchOptions<Immediate>
): WatchStopHandle {
  if (__DEV__ && !isFunction(cb)) {
    warn(
      `\`watch(fn, options?)\` signature has been moved to a separate API. ` +
      `Use \`watchEffect(fn, options?)\` instead. \`watch\` now only ` +
      `supports \`watch(source, cb, options?) signature.`
    )
  }
  return doWatch(source as any, cb, options)
}

從源碼中可以看出，watch接收三個參數：source偵聽源、cb回調函數、options偵聽配置，最後會返回一個doWatch

4.doWatch源碼分析

function doWatch(
  source: WatchSource | WatchSource[] | WatchEffect | object,
  cb: WatchCallback | null,
  { immediate, deep, flush, onTrack, onTrigger }: WatchOptions = EMPTY_OBJ
): WatchStopHandle {
  // ...
// 當前組件實例
const instance = currentInstance
// 副作用函數，在初始化effect時使用
let getter: () => any
// 強制觸發偵聽
let forceTrigger = false
// 是否為多數據源。
let isMultiSource = false
}

doWatch依然接受三個參數：source偵聽源、cb回調函數、options偵聽配置

這裡著重對偵聽源的源碼進行分析（source標準化）

  • 如果source是ref類型，getter是個返回source.value的函數，forceTrigger取決於source是否是淺層響應式。
if (isRef(source)) {
  getter = () => source.value
  forceTrigger = isShallow(source)
}
  • 如果source是reactive類型，getter是個返回source的函數，並將deep設置為true。 當直接偵聽一個響應式對象時，偵聽器會自動啟用深層模式
if (isReactive(source)) {
  getter = () => source
  deep = true
}

例子

<template>
  <div class="container">
    <h2>obj---{{ obj }}</h2>
    <button @click="changeName">修改名字</button>
    <button @click="changeAge">修改年齡</button>
  </div>
</template>

<script lang="ts" setup>
import { reactive, watch } from "vue";
const obj = reactive({
  name: "張三",
  age: 18,
});
const changeName = () => {
  obj.name += "++";
};
const changeAge = () => {
  obj.age += 1;
};
// obj 中的任一屬性變化瞭，都會被監聽到
watch(obj, () => {
  console.log("變化瞭");
});
</script>
  • 如果source是個數組，將isMultiSource設為true，forceTrigger取決於source是否有reactive類型的數據，getter函數中會遍歷source，針對不同類型的source做不同處理。
if (isArray(source)) {
  isMultiSource = true
  forceTrigger = source.some(isReactive)
  getter = () =>
    source.map(s => {
      if (isRef(s)) {
        return s.value
      } else if (isReactive(s)) {
        return traverse(s)
      } else if (isFunction(s)) {
        return callWithErrorHandling(s, instance, ErrorCodes.WATCH_GETTER)
      } else {
        __DEV__ && warnInvalidSource(s)
      }
    })
}
  • 如果source是個function。存在cb的情況下，getter函數中會執行source，這裡source會通過callWithErrorHandling函數執行，在callWithErrorHandling中會處理source執行過程中出現的錯誤；不存在cb的話，在getter中，如果組件已經被卸載瞭，直接return，否則判斷cleanup（cleanup是在watchEffect中通過onCleanup註冊的清理函數），如果存在cleanup執行cleanup，接著執行source，並返回執行結果。source會被callWithAsyncErrorHandling包裝，該函數作用會處理source執行過程中出現的錯誤，與callWithErrorHandling不同的是，callWithAsyncErrorHandling會處理異步錯誤。
if (isFunction(source)) {
  if (cb) {
    getter = () =>
      callWithErrorHandling(source, instance, ErrorCodes.WATCH_GETTER)
  } else {
    // watchEffect
    getter = () => {
      // 如果組件實例已經卸載，直接return
      if (instance && instance.isUnmounted) {
        return
      }
      // 如果清理函數，則執行清理函數
      if (cleanup) {
        cleanup()
      }
      // 執行source，傳入onCleanup，用來註冊清理函數
      return callWithAsyncErrorHandling(
        source,
        instance,
        ErrorCodes.WATCH_CALLBACK,
        [onCleanup]
      )
    }
  }
}
  • 其他情況getter會被賦值為一個空函數
getter = NOOP
__DEV__ && warnInvalidSource(source)

5.總結

其實，source標準化主要是根據source的類型，將其變成 getter 函數

  • 如果 source是ref對象，則創建一個訪問 source.value 的getter函數
  • 如果source是一個reactive對象，則創建一個訪問source的getter函數，並將deep設置為true如果source 是一個函數，則會進一步進行判斷第二個參數cb是否存在。
  • 最後的getter就是一個簡單的對source封裝的函數如果source是一個數組，則會對數組中的每個元素進行判斷並且返回相應的getter函數。
  • 最後返回一個各種getter函數封裝成的一個數組

整個doWatch 方法中的邏輯主要分為一下幾步：

  • 通過getter函數來獲取數據源的值
  • 通過job方法來調用傳入watch中的cb
  • job中通過調用runner，runner調用getter獲取數據源新值
  • doWatch中閉包緩存瞭數據源的舊值
  • 將新舊值作為參數調用cb
  • 將job作為activeEffect的scheduler方法，在後續的數據修改導致的trigger中調用
  • 首次調用，傳入瞭immediate調用job，未傳入調用runner，以數據源為被觀察者收集依賴實現響應式

偵聽的第一步就是需要通過正確的getter函數去獲取偵聽源的值，所以在使用watch偵聽數據時，務必保證偵聽源的類型是符合官方規定的類型的

到此這篇關於Vue3中watch監聽對象的屬性值，監聽源必須是一個getter函數的文章就介紹到這瞭,更多相關Vue3 watch監聽對象內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：