banner
banner
banner
NEWS LETTER

vue3

Scroll down

这篇整理 uni-app 里用 Vue3 组合式 API 的日常写法:ref 和 reactive 存什么数据、模板与 JS 中取值方式的差异,以及 watch、watchEffect 分别在什么场景下用。文末给了一个可直接对照的 <script setup> 模板。

背景:uni-app 项目的一个坑

uni-app 项目有一个弊端:如果换了文件夹或者重新导入 uni-app 项目,IDE 不会自动识别为 uni-app 项目,需要右键文件夹重新识别项目类型。

开发方式是组合式 API + 单文件组件 + Vue3。

一、ref

  • ref 的参数一般是基本数据类型,也可以是对象类型
  • 参数是对象类型时,本质还是 reactive,『系统会自动将 ref 转换为 reactive。』也就是说,声明与转换的关系可以理解为:
1
ref(1) ==> reactive({value:1})
  • 在模板中访问 ref 中的数据,系统会自动添加 .value;在 JS 中访问 ref 中的数据,需要手动添加 .value
  • ref 的底层原理同 reactive 一样,都是 Proxy
  • ref 中可以使用数组的 reduce 等方法

二、reactive

  • reactive 的参数一般是对象或数组,能够使复杂数据变为响应式数据
  • reactive 的响应式是深层次的,底层本质是将传入的数据转换为 Proxy 对象
  • 在 JS 中访问 ref 的值需要手动添加 .value,访问 reactive 不需要

三、watch

watch 的调用形态是“监听的源 + 回调 + 配置”:

1
watch(name, (curVal, preVal)=>{ /* 业务处理 */ }, options)
  • name:需要监听的属性
  • (curVal, preVal)=>{}:箭头函数,参数分别是监听到的最新值和本次修改之前的值,在此处进行逻辑处理
  • options:配置项,对监听器的配置,如是否深度监听

监听多个响应式数据时,第一个参数传数组:

1
watch([count,obj],()=>{})

只监听对象中某个属性的变化时,第一个参数传 getter 函数:

1
watch(()=>obj.name,()=> {})

配置深度监听和立即执行:

1
watch(name,()=>{},{deep:true,immediate:true})

四、watchEffect

  • 侦听器、副作用函数
  • 监听引用数据类型的所有属性,一旦运行就会立即监听,组件卸载的时候会停止监听
  • 在一些情况下,可以显式调用返回值以停止侦听
  • 侦听副作用传入的函数可以接收一个 onInvalidate 函数作入参,用来注册清理失效时的回调
  • 副作用即将重新执行时,失效回调会被触发
  • 侦听器被停止时(如果在 setup() 或生命周期钩子函数中使用了 watchEffect,则在组件卸载时),失效回调会被触发
  • 如果要操作“更新之后的 DOM”,就要配置 flush: 'post'

五、一个完整的单文件组件示例

先看逻辑部分:定义响应式数据、props、emit、计算属性、两种侦听器。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
<script setup>
import { ref, watchEffect, computed, reactive, watch } from 'vue'
// 定义一个变量,使用ref来存取变量的值
const message = ref('Hello World!')
// 在js中通过.value来获取message在ref中的值,并进行操作来更改message的值
const isRed = ref(false)

// reactive
const stats = reactive({})

// 定义props
const props = defineProps({
data: Array,
title: String
// ...
})

// emit
const emit = defineEmits(['click'])

// methods
const add = () => {
emit('click')
}

// 使用计算属性
const output = computed(() => marked(input.value))

// 该effect会立即运行,并且在变量更改时重新运行,可以加async变成异步的
watchEffect(async () => {})

// watch,要明确指明依赖的是那个变量,如count
watch(count, (newValue) => {
anotherCount.value = newValue - 1
})

// 生命周期, setup里面用on开头的生命周期函数
</script>

再看模板部分:ref 在模板里会自动解包,直接写变量名即可;: 开头的属性是动态绑定。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<template>
<!-- 在模板中直接使用变量名即可,不需要写.value,因为在模板中ref自动解包 -->
<view>{{message}}</view>

<!-- Attribute绑定 :名称
对象中,变量名(值)与属性名(键)相同的话可以简写,只写其中一个
对象中,类名可以通过布尔值来判断是否显示 -->
<view :class="{ red: isRed }" :style="{ color }" @click="可以放置函数名或简单表达式"></view>

<!-- 循环判断 -->
<ul v-if="">
<li v-for="item in 列表" :key="index">{{item}}</li>
</ul>
<p v-else></p>
</template>

踩坑与注意点

  1. 判断用 ref 还是 reactive 可以记一句:基本类型用 ref,对象/数组两者都行,但整体替换时用 ref 更省心。
  2. 在 JS 里漏写 .value 是最常见的错误,ref 的值改了但视图不更新,基本都是这个原因。
  3. watch 必须明确指定依赖;watchEffect 会自动收集回调里用到的响应式依赖,因此更适合“依赖不固定”的场景。
  4. 示例中的 marked、input、count、anotherCount 属于上下文变量,复制使用时需要自行补上定义。
其他文章
cover
uniApp + vue3组合式开发
  • 24/10/31
  • 15:20
  • uniapp-Vue
cover
HBuilder X快捷键
  • 24/10/31
  • 15:20
  • uniapp
目录导航 置顶
  1. 1. 背景:uni-app 项目的一个坑
  2. 2. 一、ref
  3. 3. 二、reactive
  4. 4. 三、watch
  5. 5. 四、watchEffect
  6. 6. 五、一个完整的单文件组件示例
  7. 7. 踩坑与注意点
请输入关键词进行搜索