企业🤖AI智能体构建引擎,智能编排和调试,一键部署,支持私有化部署方案 广告
[TOC] >[success] # Setup 函数的使用 什么是 **Composition API ?** 当我们在 **项目开发中** 的时会遇到这种问题, **data** 中很多 **变量** , **methods** 中很多 **方法** ,当我们 **想看一些代码的逻辑** 时,**需要上下文的来回查看** ,当 **项目代码上百 / 千行的时,想看一些代码逻辑定位非常麻烦** ,下图 **颜色相同** 的 **代码块** , **代表同一个功能的代码** ,可以看到 **Options API(传统vue写法)一个功能代码分布在上、中、下,代码很零散,而 Composition API(vue3 新写法) 每个功能的代码都汇聚在一块** ,这样 **查阅就会很方便可读性强** 。 ![](https://img.kancloud.cn/2f/b8/2fb862837cead795c4e49c38a23e083b_1200x1201.png) 要想使用 **Composition API** ,首先要学习一个 **函数** ,就是 **Setup 函数** , **Setup 函数** 会在 **created 实例被完全初始化之前** 执行,它有 **2 个参数** , **第1个参数参数** 是 **当前组件的 props** , **第2个参数** 是 **上下文**, **Setup函数** 必须要 **return 返回一个值** , **Setup 函数返回的值可以直接在 template 模板中使用** 如下代码: **index.html** ~~~ <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Setup 函数的使用</title> <!-- 通过cdn方式引入vue --> <script src="https://unpkg.com/vue@next"></script> </head> <body> <div id="root"></div> </body> <script> const app = Vue.createApp({ template: ` <div @click="handleClick">{{name}}</div> `, /** * created 实例被完全初始化之前 * @param {object} props - 当前组件的props * @param {number} contex - 上下文 */ setup(props, contex) { return { name: 'dell', // Options API 中data中的变量 handleClick(){ // Options API 中methods中的方法 alert(123) } } } }) const vm = app.mount('#root') </script> </html> ~~~ 我们发现 **Setup** 这个 **函数** ,它 **return** 的 **所有内容** 会 **暴露在外部** ,我们在 **template 模板** 中可以直接 **使用暴露出来的变量或方法** 。 >[success] ## Setup 函数内调用外部方法与变量 **Setup 函数** 是 **在实例被创建之前执行的一个函数** ,我们可能会想到,我们如果在 **Setup 函数** 中 **调用 methods 中定义的方法** ,会怎样呢? **index.html** ~~~ <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Setup 函数内调用外部方法与变量</title> <!-- 通过cdn方式引入vue --> <script src="https://unpkg.com/vue@next"></script> </head> <body> <div id="root"></div> </body> <script> const app = Vue.createApp({ template: ` <div @click="handleClick">{{name}}</div> `, methods: { test() { alert('test') } }, /** * created 实例被完全初始化之前 * @param {object} props - 当前组件的props * @param {number} contex - 上下文 */ setup(props, contex) { this.test() return { name: 'dell', // data中的变量 handleClick(){ // methods中的方法 alert(123) } } } }) const vm = app.mount('#root') </script> </html> ~~~ 会直接报错 **this.test is not a function** ,这是因为 **Setup 函数** 是 **在实例被初始化之前就执行的一个函数** , **实例初始化之前 methods 并没有被放到 this 上面, 所以通过 this.test() 根本就无法调用这个 methods** , 所以要记住, **在Setup 函数里面,不能使用 this 这样的关键词, this 里面实际上什么也没有** ,所以我们不要去这样写,用了 **Setup 函数** 之后,我们就 **不会去用this这样语法,再去写任何的代码** 了,后面这种 **methods** 的定义,我们都会换成新的 **composition API 的语法来定义** 。 >[success] ## 外部方法(methods)、生命周期(mounted)中调用 Setup 函数 在 **Setup 函数** 中 **我们无法调用外部的一些方法 ,或者一些模板,或者mounted这样的生命周期函数** ,但是 **在外部的方法或者生命周期中,我们可以调用 Setup 这个方法** ,原因是 **Setup 执行时,实例并没有被创建** ,但是 **在实例创建后,Setup 已经被挂载到实例上了,所以在 mounted 或者 methods 中可以获取到 Setup** ,如下代码: ~~~ <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>外部方法(methods)、生命周期(mounted)中调用 Setup 函数</title> <!-- 通过cdn方式引入vue --> <script src="https://unpkg.com/vue@next"></script> </head> <body> <div id="root"></div> </body> <script> const app = Vue.createApp({ template: ` <div @click="handleClick">{{name}}</div> `, methods: { test() { console.log(this.$options.setup()) } }, mounted(){ this.test() }, /** * created 实例被完全初始化之前 * @param {object} props - 当前组件的props * @param {number} contex - 上下文 */ setup(props, contex) { return { name: 'dell', // data中的变量 handleClick(){ // methods中的方法 alert(123) } } } }) const vm = app.mount('#root') </script> </html> ~~~