经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置：技术经验 » JS/JS库/框架 » JavaScript » 查看文章
尝鲜 vue3.x 新特性 - CompositionAPI
来源：cnblogs　　作者：刘龙彬　　时间：2019/10/11 8:58:33　　对本文有异议

原文地址 http://www.liulongbin.top:8085

0. 基础要求

  1. 了解常见的 ES6 新特性
    • ES6 的导入导出语法
    • 解构赋值
    • 箭头函数
    • etc...
  2. 了解 vue 2.x 的基本使用
    • 组件
    • 常用的指令
    • 生命周期函数
    • computed、watch、ref 等

1. 相关资源

  • 【知乎 - Vue Function-based API RFC】https://zhuanlan.zhihu.com/p/68477600
  • 【github - vuejs/composition-api】https://github.com/vuejs/composition-api
  • 【github - composition-api/CHANGELOG.md】https://github.com/vuejs/composition-api/blob/master/CHANGELOG.md
  • 【开源中国 - 尤雨溪公布 Vue 3.0 开发路线：将从头开始重写 3.0】https://www.oschina.net/news/100515/plans-for-the-next-iteration-of-vue-js

2. 初始化项目

  1. 安装 vue-cli3

    1. npm install -g @vue/cli
    2. # OR
    3. yarn global add @vue/cli

  2. 创建项目

    1. vue create my-project
    2. # OR
    3. vue ui

  3. 在项目中安装 composition-api 体验 vue3 新特性

    1. npm install @vue/composition-api --save
    2. # OR
    3. yarn add @vue/composition-api

  4. 在使用任何 @vue/composition-api 提供的能力前，必须先通过 Vue.use() 进行安装

    1. import Vue from 'vue'
    2. import VueCompositionApi from '@vue/composition-api'
    4. Vue.use(VueCompositionApi)

    安装插件后，您就可以使用新的 Composition API 来开发组件了。

3. setup

setup() 函数是 vue3 中，专门为组件提供的新属性。它为我们使用 vue3 的 Composition API 新特性提供了统一的入口。

3.1 执行时机

setup 函数会在 beforeCreate 之后、created 之前执行

3.2 接收 props 数据

  1. 在 props 中定义当前组件允许外界传递过来的参数名称：

    1. props: {
    2.     p1: String
    3. }

  2. 通过 setup 函数的第一个形参，接收 props 数据：

    1. setup(props) {
    2.     console.log(props.p1)
    3. }

3.3 context

setup 函数的第二个形参是一个上下文对象，这个上下文对象中包含了一些有用的属性，这些属性在 vue 2.x 中需要通过 this 才能访问到，在 vue 3.x 中，它们的访问方式如下：

  1. const MyComponent = {
  2.   setup(props, context) {
  3.     context.attrs
  4.     context.slots
  5.     context.parent
  6.     context.root
  7.     context.emit
  8.     context.refs
  9.   }
  10. }

注意：在 setup() 函数中无法访问到 this

4. reactive

reactive() 函数接收一个普通对象，返回一个响应式的数据对象。

4.1 基本语法

等价于 vue 2.x 中的 Vue.observable() 函数，vue 3.x 中提供了 reactive() 函数，用来创建响应式的数据对象，基本代码示例如下：

  1. import { reactive } from '@vue/composition-api'
  3. // 创建响应式数据对象，得到的 state 类似于 vue 2.x 中 data() 返回的响应式对象
  4. const state = reactive({ count: 0 })

4.2 定义响应式数据供 template 使用

  1. 按需导入 reactive 函数：

    1. import { reactive } from '@vue/composition-api'

  2. 在 setup() 函数中调用 reactive() 函数，创建响应式数据对象：

    1. setup() {
    2.      // 创建响应式数据对象
    3.  const state = reactive({count: 0})
    5.      // setup 函数中将响应式数据对象 return 出去，供 template 使用
    6.  return state
    7. }

  3. 在 template 中访问响应式数据：

    1. <p>当前的 count 值为：{{count}}</p>

