深入解析 Vue 3 中的 defineExpose

news2024/11/19 6:14:47

深入解析 Vue 3 中的 `defineExpose`

在 Vue 3 的组合式 API（Composition API）中，defineExpose 是一个重要的辅助函数，专门用于在 <script setup> 模式下暴露组件内部的属性和方法给父组件使用。本文将详细解析 defineExpose 的功能、使用场景及注意事项，并结合实际代码示例帮助你更好地理解和应用。

1. 什么是 `defineExpose`？

defineExpose 是 Vue 3 提供的一个仅能在 <script setup> 中使用的函数，用来显式暴露组件内部的属性或方法，使得父组件可以通过 ref 访问子组件的暴露内容。

作用

在 Vue 3 中，<script setup> 默认是封闭的。子组件的内容不会自动暴露给父组件。
使用 defineExpose 可以选择性地暴露内部内容，从而避免不必要的属性泄漏，同时提供更好的封装性。

2. 基本用法

语法

defineExpose(exposedObject)

参数：exposedObject，一个对象，定义要暴露的属性或方法。
返回值：无。

示例：暴露方法和数据

<script setup>
import { ref } from 'vue';

// 子组件内部的状态和方法
const count = ref(0);

function increment() {
  count.value++;
}

// 通过 defineExpose 暴露给父组件
defineExpose({
  count,
  increment
});
</script>

<template>
  <div>
    <p>计数器子组件：{{ count }}</p>
  </div>
</template>

在父组件中：

<script setup>
import { ref } from 'vue';
import Counter from './Counter.vue';

// 通过 ref 获取子组件实例
const counterRef = ref(null);

function callChildMethod() {
  counterRef.value.increment(); // 调用子组件的方法
  console.log('子组件计数值:', counterRef.value.count); // 访问子组件的暴露属性
}
</script>

<template>
  <Counter ref="counterRef" />
  <button @click="callChildMethod">调用子组件方法</button>
</template>

运行结果

点击按钮，父组件调用子组件的 increment 方法，子组件的 count 值增加。
父组件通过子组件的 ref 访问到了 count 和 increment。

3. 为什么需要 `defineExpose`？

默认行为：封闭的 `<script setup>`

在 Vue 3 的 <script setup> 中，组件的状态和方法默认是私有的。这意味着，父组件即使通过 ref 引用子组件实例，也无法访问其中的任何内容。

例如：

<script setup>
const msg = 'Hello Vue';
</script>

在父组件中，即使通过 ref 获取子组件，也无法访问 msg。

显式暴露：提高安全性

通过 defineExpose，开发者可以显式选择要暴露的内容，从而避免父组件访问到不必要的内部状态或方法，提供更好的组件封装性。

4. `defineExpose` 的典型使用场景

4.1 暴露组件方法

当父组件需要调用子组件的方法时，可以使用 defineExpose。

<script setup>
function greet() {
  console.log('子组件方法被调用！');
}
defineExpose({ greet });
</script>

在父组件中：

<template>
  <ChildComponent ref="child" />
  <button @click="child.greet()">调用子组件方法</button>
</template>

<script setup>
import { ref } from 'vue';
import ChildComponent from './ChildComponent.vue';

const child = ref(null);
</script>

4.2 配合动态模板或状态管理

当子组件需要暴露动态状态供父组件使用时：

<script setup>
import { ref } from 'vue';

const isLoading = ref(false);

function startLoading() {
  isLoading.value = true;
}

function stopLoading() {
  isLoading.value = false;
}

defineExpose({ isLoading, startLoading, stopLoading });
</script>

父组件：

<script setup>
import ChildComponent from './ChildComponent.vue';
import { ref } from 'vue';

const childRef = ref(null);

function toggleLoading() {
  childRef.value.startLoading();
  setTimeout(() => {
    childRef.value.stopLoading();
  }, 2000);
}
</script>

<template>
  <ChildComponent ref="childRef" />
  <button @click="toggleLoading">加载 2 秒</button>
</template>

4.3 复杂场景：动态父子组件交互

有时父组件需要根据子组件的状态动态渲染内容，例如表单校验、步骤管理等。

示例：子组件暴露校验方法

<script setup>
import { ref } from 'vue';

const formData = ref({ name: '', age: null });

function validate() {
  const isValid = formData.value.name !== '' && formData.value.age > 0;
  return isValid;
}

defineExpose({ formData, validate });
</script>

<template>
  <div>
    <input v-model="formData.name" placeholder="输入姓名" />
    <input v-model="formData.age" type="number" placeholder="输入年龄" />
  </div>
</template>

父组件调用校验：

<script setup>
import { ref } from 'vue';
import FormComponent from './FormComponent.vue';

const formRef = ref(null);

function submitForm() {
  if (formRef.value.validate()) {
    console.log('表单校验通过！');
  } else {
    console.log('表单校验失败！');
  }
}
</script>

<template>
  <FormComponent ref="formRef" />
  <button @click="submitForm">提交</button>
</template>

5. 注意事项

只能在 <script setup> 中使用：
defineExpose 是专为 <script setup> 设计的，不能用于普通的 <script> 或 setup() 函数中。
明确暴露的内容：
不建议直接暴露整个组件内部状态，应该只暴露必要的部分，保持组件封装性。
ref 必须正确绑定：
父组件只有在为子组件设置了 ref 属性后，才能通过 ref 访问子组件的暴露内容。
避免滥用：
如果父组件频繁依赖子组件的内部状态，可能说明父组件和子组件的职责划分不清。