破解 vue3.x 新特性 - 洞见未来
最新发布的 vue-compisition-api,来讲解大家最关心的、同时也是 vue 3.0 最重要的一些新特性,例如 setup() 函数、reactive()、ref() 等这些 Vue Hooks。
1. 相关资源
【知乎 - Vue Function-based API RFC】
【github - vuejs/composition-api】
【github - composition-api/CHANGELOG.md】
【开源中国 - 尤雨溪公布 Vue 3.0 开发路线:将从头开始重写 3.0】
2. 初始化项目
安装 vue-cli3 npm install -g @vue/cli3. setup setup() 函数是 vue3 中,专门为组件提供的新属性。它为我们使用 vue3 的 Composition API 新特性提供了统一的入口。
3.1 执行时机 setup 函数会在 beforeCreate 之后、created 之前执行
3.2 接收 props 数据 在 props 中定义当前组件允许外界传递过来的参数名称:
props: { p1: String }通过 setup 函数的第一个形参,接收 props 数据:
setup(props) { console.log(props.p1) }3.3 context setup 函数的第二个形参是一个上下文对象,这个上下文对象中包含了一些有用的属性,这些属性在 vue 2.x 中需要通过 this 才能访问到,在 vue 3.x 中,它们的访问方式如下:
const MyComponent = { setup(props, context) { context.attrs context.slots context.parent context.root context.emit context.refs } }注意:在 setup() 函数中无法访问到 this
4. reactive reactive() 函数接收一个普通对象,返回一个响应式的数据对象。
4.1 基本语法 等价于 vue 2.x 中的 Vue.observable() 函数,vue 3.x 中提供了 reactive() 函数,用来创建响应式的数据对象,基本代码示例如下:
import { reactive } from '@vue/composition-api'// 创建响应式数据对象,得到的 state 类似于 vue 2.x 中 data() 返回的响应式对象
const state = reactive({ count: 0 })4.2 定义响应式数据供 template 使用 按需导入 reactive 函数:
import { reactive } from '@vue/composition-api'在 setup() 函数中调用 reactive() 函数,创建响应式数据对象:
setup() { // 创建响应式数据对象 const state = reactive({count: 0}) // setup 函数中将响应式数据对象 return 出去,供 template 使用 return state }在 template 中访问响应式数据:
<p>当前的 count 值为:{{count}}</p>5. ref 5.1 基本语法 ref() 函数用来根据给定的值创建一个响应式的数据对象,ref() 函数调用的返回值是一个对象,这个对象上只包含一个 .value 属性:
import { ref } from '@vue/composition-api' // 创建响应式数据对象 count,初始值为 0 const count = ref(0) // 如果要访问 ref() 创建出来的响应式数据对象的值,必须通过 .value 属性才可以 console.log(count.value) // 输出 0 // 让 count 的值 +1 count.value++ // 再次打印 count 的值 console.log(count.value) // 输出 15.2 在 template 中访问 ref 创建的响应式数据 在 setup() 中创建响应式数据:
import { ref } from '@vue/composition-api' setup() { const count = ref(0) return { count, name: ref('zs') } }在 template 中访问响应式数据:
<template> <p>{{count}} --- {{name}}</p> </template> 5.3 在 reactive 对象中访问 ref 创建的响应式数据当把 ref() 创建出来的响应式数据对象,挂载到 reactive() 上时,会自动把响应式数据对象展开为原始的值,不需通过 .value 就可以直接被访问,例如:
const count = ref(0) const state = reactive({ count }) console.log(state.count) // 输出 0 state.count++ // 此处不需要通过 .value 就能直接访问原始值 console.log(count) // 输出 1注意:新的 ref 会覆盖旧的 ref,示例代码如下:
// 创建 ref 并挂载到 reactive 中 const c1 = ref(0) const state = reactive({ c1 }) // 再次创建 ref,命名为 c2 const c2 = ref(9) // 将 旧 ref c1 替换为 新 ref c2 state.c1 = c2 state.c1++ console.log(state.c1) // 输出 10 console.log(c2.value) // 输出 10 console.log(c1.value) // 输出 06. isRef isRef() 用来判断某个值是否为 ref() 创建出来的对象;应用场景:当需要展开某个可能为 ref() 创建出来的值的时候,例如:
import { isRef } from '@vue/composition-api' const unwrapped = isRef(foo) ? foo.value : foo7. toRefs toRefs() 函数可以将 reactive() 创建出来的响应式对象,转换为普通的对象,只不过,这个对象上的每个属性节点,都是 ref() 类型的响应式数据,最常见的应用场景如下:
import { toRefs } from '@vue/composition-api' setup() { // 定义响应式数据对象 const state = reactive({ count: 0 }) // 定义页面上可用的事件处理函数 const increment = () => { state.count++ } // 在 setup 中返回一个对象供页面使用 // 这个对象中可以包含响应式的数据,也可以包含事件处理函数 return { // 将 state 上的每个属性,都转化为 ref 形式的响应式数据 ...toRefs(state), // 自增的事件处理函数 increment } } 页面上可以直接访问 setup() 中 return 出来的响应式数据: <template> <div> <p>当前的count值为:{{count}}</p> <button @click="increment">+1</button> </div> </template>8. computed computed() 用来创建计算属性,computed() 函数的返回值是一个 ref 的实例。使用 computed 之前需要按需导入:
import { computed } from '@vue/composition-api'8.1 创建只读的计算属性 在调用 computed() 函数期间,传入一个 function 函数,可以得到一个只读的计算属性,示例代码如下:
// 创建一个 ref 响应式数据 const count = ref(1) // 根据 count 的值,创建一个响应式的计算属性 plusOne // 它会根据依赖的 ref 自动计算并返回一个新的 ref const plusOne = computed(() => count.value + 1) console.log(plusOne.value) // 输出 2 plusOne.value++ // error8.2 创建可读可写的计算属性 在调用 computed() 函数期间,传入一个包含 get 和 set 函数的对象,可以得到一个可读可写的计算属性,示例代码如下:
// 创建一个 ref 响应式数据 const count = ref(1) // 创建一个 computed 计算属性 const plusOne = computed({ // 取值函数 get: () => count.value + 1, // 赋值函数 set: val => { count.value = val - 1 } }) // 为计算属性赋值的操作,会触发 set 函数 plusOne.value = 9 // 触发 set 函数后,count 的值会被更新 console.log(count.value) // 输出 89. watch watch() 函数用来监视某些数据项的变化,从而触发某些特定的操作,使用之前需要按需导入:
import { watch } from '@vue/composition-api'9.1 基本用法
const count = ref(0) // 定义 watch,只要 count 值变化,就会触发 watch 回调 // watch 会在创建时会自动调用一次 watch(() => console.log(count.value)) // 输出 0 setTimeout(() => { count.value++ // 输出 1 }, 1000)9.2 监视指定的数据源 监视 reactive 类型的数据源:
// 定义数据源 const state = reactive({ count: 0 }) // 监视 state.count 这个数据节点的变化 watch( () => state.count, (count, prevCount) => { /* ... */ } ) 监视 ref 类型的数据源: // 定义数据源 const count = ref(0) // 指定要监视的数据源 watch(count, (count, prevCount) => { /* ... */ })9.3 监视多个数据源 监视 reactive 类型的数据源:
const state = reactive({ count: 0, name: 'zs' }) watch( [() => state.count, () => state.name], // Object.values(toRefs(state)), ([count, name], [prevCount, prevName]) => { console.log(count) // 新的 count 值 console.log(name) // 新的 name 值 console.log('------------') console.log(prevCount) // 旧的 count 值 console.log(prevName) // 新的 name 值 }, { lazy: true // 在 watch 被创建的时候,不执行回调函数中的代码 } ) setTimeout(() => { state.count++ state.name = 'ls' }, 1000) 监视 ref 类型的数据源: const count = ref(0) const name = ref('zs') watch( [count, name], // 需要被监视的多个 ref 数据源 ([count, name], [prevCount, prevName]) => { console.log(count) console.log(name) console.log('-------------') console.log(prevCount) console.log(prevName) }, { lazy: true } ) setTimeout(() => { count.value++ name.value = 'xiaomaolv' }, 1000)9.4 清除监视 在 setup() 函数内创建的 watch 监视,会在当前组件被销毁的时候自动停止。如果想要明确地停止某个监视,可以调用 watch() 函数的返回值即可,语法如下:
// 创建监视,并得到 停止函数 const stop = watch(() => { /* ... */ }) // 调用停止函数,清除对应的监视 stop()9.5 在 watch 中清除无效的异步任务 有时候,当被 watch 监视的值发生变化时,或 watch 本身被 stop 之后,我们期望能够清除那些无效的异步任务,此时,watch 回调函数中提供了一个 cleanup registrator function 来执行清除的工作。这个清除函数会在如下情况下被调用:
watch 被重复执行了 watch 被强制 stop 了 Template 中的代码示例如下: /* template 中的代码 */ <input type="text" v-model="keywords" /> Script 中的代码示例如下: // 定义响应式数据 keywords const keywords = ref('') // 异步任务:打印用户输入的关键词 const asyncPrint = val => { // 延时 1 秒后打印 return setTimeout(() => { console.log(val) }, 1000) } // 定义 watch 监听 watch( keywords, (keywords, prevKeywords, onCleanup) => { // 执行异步任务,并得到关闭异步任务的 timerId const timerId = asyncPrint(keywords) // 如果 watch 监听被重复执行了,则会先清除上次未完成的异步任务 onCleanup(() => clearTimeout(timerId)) }, // watch 刚被创建的时候不执行 { lazy: true } ) // 把 template 中需要的数据 return 出去 return { keywords }10. LifeCycle Hooks
新版的生命周期函数,可以按需导入到组件中,且只能在 setup() 函数中使用,代码示例如下: import { onMounted, onUpdated, onUnmounted } from '@vue/composition-api' const MyComponent = { setup() { onMounted(() => { console.log('mounted!') }) onUpdated(() => { console.log('updated!') }) onUnmounted(() => { console.log('unmounted!') }) } } 下面的列表,是 vue 2.x 的生命周期函数与新版 Composition API 之间的映射关系: beforeCreate -> use setup() created -> use setup() beforeMount -> onBeforeMount mounted -> onMounted beforeUpdate -> onBeforeUpdate updated -> onUpdated beforeDestroy -> onBeforeUnmount destroyed -> onUnmounted errorCaptured -> onErrorCaptured11. provide & inject provide() 和 inject() 可以实现嵌套组件之间的数据传递。这两个函数只能在 setup() 函数中使用。父级组件中使用 provide() 函数向下传递数据;子级组件中使用 inject() 获取上层传递过来的数据。
11.1 共享普通数据
App.vue 根组件: <template> <div id="app"> <h1>App 根组件</h1> <hr /> <LevelOne /> </div> </template> <script> import LevelOne from './components/LevelOne' // 1. 按需导入 provide import { provide } from '@vue/composition-api' export default { name: 'app', setup() { // 2. App 根组件作为父级组件,通过 provide 函数向子级组件共享数据(不限层级) // provide('要共享的数据名称', 被共享的数据) provide('globalColor', 'red') }, components: { LevelOne } } </script> LevelOne.vue 组件: <template> <div> <!-- 4. 通过属性绑定,为标签设置字体颜色 --> <h3 :style="{color: themeColor}">Level One</h3> <hr /> <LevelTwo /> </div> </template> <script> import LevelTwo from './LevelTwo' // 1. 按需导入 inject import { inject } from '@vue/composition-api' export default { setup() { // 2. 调用 inject 函数时,通过指定的数据名称,获取到父级共享的数据 const themeColor = inject('globalColor') // 3. 把接收到的共享数据 return 给 Template 使用 return { themeColor } }, components: { LevelTwo } } </script> LevelTwo.vue 组件: <template> <div> <!-- 4. 通过属性绑定,为标签设置字体颜色 --> <h5 :style="{color: themeColor}">Level Two</h5> </div> </template> <script> // 1. 按需导入 inject import { inject } from '@vue/composition-api' export default { setup() { // 2. 调用 inject 函数时,通过指定的数据名称,获取到父级共享的数据 const themeColor = inject('globalColor') // 3. 把接收到的共享数据 return 给 Template 使用 return { themeColor } } } </script>11.2 共享 ref 响应式数据 如下代码实现了点按钮切换主题颜色的功能,主要修改了 App.vue 组件中的代码,LevelOne.vue 和 LevelTwo.vue 中的代码不受任何改变:
<template> <div id="app"> <h1>App 根组件</h1> <!-- 点击 App.vue 中的按钮,切换子组件中文字的颜色 --> <button @click="themeColor='red'">红色</button> <button @click="themeColor='blue'">蓝色</button> <button @click="themeColor='orange'">橘黄色</button> <hr /> <LevelOne /> </div> </template> <script> import LevelOne from './components/LevelOne' import { provide, ref } from '@vue/composition-api' export default { name: 'app', setup() { // 定义 ref 响应式数据 const themeColor = ref('red') // 把 ref 数据通过 provide 提供的子组件使用 provide('globalColor', themeColor) // setup 中 return 数据供当前组件的 Template 使用 return { themeColor } }, components: { LevelOne } } </script>12. template refs 通过 ref() 还可以引用页面上的元素或组件。
12.1 元素的引用 示例代码如下:
<template> <div> <h3 ref="h3Ref">TemplateRefOne</h3> </div> </template> <script> import { ref, onMounted } from '@vue/composition-api' export default { setup() { // 创建一个 DOM 引用 const h3Ref = ref(null) // 在 DOM 首次加载完毕之后,才能获取到元素的引用 onMounted(() => { // 为 dom 元素设置字体颜色 // h3Ref.value 是原生DOM对象 h3Ref.value.style.color = 'red' }) // 把创建的引用 return 出去 return { h3Ref } } } </script>12.2 组件的引用 TemplateRefOne.vue 中的示例代码如下:
<template> <div> <h3>TemplateRefOne</h3> <!-- 4. 点击按钮展示子组件的 count 值 --> <button @click="showNumber">获取TemplateRefTwo中的count值</button> <hr /> <!-- 3. 为组件添加 ref 引用 --> <TemplateRefTwo ref="comRef" /> </div> </template> <script> import { ref } from '@vue/composition-api' import TemplateRefTwo from './TemplateRefTwo' export default { setup() { // 1. 创建一个组件的 ref 引用 const comRef = ref(null) // 5. 展示子组件中 count 的值 const showNumber = () => { console.log(comRef.value.count) } // 2. 把创建的引用 return 出去 return { comRef, showNumber } }, components: { TemplateRefTwo } } </script> TemplateRefTwo.vue 中的示例代码: <template> <div> <h5>TemplateRefTwo --- {{count}}</h5> <!-- 3. 点击按钮,让 count 值自增 +1 --> <button @click="count+=1">+1</button> </div> </template> <script> import { ref } from '@vue/composition-api' export default { setup() { // 1. 定义响应式的数据 const count = ref(0) // 2. 把响应式数据 return 给 Template 使用 return { count } } } </script>13. createComponent 这个函数不是必须的,除非你想要完美结合 TypeScript 提供的类型推断来进行项目的开发。
这个函数仅仅提供了类型推断,方便在结合 TypeScript 书写代码时,能为 setup() 中的 props 提供完整的类型推断。
import { createComponent } from 'vue' export default createComponent({ props: { foo: String }, setup(props) { props.foo // <- type: string } })