5. ref

5.1 基本语法

ref() 函数用来根据给定的值创建一个响应式的数据对象，ref() 函数调用的返回值是一个对象，这个对象上只包含一个 .value 属性：

  1. import { ref } from '@vue/composition-api'
  3. // 创建响应式数据对象 count，初始值为 0
  4. const count = ref(0)
  6. // 如果要访问 ref() 创建出来的响应式数据对象的值，必须通过 .value 属性才可以
  7. console.log(count.value) // 输出 0
  8. // 让 count 的值 +1
  9. count.value++
  10. // 再次打印 count 的值
  11. console.log(count.value) // 输出 1

5.2 在 template 中访问 ref 创建的响应式数据

  1. 在 setup() 中创建响应式数据：

    1. import { ref } from '@vue/composition-api'
    3. setup() {
    4.  const count = ref(0)
    6.      return {
    7.          count,
    8.          name: ref('zs')
    9.      }
    10. }

  2. 在 template 中访问响应式数据：

    1. <template>
    2.  <p>{{count}} --- {{name}}</p>
    3. </template>

5.3 在 reactive 对象中访问 ref 创建的响应式数据

当把 ref() 创建出来的响应式数据对象，挂载到 reactive() 上时，会自动把响应式数据对象展开为原始的值，不需通过 .value 就可以直接被访问，例如：

  1. const count = ref(0)
  2. const state = reactive({
  3.   count
  4. })
  6. console.log(state.count) // 输出 0
  7. state.count++            // 此处不需要通过 .value 就能直接访问原始值
  8. console.log(count)       // 输出 1

注意：新的 ref 会覆盖旧的 ref，示例代码如下：

  1. // 创建 ref 并挂载到 reactive 中
  2. const c1 = ref(0)
  3. const state = reactive({
  4.   c1
  5. })
  7. // 再次创建 ref，命名为 c2
  8. const c2 = ref(9)
  9. // 将 旧 ref c1 替换为 新 ref c2
  10. state.c1 = c2
  11. state.c1++
  13. console.log(state.c1) // 输出 10
  14. console.log(c2.value) // 输出 10
  15. console.log(c1.value) // 输出 0

6. isRef

isRef() 用来判断某个值是否为 ref() 创建出来的对象；应用场景：当需要展开某个可能为 ref() 创建出来的值的时候，例如：

  1. import { isRef } from '@vue/composition-api'
  3. const unwrapped = isRef(foo) ? foo.value : foo

7. toRefs

toRefs() 函数可以将 reactive() 创建出来的响应式对象，转换为普通的对象，只不过，这个对象上的每个属性节点，都是 ref() 类型的响应式数据，最常见的应用场景如下：

  1. import { toRefs } from '@vue/composition-api'
  3. setup() {
  4.     // 定义响应式数据对象
  5.     const state = reactive({
  6.       count: 0
  7.     })
  8.     
  9.     // 定义页面上可用的事件处理函数
  10.     const increment = () => {
  11.       state.count++
  12.     }
  13.     
  14.     // 在 setup 中返回一个对象供页面使用
  15.     // 这个对象中可以包含响应式的数据，也可以包含事件处理函数
  16.     return {
  17.       // 将 state 上的每个属性，都转化为 ref 形式的响应式数据
  18.       ...toRefs(state),
  19.       // 自增的事件处理函数
  20.       increment
  21.     }
  22. }

页面上可以直接访问 setup() 中 return 出来的响应式数据：

  1. <template>
  2.   <div>
  3.     <p>当前的count值为：{{count}}</p>
  4.     <button @click="increment">+1</button>
  5.   </div>
  6. </template>

8. computed

computed() 用来创建计算属性，computed() 函数的返回值是一个 ref 的实例。使用 computed 之前需要按需导入：

  1. import { computed } from '@vue/composition-api'

