script setup 语法糖
组合式 API:setup()
基本使用
Vue 3 的 Composition API 系列里,推出了一个全新的 setup
函数,它是一个组件选项,在创建组件之前执行,一旦 props 被解析,并作为组合式 API 的入口点。【学习视频分享:vue视频教程、web前端视频】
(相关资料图)
setup
选项是一个接收 props
和 context
的函数,我们参考文档进行讨论。此外,我们将 setup
返回的所有内容都暴露给组件的其余部分 (计算属性、方法、生命周期钩子等等) 以及组件的模板。
<script>// 这是一个基于 TypeScript 的 Vue 组件import { defineComponent } from "vue"export default defineComponent({ setup(props, context) { // 在这里声明数据,或者编写函数并在这里执行它 return { // 需要给 `` 用的数据或函数,在这里 `return` 出去 } },})</script>
登录后复制
新的 setup
选项是在组件创建之前, props
被解析之后执行,是组合式 API 的入口。
TIP:说的通俗一点,就是在使用 Vue 3 生命周期的情况下,整个组件相关的业务代码,都可以放在 setup
里执行。
因为在 setup
之后,其他的生命周期才会被启用,我们对比一下Vue2的Vue3生命周期的变化
组件生命周期
关于 Vue 生命周期的变化,可以从下表直观地了解:
Vue 2 生命周期 | Vue 3 生命周期 | 执行时间说明 |
---|---|---|
beforeCreate | setup | 组件创建前执行 |
created | setup | 组件创建后执行 |
beforeMount | onBeforeMount | 组件挂载到节点上之前执行 |
mounted | onMounted | 组件挂载完成后执行 |
beforeUpdate | onBeforeUpdate | 组件更新之前执行 |
updated | onUpdated | 组件更新完成之后执行 |
beforeDestroy | onBeforeUnmount | 组件卸载之前执行 |
destroyed | onUnmounted | 组件卸载完成后执行 |
errorCaptured | onErrorCaptured | 当捕获一个来自子孙组件的异常时激活钩子函数 |
可以看到 Vue 2 生命周期里的 beforeCreate
和 created
,在 Vue 3 里已被 setup
替代。
script setup 语法糖
它是 Vue3 的一个新语法糖,在 setup
函数中。所有 ES 模块导出都被认为是暴露给上下文的值,并包含在 setup() 返回对象中。相对于之前的写法,使用后,语法也变得更简单。
自动注册属性和方法无需返回,直接使用
1.<script setup>
语法糖并不是新增的功能模块,它只是简化了以往的组合API(compositionApi)的必须返回(return)的写法,并且有更好的运行时性能。
2.在 setup 函数中:所有 ES 模块导出都被认为是暴露给上下文的值,并包含在 setup() 返回对象中。相对于之前的写法,使用后,语法也变得更简单。
你不必担心setup语法糖的学习成本,他是组合式API的简化,并没有新增的知识点。你只需要了解一些用法和细微的不同之处,甚至比之前写setup()还要顺手!
使用方式也很简单,只需要在 script 标签加上 setup 关键字即可
<script setup></script>
登录后复制
组件核心 API 的使用
组件自动注册
在 script setup 中,引入的组件可以直接使用,无需再通过components进行注册,并且无法指定当前组件的名字,它会自动以文件名为主,也就是不用再写name属性了。
示例:
<script setup>import Child from "@/components/Child.vue"</script>
登录后复制
定义组件的 props
defineProps ----> [用来接收父组件传来的 props] 代码示列
:
通过defineProps
指定当前 props 类型,获得上下文的props对象。
示例:
<script setup> import { defineProps } from "vue" const props = defineProps({ title: String, })</script><script setup> import { ref,defineProps } from "vue"; type Props={ msg:string } defineProps(); </script>
登录后复制
定义 emit
defineEmit ----> [子组件向父组件事件传递]
使用defineEmit
定义当前组件含有的事件,并通过返回的上下文去执行 emit。
代码示列:
<script setup> import { defineEmits } from "vue" const emit = defineEmits(["change", "delete"]) </script>
登录后复制
父子组件通信
defineProps用来接收父组件传来的 props ; defineEmits用来声明触发的事件。
//父组件 <script setup>import { ref } from "vue"import Child from "@/components/Child.vue"const msg = ref("parent value")const getChild = (e) => {// 接收父组件传递过来的数据console.log(e); // child value}</script>
登录后复制
//子组件Child Components<script setup>// defineEmits,defineProps无需导入,直接使用const emits = defineEmits(["getChild"]);const props = defineProps({title: {type: String,defaule: "defaule title"}});const toEmits = () => {emits("getChild", "child value") // 向父组件传递数据}// 获取父组件传递过来的数据console.log(props.title); // parent value</script>
登录后复制
子组件通过 defineProps 接收父组件传过来的数据,子组件通过 defineEmits 定义事件发送信息给父组件
useSlots()
和 useAttrs()
获取 slots 和 attrs
可以通过useContext
从上下文中获取 slots 和 attrs。不过提案在正式通过后,废除了这个语法,被拆分成了useAttrs
和useSlots
。
useAttrs
:见名知意,这是用来获取 attrs 数据,但是这和 vue2 不同,里面包含了 class
、属性
、方法
。
const attrs = useAttrs();<script>
登录后复制
useSlots
: 顾名思义,获取插槽数据。
使用示例:
// 旧<script setup> import { useContext } from "vue" const { slots, attrs } = useContext()</script>// 新<script setup> import { useAttrs, useSlots } from "vue" const attrs = useAttrs() const slots = useSlots()</script>
登录后复制
defineExpose API
defineExpose ----> [组件暴露出自己的属性]
传统的写法,我们可以在父组件中,通过 ref 实例的方式去访问子组件的内容,但在 script setup 中,该方法就不能用了,setup 相当于是一个闭包,除了内部的 template
模板,谁都不能访问内部的数据和方法。
如果需要对外暴露 setup 中的数据和方法,需要使用 defineExpose API。示例:
//子组件{{msg}}<script setup>import { ref } from "vue"let msg = ref("Child Components");let num = ref(123);// defineExpose无需导入,直接使用defineExpose({msg,num});</script>
登录后复制
//父组件 <script setup>import { ref, onMounted } from "vue"import Child from "@/components/Child.vue"let child = ref(null);onMounted(() => {console.log(child.value.msg); // Child Componentsconsole.log(child.value.num); // 123})</script>
登录后复制
定义响应变量、函数、监听、计算属性computed
<script setup > import { ref,computed,watchEffect } from "vue";const count = ref(0); //不用 return ,直接在 templete 中使用const addCount=()=>{ //定义函数,使用同上 count.value++; } //创建一个只读的计算属性 ref:const plusOne = computed(() => count.value + 1)// 创建一个可写的计算属性 refconst plusOne = computed({get: () => count.value + 1, set: (val) => { count.value = val - 1 } })//定义监听,使用同上 //...some code else watchEffect(()=>console.log(count.value)); </script>
登录后复制
watchEffect和watch区别
1、watch是惰性执行,也就是只有监听的值发生变化的时候才会执行,但是watchEffect不同,每次代码加载watchEffect都会执行(忽略watch第三个参数的配置,如果修改配置项也可以实现立即执行)
2、watch需要传递监听的对象,watchEffect不需要
3、watch只能监听响应式数据:ref定义的属性和reactive定义的对象,如果直接监听reactive定义对象中的属性是不允许的,除非使用函数转换一下
4、watchEffect如果监听reactive定义的对象是不起作用的,只能监听对象中的属性。
reactive
返回一个对象的响应式代理。
<script setup>import { reactive, onUnmounted } from "vue"const state = reactive({ counter: 0})// 定时器 每秒都会更新数据const timer = setInterval(() => { state.counter++}, 1000);onUnmounted(() => { clearInterval(timer);})</script> {{state.counter}}
登录后复制
使用ref也能达到我们预期的"counter",并且在模板中,vue进行了处理,我们可以直接使用counter而不用写counter.value.
ref和reactive的关系:
ref是一个{value:"xxxx"}的结构,value是一个reactive对象
ref 暴露变量到模板
曾经的提案中,如果需要暴露变量到模板,需要在变量前加入export声明:
export const count = ref(0)
登录后复制
不过在新版的提案中,无需export声明,编译器会自动寻找模板中使用的变量,只需像下面这样简单的声明,即可在模板中使用该变量
<script setup >import { ref } from "vue"const counter = ref(0);//不用 return ,直接在 templete 中使用const timer = setInterval(() => { counter.value++}, 1000)onUnmounted(() => { clearInterval(timer);})</script> {{counter}}
登录后复制
其他 Hook Api
useCSSModule
:CSS Modules 是一种 CSS 的模块化和组合系统。vue-loader 集成 CSS Modules,可以作为模拟 scoped CSS。允许在单个文件组件的setup
中访问CSS模块。此 api 本人用的比较少,不过多做介绍。
useCssVars
: 此 api 暂时资料比较少。介绍v-bind in styles
时提到过。
useTransitionState
: 此 api 暂时资料比较少。
useSSRContext
: 此 api 暂时资料比较少。
支持 async await 异步
注意在vue3的源代码中,setup执行完毕,函数 getCurrentInstance 内部的有个值会释放对 currentInstance 的引用,await 语句会导致后续代码进入异步执行的情况。所以上述例子中最后一个 getCurrentInstance() 会返回 null,建议使用变量保存第一个 getCurrentInstance() 返回的引用.
<script setup> const post = await fetch(`/api/post/1`).then((r) => r.json())</script>
登录后复制
<script setup>
中可以使用顶层 await
。结果代码会被编译成 async setup()
:
<script setup>const post = await fetch(`/api/post/1`).then(r => r.json())</script>
登录后复制
另外,await 的表达式会自动编译成在 await
之后保留当前组件实例上下文的格式。
定义组件其他配置
配置项的缺失,有时候我们需要更改组件选项,在setup
中我们目前是无法做到的。我们需要在上方
再引入一个 script
,在上方写入对应的 export
即可,需要单开一个 script。
<script setup>
可以和普通的 <script>
一起使用。普通的 <script>
在有这些需要的情况下或许会被使用到:
<script setup>
声明的选项,例如 inheritAttrs
或通过插件启用的自定义的选项。声明命名导出。运行副作用或者创建只需要执行一次的对象。在script setup 外使用export default,其内容会被处理后放入原组件声明字段。
<script>// 普通 `<script>`, 在模块范围下执行(只执行一次)runSideEffectOnce()// 声明额外的选项 export default { name: "MyComponent", inheritAttrs: false, customOptions: {} }</script><script setup> import HelloWorld from "../components/HelloWorld.vue" // 在 setup() 作用域中执行 (对每个实例皆如此) // your code</script>
登录后复制
(学习视频分享:web前端开发、编程基础视频)
以上就是一文详解Vue3中的script setup语法糖的详细内容,更多请关注php中文网其它相关文章!