使用defineModel時,為什麼子組件內沒有任何關於props的定義和emit事件觸發的代碼?修改defineModel返回值會修改父組件上綁定的變數,這是否破壞了vue的單向數據流呢? ...
前言
vue3.4增加了defineModel
巨集函數,在子組件內修改了defineModel
的返回值,父組件上v-model
綁定的變數就會被更新。大家都知道v-model
是:modelValue
和@update:modelValue
的語法糖,但是你知道為什麼我們在子組件內沒有寫任何關於props
的定義和emit
事件觸發的代碼嗎?還有在template
渲染中defineModel
的返回值等於父組件v-model
綁定的變數值,那麼這個返回值是否就是名為modelValue
的props呢?直接修改defineModel
的返回值就會修改父組件上面綁定的變數,那麼這個行為是否相當於子組件直接修改了父組件的變數值,破壞了vue的單向數據流呢?
先說答案
defineModel
巨集函數經過編譯後會給vue組件對象上面增加modelValue
的props選項和update:modelValue
的emits選項,執行defineModel
巨集函數的代碼會變成執行useModel
函數,如下圖:
經過編譯後defineModel
巨集函數已經變成了useModel
函數,而useModel
函數的返回值是一個ref對象。註意這個是ref對象不是props,所以我們才可以在組件內直接修改defineModel
的返回值。當我們對這個ref
對象進行“讀操作”時,會像Proxy
一樣被攔截到ref
對象的get方法。在get方法中會返回本地維護localValue
變數,localValue
變數依靠watchSyncEffect
讓localValue
變數始終和父組件傳遞的modelValue
的props
值一致。
對返回值進行“寫操作”會被攔截到ref
對象的set方法中,在set方法中會將最新值同步到本地維護localValue
變數,調用vue實例上的emit方法拋出update:modelValue
事件給父組件,由父組件去更新父組件中v-model
綁定的變數。如下圖:
所以在子組件內無需寫任何關於props
的定義和emit
事件觸發的代碼,因為在編譯defineModel
巨集函數的時候已經幫我們生成了modelValue
的props選項。在對返回的ref變數進行寫操作時會觸發set方法,在set方法中會調用vue實例上的emit方法拋出update:modelValue
事件給父組件。
defineModel
巨集函數的返回值是一個ref變數,而不是一個props。所以我們可以直接修改defineModel
巨集函數的返回值,父組件綁定的變數之所以會改變是因為在底層會拋出update:modelValue
事件給父組件,由父組件去更新綁定的變數,這一行為當然滿足vue的單向數據流。
什麼是vue的單向數據流
vue的單向數據流是指,通過props將父組件的變數傳遞給子組件,在子組件中是沒有許可權去修改父組件傳遞過來的變數。只能通過emit
拋出事件給父組件,讓父組件在事件回調中去修改props傳遞的變數,然後通過props將更新後的變數傳遞給子組件。在這一過程中數據的流動是單向的,由父組件傳遞給子組件,只有父組件有數據的更改權,子組件不可直接更改數據。
一個defineModel
的例子
我在前面的 一文搞懂 Vue3 defineModel 雙向綁定:告別繁瑣代碼!文章中已經講過了defineModel
的各種用法,在這篇文章中我們就不多餘贅述了。我們直接來看一個簡單的defineModel
的例子。
下麵這個是父組件的代碼:
<template>
<CommonChild v-model="inputValue" />
<p>input value is: {{ inputValue }}</p>
</template>
<script setup lang="ts">
import { ref } from "vue";
import CommonChild from "./child.vue";
const inputValue = ref();
</script>
父組件的代碼很簡單,使用v-model
指令將inputValue
變數傳遞給子組件。然後在父組件上使用p標簽渲染出inputValue
變數的值。
我們接下來看子組件的代碼:
<template>
<input v-model="model" />
<button @click="handelReset">reset</button>
</template>
<script setup lang="ts">
const model = defineModel();
function handelReset() {
model.value = "init";
}
</script>
子組件內的代碼也很簡單,將defineModel
的返回值賦值給model
變數。然後使用v-model
指令將model
變數綁定到子組件的input輸入框上面。並且還在按鈕的click事件時使用model.value = "init"
將綁定的值重置為init
字元串。請註意在子組件中我們沒有任何定義props的代碼,也沒有拋出emit
事件的代碼。而是通過defineModel
巨集函數的返回值來接收父組件傳過來的名為modelValue
的prop,並且在子組件中是直接通過給defineModel
巨集函數的返回值進行賦值來修改父組件綁定的inputValue
變數的值。
defineModel
編譯後的樣子
要回答前面提的幾個問題,我們還是得從編譯後的子組件代碼說起。下麵這個是經過簡化編譯後的子組件代碼:
import {
defineComponent as _defineComponent,
useModel as _useModel
} from "/node_modules/.vite/deps/vue.js?v=23bfe016";
const _sfc_main = _defineComponent({
__name: "child",
props: {
modelValue: {},
modelModifiers: {},
},
emits: ["update:modelValue"],
setup(__props) {
const model = _useModel(__props, "modelValue");
function handelReset() {
model.value = "init";
}
const __returned__ = { model, handelReset };
return __returned__;
},
});
function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
return (
// ... 省略
);
}
_sfc_main.render = _sfc_render;
export default _sfc_main;
從上面我們可以看到編譯後主要有_sfc_main
和_sfc_render
這兩塊,其中_sfc_render
為render
函數,不是我們這篇文章關註的重點。我們來主要看_sfc_main
對象,看這個對象的樣子有name、props、emits、setup屬性,我想你也能夠猜出來他就是vue的組件對象。從組件對象中我們可以看到已經有了一個modelValue
的props
屬性,還有使用emits
選項聲明瞭update:modelValue
事件。我們在源代碼中沒有任何地方有定義props
和emits
選項,很明顯這兩個是通過編譯defineModel
巨集函數而來的。
我們接著來看裡面的setup函數,可以看到經過編譯後的setup函數中代碼和我們的源代碼很相似。只有defineModel
不在了,取而代之的是一個useModel
函數。
// 編譯前的代碼
const model = defineModel();
// 編譯後的代碼
const model = _useModel(__props, "modelValue");
還是同樣的套路,在瀏覽器的sources面板上面找到編譯後的js文件,然後給這個useModel
打個斷點。至於如何找到編譯後的js文件我們在前面的文章中已經講了很多遍了,這裡就不贅述了。刷新瀏覽器我們看到斷點已經走到了使用useModel
函數的地方,我們這裡給useModel
函數傳了兩個參數。第一個參數為子組件接收的props
對象,第二個參數是寫死的字元串modelValue
。進入到useModel
函數內部,簡化後的useModel
函數是這樣的:
function useModel(props, name) {
const i = getCurrentInstance();
const res = customRef((track2, trigger2) => {
watchSyncEffect(() => {
// 省略
});
});
return res;
}
從上面的代碼中我們可以看到useModel
中使用到的函數沒有一個是vue內部源碼專用的函數,全都是調用的vue暴露出來的API。這意味著我們可以參考defineModel
的實現源碼,也就是useModel
函數,然後根據自己實際情況改良一個適合自己項目的defineModel
函數。
我們先來簡單介紹一下useModel
函數中使用到的API,分別是getCurrentInstance
、customRef
、watchSyncEffect
,這三個API都是從vue中import導入的。
getCurrentInstance
函數
首先來看看getCurrentInstance
函數,他的作用是返回當前的vue實例。為什麼要調用這個函數呢?因為在setup中this是拿不到vue實例的,後面對值進行寫操作時會調用vue實例上面的emit方法拋出update事件。
watchSyncEffect
函數
接著我們來看watchSyncEffect
函數,這個API大家平時應該比較熟悉了。他的作用是立即運行一個函數,同時響應式地追蹤其依賴,併在依賴更改時立即重新執行這個函數。
比如下麵這段代碼,會立即執行console
,當count
變數的值改變後,也會立即執行console。
const count = ref(0)
watchSyncEffect(() => console.log(count.value))
// -> 輸出 0
customRef
函數
最後我們來看customRef
函數,他是useModel
函數的核心。這個函數小伙伴們應該用的比較少,我們這篇文章只簡單講講他的用法即可。如果小伙伴們對customRef
函數感興趣可以留言或者給我發消息,關註的小伙伴們多了我後面會安排一篇文章來專門講customRef
函數。官方的解釋為:
創建一個自定義的 ref,顯式聲明對其依賴追蹤和更新觸發的控制方式。
customRef()
預期接收一個工廠函數作為參數,這個工廠函數接受track
和trigger
兩個函數作為參數,並返回一個帶有get
和set
方法的對象。
這句話的意思是customRef
函數的返回值是一個ref對象。當我們對返回值ref對象進行“讀操作”時,會被攔截到ref對象的get方法中。當我們對返回值ref對象進行“寫操作”時,會被攔截到ref對象的set方法中。和Promise
相似同樣接收一個工廠函數作為參數,Promise
的工廠函數是接收的resolve
和reject
兩個函數作為參數,customRef
的工廠函數是接收的track
和trigger
兩個函數作為參數。track
用於手動進行依賴收集,trigger
函數用於手動進行依賴觸發。
我們知道vue的響應式原理是由依賴收集和依賴觸發的方式實現的,比如我們在template中使用一個ref
變數。當template被編譯為render
函數後,在瀏覽器中執行render
函數時,就會對ref
變數進行讀操作。讀操作會被攔截到Proxy的get方法中,由於此時在執行render
函數,所以當前的依賴就是render
函數。在get方法中會進行依賴收集,將當前的render
函數作為依賴收集起來。註意這裡的依賴收集是vue內部自動完成的,在我們的代碼中無需手動去進行依賴收集。
當我們對ref
變數進行寫操作時,此時會被攔截到Proxy的set方法,在set方法中會將收集到的依賴依次取出來執行,我們前面收集的依賴是render
函數。所以render
函數就會重新執行,執行render
函數生成虛擬DOM,再生成真實DOM,這樣瀏覽器中渲染的就是最新的ref
變數的值。同樣這裡依賴觸發也是在vue內部自動完成的,在我們的代碼中無需手動去觸發依賴。
搞清楚了依賴收集和依賴觸發現在來講track
和trigger
兩個函數你應該就能很容易理解了,track
和trigger
兩個函數可以讓我們手動控制什麼時候進行依賴收集和依賴觸發。執行track
函數就會手動收集依賴,執行trigger
函數就會手動觸發依賴,進行頁面刷新。在defineModel
這個場景中track
手動收集的依賴就是render
函數,trigger
手動觸發會導致render
函數重新執行,進而完成頁面刷新。
useModel
函數
現在我們可以來看useModel
函數了,簡化後的代碼如下:
function useModel(props, name) {
const i = getCurrentInstance();
const res = customRef((track2, trigger2) => {
let localValue;
watchSyncEffect(() => {
const propValue = props[name];
if (hasChanged(localValue, propValue)) {
localValue = propValue;
trigger2();
}
});
return {
get() {
track2();
return localValue;
},
set(value) {
if (hasChanged(value, localValue)) {
localValue = value;
trigger2();
}
i.emit(`update:${name}`, value);
},
};
});
return res;
}
從上面我們可以看到useModel
函數的代碼其實很簡單,useModel
的返回值就是customRef
函數的返回值,也就是一個ref
變數對象。我們看到返回值對象中有get
和set
方法,還有在customRef
函數中使用了watchSyncEffect
函數。
get
方法
在前面的demo中,我們在子組件的template中使用v-model
將defineModel
的返回值綁定到一個input輸入框中。代碼如下:
<input v-model="model" />
在第一次執行render
函數時會對model
變數進行讀操作,而model
變數是defineModel
巨集函數的返回值。編譯後我們看到defineModel
巨集函數變成了useModel
函數。所以對model
變數進行讀操作,其實就是對useModel
函數的返回值進行讀操作。我們看到useModel
函數的返回值是一個自定義ref,在自定義ref中有get和set方法,當對自定義ref
進行讀操作時會被攔截到ref
對象中的get方法。這裡在get
方法中會手動執行track2
方法進行依賴收集。因為此時是在執行render
函數,所以收集到的依賴就是render
函數,然後將本地維護的localValue
的值進行攔截返回。
set
方法
在我們前面的demo中,子組件reset按鈕的click事件中會對defineModel
的返回值model
變數進行寫操作,代碼如下:
function handelReset() {
model.value = "init";
}
和對model
變數“讀操作”同理,對model
變數進行“寫操作”也會被攔截到返回值ref
對象的set方法中。在set
方法中會先判斷新的值和本地維護的localValue
的值比起來是否有修改。如果有修改那就將更新後的值同步更新到本地維護的localValue
變數,這樣就保證了本地維護的localValue
始終是最新的值。然後執行trigger2
函數手動觸發收集的依賴,在前面get
的時候收集的依賴是render
函數,所以這裡觸發依賴會重新執行render函數,然後將最新的值渲染到瀏覽器上面。
在set方法中接著會調用vue實例上面的emit
方法進行拋出事件,代碼如下:
i.emit(`update:${name}`, value)
這裡的i
就是getCurrentInstance
函數的返回值。前面我們講過了getCurrentInstance
函數的返回值是當前vue實例,所以這裡就是調用vue實例上面的emit
方法向父組件拋出事件。這裡的name
也就是調用useModel
函數時傳入的第二個參數,我們來回憶一下前面是怎樣調用useModel
函數的 ,代碼如下:
const model = _useModel(__props, "modelValue")
傳入的第一個參數為當前的props
對象,第二個參數是寫死的字元串"modelValue"
。那這裡調用emit
拋出的事件就是update:modelValue
,傳遞的參數為最新的value的值。這就是為什麼不需要在子組件中使用使用emit
拋出事件,因為在defineModel
巨集函數編譯成的useModel
函數中已經幫我們使用emit
拋出事件了。
watchSyncEffect
函數
我們接著來看子組件中怎麼接收父組件傳遞過來的props呢,答案就在watchSyncEffect
函數中。回憶一下前面講過的useModel
函數中的watchSyncEffect
代碼如下:
function useModel(props, name) {
const res = customRef((track2, trigger2) => {
let localValue;
watchSyncEffect(() => {
const propValue = props[name];
if (hasChanged(localValue, propValue)) {
localValue = propValue;
trigger2();
}
});
return {
// ...省略
};
});
return res;
}
這個name
也就是調用useModel
函數時傳過來的第二個參數,我們前面已經講過了是一個寫死的字元串"modelValue"
。那這裡的const propValue = props[name]
就是取父組件傳遞過來的名為modelValue
的prop
,我們知道v-model
就是:modelValue
的語法糖,所以這個propValue
就是取的是父組件v-model
綁定的變數值。如果本地維護的localValue
變數的值不等於父組件傳遞過來的值,那麼就將本地維護的localValue
變數更新,讓localValue
變數始終和父組件傳遞過來的值一樣。並且觸發依賴重新執行子組件的render
函數,將子組件的最新變數的值更新到瀏覽器中。為什麼要調用trigger2
函數呢?原因是可以在子組件的template中渲染defineModel
函數的返回值,也就是父組件傳遞過來的prop變數。如果父組件傳遞過來的prop變數值改變後不重新調用trigger2
函數以重新執行render函數
,那麼子組件中的渲染的變數值就一直都是舊的值了。因為這個是在watchSyncEffect
內執行的,所以每次父組件傳過來的props
值變化後都會再執行一次,讓本地維護的localValue
變數的值始終等於父組件傳遞過來的值,並且子組件頁面上也始終渲染的是最新的變數值。
這就是為什麼在子組件中沒有任何props
定義了,因為在defineModel
巨集函數編譯後會給vue組件對象塞一個modelValue
的prop,並且在useModel
函數中會維護一個名為localValue
的本地變數接收父組件傳遞過來的props.modelValue
,並且讓localValue
變數和props.modelValue
的值始終保持一致。
總結
現在我們可以回答前面提的幾個問題了:
-
使用
defineModel
巨集函數後,為什麼我們在子組件內沒有寫任何關於props
定義的代碼?答案是本地會維護一個
localValue
變數接收父組件傳遞過來的名為modelValue
的props。調用defineModel
函數的代碼經過編譯後會變成一個調用useModel
函數的代碼,useModel
函數的返回值是一個ref
對象。當我們對defineModel
的返回值進行“讀操作”時,類似於Proxy
的get
方法一樣會對讀操作進行攔截到返回值ref
對象的get
方法中。而get
方法的返回值為本地維護的localValue
變數,在watchSyncEffect
的回調中將父組件傳遞過來的名為modelValue
的props賦值給本地維護的localValue
變數。並且由於是在watchSyncEffect
中,所以每次props
改變都會執行這個回調,所以本地維護的localValue
變數始終是等於父組件傳遞過來的modelValue
。也正是因為defineModel
巨集函數的返回值是一個ref對象而不是一個prop,所以我們可以在子組件內直接將defineModel
的返回值使用v-model
綁定到子組件input輸入框上面。 -
使用
defineModel
巨集函數後,為什麼我們在子組件內沒有寫任何關於emit
事件觸發的代碼?答案是因為調用
defineModel
函數的代碼經過編譯後會變成一個調用useModel
函數的代碼,useModel
函數的返回值是一個ref
對象。當我們直接修改defineModel
的返回值,也就是修改useModel
函數的返回值。類似於Proxy
的set
方法一樣會對寫行為進行攔截到ref
對象中的set
方法中。在set
方法中會手動觸發依賴,render
函數就會重新執行,瀏覽器上就會渲染最新的變數值。然後調用vue實例上的emit
方法,向父組件拋出update:modelValue
事件。並且將最新的值隨著事件一起傳遞給父組件,由父組件在update:modelValue
事件回調中將父組件中v-model
綁定的變數更新為最新值。 -
在
template
渲染中defineModel
的返回值等於父組件v-model
綁定的變數值,那麼這個返回值是否就是名為modelValue
的props呢?從第一個回答中我們知道
defineModel
的返回值不是props,而是一個ref對象。 -
直接修改
defineModel
的返回值就會修改父組件上面綁定的變數,那麼這個行為是否相當於子組件直接修改了父組件的變數值,破壞了vue的單向數據流呢?修改
defineModel
的返回值,就會更新父組件中v-model
綁定的變數值。看著就像是子組件中直接修改了父組件的變數值,從錶面上看著像是打破了vue的單向數據流。實則並不是那樣的,雖然我們在代碼中沒有寫過emit
拋出事件的代碼,但是在defineModel
函數編譯成的useModel
函數中已經幫我們使用emit
拋出事件了。所以並沒有打破vue的單向數據流
關註公眾號:前端歐陽
,解鎖我更多vue
乾貨文章。還可以加我微信,私信我想看哪些vue
原理文章,我會根據大家的反饋進行創作。