Composition API也叫組合式API,是Vue3.x的新特性。
通過創(chuàng)建 Vue 組件,我們可以將接口的可重復(fù)部分及其功能提取到可重用的代碼段中。僅此一項(xiàng)就可以使我們的應(yīng)用程序在可維護(hù)性和靈活性方面走得更遠(yuǎn)。然而,我們的經(jīng)驗(yàn)已經(jīng)證明,光靠這一點(diǎn)可能是不夠的,尤其是當(dāng)你的應(yīng)用程序變得非常大的時(shí)候——想想幾百個(gè)組件。在處理如此大的應(yīng)用程序時(shí),共享和重用代碼變得尤為重要
通俗的講:
沒有Composition API之前vue相關(guān)業(yè)務(wù)的代碼需要配置到option的特定的區(qū)域,中小型項(xiàng)目是沒有問題的,但是在大型項(xiàng)目中會(huì)導(dǎo)致后期的維護(hù)性比較復(fù)雜,同時(shí)代碼可復(fù)用性不高。Vue3.x中的composition-api就是為了解決這個(gè)問題而生的
compositon api提供了以下幾個(gè)函數(shù):
setuprefreactivewatchEffectwatchcomputedtoRefs- 生命周期的
hooks
一、setup組件選項(xiàng)
新的
setup組件選項(xiàng)在創(chuàng)建組件之前執(zhí)行,一旦props被解析,并充當(dāng)合成API的入口點(diǎn)
提示:
由于在執(zhí)行
setup時(shí)尚未創(chuàng)建組件實(shí)例,因此在setup選項(xiàng)中沒有this。這意味著,除了props之外,你將無法訪問組件中聲明的任何屬性——本地狀態(tài)、計(jì)算屬性或方法。
使用 setup 函數(shù)時(shí),它將接受兩個(gè)參數(shù):
propscontext
讓我們更深入地研究如何使用每個(gè)參數(shù)
1. Props
setup函數(shù)中的第一個(gè)參數(shù)是props。正如在一個(gè)標(biāo)準(zhǔn)組件中所期望的那樣,setup函數(shù)中的props是響應(yīng)式的,當(dāng)傳入新的prop時(shí),它將被更新
// MyBook.vue
export default {
props: {
title: String
},
setup(props) {
console.log(props.title)
}
}
注意:
但是,因?yàn)?
props是響應(yīng)式的,你不能使用ES6解構(gòu),因?yàn)樗鼤?huì)消除prop的響應(yīng)性。
如果需要解構(gòu) prop,可以通過使用 setup 函數(shù)中的 toRefs 來安全地完成此操作。
// MyBook.vue
import { toRefs } from 'vue'
setup(props) {
const { title } = toRefs(props)
console.log(title.value)
}
2. 上下文
傳遞給
setup函數(shù)的第二個(gè)參數(shù)是context。context是一個(gè)普通的 JavaScript 對象,它暴露三個(gè)組件的 property
// MyBook.vue
export default {
setup(props, context) {
// Attribute (非響應(yīng)式對象)
console.log(context.attrs)
// 插槽 (非響應(yīng)式對象)
console.log(context.slots)
// 觸發(fā)事件 (方法)
console.log(context.emit)
}
}
context是一個(gè)普通的 JavaScript 對象,也就是說,它不是響應(yīng)式的,這意味著你可以安全地對context使用 ES6 解構(gòu)
// MyBook.vue
export default {
setup(props, { attrs, slots, emit }) {
...
}
}
attrs和slots是有狀態(tài)的對象,它們總是會(huì)隨組件本身的更新而更新。這意味著你應(yīng)該避免對它們進(jìn)行解構(gòu),并始終以attrs.x或slots.x的方式引用 property。請注意,與props不同,attrs和slots是非響應(yīng)式的。如果你打算根據(jù)attrs或slots更改應(yīng)用副作用,那么應(yīng)該在onUpdated生命周期鉤子中執(zhí)行此操作。
3. setup組件的 property
執(zhí)行
setup時(shí),組件實(shí)例尚未被創(chuàng)建。因此,你只能訪問以下 property:
propsattrsslotsemit
換句話說,你將無法訪問以下組件選項(xiàng):
datacomputedmethods
4. ref reactive 以及setup結(jié)合模板使用
在看setup結(jié)合模板使用之前,我們首先得知道ref 和 reactive 方法。
如果 setup 返回一個(gè)對象則可以在模板中綁定對象中的屬性和方法,但是要定義響應(yīng)式數(shù)據(jù)的時(shí)候可以使用ref, reactive方法定義響應(yīng)式的數(shù)據(jù)
錯(cuò)誤寫法:
<template>
{{msg}}
<br>
<button @click="updateMsg">改變etup中的msg</button>
<br>
</template>
<script>
export default {
data() {
return {
}
},
setup() {
let msg = "這是setup中的msg";
let updateMsg = () => {
alert("觸發(fā)方法")
msg = "改變后的值"
}
return {
msg,
updateMsg
}
},
}
</script>
<style lang="scss">
.home {
position: relative;
}
</style>
正確寫法一:
ref用來定義響應(yīng)式的 字符串、 數(shù)值、 數(shù)組、
Bool類型
import {
ref
} from 'vue'
<template>
{{msg}}
<br>
<br>
<button @click="updateMsg">改變etup中的msg</button>
<br>
<br>
<ul>
<li v-for="(item,index) in list" :key="index">
{{item}}
</li>
</ul>
<br>
</template>
<script>
import {
ref
} from 'vue'
export default {
data() {
return {
}
},
setup() {
let msg = ref("這是setup中的msg");
let list = ref(["馬總", "李總", "劉總"])
let updateMsg = () => {
alert("觸發(fā)方法");
msg.value = "改變后的值"
}
return {
msg,
list,
updateMsg
}
},
}
</script>
<style lang="scss">
.home {
position: relative;
}
</style>
正確寫法二:
reactive 用來定義響應(yīng)式的對象
import {
reactive
} from 'vue'
<template>
{{msg}}
<br>
<br>
<button @click="updateMsg">改變setup中的msg</button>
<br>
<br>
<ul>
<li v-for="(item,index) in list" :key="index">
{{item}}
</li>
</ul>
<br>
{{setupData.title}}
<br>
<button @click="updateTitle">更新setup中的title</button>
<br>
<br>
</template>
<script>
import {
reactive,
ref
} from 'vue'
export default {
data() {
return {
}
},
setup() {
let msg = ref("這是setup中的msg");
let setupData = reactive({
title: "reactive定義響應(yīng)式數(shù)據(jù)的title",
userinfo: {
username: "張三",
age: 20
}
})
let updateMsg = () => {
alert("觸發(fā)方法");
msg.value = "改變后的值"
}
let updateTitle = () => {
alert("觸發(fā)方法");
setupData.title = "我是改變后的title"
}
return {
msg,
setupData,
updateMsg,
updateTitle
}
},
}
</script>
<style lang="scss">
.home {
position: relative;
}
</style>
說明:要改變r(jià)ef定義的屬性名稱需要通過 屬性名稱.value來修改,要改變reactive中定義的對象名稱可以直接
5. 使用 this
在
setup()內(nèi)部,this不會(huì)是該活躍實(shí)例的引用,因?yàn)?setup()是在解析其它組件選項(xiàng)之前被調(diào)用的,所以setup()內(nèi)部的this的行為與其它選項(xiàng)中的this完全不同。這在和其它選項(xiàng)式 API 一起使用setup()時(shí)可能會(huì)導(dǎo)致混淆
二、toRefs - 解構(gòu)響應(yīng)式對象數(shù)據(jù)
把一個(gè)響應(yīng)式對象轉(zhuǎn)換成普通對象,該普通對象的每個(gè)
property都是一個(gè)ref,和響應(yīng)式對象property一一對應(yīng)
<template>
<div>
<h1>解構(gòu)響應(yīng)式對象數(shù)據(jù)</h1>
<p>Username: {{username}}</p>
<p>Age: {{age}}</p>
</div>
</template>
<script>
import {
reactive,
toRefs
} from "vue";
export default {
name: "解構(gòu)響應(yīng)式對象數(shù)據(jù)",
setup() {
const user = reactive({
username: "張三",
age: 10000,
});
return {
...toRefs(user)
};
},
};
</script>
當(dāng)想要從一個(gè)組合邏輯函數(shù)中返回響應(yīng)式對象時(shí),用 toRefs 是很有效的,該 API 讓消費(fèi)組件可以 解構(gòu) / 擴(kuò)展(使用
…操作符)返回的對象,并不會(huì)丟失響應(yīng)性:
function useFeatureX() {
const state = reactive({
foo: 1,
bar: 2,
})
// 對 state 的邏輯操作
// ....
// 返回時(shí)將屬性都轉(zhuǎn)為 ref
return toRefs(state)
}
export default {
setup() {
// 可以解構(gòu),不會(huì)丟失響應(yīng)性
const { foo, bar } = useFeatureX()
return {
foo,
bar,
}
},
}
三、computed - 計(jì)算屬性
<template>
<div>
<h1>解構(gòu)響應(yīng)式對象數(shù)據(jù)+computed</h1>
<input type="text" v-model="firstName" placeholder="firstName" />
<br>
<br>
<input type="text" v-model="lastName" placeholder="lastName" />
<br>
{{fullName}}
</div>
</template>
<script>
import {
reactive,
toRefs,
computed
} from "vue";
export default {
name: "解構(gòu)響應(yīng)式對象數(shù)據(jù)",
setup() {
const user = reactive({
firstName: "",
lastName: "",
});
const fullName = computed(() => {
return user.firstName + " " + user.lastName
})
return {
...toRefs(user),
fullName
};
},
};
</script>
四、readonly “深層”的只讀代理
傳入一個(gè)對象(響應(yīng)式或普通)或 ref,返回一個(gè)原始對象的只讀代理。一個(gè)只讀的代理是“深層的”,對象內(nèi)部任何嵌套的屬性也都是只讀的
<template>
<div>
<h1>readonly - “深層”的只讀代理</h1>
<p>original.count: {{original.count}}</p>
<p>copy.count: {{copy.count}}</p>
</div>
</template>
<script>
import { reactive, readonly } from "vue";
export default {
name: "Readonly",
setup() {
const original = reactive({ count: 0 });
const copy = readonly(original);
setInterval(() => {
original.count++;
copy.count++; // 報(bào)警告,Set operation on key "count" failed: target is readonly. Proxy {count: 1}
}, 1000);
return { original, copy };
},
};
</script>
五、watchEffect
在響應(yīng)式地跟蹤其依賴項(xiàng)時(shí)立即運(yùn)行一個(gè)函數(shù),并在更改依賴項(xiàng)時(shí)重新運(yùn)行它。
<template>
<div>
<h1>watchEffect - 偵聽器</h1>
<p>{{data.count}}</p>
<button @click="stop">手動(dòng)關(guān)閉偵聽器</button>
</div>
</template>
<script>
import {
reactive,
watchEffect
} from "vue";
export default {
name: "WatchEffect",
setup() {
const data = reactive({
count: 1,
num: 1
});
const stop = watchEffect(() => console.log(`偵聽器:${data.count}`));
setInterval(() => {
data.count++;
}, 1000);
return {
data,
stop
};
},
};
</script>
六、watch 、watch 與watchEffect區(qū)別
對比watchEffect,watch允許我們:
- 懶執(zhí)行,也就是說僅在偵聽的源變更時(shí)才執(zhí)行回調(diào);
- 更明確哪些狀態(tài)的改變會(huì)觸發(fā)偵聽器重新運(yùn)行;
- 訪問偵聽狀態(tài)變化前后的值
更明確哪些狀態(tài)的改變會(huì)觸發(fā)偵聽器重新運(yùn)行
<template>
<div>
<h1>watch - 偵聽器</h1>
<p>count1: {{data.count1}}</p>
<p>count2: {{data.count2}}</p>
<button @click="stopAll">Stop All</button>
</div>
</template>
<script>
import {
reactive,
watch
} from "vue";
export default {
name: "Watch",
setup() {
const data = reactive({
count1: 0,
count2: 0
});
// 偵聽單個(gè)數(shù)據(jù)源
const stop1 = watch(data, () =>
console.log("watch1", data.count1, data.count2)
);
// 偵聽多個(gè)數(shù)據(jù)源
const stop2 = watch([data], () => {
console.log("watch2", data.count1, data.count2);
});
setInterval(() => {
data.count1++;
}, 1000);
return {
data,
stopAll: () => {
stop1();
stop2();
},
};
},
};
</script>
訪問偵聽狀態(tài)變化前后的值
<template>
<div>
<h1>watch - 偵聽器</h1>
<input type="text" v-model="keywords" />
</div>
</template>
<script>
import {
ref,
watch
} from "vue";
export default {
name: "Watch",
setup() {
let keywords = ref("111");
// 偵聽單個(gè)數(shù)據(jù)源
watch(keywords, (newValue, oldValue) => {
console.log(newValue, oldValue)
});
return {
keywords
};
},
};
</script>
懶執(zhí)行,也就是說僅在偵聽的源變更時(shí)才執(zhí)行回調(diào)
<template>
<div>
<h1>watch - 偵聽器</h1>
<p>num1={{num1}}</p>
<p>num2={{num2}}</p>
</div>
</template>
<script>
import {
ref,
watch,
watchEffect
} from "vue";
export default {
name: "Watch",
setup() {
let num1 = ref(10);
let num2 = ref(10);
// 偵聽單個(gè)數(shù)據(jù)源
watch(num1, (newValue, oldValue) => {
console.log(newValue, oldValue)
});
watchEffect(() => console.log(`watchEffect偵聽器:${num2.value}`));
return {
num1,
num2
};
},
};
</script>
七、組合式api生命周期鉤子
你可以通過在生命周期鉤子前面加上 “on” 來訪問組件的生命周期鉤子。
下表包含如何在 setup () 內(nèi)部調(diào)用生命周期鉤子:
| 選項(xiàng)式 API | Hook inside setup
|
|---|---|
beforeCreate |
不需要* |
created |
不需要* |
beforeMount |
onBeforeMount |
mounted |
onMounted |
beforeUpdate |
onBeforeUpdate |
updated |
onUpdated |
beforeUnmount |
onBeforeUnmount |
unmounted |
onUnmounted |
errorCaptured |
onErrorCaptured |
renderTracked |
onRenderTracked |
renderTriggered |
onRenderTriggered |
因?yàn)?
setup是圍繞beforeCreate和created生命周期鉤子運(yùn)行的,所以不需要顯式地定義它們。換句話說,在這些鉤子中編寫的任何代碼都應(yīng)該直接在setup函數(shù)中編寫
export default {
setup() {
// mounted
onMounted(() => {
console.log('Component is mounted!')
})
}
}
八、Provider Inject
通常,當(dāng)我們需要將數(shù)據(jù)從父組件傳遞到子組件時(shí),我們使用 props。想象一下這樣的結(jié)構(gòu):你有一些深嵌套的組件,而你只需要來自深嵌套子組件中父組件的某些內(nèi)容。在這種情況下,你仍然需要將 prop 傳遞到整個(gè)組件鏈中,這可能會(huì)很煩人
對于這種情況,我們可以使用
provide和inject對父組件可以作為其所有子組件的依賴項(xiàng)提供程序,而不管組件層次結(jié)構(gòu)有多深。這個(gè)特性有兩個(gè)部分:父組件有一個(gè)provide選項(xiàng)來提供數(shù)據(jù),子組件有一個(gè)inject選項(xiàng)來開始使用這個(gè)數(shù)據(jù)
1. 非組合式api中的寫法
<!-- src/components/MyMap.vue -->
<template>
<MyMarker />
</template>
<script>
import MyMarker from './MyMarker.vue'
export default {
components: {
MyMarker
},
provide: {
location: 'North Pole',
geolocation: {
longitude: 90,
latitude: 135
}
}
}
</script>
<!-- src/components/MyMarker.vue -->
<script>
export default {
inject: ['location', 'geolocation']
}
</script>
2. 組合式api中的寫法
Provider:
在
setup()中使用provide時(shí),我們首先從vue顯式導(dǎo)入provide方法。這使我們能夠調(diào)用provide時(shí)來定義每個(gè)property
provide 函數(shù)允許你通過兩個(gè)參數(shù)定義 property:
-
property的name(<String>類型) -
property的value
使用 MyMap 組件,我們提供的值可以按如下方式重構(gòu):
<!-- src/components/MyMap.vue -->
<template>
<MyMarker />
</template>
<script>
import { provide } from 'vue'
import MyMarker from './MyMarker.vue
export default {
components: {
MyMarker
},
setup() {
provide('location', 'North Pole')
provide('geolocation', {
longitude: 90,
latitude: 135
})
}
}
</script>
Inject:
在
setup()中使用inject時(shí),還需要從vue顯式導(dǎo)入它。一旦我們這樣做了,我們就可以調(diào)用它來定義如何將它暴露給我們的組件。
inject 函數(shù)有兩個(gè)參數(shù):
- 要注入的
property的名稱 - 一個(gè)默認(rèn)的值 (可選)
使用 MyMarker 組件,可以使用以下代碼對其進(jìn)行重構(gòu):
<!-- src/components/MyMarker.vue -->
<script>
import { inject } from 'vue'
export default {
setup() {
const userLocation = inject('location', 'The Universe')
const userGeolocation = inject('geolocation')
return {
userLocation,
userGeolocation
}
}
}
</script>
Provider Inject 響應(yīng)性
父組件:
import {
provide,
ref,
reactive
} from 'vue'
setup() {
const location = ref('北京')
const geolocation = reactive({
longitude: 90,
latitude: 135
})
const updateLocation = () => {
location.value = '上海'
}
provide('location', location);
provide('geolocation', geolocation);
return {
updateLocation
}
}
<button @click="updateLocation">改變location</button>
子組件:
import { inject } from 'vue'
export default {
setup() {
const userLocation = inject('location', 'The Universe')
const userGeolocation = inject('geolocation')
return {
userLocation,
userGeolocation
}
}
}
</script>