8.1 创建只读的计算属性

在调用 computed() 函数期间，传入一个 function 函数，可以得到一个只读的计算属性，示例代码如下：

  1. // 创建一个 ref 响应式数据
  2. const count = ref(1)
  4. // 根据 count 的值，创建一个响应式的计算属性 plusOne
  5. // 它会根据依赖的 ref 自动计算并返回一个新的 ref
  6. const plusOne = computed(() => count.value + 1)
  8. console.log(plusOne.value) // 输出 2
  9. plusOne.value++            // error

8.2 创建可读可写的计算属性

在调用 computed() 函数期间，传入一个包含 get 和 set 函数的对象，可以得到一个可读可写的计算属性，示例代码如下：

  1. // 创建一个 ref 响应式数据
  2. const count = ref(1)
  4. // 创建一个 computed 计算属性
  5. const plusOne = computed({
  6.   // 取值函数
  7.   get: () => count.value + 1,
  8.   // 赋值函数
  9.   set: val => { count.value = val - 1 }
  10. })
  12. // 为计算属性赋值的操作，会触发 set 函数
  13. plusOne.value = 9
  14. // 触发 set 函数后，count 的值会被更新
  15. console.log(count.value) // 输出 8

9. watch

watch() 函数用来监视某些数据项的变化，从而触发某些特定的操作，使用之前需要按需导入：

  1. import { watch } from '@vue/composition-api'

9.1 基本用法

  1. const count = ref(0)
  3. // 定义 watch，只要 count 值变化，就会触发 watch 回调
  4. // watch 会在创建时会自动调用一次
  5. watch(() => console.log(count.value))
  6. // 输出 0
  8. setTimeout(() => {
  9.   count.value++
  10.   // 输出 1
  11. }, 1000)

9.2 监视指定的数据源

监视 reactive 类型的数据源：

  1. // 定义数据源
  2. const state = reactive({ count: 0 })
  3. // 监视 state.count 这个数据节点的变化
  4. watch(() => state.count, (count, prevCount) => { /* ... */ })

监视 ref 类型的数据源：

  1. // 定义数据源
  2. const count = ref(0)
  3. // 指定要监视的数据源
  4. watch(count, (count, prevCount) => { /* ... */ })

9.3 监视多个数据源

监视 reactive 类型的数据源：

  1. const state = reactive({ count: 0, name: 'zs' })
  3. watch(
  4.   [() => state.count, () => state.name],    // Object.values(toRefs(state)),
  5.   ([count, name], [prevCount, prevName]) => {
  6.     console.log(count)         // 新的 count 值
  7.     console.log(name)          // 新的 name 值
  8.     console.log('------------')
  9.     console.log(prevCount)     // 旧的 count 值
  10.     console.log(prevName)      // 新的 name 值
  11.   },
  12.   {
  13.     lazy: true // 在 watch 被创建的时候，不执行回调函数中的代码
  14.   }
  15. )
  17. setTimeout(() => {
  18.   state.count++
  19.   state.name = 'ls'
  20. }, 1000)

监视 ref 类型的数据源：

  1. const count = ref(0)
  2. const name = ref('zs')
  4. watch(
  5.   [count, name], // 需要被监视的多个 ref 数据源
  6.   ([count, name], [prevCount, prevName]) => {
  7.     console.log(count)
  8.     console.log(name)
  9.     console.log('-------------')
  10.     console.log(prevCount)
  11.     console.log(prevName)
  12.   },
  13.   {
  14.     lazy: true
  15.   }
  16. )
  18. setTimeout(() => {
  19.   count.value++
  20.   name.value = 'xiaomaolv'
  21. }, 1000)

9.4 清除监视

