vue3中ref綁定dom或者組件失敗的原因及分析

Posted on by

vue3 ref綁定dom或者組件失敗原因分析

場景描述

在vue3中經常用到使用ref綁定組件或者dom元素的情況，很多時候，明明使用ref綁定瞭相關組件，但是經常ref綁定失敗的情況。

ref綁定失敗情況舉例

ref綁定失敗的絕大多數情況是，在ref和組件綁定的時候，該組件還未渲染，所以綁定失敗。

或者組件剛開始未渲染，ref未綁定，當組件開始渲染，ref也開始綁定，但是ref和組件並未綁定完成，這個時候使用組件相關的方法就會出現問題。

  • ref綁定的組件使用瞭v-if,或者他的父組件使用瞭v-if導致頁面開始渲染的時候，這些組件並沒有渲染，所以綁定失敗。
  • 在element-plus中有很多 dialog彈窗等組件，這些組件開始是隱藏的，隻有用戶點擊瞭按鈕才展示，所以很多時候是在用戶點擊按鈕的時候，ref才開始和組件綁定，這個時候綁定還未完成，我們通過ref的變量使用組件的方法，就會出現Uncaught TypeError: Cannot read properties of null (reading 'setCheckedNodes')的錯誤

解決方案

使用vue3的nextTick方法，讓調用ref組件方法的邏輯放到下一個時間片執行即可。（推薦）

function addFilterPropertyRule(row) {

    let ruleParamObj = JSON.parse(row.hardwareParam)
    if (ruleParamObj) {
        makePropertityTree(ruleParamObj, treeData)
    }
    addOrEditRuleVisible.value = true
    currentRuleItem = row
    if (row.ruleJson) {
        nextTick(() => {
            treeRef.value.setCheckedNodes(JSON.parse(row.ruleJson), false)
        })
    }
}

使用一個延時定時器，讓調用ref組件方法的邏輯等一會再執行。（不推薦） 

vue3組合式API的v-for及ref綁定DOM

組合式 API 模板引用在 v-for 內部使用時沒有特殊處理。需要綁定函數自定義處理。

<template>
  <div v-for="(item, i) in list" :ref="el => { if (el) divs[i] = el }">
    {{ item }}
  </div>
</template>
 
<script>
  import { ref, reactive, onBeforeUpdate } from 'vue'
 
  export default {
    setup() {
      const list = reactive([1, 2, 3])
      const divs = ref([])
 
      // 確保在每次更新之前重置ref
      onBeforeUpdate(() => {
        divs.value = []
      })
 
      return {
        list,
        divs
      }
    }
  }
</script>
  • Ref
<template> 
  <div ref="root">This is a root element</div>
</template>
 
<script>
  import { ref, onMounted } from 'vue'
 
  export default {
    setup() {
      const root = ref(null)
 
      onMounted(() => {
        // DOM 元素將在初始渲染後分配給 ref
        console.log(root.value) // <div>This is a root element</div>
      })
 
      return {
        root
      }
    }
  }
</script>

總結

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：