Vue組件懶加載的操作代碼

更新時間：2023年09月21日 08:53:53 作者：chuckQu

在本文中，我們學習了如何使用 Intersection Observer API 和?defineAsyncComponent?函數在 Vue 組件可見時對其進行懶加載，本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友一起看看吧

Intersection Observer API

Intersection Observer API 是一種功能強大的工具，它允許開發(fā)人員有效地跟蹤和響應瀏覽器視口中元素可見性的變化。

它提供了一種異步觀察元素與其父元素之間或元素與視口之間交集的方法。它為檢測元素何時可見或隱藏提供了性能優(yōu)越的優(yōu)化解決方案，減少了對低效滾動事件監(jiān)聽器的需求，使開發(fā)人員能夠在必要時有選擇地加載或操作內容，從而增強用戶體驗。

它通常用于實現(xiàn)諸如無限滾動和圖片懶加載等功能。

異步組件

Vue 3 提供了 defineAsyncComponent，用于僅在需要時異步加載組件。

它返回一個組件定義的 Promise：

import { defineAsyncComponent } from 'vue'
const AsyncComp = defineAsyncComponent(() => {
  return new Promise((resolve, reject) => {
    // ...load component from server
    resolve(/* loaded component */)
  })
})

還可以處理錯誤和加載狀態(tài)：

const AsyncComp = defineAsyncComponent({
  // the loader function
  loader: () => import('./Foo.vue'),
  // A component to use while the async component is loading
  loadingComponent: LoadingComponent,
  // Delay before showing the loading component. Default: 200ms.
  delay: 200,
  // A component to use if the load fails
  errorComponent: ErrorComponent,
  // The error component will be displayed if a timeout is
  // provided and exceeded. Default: Infinity.
  timeout: 3000
})

當組件可見時，我們將使用該功能異步加載組件。

懶加載組件

現(xiàn)在，讓我們結合 Intersection Observer API 和 defineAsyncComponent 函數，在組件可見時異步加載它們：

import {
  h,
  defineAsyncComponent,
  defineComponent,
  ref,
  onMounted,
  AsyncComponentLoader,
  Component,
} from 'vue';
type ComponentResolver = (component: Component) => void
export const lazyLoadComponentIfVisible = ({
  componentLoader,
  loadingComponent,
  errorComponent,
  delay,
  timeout
}: {
  componentLoader: AsyncComponentLoader;
  loadingComponent: Component;
  errorComponent?: Component;
  delay?: number;
  timeout?: number;
}) => {
  let resolveComponent: ComponentResolver;
  return defineAsyncComponent({
    // the loader function
    loader: () => {
      return new Promise((resolve) => {
        // We assign the resolve function to a variable
        // that we can call later inside the loadingComponent 
        // when the component becomes visible
        resolveComponent = resolve as ComponentResolver;
      });
    },
    // A component to use while the async component is loading
    loadingComponent: defineComponent({
      setup() {
        // We create a ref to the root element of 
        // the loading component
        const elRef = ref();
        async function loadComponent() {
            // `resolveComponent()` receives the
            // the result of the dynamic `import()`
            // that is returned from `componentLoader()`
            const component = await componentLoader()
            resolveComponent(component)
        }
        onMounted(async() => {
          // We immediately load the component if
          // IntersectionObserver is not supported
          if (!('IntersectionObserver' in window)) {
            await loadComponent();
            return;
          }
          const observer = new IntersectionObserver((entries) => {
            if (!entries[0].isIntersecting) {
              return;
            }
            // We cleanup the observer when the 
            // component is not visible anymore
            observer.unobserve(elRef.value);
            await loadComponent();
          });
          // We observe the root of the
          // mounted loading component to detect
          // when it becomes visible
          observer.observe(elRef.value);
        });
        return () => {
          return h('div', { ref: elRef }, loadingComponent);
        };
      },
    }),
    // Delay before showing the loading component. Default: 200ms.
    delay,
    // A component to use if the load fails
    errorComponent,
    // The error component will be displayed if a timeout is
    // provided and exceeded. Default: Infinity.
    timeout,
  });
};

讓我們分解一下上面的代碼：

我們創(chuàng)建一個 lazyLoadComponentIfVisible 函數，該函數接受以下參數：

componentLoader：返回一個解析為組件定義的 Promise 的函數
loadingComponent：異步組件加載時使用的組件。
errorComponent：加載失敗時使用的組件。
delay：顯示加載組件前的延遲。默認值：200 毫秒。
timeout：如果提供了超時時間，則將顯示錯誤組件。默認值：Infinity。

函數返回 defineAsyncComponent，其中包含在組件可見時異步加載組件的邏輯。

主要邏輯發(fā)生在 defineAsyncComponent 內部的 loadingComponent 中：

我們使用 defineComponent 創(chuàng)建一個新組件，該組件包含一個渲染函數，用于在傳遞給 lazyLoadComponentIfVisible 的 div中渲染 loadingComponent。該渲染函數包含一個指向加載組件根元素的模板ref。

在 onMounted 中，我們會檢查 IntersectionObserver 是否受支持。如果不支持，我們將立即加載組件。否則，我們將創(chuàng)建一個 IntersectionObserver，用于觀察已加載組件的根元素，以檢測它何時變得可見。當組件變?yōu)榭梢姇r，我們會清理觀察者并加載組件。

現(xiàn)在，你可以使用該函數在組件可見時對其進行懶加載：

<script setup lang="ts">
import Loading from './components/Loading.vue';
import { lazyLoadComponentIfVisible } from './utils';
const LazyLoaded = lazyLoadComponentIfVisible({
  componentLoader: () => import('./components/HelloWorld.vue'),
  loadingComponent: Loading,
});
</script>
<template>
  <LazyLoaded />
</template>