通常用 Vue.js 編寫單頁應(yīng)用(SPA)時(shí),當(dāng)加載頁面時(shí),所有必需的資源(如 JavaScript 和 CSS 文件)都會被一起加載。在處理大文件時(shí),這可能會導(dǎo)致用戶體驗(yàn)不佳。
借助 Webpack,可以用 import() 函數(shù)而不是 import 關(guān)鍵字在 Vue.js 中按需加載頁面。
為什么要按需加載?
Vue.js 中 SPA 的典型工作方式是將所有功能和資源打包一并交付,這樣可以使用戶無需刷新頁面即可使用你的應(yīng)用。如果你沒有為了按需加載頁面針對自己的應(yīng)用進(jìn)行明確的設(shè)計(jì),那么所有的頁面會被立即加載,或者提前使用大量內(nèi)存進(jìn)行不必要的預(yù)加載。
這對有許多頁面的大型 SPA 非常不利,會導(dǎo)致使用低端手機(jī)和低網(wǎng)速的用戶體驗(yàn)會很差。如果通過按需加載,用戶將不需要下載他們當(dāng)前不需要的資源。
Vue.js 沒有為動態(tài)模塊提供任何加載指示器相關(guān)的控件。即使進(jìn)行了預(yù)取和預(yù)加載,也沒有對應(yīng)的空間讓用戶知道加載的過程,所以還需要通過添加進(jìn)度條來改善用戶體驗(yàn)。
準(zhǔn)備項(xiàng)目
首先需要一種讓進(jìn)度條與 Vue Router 通信的方法。事件總線模式比較合適。
事件總線是一個 Vue 實(shí)例的單例。由于所有 Vue 實(shí)例都有一個使用 $on和 $emit的事件系統(tǒng),因此可以用它在應(yīng)用中的任何地方傳遞事件。
首先在 components 目錄中創(chuàng)建一個新文件 eventHub.js:
import Vue from 'vue'
export default new Vue()
然后把 Webpack 配置為禁用預(yù)取和預(yù)加載,這樣就可以針對每個函數(shù)單獨(dú)執(zhí)行此類操作,當(dāng)然你也可以全局禁用它。在根文件夾中創(chuàng)建一個 vue.config.js 文件并添加禁用預(yù)取和預(yù)加載的相關(guān)配置:
module.exports = {
chainWebpack: (config) => {
// 禁用預(yù)取和預(yù)加載
config.plugins.delete('prefetch')
config.plugins.delete('preload')
},
}
添加路由和頁面
用 npx 安裝 Vue router 并使用:
$ npx vue add router
編輯位于 router/index.js 下的 router 文件并更新路由,以便可以用 import() 函數(shù)代替 import 語句:
以下默認(rèn)配置:
import About from '../views/About.vue'
{
path: '/about',
name: 'About',
component: About
},
將其改為:
{
path: '/about',
name: 'About',
component: () => import('../views/About.vue')
},
如果希望可以選擇按需加載某些頁面,而不是全局禁用預(yù)取和預(yù)加載,可以用特殊的 Webpack 注釋,不要在 vue.config.js 中配置 Webpack:
import(
/* webpackPrefetch: true */
/* webpackPreload: true */
'../views/About.vue'
)
import() 和 import 之間的主要區(qū)別是在運(yùn)行時(shí)加載由 import() 加載的 ES 模塊,在編譯時(shí)加載由 import 加載的 ES 模塊。這就意味著可以用 import() 延遲模塊的加載,并僅在必要時(shí)加載。
實(shí)現(xiàn)進(jìn)度條
由于無法準(zhǔn)確估算頁面的加載時(shí)間(或完全加載),因此我們無法真正的去創(chuàng)建進(jìn)度條。也沒有辦法檢查頁面已經(jīng)加載了多少。不過可以創(chuàng)建一個進(jìn)度條,并使它在頁面加載時(shí)完成。
由于不能真正反映進(jìn)度,所以描繪的進(jìn)度只是進(jìn)行了隨機(jī)跳躍。
先安裝 lodash.random,因?yàn)樵谏蛇M(jìn)度條的過程中將會用這個包產(chǎn)生一些隨機(jī)數(shù):
$ npm i lodash.random
然后,創(chuàng)建一個 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>
接下來向該組件添加腳本。在腳本中先導(dǎo)入 random 和 $eventHub,后面會用到:
<script>
import random from 'lodash.random'
import $eventHub from '../components/eventHub'
</script>
導(dǎo)入之后,在腳本中定義一些后面要用到的變量:
// 假設(shè)加載將在此時(shí)間內(nèi)完成。
const defaultDuration = 8000
// 更新頻率
const defaultInterval = 1000
// 取值范圍 0 - 1. 每個時(shí)間間隔進(jìn)度增長多少
const variation = 0.5
// 0 - 100. 進(jìn)度條應(yīng)該從多少開始。
const startingPoint = 0
// 限制進(jìn)度條到達(dá)加載完成之前的距離
const endingPoint = 90
然后編碼實(shí)現(xiàn)異步加載組件的邏輯:
export default {
name: 'ProgressBar',
data: () => ({
isLoading: true, // 加載完成后,開始逐漸消失
isVisible: false, // 完成動畫后,設(shè)置 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() 函數(shù)中,用事件總線來偵聽異步組件的加載。一旦路由告訴我們已經(jīng)導(dǎo)航到尚未加載的頁面,它將會開始加載動畫。
最后其添加一些樣式:
<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 或布局組件中,只要它與路由視圖位于同一組件中即可,它在應(yīng)用的整個生命周期中都可用:
<template>
<div>
<progress-bar></progress-bar>
<router-view></router-view>
<!--- 你的其它組件 -->
</div>
</template>
<script>
import ProgressBar from './components/ProgressBar.vue'
export default {
components: { ProgressBar },
}
</script>
然后你就可以在頁面頂端看到一個流暢的進(jìn)度條:
頁面頂端的進(jìn)度條
為延遲加載觸發(fā)進(jìn)度條現(xiàn)在 ProgressBar 正在事件總線上偵聽異步組件加載事件。當(dāng)某些資源以這種方式加載時(shí)應(yīng)該觸發(fā)動畫?,F(xiàn)在向路由添加一個路由守護(hù)來接收以下事件:
import $eventHub from '../components/eventHub'
router.beforeEach((to, from, next) => {
if (typeof to.matched[0]?.components.default === 'function') {
$eventHub.$emit('asyncComponentLoading', to) // 啟動進(jìn)度條
}
next()
})
router.beforeResolve((to, from, next) => {
$eventHub.$emit('asyncComponentLoaded') // 停止進(jìn)度條
next()
})
為了檢測頁面是否被延遲加載了,需要檢查組件是不是被定義為動態(tài)導(dǎo)入的,也就是應(yīng)該為 component:() => import('...') 而不是component:MyComponent。
這是通過 typeof to.matched[0]?.components.default === 'function'完成的。帶有 import 語句的組件不會被歸為函數(shù)。
總結(jié)
在本文中,我們禁用了在 Vue 應(yīng)用中的預(yù)取和預(yù)加載功能,并創(chuàng)建了一個進(jìn)度條組件,該組件可顯示以模擬加載頁面時(shí)的實(shí)際進(jìn)度。