Vue3的setup还能这么用?

本文详细介绍了Vue3的setup选项新用法,包括响应式数据的定义、toRefs的运用、在setup中执行方法的技巧,以及<scriptsetup>的引入。重点展示了如何利用reactive、ref和toRefs创建、管理响应式对象,以及如何组织和复用功能函数。

一、前言

vue3的setup都能怎么用:

  1. setup选项是一个接收 props 和 context 的函数 ;
  2. 基本写法代码片显示
    export default{
        name: 'test',
        setup(props,context){
         return {}   // 这里返回的任何内容都可以用于组件的其余部分
        }
        // 组件的“其余部分”
    }
    

3.接收一个propscontext函数并且将setup内的内容通过return暴露给组件的其余部分。

二、setup 注意点

  1. 由于在执行 setup函数的时候,还没有执行 Created 生命周期方法,所以在 setup 函数中,无法使用 datamethods 的变量和方法
  2. 由于我们不能在 setup函数中使用 data methods,所以 Vue 为了避免我们错误的使用,直接将 setup函数中的this 修改成了 undefined

三、定义响应式数据

vue3 通过 refreactive 来定义响应式数据。

  • refreactive一样, 也是用来实现响应式数据的方法。
  • 由于reactive 必须传递一个对象, 所以导致在企业开发中如果我们只想让某个变量实现响应式的时候会非常麻烦所以Vue3就给我们提供了 ref方法, 实现对 简单值的监听
  1. ref 我们用来将基本数据类型定义为响应式数据(ref更适合定义基本数据类型),ref 底层的本质其实还是reactive ,系统会自动根据我们给ref 传入的值将它转换成ref (xx) ->reactive ({value:xx})

  2. [reactive ][1]用来将引用类型定义为响应式数据,其本质是[基于Proxy实现对象代理 ][1]

  3. 基本数据类型(单类型):undefined、. null布尔值(Boolean)字符串(String)数值(Number)

  4. 引用类型:{对象(Object)} ;里面包含的 function、Array、Date。
    demo:html

<template>
    <div>
      <h1>基本类型</h1>
      <p>nub:{{ nub }}</p>
      <p>str:{{ str }}</p>
      <p>boo:{{ boo }}</p>
    </div>
    <div>
      <h1>引用类型</h1>
      <p>obj:{{ obj.name }}</p>
      <p>arr:{{ arr[1] }}</p>
    </div>
</template>

demo:javascript

<script>
import {ref, reactive} from "vue";
export default {
  name: "test",
  setup(){
    // 基本类型
    const nub = ref(0)
    const str = ref('inline')
    const boo = ref(false)
    // 引用类型
    const obj = reactive({
      name:'inline',
      age:'18'
    })
    const arr = reactive(['0','1','2'])
    return{
      nub,str, boo,obj,arr,
    }
  }
}
</script>

结果:
在这里插入图片描述

四、关于toRefs

如果我们用[reactive][1]的形式来定义响应式变量:

<div>
  <p>姓名:{{ obj.name }}</p>
  <p>性别:{{ obj.gender }}</p>
  <p>年龄:{{ obj.age }}</p>
</div>
setup(){
  const obj = reactive({
    name:'inline',
    gender:'男',
    age:'18'
  })
  return{
    obj
  }
}

我们发现在模板内使用参数很麻烦,如果想直接用{{ name }}的方式访问行不行,答案是可行的

<div>
  <p>姓名:{{ name }}</p>
  <p>性别:{{ gender }}</p>
  <p>年龄:{{ age }}</p>
</div>

<div>
  <button @click="name = 'juejin'">改变姓名</button>
  <button @click="gender = ''">改变性别</button>
  <button @click="age = '20'">改变年龄</button>
</div>

这里我们使用es6的扩展运算符:

setup(){
  const obj = reactive({
    name:'inline',
    gender:'男',
    age:'18',
  })
  return{
    ...obj,
  }
}

这里看到我们的参数都正常的显示到了页面上,但是我们去改变参数时发现视图并没有更新,这是为什么呢???:
在这里插入图片描述

当我们用…扩展运算符时我们得到的只是一个[普通类型][1]的数值,并不是一个[响应式数据][1]

为了解决这个问题呢,vue3给我们提供了toRefs函数,来让我们看看效果如何

setup(){
  const obj = reactive({
    name:'inline',
    gender:'男',
    age:'18',
  })
  return{
    ...toRefs(obj),
  }
}

在这里插入图片描述

