Axios Element 實現全域性的請求 loading
背景
業務需求是這樣子的,每當發請求到後端時就觸發一個全屏的 loading,多個請求合併為一次 loading。
現在專案中用的是 vue 、axios、element等,所以文章主要是講如果使用 axios 和 element 實現這個功能。
分析
首先,請求開始的時候開始 loading, 然後在請求返回後結束 loading。重點就是要攔截請求和響應。
然後,要解決多個請求合併為一次 loading。
最後,呼叫element 的 loading 元件即可。
攔截請求和響應
axios 的基本使用方法不贅述。筆者在專案中使用 axios 是以建立例項的方式。
// 建立axios例項
const $ = axios.create({
baseURL: `${URL_PREFIX}`,
timeout: 15000
})
然後再封裝 post 請求(以 post 為例)
export default {
post: (url, data, config = { showLoading: true }) => $.post(url, data, config)
}
axios 提供了請求攔截和響應攔截的介面,每次請求都會呼叫showFullScreenLoading
方法,每次響應都會呼叫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
,每次呼叫showFullScreenLoading
方法 needLoadingRequestCount + 1
。呼叫tryHideFullScreenLoading()
方法,needLoadingRequestCount - 1
。needLoadingRequestCount
為 0 時,結束 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()
就是呼叫 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()
}
到這裡,基本功能已經實現了。每發一個 post 請求,都會顯示全屏 loading。同一時刻的多個請求合併為一次 loading,在所有響應都返回後,結束 loading。
功能增強
實際上,現在的功能還差一點。如果某個請求不需要 loading 呢,那麼發請求的時候加個 showLoading: false
的引數就好了。在請求攔截和響應攔截時判斷下該請求是否需要loading,需要 loading 再去呼叫showFullScreenLoading()
方法即可。
在封裝 post 請求時,已經在第三個引數加了 config 物件。config 裡包含了 showloading
。然後在攔截器中分別處理。
// 請求攔截器
$.interceptors.request.use((config) => {
if (config.showLoading) {
showFullScreenLoading()
}
return config
})
// 響應攔截器
$.interceptors.response.use((response) => {
if (response.config.showLoading) {
tryHideFullScreenLoading()
}
return response
})
我們在呼叫 axios 時把 config 放在第三個引數中,axios 會直接把 showloading 放在請求攔截器的回撥引數裡,可以直接使用。在響應攔截器中的回撥引數 response 中則是有一個 config 的 key。這個 config 則是和請求攔截器的回撥引數 config 一樣。
更新:2018-6-7
合併一定間隔時間內請求的 loading
上面的程式碼已經實現了將有時間重合的 loading 合併,什麼意思呢?請看下圖
image.png
在 request1 的 loading 還沒結束時,request2 的 loading 已經開始。這種情況 request1 和 request2 在時間上有一定的重合,所以 loading 可以合併。
那麼 request3 是在 request2 結束後 100ms 開始 loading.這時你會發現 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。現在使用 lodash. debounce,延遲 300ms 再呼叫 tryCloseLoading 方法。
現在 300ms 間隔內的 loading 也就合併為一次啦……
連結:https://www.jianshu.com/p/c66adc327553