itclancoder

V1

2022/12/25阅读:20主题:绿意

VueJs中setup的使用(上)

前言

在写组合式API代码时,首先接触到的是setup这个函数,在一些项目代码里,你会看到有的直接在script标签上添加setup标识,有的在选项式API

方式里,以setup()函数,配置选项的方式出现在单文件组件里

什么时候用setup()函数方式,什么时候不用,对于有些新手同学,有些困惑,以及它的一个使用特点和规则,都是需要知道的

在学习setup之前,先写一个常见的数字加减的示例,介绍两个概念声明式渲染与响应式

数字加减选项式API实现

如下是选项式示例代码如下所示

<template>
  <div class="base-vue3-setup">
      <p><el-input-number v-model="num" @change="handleChange" :min="1"></el-input-number></p>
      <p>num: {{num}}</p>
  </div>
</template>

<script>
  export default {
    data() {
        return {
            num:0
        }
    },
    methods: {
      handleChange(value) {
        this.num = value;
      }
    },
  };
</script>
<style scoped>
  .base-vue3-setup {
    text-align: center;
  }
</style>

以上是使用选项式API实现的,响应式数据挂载在配置选项data()函数下,而方法绑定在methiods

数字加减组合式API实现

如下是组合式API代码

<template>
   <div class="base-vue3-setup">
      <p><el-input-number v-model="num" @change="handleChangeCom" :min="1"></el-input-number></p>
      <p>num: {{num}}</p>
  </div> 
</template>
<script setup>
import {ref} from "vue";
const num = ref(0);
function handleChangeCom(value) {
    num1.value = value;
}
</script>

以上就是通过组合式API代码实现的,响应式定义的数据直接放在函数里面,并通过ref函数包裹起来,才具备响应式能力,同时在script标签上添加setup标识

在组件的模板中可直接使用函数内定义的变量,但在逻辑代码中,若想要取到响应式变量的值时,需要通过.value的形式获取的

声明式渲染

编写Vue代码,本质上就是在编写Vue组件,而Vue基于html拓展了一套自己的模板语法,让我们可以声明式的描述最终输出的HTMLJavaScript状态之间的一个关系

当状态改变时,HTML会自动的更新,那么页面也会自动更新

响应式状态

Vue会自动跟踪JavaScript的状态,并在其发生变化时响应式的更新DOM,能在改变时触发更新状态的,就可以称为响应式数据

vue3中想要一个基本类型数据具备响应式,那么需要用ref这个组合API函数给包裹起来,经过该函数处理加工一下,就具备了响应式的能力,而对象类型数据

则需要使用reactive()API函数来声明响应式状态,这些组合式API函数都是Vue框架提供的,它是固定的,相当于是Vue对外暴露的接口