toRefs会将我们一个响应式的对象转变为一个普通对象,然后将这个普通对象里的每一个属性变为一个响应式的数据

五、setup中执行方法

1. 以reactive定义响应式数据的方式来定义方法

<button @click="fun1('你好')">点我1</button>

通过点击事件将值传给fun1,fun1接收到后在传给fun2
这里我们用this.fun2()的方式去调用fun2,为什么这里用this可以正常执行不会报undefind
因为这里的this非彼thisVue2里的this是实例这里的this是对象

<script>
import {ref, reactive,toRefs} from "vue";

export default {
  name: "test",
  setup(){
    const str = ref('inline')
    const fun = reactive({
      fun1(data){
        console.log(str.value)
        this.fun2(data)
      },
      fun2(data){
        console.log(data)
        console.log('我是fun2')
      }
    })
    return{
      ...toRefs(fun),
    }
  }
}
</script>

结果,成功调用并输出
在这里插入图片描述

2. setup直接把函数return出来,

注意这里调用fun2的方式与方式一不同,这里是直接调用就可以,不用this调用

  export default {
  name: "test",
  setup(){
      const fun1 = (data) => {
        fun2(data)
      }
      const fun2 = (data) => {
        console.log(data)
      }
    return{
      fun1,
    }
  }
}

调用fun1正常输出

3. 将独立的功能写成单独的函数

这里我在 setup外写了 fun()login()两个功能函数,并在setup内分别调用
这种方式避免了将功能逻辑都堆叠在setup的问题

<button @click="fun1('你好 inline')">点我1</button>
<button @click="test">点我2</button>
import {ref, reactive,toRefs} from "vue";

export default {
  name: "test",
  setup(){
    const test1 = fun()      // 如果函数返回参数过多,可以赋值给变量并用扩展运算符暴露给组件的其余部分
    const { test } = login() // 也可单个接收
    return{
      ...toRefs(test1),
      test,
    }
  }
}

// 功能1
function fun(){
  let str = ref('我是功能1')
  function fun1(data){
    console.log(str.value)
    fun2(data)
  }
  function fun2(data){
    console.log(data)
  }
  return{
    fun1,fun2,
  }
}
// 功能2
function login() {
  const obj = reactive({
    msg:'我是功能2,我爱掘金'
  })
  function test() {
    console.log(obj.msg)
  }
  return{
    test
  }
}
</script>

在这里插入图片描述

4. 与方式三一样,将两个功能函数提取出来放在单独的.js文件中

在这里插入图片描述
然后引入组件,并在[setup内][1]调用

<template>
  <div style="text-align: center;margin-top: 50px">
    <button @click="fun1('你好 inline')">点我1</button>
    <button @click="test">点我2</button>
  </div>
</template>
<script>
import {ref, reactive,toRefs} from "vue";
import { fun,login } from './test.js'
export default {
  name: "test",
  setup(){
    const test1 = fun()
    const { test } = login()
    return{
      ...toRefs(test1),
      test,
    }
  }
}
</script>

正常执行且输入
在这里插入图片描述

5. 定义一个 reactive响应式对象,赋值给login 变量,这个响应式对象内有我们登录需要的参数、验证和方法,这里我们全部放在login 这个响应式对象内然后用 toRefs及扩展运算符暴露出去

<input type="text" v-model="param.username">
<input type="password" v-model="param.password">
<button @click="login">登录</button>
<script>
import {ref, reactive,toRefs} from "vue";
export default {
  name: "test",
  setup(){
    const login = reactive({
      param: {
        username: '123',
        password: '123456',
      },
      rules: {
        username: [{ required: true, message: '请输入用户名', trigger: 'blur' }],
        password: [{ required: true, message: '请输入密码', trigger: 'blur' }],
      },
      login(){
        this.param.username = 'inline'
        this.param.password = '123456'
        console.log('成功登录!')
      }
    })
    return{
      ...toRefs(login),
    }
  }
}
</script>

在这里插入图片描述

六. < script setup>已在vue3.2的版本上正式发布

使用< script setup>时,模板被编译成一个内联在 setup函数作用域内的渲染函数。这意味着内部声明的任何顶级绑定< script setup>都可以直接在模板中使用

< script setup>内定义的变量和方法无需返回,可直接使用

<template>
  <div>{{ msg }}</div>
</template>

变量方法无需return

<script setup>
  const msg = 'Hello!'
</script>

组件引入

<template>
  <Foo :count="count" @click="inc" />
