基本用法
在大型项目中,我们可能需要拆分应用为更小的块,并仅在需要时再从服务器加载相关组件。Vue 提供了 [defineAsyncComponent
]方法来实现此功能:
import { defineAsyncComponent } from 'vue' const AsyncComp = defineAsyncComponent(() => { return new Promise((resolve, reject) => { // ...从服务器获取组件 resolve(/* 获取到的组件 */) }) }) // ... 像使用其他一般组件一样使用 `AsyncComp`
如你所见,defineAsyncComponent
方法接收一个返回 Promise 的加载函数。这个 Promise 的 resolve
回调方法应该在从服务器获得组件定义时调用。你也可以调用 reject(reason)
表明加载失败。
[ES 模块动态导入]也会返回一个 Promise,所以多数情况下我们会将它和 defineAsyncComponent
搭配使用。类似 Vite 和 Webpack 这样的构建工具也支持此语法 (并且会将它们作为打包时的代码分割点),因此我们也可以用它来导入 Vue 单文件组件:
import { defineAsyncComponent } from 'vue' const AsyncComp = defineAsyncComponent(() => import('./components/MyComponent.vue') )
最后得到的 AsyncComp
是一个外层包装过的组件,仅在页面需要它渲染时才会调用加载内部实际组件的函数。它会将接收到的 props 和插槽传给内部组件,所以你可以使用这个异步的包装组件无缝地替换原始组件,同时实现延迟加载。
与普通组件一样,异步组件可以使用 app.component()
[全局注册]:
app.component('MyComponent', defineAsyncComponent(() => import('./components/MyComponent.vue') ))
也可以直接在父组件中直接定义它们:
<script setup> import { defineAsyncComponent } from 'vue' const AdminPage = defineAsyncComponent(() => import('./components/AdminPageComponent.vue') ) </script> <template> <AdminPage /> </template>
加载与错误状态
异步操作不可避免地会涉及到加载和错误状态,因此 defineAsyncComponent()
也支持在高级选项中处理这些状态:
const AsyncComp = defineAsyncComponent({ // 加载函数 loader: () => import('./Foo.vue'), // 加载异步组件时使用的组件 loadingComponent: LoadingComponent, // 展示加载组件前的延迟时间,默认为 200ms delay: 200, // 加载失败后展示的组件 errorComponent: ErrorComponent, // 如果提供了一个 timeout 时间限制,并超时了 // 也会显示这里配置的报错组件,默认值是:Infinity timeout: 3000 })
如果提供了一个加载组件,它将在内部组件加载时先行显示。在加载组件显示之前有一个默认的 200ms 延迟——这是因为在网络状况较好时,加载完成得很快,加载组件和最终组件之间的替换太快可能产生闪烁,反而影响用户感受。
如果提供了一个报错组件,则它会在加载器函数返回的 Promise 抛错时被渲染。你还可以指定一个超时时间,在请求耗时超过指定时间时也会渲染报错组件。
搭配 Suspense 使用
异步组件可以搭配内置的 <Suspense>
组件一起使用,
异步组件的应用场景及必要性
Vue.js 中的异步组件是一种优化手段,它允许我们在需要的时候才加载组件的代码,而不是在应用初始化时就加载所有组件。这种技术在以下场景中特别有用:
- 大型应用中的懒加载:
对于大型单页应用(SPA),如果一次性加载所有组件,会导致初始加载时间过长。使用异步组件可以实现按需加载,即只有当用户访问到某个特定路由或功能时,才加载对应的组件,这样可以显著减少初始加载时间,提升用户体验。 - 优化性能:
通过异步加载组件,可以减少初始化的 JavaScript 包大小,从而加快页面渲染速度。这对于移动端或网络条件较差的用户尤为重要。 - 代码分割:
异步组件与 Webpack 的代码分割功能结合使用,可以将应用代码分割成多个小块,按需加载,这有助于更好地利用浏览器的缓存机制。 - 动态组件加载:
在某些情况下,组件的加载取决于用户的操作或应用的状态。例如,一个论坛应用可能根据用户点击的帖子类型来加载不同的评论组件。 - 插件或第三方库的管理:
当使用第三方库或插件时,可能不需要在应用启动时就加载它们。通过异步组件,可以在需要时才引入这些库,避免不必要的资源消耗。
使用异步组件的必要性在于它能够提升应用的性能和用户体验。通过减少初始加载的资源量,应用可以更快地响应用户的操作,同时也有助于减少服务器负载和带宽使用。
在 Vue.js 中,可以通过工厂函数来定义异步组件:
const AsyncComponent = () => ({ // 需要加载的组件 (应该是一个 `import()` 函数) component: import('./MyComponent.vue'), // 异步组件加载时使用的组件 loading: LoadingComponent, // 加载失败时使用的组件 error: ErrorComponent, // 展示加载时组件的延时时间。默认值是 200 (毫秒) delay: 200, // 如果提供了超时时间且组件加载也超时了, // 则使用加载失败时使用的组件。默认值是:`Infinity` timeout: 3000 })
在这个例子中,MyComponent.vue
会在需要时才被加载,同时可以提供加载中和加载失败时的占位组件。
关注我,不迷路,共学习,同进步