当前位置：首页 > news >正文

Ｖue 3.0中异步组件defineAsyncComponent

news 来源：原创 2025/5/23 8:26:44

在大型项目中，组件的体积可能会随着项目规模的增加而变得庞大。为了优化性能，我们可以将应用拆分为更小的块，并仅在需要时从服务器加载相关组件，这样的组件称为异步组件。

在 Vue 3 中，可以使用 defineAsyncComponent 方法来实现异步组件。

1. 异步组件

1.1. 组件的定义

import { defineAsyncComponent } from 'vue';const MyComponent = defineAsyncComponent(() => import('./components/MyComponent.vue'));

defineAsyncComponent 方法接收一个返回 Promise 的加载函数，ES 模块动态导入会返回一个 Promise，因此可以与 defineAsyncComponent 搭配使用。像 Vite 和 Webpack 这样的构建工具支持此语法，并将其作为代码分割点。

1.2. 使用异步组件

<script setup>
import { defineAsyncComponent } from 'vue';const AdminPage = defineAsyncComponent(() => import('./components/AdminPageComponent.vue'));
</script><template><AdminPage />
</template>

异步组件可以像普通组件一样使用和全局注册。通常异步组件我们会根据特定情况来使用，比如说以下场景：

1. 按照路由入口定义的异步组件；

2. 按照条件判断引入的异步组件；

因为只有组件在某一时机加载，这一特性才使得异步组件给应用加载带来性能提升，因为异步组件只在需要渲染时，才引入对应文件 chunk。

2. Suspense配合使用

<Suspense> 是一个内置组件，用来在组件树中协调对异步依赖的处理，它可以在等待异步组件加载时渲染一个加载状态。

<template><Suspense><template #default><MyComponent /></template><template #fallback><div>Loading...</div></template></Suspense>
</template><script setup>
import { defineAsyncComponent } from 'vue';const MyComponent = defineAsyncComponent(() => import('./components/MyComponent.vue'));
</script>

在上述代码中，当 MyComponent 组件正在加载时，<Suspense> 组件会显示 fallback 插槽中的内容。

3. 异步组件价值

为了分析异步组件对打包产物的影响，我们可以使用 rollup-plugin-visualizer 进行打包产物分析。

首先，安装该插件：然后在 vite.config.js 中配置插件：

import { defineConfig } from 'vite';
import vue from '@vitejs/plugin-vue';
import { visualizer } from 'rollup-plugin-visualizer';export default defineConfig({plugins: [vue(),visualizer({filename: './dist/report.html',open: true})]
});

构建项目后，打开生成的 report.html 文件，可以查看打包产物的可视化分析报告。示例分析如下：

3.1. 未使用异步组件

假设我们有一个普通组件 MyComponent.vue ，直接导入并使用：

<template><MyComponent />
</template><script setup>
import MyComponent from './components/MyComponent.vue';
</script>

在打包产物中，MyComponent 将被包含在主包内，导致主包体积较大。

3.2. 使用异步组件

使用 defineAsyncComponent 将 MyComponent 异步导入：

<template><Suspense><template #default><MyComponent /></template><template #fallback><div>Loading...</div></template></Suspense>
</template><script setup>import { defineAsyncComponent } from 'vue';
const MyComponent = defineAsyncComponent(() => import('./components/MyComponent.vue'));</script>

在打包产物中，MyComponent 将被拆分到一个独立的异步块中，仅在需要时加载，主包体积减小。

通过 rollup-plugin-visualizer 的可视化报告，可以清晰地看到未使用异步组件和使用异步组件后的打包体积差异。这种拆分可以显著提升应用的初始加载性能。

异步组件和 <Suspense> 组件的结合使用，可以优化大型应用的性能，减少主包体积，提升用户体验。通过打包分析工具如 rollup-plugin-visualizer，可以直观地查看异步组件带来的性能优化效果。在生产环境中，建议根据项目具体情况和稳定性需求，合理使用异步组件和 <Suspense> 组件。

4. 实现原理浅析

defineAsyncComponent 是一个高阶函数，它接收一个工厂函数作为参数，该工厂函数返回一个 Promise，用于异步加载组件。defineAsyncComponent 会返回一个新的组件，该组件内部处理了异步加载的逻辑。

4.1. 基本原理

1. 接收工厂函数: defineAsyncComponent 接收一个工厂函数，该工厂函数返回一个 Promise。

2. 返回异步组件: 返回的组件具有生命周期钩子和状态管理，用于处理加载过程、错误状态和超时等。

3. 加载组件: 在组件挂载时，执行工厂函数加载组件，并根据加载状态更新组件的显示。

4.2. 简单实例

以下是一个简化的 defineAsyncComponent 实现：

import { defineComponent, h, ref, onMounted, onUnmounted } from 'vue'export function defineAsyncComponent(loader) {return defineComponent({name: 'AsyncComponentWrapper',setup() {const component = ref(null)const error = ref(null)const loading = ref(true)onMounted(() => {loader().then((comp) => {component.value = comp.defaultloading.value = false}).catch((err) => {error.value = errloading.value = false})})return () => {if (loading.value) {return h('div', 'Loading...')} else if (error.value) {return h('div', `Error: ${error.value.message}`)} else if (component.value) {return h(component.value)}}}})
}

在这个简化版的实现中：

1. 定义状态：使用 ref 定义 component，error 和 loading 三个状态变量。

2. 组件挂载时加载：在 onMounted 钩子中调用传入的 loader 工厂函数来加载组件。

3. 处理加载结果：根据 Promise 的结果来更新状态变量。成功加载时，将组件赋值给 component，并设置 loading 为 false；加载失败时，将错误信息赋值给 error，并设置 loading 为 false。

4. 渲染逻辑：根据 loading，error 和 component 的状态来渲染不同的内容。

本示例代码展示了 defineAsyncComponent 的基本原理：通过工厂函数加载组件，并根据加载过程中的不同状态来更新显示内容。实际的 Vue 3 实现会更加复杂和健壮，支持更多的选项和功能，如加载超时、重试机制等