</template>
在这里插入代码片
<script setup>
  // 导入的组件也可以直接在模板中使用
  import Foo from './Foo.vue'
  import { ref } from 'vue'
  // 编写合成API代码,就像在正常设置中一样
  // 不需要手动返回所有内容
  const count = ref(0)
  const inc = () => {
    count.value++
  }
</script>

propsemits

<script setup>
  const props = defineProps({
    foo: String
  })
  const emit = defineEmits(['update', 'delete'])
</script>

普通的script script setup

script setup可以和script同时存在

<script>
  export const name = 1
</script>
<script setup>
  import { ref } from 'vue'
  const count = ref(0)
</script>

script setup附加选项

script setup给我们提供了大多数与 options api等效的能力
就是说options api能办到的事 script setup大部分都能办到

那还有哪些是script setup做不到的呢?如下

  1. name
  2. inheritAttrs
  3. 插件或库所需要的自定义选项
    那我要是想用这些怎么办呢? 答案是分开写
<script>
  export default {
    name: 'CustomName',
    inheritAttrs: false,
    customOptions: {}
  }
</script>
<script setup>
  // script setup logic
</script>

definExpose

SmartyPants将ASCII标点字符转换为“智能”印刷标点HTML实体。例如:

<script setup>
  const a = 1
  const b = ref(2)

  defineExpose({
    a, b
  })
</script>

当父组件通过模板引用获取此组件的实例时,检索到的实例将会是这样{ a: number, b: number }(引用会像在普通实例上一样自动展开)