在 setup() 函数内创建的 watch 监视，会在当前组件被销毁的时候自动停止。如果想要明确地停止某个监视，可以调用 watch() 函数的返回值即可，语法如下：

  1. // 创建监视，并得到 停止函数
  2. const stop = watch(() => { /* ... */ })
  4. // 调用停止函数，清除对应的监视
  5. stop()

9.5 在 watch 中清除无效的异步任务

有时候，当被 watch 监视的值发生变化时，或 watch 本身被 stop 之后，我们期望能够清除那些无效的异步任务，此时，watch 回调函数中提供了一个 cleanup registrator function 来执行清除的工作。这个清除函数会在如下情况下被调用：

  • watch 被重复执行了
  • watch 被强制 stop 了

Template 中的代码示例如下：

  1. /* template 中的代码 */
  2. <input type="text" v-model="keywords" />

Script 中的代码示例如下：

  1. // 定义响应式数据 keywords   
  2. const keywords = ref('')
  4. // 异步任务：打印用户输入的关键词
  5. const asyncPrint = val => {
  6.   // 延时 1 秒后打印
  7.   return setTimeout(() => {
  8.     console.log(val)
  9.   }, 1000)
  10. }
  12. // 定义 watch 监听
  13. watch(
  14.   keywords,
  15.   (keywords, prevKeywords, onCleanup) => {
  16.     // 执行异步任务，并得到关闭异步任务的 timerId
  17.     const timerId = asyncPrint(keywords)
  19.     // 如果 watch 监听被重复执行了，则会先清除上次未完成的异步任务
  20.     onCleanup(() => clearTimeout(timerId))
  21.   },
  22.   // watch 刚被创建的时候不执行
  23.   { lazy: true }
  24. )
  26. // 把 template 中需要的数据 return 出去
  27. return {
  28.   keywords
  29. }

10. LifeCycle Hooks

新版的生命周期函数，可以按需导入到组件中，且只能在 setup() 函数中使用，代码示例如下：

  1. import { onMounted, onUpdated, onUnmounted } from '@vue/composition-api'
  3. const MyComponent = {
  4.   setup() {
  5.     onMounted(() => {
  6.       console.log('mounted!')
  7.     })
  8.     onUpdated(() => {
  9.       console.log('updated!')
  10.     })
  11.     onUnmounted(() => {
  12.       console.log('unmounted!')
  13.     })
  14.   }
  15. }

下面的列表，是 vue 2.x 的生命周期函数与新版 Composition API 之间的映射关系：

  • beforeCreate -> use setup()
  • created -> use setup()
  • beforeMount -> onBeforeMount
  • mounted -> onMounted
  • beforeUpdate -> onBeforeUpdate
  • updated -> onUpdated
  • beforeDestroy -> onBeforeUnmount
  • destroyed -> onUnmounted
  • errorCaptured -> onErrorCaptured

11. provide & inject

provide() 和 inject() 可以实现嵌套组件之间的数据传递。这两个函数只能在 setup() 函数中使用。父级组件中使用 provide() 函数向下传递数据；子级组件中使用 inject() 获取上层传递过来的数据。

11.1 共享普通数据

App.vue 根组件：

  1. <template>
  2.   <div id="app">
  3.     <h1>App 根组件</h1>
  4.     <hr />
  5.     <LevelOne />
  6.   </div>
  7. </template>
  9. <script>
  10. import LevelOne from './components/LevelOne'
  11. // 1. 按需导入 provide
  12. import { provide } from '@vue/composition-api'
  14. export default {
  15.   name: 'app',
  16.   setup() {
  17.     // 2. App 根组件作为父级组件，通过 provide 函数向子级组件共享数据（不限层级）
  18.     //    provide('要共享的数据名称', 被共享的数据)
  19.     provide('globalColor', 'red')
  20.   },
  21.   components: {
  22.     LevelOne
  23.   }
  24. }
  25. </script>

