Vue3.2单文件组件setup的语法糖与新特性总结

前言

setup语法糖

一、基本用法

二、data和methods

三、计算属性computed

四、监听器watch、watchEffect

五、自定义指令directive

六、import导入的内容可直接使用

七、声明props和emits

八、父组件获取子组件的数据

九、provide和inject传值

十、路由useRoute和useRouter

十一、对await异步的支持

十三、全局属性globalProperties

十四、生命周期

十五、与普通的script标签一起使用

十六、v-memo新指令

style新特性

一、局部样式

二、深度选择器

三、插槽选择器

四、全局选择器

五、混合使用局部与全局样式

六、支持CSS Modules

七、与setup一同使用

八、动态 CSS

参考文献：

总结

前言

满满的干货，建议收藏慢慢看，可以当作Vue3.0的学习资料。

在vue2.0时期，组件里定义的各类变量、方法、计算属性等是分别存放到data、methods、computed...选项里，这样编写的代码不便于后期的查阅（查找一个业务逻辑需要在各个选项来回切换）。setup函数的推出就是为了解决这个问题，让新手开发者更容易上手...

setup语法糖

setup是Vue3.0后推出的语法糖，并且在Vue3.2版本进行了大更新，像写普通JS一样写vue组件，对于开发者更加友好了；按需引入computed、watch、directive等选项，一个业务逻辑可以集中编写在一起，让代码更加简洁便于浏览。

一、基本用法

只需在<script>里添加一个setup属性，编译时会把<script setup></script>里的代码编译成一个setup函数

<script setup>
console.log('hello script setup')
</script>

普通的<script>只会在组件被首次引入的时候执行一次，<script setup>里的代码会在每次组件实例被创建的时候执行。

二、data和methods

<script setup>
import { ref, reactive } from 'vue'    
// 普通变量
const msg = 'Hello!'
// 响应式变量
let num = ref(1111)         // ref声明基本类型变量
const obj = reactive({        // reactive声明对象类型变量，如Object、Array、Date...
    key: 'this is a object'
})
// 函数
function log() {
    console.log(msg)          // Hello
    console.log(num.value)    // 1111（可根据input输入值而改变）
    console.log(obj.key)      // this is a object
}
</script>
<template>
    <h1>{{ msg }}</h1>
    <p>{{obj.key}}</p>
    <input v-model="num" type="text" />
    <button @click="log">打印日志</button>
</template>

三、计算属性computed

<script setup>
import { ref, computed } from 'vue'
let count = ref(0)
const countPlus = computed(()=>{
    return count.value+1
})
</script>
<template>
    <h1>计数：{{ countPlus }}</h1>
</template>

四、监听器watch、watchEffect

1、watch监听器除了使用方式有区别之外，其他的与vue2.0没啥变化

<script setup>
import { ref, reactive, watch } from 'vue'
// 监听ref
let count = ref(0)
watch(count, (newVal, oldVal)=> {
    console.log('修改后', newVal)
    console.log('修改前', oldVal)
})
// 监听reactive属性
const obj = reactive({
    count: 0
})
watch(
    ()=> obj.count,     // 一个函数，返回监听属性
    (newVal, oldVal)=> {
        console.log('修改后', newVal)
        console.log('修改前', oldVal)
    },
    {
        immediate: true,     // 立即执行，默认为false
        deep: true     // 深度监听，默认为false
    }
)
const onChange = function(){
    count.value++
    obj.count++
}
</script>
<template>
    <button @click="onChange">改变count</button>
</template>

2、watchEffect

watchEffect是Vue3.0新增的一个监听属性的方法，它与watch的区别在于watchEffect不需要指定监听对象，回调函数里可直接获取到修改后的属性的值

<script setup>
import { ref, reactive, watchEffect } from 'vue'
let count = ref(0)
const obj = reactive({
    count: 0
})
setTimeout(()=>{
    count.value++
    obj.count++
}, 1000)
watchEffect(()=> {
    console.log('修改后的count', count.value)
    console.log('修改前的obj', obj.value)
})
</script>

五、自定义指令directive

以 vNameOfDirective 的形式来命名本地自定义指令，可以直接在模板中使用

<script setup>
// 导入指令可重命名
// import { myDirective as vMyDirective } from './MyDirective.js'
// 自定义指令
const vMyDirective = {
  beforeMount: (el) => {
    // 在元素上做些操作
  }
}
</script>
<template>
  <h1 v-my-directive>This is a Heading</h1>
</template>

六、import导入的内容可直接使用

1、导入的模块内容，不需要通过 methods 来暴露它

// utils.js 
export const onShow = function(name) {
    return 'my name is ' + name
}

// Show.vue
<script setup>
    import { onShow } from './utils.js'
</script>
<template>
    <div>{{ onShow('jack') }}</div>
</template>