<think>我们正在使用Vue3的`<script setup>`语法,并尝试通过`document.getElementById`获取DOM元素,但无法获取到。 原因分析: 在Vue3中,由于组件的渲染是异步的,在`setup`阶段(包括`<script setup>`)中,DOM尚未渲染完成,因此使用`document.getElementById`获取不到元素。 解决方案: 1. 使用Vue的模板引用(ref)代替直接操作DOM。 2. 在生命周期钩子中确保DOM已经挂载。 具体步骤: 方法一:使用模板引用(推荐) 在Vue中,我们通常使用`ref`来获取DOM元素或组件实例。 示例代码: ```vue <template> <div ref="myElement">这是一个DOM元素</div> </template> <script setup> import { ref, onMounted } from &#39;vue&#39; // 创建一个同名的ref const myElement = ref(null) onMounted(() => { // 此时DOM已经挂载,可以通过myElement.value访问 console.log(myElement.value) // 输出:<div>这是一个DOM元素</div> }) </script> ``` 方法二:在onMounted生命周期钩子中使用document.getElementById 如果你仍然想使用`document.getElementById`,那么需要确保在DOM挂载之后执行。 示例代码: ```vue <template> <div id="my-element">这是一个DOM元素</div> </template> <script setup> import { onMounted } from &#39;vue&#39; onMounted(() => { const element = document.getElementById(&#39;my-element&#39;) console.log(element) // 输出:<div id="my-element">...</div> }) </script> ``` 注意事项: 1. 在`<script setup>`中,组件的`setup`函数执行时,模板尚未编译和挂载,所以无法访问DOM。 2. 使用`ref`的方式更符合Vue的响应式理念,并且可以避免直接操作DOM带来的副作用。 3. 如果元素是通过`v-if`等条件渲染的,那么需要确保在元素渲染完成后再获取(比如在更新后的生命周期钩子中)。 为什么在`<script setup>`中直接使用`document.getElementById`获取不到? 因为`<script setup>`中的代码相当于在组件的`setup`函数中执行,此时DOM还未渲染,所以无法获取到。 相关问题: 1. Vue3中如何获取动态生成的DOM元素? 2. 在Vue3的`<script setup>`中如何访问子组件的方法? 3. Vue3的生命周期钩子在`<script setup>`中如何使用? 4. 使用`ref`和`document.getElementById`有何优劣? 5. 如何在Vue3中监听DOM元素的变化? 引用说明: 根据引用[3]中提到的,在Vue2和Vue3中获取DOM元素的时机都是在挂载完成后(mounted或onMounted)。在Vue3的组合式API中,我们使用`onMounted`钩子来确保DOM已经挂载[^3]。 同时,引用[4]提到在`<script setup>`中不能使用`this`,所以我们使用`ref`和生命周期钩子来替代[^4]。</think># Vue3 `<script setup>` 中通过 getElementById 获取 DOM 元素的问题解决方案 在 Vue3 的 `<script setup>` 语法中,使用 `document.getElementById()` 无法获取 DOM 元素的原因在于**组件的生命周期和渲染时机**。下面我将详细解释问题原因并提供完整解决方案。 ## 问题分析 ### 为什么无法获取元素? 1. **执行时机问题**:`<script setup>` 中的代码在组件初始化时执行,此时 DOM 尚未渲染完成 2. **异步渲染机制**:Vue3 使用异步渲染,setup 阶段执行时模板还未挂载到 DOM 3. **响应式原则**:Vue 推荐使用 ref 而不是直接操作 DOM,以保持响应式系统的完整性 ## 完整解决方案 ### 推荐方案:使用模板引用(ref) ```vue <template> <!-- 使用 ref 属性标记元素 --> <div ref="myElement">需要操作的元素</div> </template> <script setup> import { ref, onMounted } from &#39;vue&#39;; // 1. 创建同名的 ref 变量 const myElement = ref(null); onMounted(() => { // 2. 在挂载后访问元素 console.log(myElement.value); // 正确获取到 DOM 元素 // 3. 操作元素 if (myElement.value) { myElement.value.style.color = &#39;red&#39;; } }); </script> ``` ### 替代方案:在 onMounted 中使用 getElementById ```vue <template> <div id="target-element">目标元素</div> </template> <script setup> import { onMounted } from &#39;vue&#39;; onMounted(() => { // 确保在挂载后获取元素 const element = document.getElementById(&#39;target-element&#39;); if (element) { console.log(&#39;获取元素成功:&#39;, element); element.style.backgroundColor = &#39;lightblue&#39;; } }); </script> ``` ### 动态元素场景:使用 nextTick ```vue <template> <div v-if="showElement" id="dynamic-element">动态显示的元素</div> <button @click="showElement = !showElement">切换显示</button> </template> <script setup> import { ref, nextTick } from &#39;vue&#39;; const showElement = ref(false); const handleClick = async () => { showElement.value = true; // 等待 DOM 更新完成 await nextTick(); const element = document.getElementById(&#39;dynamic-element&#39;); if (element) { element.style.fontWeight = &#39;bold&#39;; } }; </script> ``` ## 关键概念解释 1. **ref 系统**: - Vue3 使用 `ref` 创建响应式引用 - 模板中的 `ref="name"` 会自动绑定到同名的 ref 变量 - 通过 `.value` 访问 DOM 元素(在模板中不需要 `.value`) 2. **生命周期钩子**: - `onMounted`:组件挂载到 DOM 后执行 - `onUpdated`:组件更新后执行 - `nextTick`:等待下一次 DOM 更新后执行 3. **`<script setup>` 特性**: - 编译时语法糖,简化组合式 API - 自动暴露顶层变量到模板 - 无法使用 `this`,需使用 `getCurrentInstance()` 获取组件实例[^4] ## 对比:ref vs getElementById | 特性 | Vue ref | getElementById | |------|---------|---------------| | **响应式** | ✅ 自动更新 | ❌ 静态引用 | | **生命周期感知** | ✅ 自动处理 | ❌ 需手动处理 | | **组件作用域** | ✅ 组件内安全 | ❌ 全局查找 | | **动态元素** | ✅ 自动追踪 | ❌ 需手动处理 | | **Vue 推荐** | ✅ 官方推荐 | ⚠️ 尽量避免 | ## 最佳实践 1. **优先使用 ref 系统**:符合 Vue 的响应式设计原则 2. **避免在 setup 中直接操作 DOM**:会导致时机问题和维护困难 3. **复杂场景使用 nextTick**:确保 DOM 更新完成后再操作 4. **封装 DOM 操作逻辑**:保持组件的纯净性 ```vue <script setup> import { ref, onMounted } from &#39;vue&#39;; const containerRef = ref(null); // 封装 DOM 操作逻辑 const initCustomScroll = () => { if (!containerRef.value) return; // 实现自定义滚动逻辑 containerRef.value.addEventListener(&#39;wheel&#39;, (e) => { e.preventDefault(); containerRef.value.scrollTop += e.deltaY; }); }; onMounted(initCustomScroll); </script> ``` ## 相关问题 1. Vue3 中如何在 `<script setup>` 内获取子组件实例? 2. 使用 ref 和 `document.querySelector` 有何性能差异? 3. Vue3 的生命周期钩子在组合式 API 中如何使用? 4. 如何监听 DOM 元素尺寸变化? 5. Vue3 的 Teleport 组件中如何获取目标容器? > 根据 Vue3 的生命周期特性,在 setup 阶段直接操作 DOM 会导致元素未找到的问题。推荐使用 ref 系统结合生命周期钩子来安全地访问 DOM 元素[^3][^4]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值