用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 也就合并为一次啦……