LevelOne.vue 组件：

  1. <template>
  2.   <div>
  3.     <!-- 4. 通过属性绑定，为标签设置字体颜色 -->
  4.     <h3 :style="{color: themeColor}">Level One</h3>
  5.     <hr />
  6.     <LevelTwo />
  7.   </div>
  8. </template>
  10. <script>
  11. import LevelTwo from './LevelTwo'
  12. // 1. 按需导入 inject
  13. import { inject } from '@vue/composition-api'
  15. export default {
  16.   setup() {
  17.     // 2. 调用 inject 函数时，通过指定的数据名称，获取到父级共享的数据
  18.     const themeColor = inject('globalColor')
  19.     
  20.     // 3. 把接收到的共享数据 return 给 Template 使用
  21.     return {
  22.       themeColor
  23.     }
  24.   },
  25.   components: {
  26.     LevelTwo
  27.   }
  28. }
  29. </script>

LevelTwo.vue 组件：

  1. <template>
  2.   <div>
  3.     <!-- 4. 通过属性绑定，为标签设置字体颜色 -->
  4.     <h5 :style="{color: themeColor}">Level Two</h5>
  5.   </div>
  6. </template>
  8. <script>
  9. // 1. 按需导入 inject
  10. import { inject } from '@vue/composition-api'
  12. export default {
  13.   setup() {
  14.     // 2. 调用 inject 函数时，通过指定的数据名称，获取到父级共享的数据
  15.     const themeColor = inject('globalColor')
  17.     // 3. 把接收到的共享数据 return 给 Template 使用
  18.     return {
  19.       themeColor
  20.     }
  21.   }
  22. }
  23. </script>

11.2 共享 ref 响应式数据

如下代码实现了点按钮切换主题颜色的功能，主要修改了 App.vue 组件中的代码，LevelOne.vue 和 LevelTwo.vue 中的代码不受任何改变：

  1. <template>
  2.   <div id="app">
  3.     <h1>App 根组件</h1>
  4.     
  5.     <!-- 点击 App.vue 中的按钮，切换子组件中文字的颜色 -->
  6.     <button @click="themeColor='red'">红色</button>
  7.     <button @click="themeColor='blue'">蓝色</button>
  8.     <button @click="themeColor='orange'">橘黄色</button>
  10.     <hr />
  11.     <LevelOne />
  12.   </div>
  13. </template>
  15. <script>
  16. import LevelOne from './components/LevelOne'
  17. import { provide, ref } from '@vue/composition-api'
  19. export default {
  20.   name: 'app',
  21.   setup() {
  22.     // 定义 ref 响应式数据
  23.     const themeColor = ref('red')
  24.     
  25.     // 把 ref 数据通过 provide 提供的子组件使用
  26.     provide('globalColor', themeColor)
  27.     
  28.     // setup 中 return 数据供当前组件的 Template 使用
  29.     return {
  30.       themeColor
  31.     }
  32.   },
  33.   components: {
  34.     LevelOne
  35.   }
  36. }
  37. </script>

12. template refs

通过 ref() 还可以引用页面上的元素或组件。

12.1 元素的引用

示例代码如下：

  1. <template>
  2.   <div>
  3.     <h3 ref="h3Ref">TemplateRefOne</h3>
  4.   </div>
  5. </template>
  7. <script>
  8. import { ref, onMounted } from '@vue/composition-api'
  10. export default {
  11.   setup() {
  12.     // 创建一个 DOM 引用
  13.     const h3Ref = ref(null)
  15.     // 在 DOM 首次加载完毕之后，才能获取到元素的引用
  16.     onMounted(() => {
  17.       // 为 dom 元素设置字体颜色
  18.       // h3Ref.value 是原生DOM对象
  19.       h3Ref.value.style.color = 'red'
  20.     })
  22.     // 把创建的引用 return 出去
  23.     return {
  24.       h3Ref
  25.     }
  26.   }
  27. }
  28. </script>

12.2 组件的引用

