爲 Vue 的惰性加載加一個進度條

時間 2020-10-24

標籤 javascript html 前端 vue java webpack 程序員 web 面試 vue-router 欄目 JavaScript 简体版

原文原文鏈接

做者：Stack Abuse
翻譯：瘋狂的技術宅javascript

https://stackabuse.com/lazy-l...html

未經容許嚴禁轉載前端

簡介

一般用 Vue.js 編寫單頁應用（SPA）時，當加載頁面時，全部必需的資源（如 JavaScript 和 CSS 文件）都會被一塊兒加載。在處理大文件時，這可能會致使用戶體驗不佳。vue

藉助 Webpack，能夠用 import() 函數而不是 import 關鍵字在 Vue.js 中按需加載頁面。java

爲何要按需加載？

Vue.js 中 SPA 的典型工做方式是將全部功能和資源打包一併交付，這樣可使用戶無需刷新頁面便可使用你的應用。若是你沒有爲了按需加載頁面針對本身的應用進行明確的設計，那麼全部的頁面會被當即加載，或者提早使用大量內存進行沒必要要的預加載。webpack

這對有許多頁面的大型 SPA 很是不利，會致使使用低端手機和低網速的用戶體驗會不好。若是經過按需加載，用戶將不須要下載他們當前不須要的資源。程序員

Vue.js 沒有爲動態模塊提供任何加載指示器相關的控件。即便進行了預取和預加載，也沒有對應的空間讓用戶知道加載的過程，因此還須要經過添加進度條來改善用戶體驗。web

準備項目

首先須要一種讓進度條與 Vue Router 通訊的方法。事件總線模式比較合適。面試

事件總線是一個 Vue 實例的單例。因爲全部 Vue 實例都有一個使用 $on和 $emit 的事件系統，所以能夠用它在應用中的任何地方傳遞事件。vue-router

首先在 components 目錄中建立一個新文件 eventHub.js：

import Vue from 'vue'
export default new Vue()

而後把 Webpack 配置爲禁用預取和預加載，這樣就能夠針對每一個函數單獨執行此類操做，固然你也能夠全局禁用它。在根文件夾中建立一個 vue.config.js 文件並添加禁用預取和預加載的相關配置：

module.exports = {
    chainWebpack: (config) => {
        // 禁用預取和預加載
        config.plugins.delete('prefetch')
        config.plugins.delete('preload')
    },
}

添加路由和頁面

用 npx 安裝 Vue router 並使用：

$ npx vue add router

編輯位於 router/index.js 下的 router 文件並更新路由，以即可以用 import() 函數代替 import 語句：

如下默認配置：

import About from '../views/About.vue'
{
    path: '/about',
    name: 'About',
    component: About
},

將其改成：

{
    path: '/about',
    name: 'About',
    component: () => import('../views/About.vue')
},

若是但願能夠選擇按需加載某些頁面，而不是全局禁用預取和預加載，能夠用特殊的 Webpack 註釋，不要在 vue.config.js 中配置 Webpack：

import(
    /* webpackPrefetch: true */
    /* webpackPreload: true */
    '../views/About.vue'
)

import() 和 import 之間的主要區別是在運行時加載由 import() 加載的 ES 模塊，在編譯時加載由 import 加載的 ES 模塊。這就意味着能夠用 import() 延遲模塊的加載，並僅在必要時加載。

實現進度條

因爲沒法準確估算頁面的加載時間（或徹底加載），所以咱們沒法真正的去建立進度條。也沒有辦法檢查頁面已經加載了多少。不過能夠建立一個進度條，並使它在頁面加載時完成。

因爲不能真正反映進度，因此描繪的進度只是進行了隨機跳躍。

先安裝 lodash.random，由於在生成進度條的過程當中將會用這個包產生一些隨機數：

$ npm i lodash.random

而後，建立一個 Vue 組件 components/ProgressBar.vue：

<template>
    <div :class="{'loading-container': true, loading: isLoading, visible: isVisible}">
        <div class="loader" :style="{ width: progress + '%' }">
            <div class="light"></div>
        </div>
        <div class="glow"></div>
    </div>
</template>

接下來向該組件添加腳本。在腳本中先導入 random 和 $eventHub，後面會用到：

<script>
import random from 'lodash.random'
import $eventHub from '../components/eventHub'
</script>

導入以後，在腳本中定義一些後面要用到的變量：