你只需要拿来即用就可以,无需关心底部是如何操作的(当然如果想深入了解,那可以看研究源码,是如何编译实现的

Vue中setup的两种风格

对于有些初学者,有时看到setup以属性的方式出现在script标签上,有时,又会看到,在选项式API当中以setup()函数的形式出现

那什么时候用,什么场景用呢,下面就来讲一讲的

setup直接以属性的方式写在script标签上

Vue3中,在xxx.vue单文件组件中的<script setup></script>``,会有一个setup标记,只要标记了它,那就说明,在script标签代码块内就具备了vue3的语法环境,可以使用Vue3中的一些特性,比如组合式API函数,ref,reactive`等

可以在script中声明响应式数据状态,定义声明完后,可以直接在模板中使用

比如如下:

<template>
     <!--在模板中不用.value,它会被自动解析,直接可以使用变量名--->
     {{name}}
</template>
<script setup>
  import {ref} from "vue";
  let name = ref("itclanCoder");
  //在逻辑中,想要读取name的值,需要.value方式
  console.log(name.value);
</script>

从上面的Vue3代码风格看出,它是比Vue2更简洁的,可以自由的编写javascript代码,不受约束,就是需要另一个思维方式从vue2固定编程方式走出来

setup写在标签上优势

[1]. 更少的样板内容,更简洁的代码

[2]. 能够使用纯TypeScript声明props和自定义事件

[3]. 更好的运行时性能(模板会编译成同一作用域内的渲染函数,避免了渲染上下文代理对象)

setup()以函数配置选项方式

vue3当中,它是向下兼容的,如果想要在vue2中体验vue3当中的一些新特性,在vue3中新增了一setup的配置选项

setup是一个新的配置项,值为一个函数,setup为设置,译为组合,是所有Composition API组合API表演的舞台,它是在组件中使用组合式API的入口

一般,在如下情况下使用setup()钩子

[1]. 需要在非单文件组件中使用组合式API时

[2]. 需要在基于选项式API的组合中集成基于组合式API的代码时或第三方库整合的项目中,可以用setup()函数

其他情况下,都应该优先使用<script setup></script>语法

如下代码所示

<template>
    <div>
        {{name}}
    </div>
</template>
<script>
  import { ref } from "vue";
  export default {
    // 其他配置选项
    data() {
      return {
        num: 1
      }
    },
    setup() {
      const name = ref('itclanCoder');
      // 在逻辑中访问,同样需要使用.value的方式访问
      console.log(name.value);
      // 声明的变量或函数,都需要暴露出去,否则在模板中使用,会不起作用
      return {
        name
      }
    }
  }
</script>

重点注意

[1]. 在setup()函数内定义声明的响应式数据变量或函数,都需要对外暴露出去,否则在模板中直接使用的话,是不起作用的

[2]. 在模板中可以直接使用定义的响应式数据变量,或函数,因为它可以自动解析,而在逻辑中需要使用变量.value读取

[3]. setup()函数自身并不具备对组件实例的访问权限,所以在setup()函数作用域内,访问this会是undefined,但在选项式API中可以访问组合式API对外暴露出来的值(通过this.对外暴露的变量或方法),反过来却不行,也就是在setup()中无法通过this访问选项式API配置选项下的data数据或methods方法

[4]. 当选项式API中的data数据,methods方法名与setup()内定义的变量名或函数同名时,后者会覆盖前者

[5]. 凡是组合中用到数据,方法,均要配置在setup中,并且需要通过return对外暴露出去

[6]. setup函数有两种返回值,一个是对象,另一个是函数

[7]. 如果setup()函数返回一个对象,则对象中的属性,方法,在模板中可以直接使用,但在逻辑内,普通变量需要使用.value访问读取,若返回一个渲染函数,则可以自定义渲染内容

import {h} from 'vue';
export default {
  setup() {
    // 返回一个函数
    return () => h('h1','内容')
  }
}

[8]. 如果你使用vue3组合式API,尽量不要与vue2.x配置混用

[9]. setup不能是一个async函数,因为返回值不在是return的对象,而是propmise,这样会令,模板看不到return对象中属性(其实也可以返回一个Promises实例,但需要结合Suspense和异步组件配合进行使用

setup()是在什么时候执行的?

setup()Vue提供的一个钩子,它的执行时机是在beforeCreate()函数之前执行的,在setup()函数里面访问thisundefined

总结

setupvue3新增的一个特性,有两种使用,一种是直接写在script标签上,此时script标签代码块内可写vue3的新特性

而在选项式API编码风格当中,若想要使用vue3,那么需要借用setup()这配置选项,所有的组合响应式API函数,响应式变量,都需要放在setup()函数里面

同时,需要对外暴露出去

两种方式都是可以使用的,不过在官方推荐的使用当中,应当优先使用setup放在script标签上,当需要基于选项式API的组合中,基于组合式API的代码时或第三方库整合的项目中,或非单文件组件中使用组合式API时,可以用setup()函数

分类:

前端

标签:

Vue.js

作者介绍

itclancoder
V1

微公号:itclanCoder