2、导入外部组件，不需要通过components注册使用

// Child.vue
<template>
    <div>I am a child</div>
</template>

// Parent.vue
<script setup>
    import Child from './Child.vue'
</script>
<template>
    <child></child>
</template>

七、声明props和emits

在 <script setup> 中必须使用 defineProps 和 defineEmits API 来声明 props 和 emits ，它们具备完整的类型推断并且在 <script setup> 中是直接可用的

// Child.vue
<script setup>
// 声明props
const props = defineProps({
    info: {
        type: String,
        default: ''
    }
})
// 声明emits
const $emit = defineEmits(['change'])
const onChange = function() {
    $emit('change', 'child返回值')
}
</script>
<template>
    <h1>信息：{{ info }}</h1>
    <button @click="onChange">点击我</button>
</template>

// Parent.vue
<script setup>
import { ref } from 'vue'
import Child from './Child.vue'
const msg = ref('hello setup !')    // 响应式变量
const onAction = function(event) {
    console.log(event)    // child返回值
}
</script>
<template>
    <child :info="msg" @change="onAction"></child>
</template>

如果使用了 Typescript，使用纯类型声明来声明 prop 和 emits 也是可以的。

八、父组件获取子组件的数据

父组件要想通过ref获取子组件的变量或函数，子组件须使用defineExpose暴露出去

// Child.vue
<script setup>
import { ref, defineExpose } from 'vue'
const info = ref('I am child')
const onChange = function() {
    console.log('Function of child')
}
// 暴露属性
defineExpose({
    info,
    onChange
})
</script>
<template>
    <h1>信息：{{ info }}</h1>
    <button @click="onChange">点击我</button>
</template>

// Parent.vue
<script setup>
import { ref } from 'vue'
import Child from './Child.vue'
const childRef = ref()
const onAction = function() {
    console.log(childRef.value.info)    // I am child
    console.log(childRef.value.onChange())    // Function of child
}
</script>
<template>
    <child ref="childRef"></child>
    <button @click="onAction">获取子值</button>
</template>

九、provide和inject传值

无论组件层次结构有多深，父组件都可以通过provide 选项来其所有子组件提供数据，子组件通过inject接收数据

// Parent.vue
<script setup>
import { ref, provide } from 'vue'
import Child from './Child.vue'
const msg = ref('Hello, my son')
const onShow = function() {
    console.log('I am your parent')
}
provide('myProvide', {
    msg,
    onShow
})
</script>
<template>
    <child></child>
</template>

// Child.vue
<script setup>
import { inject } from 'vue'
const provideState = inject('myProvide')    // 接收参数
const getData = function() {
    console.log(provideState.msg)    // Hello, my son
    console.log(provideState.onShow())    // I am your parent
}
</script>
<template>
    <button @click="getData">获取父值</button>
</template>

十、路由useRoute和useRouter

<script setup>
import { useRoute, useRouter } from 'vue-router'
const $route = useRoute()
const $router = userRouter()
// 路由信息
console.log($route.query)
// 路由跳转
$router.push('/login')
</script>

十一、对await异步的支持

<script setup> 中可以使用顶层 await。结果代码会被编译成 async setup()

<script setup>
    const post = await fetch(`/api/post/1`).then(r => r.json())
</script>

十二、nextTick

// 方式一
<script setup>
import { nextTick } from 'vue'
nextTick(()=>{
    console.log('Dom已更新！')
})
</script>

// 方式二
<script setup>
import { nextTick } from 'vue'
await nextTick()    // nextTick是一个异步函数，返回一个Promise实例
// console.log('Dom已更新！')
</script>

十三、全局属性globalProperties

// main.js里定义
import { createApp } from 'vue'
import App from './App.vue'
const app = createApp(App)
// 定义一个全局属性$global 
app.config.globalProperties.$global = 'This is a global property.' 
app.mount('#app')

// 组件内使用
<script setup>
import { getCurrentInstance } from 'vue'
// 获取vue实例
const { proxy } = getCurrentInstance()
// 输出
console.log(proxy.$global)    // This is a global property.
</script>

十四、生命周期

setup()里访问组件的生命周期需要在生命周期钩子前加上“on”，并且没有beforeCreate和created生命周期钩子

因为 setup 是围绕 beforeCreate 和 created 生命周期钩子运行的，所以不需要显式地定义它们。换句话说，在这些钩子中编写的任何代码都应该直接在 setup 函数中编写。

// 使用方式
<script setup>
import { onMounted } from 'vue'
onMounted(()=> {
    console.log('onMounted')
})
</script>

十五、与普通的script标签一起使用

<script setup> 可以和普通的 <script> 一起使用。普通的 <script> 在有这些需要的情况下或许会被使用到：

无法在 <script setup> 声明的选项，例如 inheritAttrs 或通过插件启用的自定义的选项；