// 假設加載將在此時間內完成。
const defaultDuration = 8000 
// 更新頻率
const defaultInterval = 1000 
// 取值範圍 0 - 1. 每一個時間間隔進度增加多少
const variation = 0.5 
// 0 - 100. 進度條應該從多少開始。
const startingPoint = 0 
// 限制進度條到達加載完成以前的距離
const endingPoint = 90

而後編碼實現異步加載組件的邏輯：

export default {
    name: 'ProgressBar',
    
    data: () => ({
        isLoading: true, // 加載完成後，開始逐漸消失
        isVisible: false, // 完成動畫後，設置 display: none
        progress: startingPoint,
        timeoutId: undefined,
    }),

    mounted() {
        $eventHub.$on('asyncComponentLoading', this.start)
        $eventHub.$on('asyncComponentLoaded', this.stop)
    },

    methods: {
        start() {
            this.isLoading = true
            this.isVisible = true
            this.progress = startingPoint
            this.loop()
        },

        loop() {
            if (this.timeoutId) {
                clearTimeout(this.timeoutId)
            }
            if (this.progress >= endingPoint) {
                return
            }
            const size = (endingPoint - startingPoint) / (defaultDuration / defaultInterval)
            const p = Math.round(this.progress + random(size * (1 - variation), size * (1 + variation)))
            this.progress = Math.min(p, endingPoint)
            this.timeoutId = setTimeout(
                this.loop,
                random(defaultInterval * (1 - variation), defaultInterval * (1 + variation))
            )
        },

        stop() {
            this.isLoading = false
            this.progress = 100
            clearTimeout(this.timeoutId)
            const self = this
            setTimeout(() => {
                if (!self.isLoading) {
                    self.isVisible = false
                }
            }, 200)
        },
    },
}

在 mounted() 函數中，用事件總線來偵聽異步組件的加載。一旦路由告訴咱們已經導航到還沒有加載的頁面，它將會開始加載動畫。

最後其添加一些樣式：

<style scoped>
.loading-container {
    font-size: 0;
    position: fixed;
    top: 0;
    left: 0;
    height: 5px;
    width: 100%;
    opacity: 0;
    display: none;
    z-index: 100;
    transition: opacity 200;
}

.loading-container.visible {
    display: block;
}
.loading-container.loading {
    opacity: 1;
}

.loader {
    background: #23d6d6;
    display: inline-block;
    height: 100%;
    width: 50%;
    overflow: hidden;
    border-radius: 0 0 5px 0;
    transition: 200 width ease-out;
}

.loader > .light {
    float: right;
    height: 100%;
    width: 20%;
    background-image: linear-gradient(to right, #23d6d6, #29ffff, #23d6d6);
    animation: loading-animation 2s ease-in infinite;
}

.glow {
    display: inline-block;
    height: 100%;
    width: 30px;
    margin-left: -30px;
    border-radius: 0 0 5px 0;
    box-shadow: 0 0 10px #23d6d6;
}

@keyframes loading-animation {
    0% {
        margin-right: 100%;
    }
    50% {
        margin-right: 100%;
    }
    100% {
        margin-right: -10%;
    }
}
</style>

最後將 ProgressBar 添加到 App.vue 或佈局組件中，只要它與路由視圖位於同一組件中便可，它在應用的整個生命週期中均可用：

<template>
    <div>
        <progress-bar></progress-bar>
        <router-view></router-view>
        <!--- 你的其它組件 -->
    </div>
</template>

<script>
import ProgressBar from './components/ProgressBar.vue'
export default {
       components: { ProgressBar },
}
</script>

而後你就能夠在頁面頂端看到一個流暢的進度條：

爲延遲加載觸發進度條

如今 ProgressBar 正在事件總線上偵聽異步組件加載事件。當某些資源以這種方式加載時應該觸發動畫。如今向路由添加一個路由守護來接收如下事件：

import $eventHub from '../components/eventHub'

router.beforeEach((to, from, next) => {
    if (typeof to.matched[0]?.components.default === 'function') {
        $eventHub.$emit('asyncComponentLoading', to) // 啓動進度條
    }
    next()
})

router.beforeResolve((to, from, next) => {
    $eventHub.$emit('asyncComponentLoaded') // 中止進度條
    next()
})

爲了檢測頁面是否被延遲加載了，須要檢查組件是否是被定義爲動態導入的，也就是應該爲 component:() => import('...') 而不是component:MyComponent。

這是經過 typeof to.matched[0]?.components.default === 'function' 完成的。帶有 import 語句的組件不會被歸爲函數。