您现在的位置是:首页 >技术杂谈 >Vue 3 第十三章:组件四(异步组件-defineAsyncComponent)网站首页技术杂谈
Vue 3 第十三章:组件四(异步组件-defineAsyncComponent)
简介Vue 3 第十三章:组件四(异步组件-defineAsyncComponent)
1. 基本用法
在大型项目中,我们可能需要拆分应用为更小的块,并仅在需要时再从服务器加载相关组件。Vue 3 提供了 defineAsyncComponent
方法来实现此功能:
1.1. 获取服务端组件
import { defineAsyncComponent } from 'vue'
const AsyncComponent = defineAsyncComponent(() => {
return new Promise((resolve, reject) => {
// ...从服务器获取组件
resolve(/* 获取到的组件 */)
})
})
// ... 像使用其他一般组件一样使用 `AsyncComp`
如你所见,defineAsyncComponent
方法接收一个返回Promise
的加载函数。这个Promise
的resolve
回调方法应该在从服务器获得组件定义时调用。你也可以调用reject(reason)
表明加载失败。
1.2. ES module动态导入
ES 模块动态导入
也会返回一个 Promise
,所以多数情况下我们会将它和defineAsyncComponent
搭配使用。类似Vite
和Webpack
这样的构建工具也支持此语法 (并且会将它们作为打包时的代码分割点),因此我们也可以用它来导入 Vue
单文件组件:例如:
<template>
<div>
异步组件
<AsyncComponent />
</div>
</template>
<script setup lang="ts">
import { defineAsyncComponent } from 'vue';
const AsyncComponent = defineAsyncComponent(() => import('./components/MyAsyncCom.vue'))
</script>
<style scoped>
</style>
最后得到的AsyncComp
是一个外层包装过的组件,仅在页面需要它渲染时
才会调用加载内部实际组件的函数。它会将接收到的props
和插槽
传给内部组件,所以你可以使用这个异步的包装组件无缝地替换原始组件,同时实现延迟加载。
与普通组件一样,异步组件可以使用app.component()
全局注册:
app.component('MyAsyncCom', defineAsyncComponent(() =>
import('./components/MyAsyncCom.vue')
))
也可以直接在父组件中直接定义它们:
<template>
<div>
异步组件
<AsyncComponent />
</div>
</template>
<script setup lang="ts">
import { defineAsyncComponent } from 'vue';
const AsyncComponent = defineAsyncComponent(() => import('./components/MyAsyncCom.vue'))
</script>
<style scoped>
</style>
2. 加载与错误状态
异步操作不可避免地会涉及到加载和错误状态,因此defineAsyncComponent()
也支持在高级选项中处理这些状态:
const AsyncComponent = defineAsyncComponent({
// 加载函数
loader: () => import('./components/MyAsyncCom.vue'),
// 加载异步组件时使用的组件
loadingComponent: LoadingComponent,
// 展示加载组件前的延迟时间,默认为 200ms
delay: 200,
// 加载失败后展示的组件
errorComponent: ErrorComponent,
// 如果提供了一个 timeout 时间限制,并超时了
// 也会显示这里配置的报错组件,默认值是:Infinity
timeout: 3000
})
如果提供了一个加载组件,它将在内部组件加载时先行显示。在加载组件显示之前有一个默认的200ms
延迟——这是因为在网络状况较好时,加载完成得很快,加载组件和最终组件之间的替换太快可能产生闪烁,反而影响用户感受。
如果提供了一个报错组件,则它会在加载器函数返回的Promise
抛错时被渲染。你还可以指定一个超时时间,在请求耗时超过指定时间时也会渲染报错组件。
风语者!平时喜欢研究各种技术,目前在从事后端开发工作,热爱生活、热爱工作。