声明命名导出，<script setup>定义的组件默认以组件文件的名称作为组件名；

运行副作用或者创建只需要执行一次的对象。

<script>
// 普通 <script>, 在模块范围下执行(只执行一次)
runSideEffectOnce()
// 声明额外的选项
export default {
  name: 'ComponentName',    // 组件重命名
  inheritAttrs: false,
  customOptions: {}
}
</script>
<script setup>
// 在 setup() 作用域中执行 (对每个实例皆如此)
</script>

十六、v-memo新指令

该指令与v-once类似，v-once是只渲染一次之后的更新不再渲染，而v-memo是根据条件来渲染。该指令接收一个固定长度的数组作为依赖值进行记忆比对，如果数组中的每个值都和上次渲染的时候相同，则该元素（含子元素）不刷新。

1、应用于普通元素或组件；

<template>
<-- 普通元素 -->
<div v-memo="[valueA, valueB]">
  ... 
</div>
<-- 组件 -->
<component v-memo="[valueA, valueB]"></component>
</template>
<script setup>
import component from "../compoents/component.vue"
</script>

当组件重新渲染的时候，如果 valueA 与 valueB 都维持不变，那么对这个 <div> 以及它的所有子节点的更新都将被跳过。

2、结合v-for使用

v-memo 仅供性能敏感场景的针对性优化，会用到的场景应该很少。渲染 v-for 长列表 (长度大于 1000) 可能是它最有用的场景：

<template>
<div v-for="item in list" :key="item.id" v-memo="[item.id === selected]">
  <p>ID: {{ item.id }} - selected: {{ item.id === selected }}</p>
  <p>...more child nodes</p>
</div>
</template>

当selected发生变化时，只有item.id===selected的该项重新渲染，其余不刷新。

style新特性

Vue3.2版本对单文件组件的style样式进行了很多升级，如局部样式、css变量以及样式暴露给模板使用等。

一、局部样式

当 <style> 标签带有 scoped attribute 的时候，它的 CSS 只会应用到当前组件的元素上：

<template>
  <div class="example">hi</div>
</template>
<style scoped>
.example {
  color: red;
}
</style>

二、深度选择器

处于 scoped 样式中的选择器如果想要做更“深度”的选择，也即：影响到子组件，可以使用 :deep() 这个伪类：

<style scoped>
.a :deep(.b) {
  /* ... */
}
</style>

通过 v-html 创建的 DOM 内容不会被作用域样式影响，但你仍然可以使用深度选择器来设置其样式。

三、插槽选择器

默认情况下，作用域样式不会影响到 <slot/> 渲染出来的内容，因为它们被认为是父组件所持有并传递进来的。使用 :slotted 伪类以确切地将插槽内容作为选择器的目标：

<style scoped>
:slotted(div) {
  color: red;
}
</style>

四、全局选择器

如果想让其中一个样式规则应用到全局，比起另外创建一个 <style>，可以使用 :global 伪类来实现：

<style scoped>
:global(.red) {
  color: red;
}
</style>

五、混合使用局部与全局样式

你也可以在同一个组件中同时包含作用域样式和非作用域样式：

<style>
/* global styles */
</style>
<style scoped>
/* local styles */
</style>

六、支持CSS Modules

<style module> 标签会被编译为 CSS Modules 并且将生成的 CSS 类键暴露给组件：

1、默认以$style 对象暴露给组件；

<template>
  <p :class="$style.red">
    This should be red
  </p>
</template>
<style module>
.red {
  color: red;
}
</style>

2、可以自定义注入module名称

<template>
  <p :class="classes.red">red</p>
</template>
<style module="classes">
.red {
  color: red;
}
</style>

七、与setup一同使用

注入的类可以通过 useCssModule API 在 setup() 和 <script setup> 中使用：

<script setup>
import { useCssModule } from 'vue'
// 默认, 返回 <style module> 中的类
const defaultStyle = useCssModule()
// 命名, 返回 <style module="classes"> 中的类
const classesStyle = useCssModule('classes')
</script>

八、动态 CSS

单文件组件的 <style> 标签可以通过 v-bind 这一 CSS 函数将 CSS 的值关联到动态的组件状态上：

<script setup>
const theme = {
  color: 'red'
}
</script>
<template>
  <p>hello</p>
</template>
<style scoped>
p {
  color: v-bind('theme.color');
}
</style>

参考文献：

SFC 语法规范 | Vue.js

Vue3.2 setup语法糖、Composition API、状态库Pinia归纳总监

总结

到此这篇关于Vue3.2单文件组件setup的语法糖与新特性的文章就介绍到这了,更多相关Vue3.2单文件组件setup语法糖内容请搜索易知道(ezd.cc)以前的文章或继续浏览下面的相关文章希望大家以后多多支持易知道(ezd.cc)！

推荐阅读