• 首页
  • vue
  • TypeScript
  • JavaScript
  • scss
  • css3
  • html5
  • php
  • MySQL
  • redis
  • jQuery
  • 异步组件

    异步组件

    在大型项目中,我们可能需要拆分应用为更小的块,并仅在需要时再从服务器加载相关组件。Vue 提供了defineAsyncComponent方法来实现此功能::

    import { defineAsyncComponent } from 'vue'
    
    const AsyncComp = defineAsyncComponent(() => {
      return new Promise((resolve, reject) => {
        // ...从服务器获取组件
        resolve(/* 获取到的组件 */)
      })
    })
    
    // ... 像使用其他一般组件一样使用 `AsyncComp`
    

    如你所见,defineAsyncComponent方法接收一个返回Promise的加载函数。这个Promiseresolve()回调方法应该在从服务器获得组件定义时调用。你也可以调用reject(reason)表明加载失败。

    ES 模块动态导入也会返回一个Promise,所以多数情况下我们会将它和defineAsyncComponent搭配使用,类似ViteWebpack这样的构建工具,也支持这种语法,因此我们也可以用它来导入 Vue 单文件组件:

    <script setup>
    import { defineAsyncComponent } from 'vue'
    
    const AsyncComp = defineAsyncComponent(() => import('./components/MyComponent.vue'))
    </script>
    

    最后得到的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>组件一起使用,若想了解<Suspense>和异步组件之间交互,请参阅文档中<Suspense>章节。

    上篇:插槽 slot

    下篇:组件 v-model