vue3中的defineAsyncComponent-JXin的博客

温馨提示

该文章距离上次更新已经过去了 1000 天，文章内容可能已经过时。

什么是 defineAsyncComponent
defineAsyncComponent 的使用
- defineAsyncComponent 的高阶用法

什么是 defineAsyncComponent

官方文档

官方解释：创建一个只有在需要时才会加载的异步组件。

也就是一些组件在页面加载的时候可以先不去加载，等到需要用到这个组件的时候再去加载，例如一个文章页面，包含了文章列表组件和创建文章的组件，在进入页面的时候就可以先不去加载创建文章的组件，等到用户点击创建的时候，或者进入页面几秒钟之后再去加载创建文章的组件。

defineAsyncComponent 的使用

<template>
  <div>
    <button @click="showAsyncComm = true">显示</button>
    <AsyncComp v-if="showAsyncComm" />
  </div>
</template>

<script setup>
import { defineAsyncComponent, ref } from "vue";

let showAsyncComm = ref(false);

const AsyncComp = defineAsyncComponent(() =>
  import("./components/TestComm/index.vue")
);
</script>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

AsyncComp 会在用户点击了按钮之后才会去加载

也可以直接返回一个Promise函数

<template>
  <div>
    <button @click="showAsyncComm = true">显示</button>
    <AsyncComp v-if="showAsyncComm" />
  </div>
</template>

<script>
import { defineAsyncComponent, ref } from "vue";

export default {
  name: "App",
  components: {
    AsyncComp: defineAsyncComponent(() =>
      import("./components/TestComm/index.vue")
    ),
  },
  setup() {
    let showAsyncComm = ref(false);
    return {
      showAsyncComm,
    };
  },
};
</script>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

defineAsyncComponent 的高阶用法

import { defineAsyncComponent } from 'vue'

const AsyncComp = defineAsyncComponent({
  // 工厂函数
  loader: () => import('./Foo.vue'),
  // 加载异步组件时要使用的组件
  loadingComponent: LoadingComponent,
  // 加载失败时要使用的组件
  errorComponent: ErrorComponent,
  // 在显示 loadingComponent 之前的延迟 | 默认值：200（单位 ms）
  delay: 200,
  // 如果提供了 timeout ，并且加载组件的时间超过了设定值，将显示错误组件
  // 默认值：Infinity（即永不超时，单位 ms）
  timeout: 3000,
  // 定义组件是否可挂起 | 默认值：true
  suspensible: false,
  /**
   *
   * @param {*} error 错误信息对象
   * @param {*} retry 一个函数，用于指示当 promise 加载器 reject 时，加载器是否应该重试
   * @param {*} fail  一个函数，指示加载程序结束退出
   * @param {*} attempts 允许的最大重试次数
   */
  onError(error, retry, fail, attempts) {
    if (error.message.match(/fetch/) && attempts <= 3) {
      // 请求发生错误时重试，最多可尝试 3 次
      retry()
    } else {
      // 注意，retry/fail 就像 promise 的 resolve/reject 一样：
      // 必须调用其中一个才能继续错误处理。
      fail()
    }
  }
})

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34