TemplateRefOne.vue 中的示例代码如下：

  1. <template>
  2.   <div>
  3.     <h3>TemplateRefOne</h3>
  4.     
  5.     <!-- 4. 点击按钮展示子组件的 count 值 -->
  6.     <button @click="showNumber">获取TemplateRefTwo中的count值</button>
  8.     <hr />
  9.     <!-- 3. 为组件添加 ref 引用 -->
  10.     <TemplateRefTwo ref="comRef" />
  11.   </div>
  12. </template>
  14. <script>
  15. import { ref } from '@vue/composition-api'
  16. import TemplateRefTwo from './TemplateRefTwo'
  18. export default {
  19.   setup() {
  20.     // 1. 创建一个组件的 ref 引用
  21.     const comRef = ref(null)
  23.     // 5. 展示子组件中 count 的值
  24.     const showNumber = () => {
  25.       console.log(comRef.value.count)
  26.     }
  28.     // 2. 把创建的引用 return 出去
  29.     return {
  30.       comRef,
  31.       showNumber
  32.     }
  33.   },
  34.   components: {
  35.     TemplateRefTwo
  36.   }
  37. }
  38. </script>

TemplateRefTwo.vue 中的示例代码：

  1. <template>
  2.   <div>
  3.     <h5>TemplateRefTwo --- {{count}}</h5>
  4.     <!-- 3. 点击按钮，让 count 值自增 +1 -->
  5.     <button @click="count+=1">+1</button>
  6.   </div>
  7. </template>
  9. <script>
  10. import { ref } from '@vue/composition-api'
  12. export default {
  13.   setup() {
  14.     // 1. 定义响应式的数据
  15.     const count = ref(0)
  16.     
  17.     // 2. 把响应式数据 return 给 Template 使用
  18.     return {
  19.       count
  20.     }
  21.   }
  22. }
  23. </script>

13. createComponent

这个函数不是必须的，除非你想要完美结合 TypeScript 提供的类型推断来进行项目的开发。

这个函数仅仅提供了类型推断，方便在结合 TypeScript 书写代码时，能为 setup() 中的 props 提供完整的类型推断。

  1. import { createComponent } from 'vue'
  3. export default createComponent({
  4.   props: {
  5.     foo: String
  6.   },
  7.   setup(props) {
  8.     props.foo // <- type: string
  9.   }
  10. })

原文链接：http://www.cnblogs.com/liulongbinblogs/p/11649393.html

 友情链接：直通硅谷 　点职佳 　北美留学生论坛

JavaScript热门文章

  • echarts 饼图 + 全屏显示
  • js正则匹配以{开头,以}结尾的表达式怎么写？-附源码
  • echarts 实现数据(tooltip)自动轮播插件
  • Js设置博客园主题色(theme-color)
  • elementUI 设置input的只读或禁用的方法
  • 超级好用的流程图js框架 值得收藏
  • layui table+复杂表头+合并单元格
  • 获取地理位置
  • 如何使用JavaScript导入和导出Excel文件
  • WebStorm eslint插件报错解决 - TypeError: this.CliEngine is not a constructor

    • JavaScript推荐文章

  • 一些八股：1.fetch 的理解。2.let、const、var
  • 电子表格转身购物车：三步轻松实现
  • Canvas简历编辑器-图形绘制与状态管理(轻量级DOM)
  • IntersectionObserver + scrollIntoView 实现电梯导航 - xingba-coder
  • 可视化—gojs 超多超实用经验分享(三)
  • PixiJS源码分析系列： 第一章 从最简单的例子入手
  • WebRTC入门
  • 前端 Array.sort() 源码学习
  • 【技巧】JS代码这么写，前端小姐姐都会爱上你
  • 【JS】await异常捕获，这样做才完美

    • 本站QQ群：前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

    W3xue 的所有内容仅供测试，对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
    关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接（目前9元/月）请联系QQ：27243702 沸活量
    皖ICP备17017327号-2　皖公网安备34020702000426号