用Axios Element 實現全局的請求 loading

 

 

Kapture 2018-06-07 at 14.57.40.gif

demo in github

背景

業務需求是這樣子的，每當發請求到後端時就觸發一個全屏的 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 也就合併爲一次啦……