demo in github
背景
業(yè)務需求是這樣子的画机,每當發(fā)請求到后端時就觸發(fā)一個全屏的 loading赖歌,多個請求合并為一次 loading。
現(xiàn)在項目中用的是 vue 、axios绣的、element等,所以文章主要是講如果使用 axios 和 element 實現(xiàn)這個功能欲账。
分析
首先屡江,請求開始的時候開始 loading, 然后在請求返回后結(jié)束 loading赛不。重點就是要攔截請求和響應惩嘉。
然后,要解決多個請求合并為一次 loading踢故。
最后文黎,調(diào)用element 的 loading 組件即可。
攔截請求和響應
axios 的基本使用方法不贅述殿较。筆者在項目中使用 axios 是以創(chuàng)建實例的方式耸峭。
// 創(chuàng)建axios實例
const $ = axios.create({
baseURL: `${URL_PREFIX}`,
timeout: 15000
})
然后再封裝 post 請求(以 post 為例)
export default {
post: (url, data, config = { showLoading: true }) => $.post(url, data, config)
}
axios 提供了請求攔截和響應攔截的接口,每次請求都會調(diào)用showFullScreenLoading
方法淋纲,每次響應都會調(diào)用tryHideFullScreenLoading()
方法
// 請求攔截器
$.interceptors.request.use((config) => {
showFullScreenLoading()
return config
}, (error) => {
return Promise.reject(error)
})
// 響應攔截器
$.interceptors.response.use((response) => {
tryHideFullScreenLoading()
return response
}, (error) => {
return Promise.reject(error)
})
那么showFullScreenLoading
tryHideFullScreenLoading()
要干的事兒就是將同一時刻的請求合并劳闹。聲明一個變量needLoadingRequestCount
,每次調(diào)用showFullScreenLoading
方法 needLoadingRequestCount + 1
。調(diào)用tryHideFullScreenLoading()
方法本涕,needLoadingRequestCount - 1
业汰。needLoadingRequestCount
為 0 時,結(jié)束 loading菩颖。
let needLoadingRequestCount = 0
export function showFullScreenLoading() {
if (needLoadingRequestCount === 0) {
startLoading()
}
needLoadingRequestCount++
}
export function tryHideFullScreenLoading() {
if (needLoadingRequestCount <= 0) return
needLoadingRequestCount--
if (needLoadingRequestCount === 0) {
endLoading()
}
}
startLoading()
和endLoading()
就是調(diào)用 element 的 loading 方法样漆。
import { Loading } from 'element-ui'
let loading
function startLoading() {
loading = Loading.service({
lock: true,
text: '加載中……',
background: 'rgba(0, 0, 0, 0.7)'
})
}
function endLoading() {
loading.close()
}
到這里,基本功能已經(jīng)實現(xiàn)了位他。每發(fā)一個 post 請求氛濒,都會顯示全屏 loading产场。同一時刻的多個請求合并為一次 loading鹅髓,在所有響應都返回后,結(jié)束 loading京景。
功能增強
實際上窿冯,現(xiàn)在的功能還差一點。如果某個請求不需要 loading 呢确徙,那么發(fā)請求的時候加個 showLoading: false
的參數(shù)就好了醒串。在請求攔截和響應攔截時判斷下該請求是否需要loading,需要 loading 再去調(diào)用showFullScreenLoading()
方法即可鄙皇。
在封裝 post 請求時芜赌,已經(jīng)在第三個參數(shù)加了 config 對象。config 里包含了 showloading
伴逸。然后在攔截器中分別處理缠沈。
// 請求攔截器
$.interceptors.request.use((config) => {
if (config.showLoading) {
showFullScreenLoading()
}
return config
})
// 響應攔截器
$.interceptors.response.use((response) => {
if (response.config.showLoading) {
tryHideFullScreenLoading()
}
return response
})
我們在調(diào)用 axios 時把 config 放在第三個參數(shù)中,axios 會直接把 showloading 放在請求攔截器的回調(diào)參數(shù)里错蝴,可以直接使用洲愤。在響應攔截器中的回調(diào)參數(shù) response 中則是有一個 config 的 key。這個 config 則是和請求攔截器的回調(diào)參數(shù) config 一樣顷锰。
更新:2018-6-7
合并一定間隔時間內(nèi)請求的 loading
上面的代碼已經(jīng)實現(xiàn)了將有時間重合的 loading 合并柬赐,什么意思呢?請看下圖
在 request1 的 loading 還沒結(jié)束時官紫,request2 的 loading 已經(jīng)開始肛宋。這種情況 request1 和 request2 在時間上有一定的重合,所以 loading 可以合并束世。
那么 request3 是在 request2 結(jié)束后 100ms 開始 loading.這時你會發(fā)現(xiàn) loading 兩次酝陈,并且中間有一次極短的閃爍,這當然是很不好的體驗了良狈。
我們只需要修改 tryHideFullScreenLoading 即可:
export function tryHideFullScreenLoading() {
if (needLoadingRequestCount <= 0) return
needLoadingRequestCount--
if (needLoadingRequestCount === 0) {
_.debounce(tryCloseLoading, 300)()
}
}
const tryCloseLoading = () => {
if (needLoadingRequestCount === 0) {
loading.close()
}
}
在之前的版本中后添,tryHideFullScreenLoading 方法會判斷 needLoadingRequestCount === 0 立即關閉 loading。現(xiàn)在使用 lodash. debounce,延遲 300ms 再調(diào)用 tryCloseLoading 方法。
現(xiàn)在 300ms 間隔內(nèi)的 loading 也就合并為一次啦……